lsst.daf.persistence  13.0-35-g3a9824c
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
lsst.daf.persistence.repository.RepositoryArgs Class Reference
Inheritance diagram for lsst.daf.persistence.repository.RepositoryArgs:

Public Member Functions

def __init__
 
def __repr__
 
def mapper
 
def mapper
 
def cfgRoot
 
def root
 
def tag
 

Static Public Member Functions

def inputRepo
 
def outputRepo
 

Public Attributes

 mapperArgs
 
 tags
 
 mode
 
 policy
 

Detailed Description

Arguments passed into a Butler that are used to instantiate a repository. This includes arguments that
can be used to create a new repository (cfgRoot, root, mapper, mapperArgs, policy) and are persisted along
with the new repository's configuration file. These arguments can also describe how a new or existing
repository are to be used (cfgRoot or root, tags, mode). When indicating an existing repository it is
better to not specify unnecessary arguments, as if they conflict with the persisted repository
configuration then a RuntimeError will be raised during Butler init.

A RepositoryArgs class can be initialized from a dict, if the first argument to the initializer is a dict.

Parameters
----------
cfgRoot : URI or dict, optional
    If dict, the initalizer is re-called with the expanded dict.
    If URI, this is the location where the RepositoryCfg should be found (existing repo) or put (new repo)
root : URI, optional
    If different than cfgRoot then this is the location where the repository should exist. A RepositoryCfg
    will be put at cfgRoot and its root will be a path to root.
mapper : string or class object, optional
    The mapper to use with this repository. If string, should refer an importable object. If class object,
    should be a mapper to be instantiated by the Butler during Butler init.
mapperArgs : dict
    Arguments & values to pass to the mapper when initializing it.
tags : list or object, optional
    One or more unique identifiers to uniquely identify this repository and its parents when performing
    Butler.get.
mode : string, optional
    should be one of 'r', 'w', or 'rw', for 'read', 'write', or 'read-write'. Can be omitted; input
    repositories will default to 'r', output repositories will default to 'w'. 'w' on an input repository
    will raise a RuntimeError during Butler init, although 'rw' works and is equivalent to 'r'. Output
    repositories may be 'r' or 'rw', 'r' for an output repository will raise a RuntimeError during Butler
    init.
policy : dict
    Policy associated with this repository, overrides all other policy data (which may be loaded from
    policies in derived packages).

Definition at line 34 of file repository.py.

Constructor & Destructor Documentation

def lsst.daf.persistence.repository.RepositoryArgs.__init__ (   self,
  cfgRoot = None,
  root = None,
  mapper = None,
  mapperArgs = None,
  tags = None,
  mode = None,
  policy = None 
)

Definition at line 72 of file repository.py.

Member Function Documentation

def lsst.daf.persistence.repository.RepositoryArgs.__repr__ (   self)

Definition at line 85 of file repository.py.

def lsst.daf.persistence.repository.RepositoryArgs.cfgRoot (   self)

Definition at line 101 of file repository.py.

def lsst.daf.persistence.repository.RepositoryArgs.inputRepo (   storage,
  tags = None 
)
static

Definition at line 109 of file repository.py.

def lsst.daf.persistence.repository.RepositoryArgs.mapper (   self)

Definition at line 91 of file repository.py.

def lsst.daf.persistence.repository.RepositoryArgs.mapper (   self,
  mapper 
)

Definition at line 95 of file repository.py.

def lsst.daf.persistence.repository.RepositoryArgs.outputRepo (   storage,
  mapper = None,
  mapperArgs = None,
  tags = None,
  mode = None 
)
static

Definition at line 113 of file repository.py.

def lsst.daf.persistence.repository.RepositoryArgs.root (   self)

Definition at line 105 of file repository.py.

def lsst.daf.persistence.repository.RepositoryArgs.tag (   self,
  tag 
)
add a tag to the repository cfg

Definition at line 116 of file repository.py.

Member Data Documentation

lsst.daf.persistence.repository.RepositoryArgs.mapperArgs

Definition at line 80 of file repository.py.

lsst.daf.persistence.repository.RepositoryArgs.mode

Definition at line 82 of file repository.py.

lsst.daf.persistence.repository.RepositoryArgs.policy

Definition at line 83 of file repository.py.

lsst.daf.persistence.repository.RepositoryArgs.tags

Definition at line 81 of file repository.py.


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