lsst.daf.persistence  13.0-17-gd5d205a+2
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.daf.persistence.repositoryCfg.RepositoryCfg Class Reference
Inheritance diagram for lsst.daf.persistence.repositoryCfg.RepositoryCfg:

Public Member Functions

def __init__
 
def __eq__
 
def __ne__
 
def root
 
def root
 
def mapper
 
def mapper
 
def mapperArgs
 
def mapperArgs
 
def parents
 
def addParents
 
def policy
 
def matchesArgs
 
def __repr__
 

Static Public Member Functions

def v1Constructor
 
def makeFromArgs
 

Public Attributes

 root
 
 mapper
 
 mapperArgs
 
 parents
 

Static Public Attributes

string yaml_tag = u"!RepositoryCfg_v1"
 

Detailed Description

RepositoryCfg stores the configuration of a repository. Its contents are persisted to the repository
when the repository is created in persistent storage. Thereafter the the RepositoryCfg should not change.

Parameters
----------
mapper : string
    The mapper associated with the repository. The string should be importable to a class object.
mapperArgs : dict
    Arguments & values to pass to the mapper when initializing it.
parents : list of URI
    URIs to the locaiton of the parent RepositoryCfgs of this repository.
policy : dict
    Policy associated with this repository, overrides all other policy data (which may be loaded from
    policies in derived packages).
deserializing : bool
    Butler internal use only. This flag is used to indicate to the init funciton that the repository class
    is being deserialized and should not perform certain operations that normally happen in other uses of
    init.

Definition at line 34 of file repositoryCfg.py.

Constructor & Destructor Documentation

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.__init__ (   self,
  root,
  mapper,
  mapperArgs,
  parents,
  policy,
  deserializing = False 
)

Definition at line 56 of file repositoryCfg.py.

Member Function Documentation

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.__eq__ (   self,
  other 
)

Definition at line 93 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.__ne__ (   self,
  other 
)

Definition at line 101 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.__repr__ (   self)

Definition at line 181 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.addParents (   self,
  newParents 
)

Definition at line 136 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.makeFromArgs (   repositoryArgs,
  parents 
)
static

Definition at line 148 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.mapper (   self)

Definition at line 115 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.mapper (   self,
  mapper 
)

Definition at line 119 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.mapperArgs (   self)

Definition at line 125 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.mapperArgs (   self,
  newDict 
)

Definition at line 129 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.matchesArgs (   self,
  repositoryArgs 
)
Checks that a repositoryArgs instance will work with this repositoryCfg. This is useful
when loading an already-existing repository that has a persisted cfg, to ensure that the args that are
passed into butler do not conflict with the persisted cfg.

Definition at line 156 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.parents (   self)

Definition at line 133 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.policy (   self)

Definition at line 144 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.root (   self)

Definition at line 105 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.root (   self,
  root 
)

Definition at line 109 of file repositoryCfg.py.

def lsst.daf.persistence.repositoryCfg.RepositoryCfg.v1Constructor (   loader,
  node 
)
static
Constructor for 'version 1' of the serlized RepositoryCfg.

If new parameters are added to RepositoryCfg they will have to be checked for in d; if they are there
then their value should be used and if they are not there a default value must be used in place.

In case the structure of the serialzed file must be changed in a way that invalidates some of the
keys:
1. Increment the version number (after _v1) in the yaml_tag of this class.
2. Add a new constructor (similar to this one) to deserialze new serializations of this class.
3. Registered the new constructor for the new version with yaml, the same way it is done at the bottom
   of this file.
4. All constructors for the older version(s) of persisted RepositoryCfg must be changed to adapt
   the old keys to their new uses and create the current (new) version of a repository cfg, or raise a
   RuntimeError in the case that older versions of serialized RepositoryCfgs can not be adapted.
There is an example of migrating from a fictitious v0 to v1 in tests/repositoryCfg.py

Definition at line 71 of file repositoryCfg.py.

Member Data Documentation

lsst.daf.persistence.repositoryCfg.RepositoryCfg.mapper

Definition at line 97 of file repositoryCfg.py.

lsst.daf.persistence.repositoryCfg.RepositoryCfg.mapperArgs

Definition at line 98 of file repositoryCfg.py.

lsst.daf.persistence.repositoryCfg.RepositoryCfg.parents

Definition at line 99 of file repositoryCfg.py.

lsst.daf.persistence.repositoryCfg.RepositoryCfg.root

Definition at line 96 of file repositoryCfg.py.

string lsst.daf.persistence.repositoryCfg.RepositoryCfg.yaml_tag = u"!RepositoryCfg_v1"
static

Definition at line 54 of file repositoryCfg.py.


The documentation for this class was generated from the following file: