LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
repositoryMapper.py
Go to the documentation of this file.
1 #!/usr/bin/env python
2 
3 #
4 # LSST Data Management System
5 # Copyright 2016 LSST Corporation.
6 #
7 # This product includes software developed by the
8 # LSST Project (http://www.lsst.org/).
9 #
10 # This program is free software: you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation, either version 3 of the License, or
13 # (at your option) any later version.
14 #
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
19 #
20 # You should have received a copy of the LSST License Statement and
21 # the GNU General Public License along with this program. If not,
22 # see <http://www.lsstcorp.org/LegalNotices/>.
23 #
24 
25 from lsst.daf.persistence import Mapper, ButlerLocation, Policy
26 
27 
29  """"Base class for a mapper to find repository configurations within a butler repository.
30 
31  .. warning::
32 
33  cfg is 'wet paint' and very likely to change. Use of it in production code other than via the 'old
34  butler' API is strongly discouraged.
35  """
36 
37  def __init__(self, storage, policy):
38  # todo I'm guessing the policy would probably want to come from the default in-package location, and
39  # then be overridden where desired by policy in repository root, and then
40  # have the cfg policy applied
41  self.policy = Policy(policy)
42  self.storage = storage
43 
44  def __repr__(self):
45  if 'policy' in self.__dict__ and 'storageCfg' in self.__dict__:
46  return 'RepositoryMapper(policy=%s, storageCfg=%s)' % (self.policy, self.storageCfg)
47  else:
48  return 'uninitialized RepositoryMapper'
49 
50  def map_cfg(self, dataId, write):
51  """Map a location for a cfg file.
52 
53  :param dataId: keys & values to be applied to the template.
54  :param write: True if this map is being done do perform a write operation, else assumes read. Will
55  verify location exists if write is True.
56  :return: a butlerLocation that describes the mapped location.
57  """
58  # todo check: do we need keys to complete dataId? (search Registry)
59  template = self.policy['repositories.cfg.template']
60  location = template % dataId
61  if not write and not self.storage.exists(location):
62  return None
63  bl = ButlerLocation(
64  pythonType=self.policy['repositories.cfg.python'],
65  cppType=None,
66  storageName=self.policy['repositories.cfg.storage'],
67  locationList=(self.storage.locationWithRoot(location),),
68  dataId=dataId,
69  mapper=self)
70  return bl
71 
72  def map_repo(self, dataId, write):
73  if write:
74  return None
75 
76  # todo check: do we need keys to complete dataId? (search Registry)
77 
78  template = self.policy['repositories.repo.template']
79  location = template % dataId
80  if self.storage.exists(location):
81  bl = ButlerLocation(
82  pythonType=self.policy['repositories.repo.python'],
83  cppType=None,
84  storageName=None,
85  locationList=(location,),
86  dataId=dataId,
87  mapper=self)
88  return bl
89  return None
lsst::daf::persistence.repositoryMapper.RepositoryMapper.storage
storage
Definition: repositoryMapper.py:42
lsst::daf::persistence.repositoryMapper.RepositoryMapper.map_cfg
def map_cfg(self, dataId, write)
Definition: repositoryMapper.py:50
lsst::daf::persistence.repositoryMapper.RepositoryMapper.map_repo
def map_repo(self, dataId, write)
Definition: repositoryMapper.py:72
lsst::daf::persistence.butlerLocation.ButlerLocation
Definition: butlerLocation.py:148
lsst::daf::persistence.repositoryMapper.RepositoryMapper.__init__
def __init__(self, storage, policy)
Definition: repositoryMapper.py:37
lsst::daf::persistence.mapper.Mapper
Definition: mapper.py:29
lsst::daf::persistence.repositoryMapper.RepositoryMapper
Definition: repositoryMapper.py:28
lsst::daf::persistence.repositoryMapper.RepositoryMapper.policy
policy
Definition: repositoryMapper.py:41
lsst::daf::persistence.policy.Policy
Definition: policy.py:48
lsst::daf::persistence
Definition: Utils.h:50
lsst::daf::persistence.repositoryMapper.RepositoryMapper.__repr__
def __repr__(self)
Definition: repositoryMapper.py:44