lsst.daf.persistence.butlerLocation.ButlerLocation Class Reference

Inheritance diagram for lsst.daf.persistence.butlerLocation.ButlerLocation:

Public Member Functions
def	__repr__ (self)
def	__init__ (self, pythonType, cppType, storageName, locationList, dataId, mapper, storage, usedDataId=None, datasetType=None, additionalData=None)
def	__str__ (self)
def	setRepository (self, repository)
def	getRepository (self)
def	getPythonType (self)
def	getCppType (self)
def	getStorageName (self)
def	getLocations (self)
def	getLocationsWithRoot (self)
def	getAdditionalData (self)
def	getStorage (self)

Static Public Member Functions
def	to_yaml (dumper, obj)
def	from_yaml (loader, node)

Public Attributes
	pythonType
	cppType
	storageName
	mapper
	storage
	locationList
	additionalData
	dataId
	usedDataId
	datasetType
	repository

Static Public Attributes
string	yaml_tag = u"!ButlerLocation"
	yaml_loader = yaml.UnsafeLoader
	yaml_dumper = yaml.Dumper

Detailed Description

ButlerLocation is a struct-like class that holds information needed to
persist and retrieve an object using the LSST Persistence Framework.

Mappers should create and return ButlerLocations from their
map_{datasetType} methods.

Parameters
----------
pythonType - string or class instance
    This is the type of python object that should be created when reading the location.

cppType - string or None
    The type of cpp object represented by the location (optional, may be None)

storageName - string
    The type of storage the object is in or should be place into.

locationList - list of string
    A list of URI to place the object or where the object might be found. (Typically when reading the
    length is expected to be exactly 1).

dataId - dict
    The dataId that was passed in when mapping the location. This may include keys that were not used for
    mapping this location.

mapper - mapper class instance
    The mapper object that mapped this location.

storage - storage class instance
    The storage interface that can be used to read or write this location.

usedDataId - dict
    The dataId components that were used to map this location. If the mapper had to look up keys those
    will be in this dict (even though they may not appear in the dataId parameter). If the dataId
    parameter contained keys that were not required to map this item then those keys will NOT be in this
    parameter.

datasetType - string
    The datasetType that this location represents.

additionalData : `lsst.daf.base.PropertySet`, optional
    Additional metadata to be passed to the persistence framework,
    or `None`.

Definition at line 148 of file butlerLocation.py.

Constructor & Destructor Documentation

__init__()

def lsst.daf.persistence.butlerLocation.ButlerLocation.__init__	(		self,
			pythonType,
			cppType,
			storageName,
			locationList,
			dataId,
			mapper,
			storage,
			usedDataId = None,
			datasetType = None,
			additionalData = None
	)

Definition at line 209 of file butlerLocation.py.

                 usedDataId=None, datasetType=None, additionalData=None):
        self.pythonType = pythonType
        self.cppType = cppType
        self.storageName = storageName
        self.mapper = mapper
        self.storage = storage
        self.locationList = iterify(locationList)
        self.additionalData = additionalData if additionalData else dafBase.PropertySet()
        for k, v in dataId.items():
            self.additionalData.set(k, v)
        self.dataId = dataId
        self.usedDataId = usedDataId
        self.datasetType = datasetType
 

Member Function Documentation

__repr__()

def lsst.daf.persistence.butlerLocation.ButlerLocation.__repr__

(

self

)

Definition at line 202 of file butlerLocation.py.

    def __repr__(self):
        return \
            'ButlerLocation(pythonType=%r, cppType=%r, storageName=%r, storage=%r, locationList=%r,' \
            ' additionalData=%r, mapper=%r, dataId=%r)' % \
            (self.pythonType, self.cppType, self.storageName, self.storage, self.locationList,
             self.additionalData, self.mapper, self.dataId)
 

__str__()

def lsst.daf.persistence.butlerLocation.ButlerLocation.__str__

(

self

)

Definition at line 224 of file butlerLocation.py.

    def __str__(self):
        s = "%s at %s(%s)" % (self.pythonType, self.storageName,
                              ", ".join(self.locationList))
        return s
 

from_yaml()

def lsst.daf.persistence.butlerLocation.ButlerLocation.from_yaml (   loader,   node  )

static

Definition at line 243 of file butlerLocation.py.

    def from_yaml(loader, node):
        obj = loader.construct_mapping(node)
        return ButlerLocation(**obj)
 

getAdditionalData()

def lsst.daf.persistence.butlerLocation.ButlerLocation.getAdditionalData

(

self

)

Definition at line 268 of file butlerLocation.py.

    def getAdditionalData(self):
        return self.additionalData
 

getCppType()

def lsst.daf.persistence.butlerLocation.ButlerLocation.getCppType

(

self

)

Definition at line 256 of file butlerLocation.py.

    def getCppType(self):
        return self.cppType
 

getLocations()

def lsst.daf.persistence.butlerLocation.ButlerLocation.getLocations

(

self

)

Definition at line 262 of file butlerLocation.py.

    def getLocations(self):
        return self.locationList
 

getLocationsWithRoot()

def lsst.daf.persistence.butlerLocation.ButlerLocation.getLocationsWithRoot

(

self

)

Definition at line 265 of file butlerLocation.py.

    def getLocationsWithRoot(self):
        return [os.path.join(self.storage.root, loc) for loc in self.getLocations()]
 

getPythonType()

def lsst.daf.persistence.butlerLocation.ButlerLocation.getPythonType

(

self

)

Definition at line 253 of file butlerLocation.py.

    def getPythonType(self):
        return self.pythonType
 

getRepository()

def lsst.daf.persistence.butlerLocation.ButlerLocation.getRepository

(

self

)

Definition at line 250 of file butlerLocation.py.

    def getRepository(self):
        return self.repository
 

getStorage()

def lsst.daf.persistence.butlerLocation.ButlerLocation.getStorage

(

self

)

Definition at line 271 of file butlerLocation.py.

    def getStorage(self):
        return self.storage

getStorageName()

def lsst.daf.persistence.butlerLocation.ButlerLocation.getStorageName

(

self

)

Definition at line 259 of file butlerLocation.py.

    def getStorageName(self):
        return self.storageName
 

setRepository()

def lsst.daf.persistence.butlerLocation.ButlerLocation.setRepository	(		self,
			repository
	)

Definition at line 247 of file butlerLocation.py.

    def setRepository(self, repository):
        self.repository = repository
 

to_yaml()

def lsst.daf.persistence.butlerLocation.ButlerLocation.to_yaml (   dumper,   obj  )

static

Representer for dumping to YAML
:param dumper:
:param obj:
:return:

Definition at line 230 of file butlerLocation.py.

    def to_yaml(dumper, obj):
        """Representer for dumping to YAML
        :param dumper:
        :param obj:
        :return:
        """
        return dumper.represent_mapping(ButlerLocation.yaml_tag,
                                        {'pythonType': obj.pythonType, 'cppType': obj.cppType,
                                         'storageName': obj.storageName,
                                         'locationList': obj.locationList, 'mapper': obj.mapper,
                                         'storage': obj.storage, 'dataId': obj.dataId})
 

Member Data Documentation

additionalData

lsst.daf.persistence.butlerLocation.ButlerLocation.additionalData

Definition at line 217 of file butlerLocation.py.

cppType

lsst.daf.persistence.butlerLocation.ButlerLocation.cppType

Definition at line 212 of file butlerLocation.py.

dataId

lsst.daf.persistence.butlerLocation.ButlerLocation.dataId

Definition at line 220 of file butlerLocation.py.

datasetType

lsst.daf.persistence.butlerLocation.ButlerLocation.datasetType

Definition at line 222 of file butlerLocation.py.

locationList

lsst.daf.persistence.butlerLocation.ButlerLocation.locationList

Definition at line 216 of file butlerLocation.py.

mapper

lsst.daf.persistence.butlerLocation.ButlerLocation.mapper

Definition at line 214 of file butlerLocation.py.

pythonType

lsst.daf.persistence.butlerLocation.ButlerLocation.pythonType

Definition at line 211 of file butlerLocation.py.

repository

lsst.daf.persistence.butlerLocation.ButlerLocation.repository

Definition at line 248 of file butlerLocation.py.

storage

lsst.daf.persistence.butlerLocation.ButlerLocation.storage

Definition at line 215 of file butlerLocation.py.

storageName

lsst.daf.persistence.butlerLocation.ButlerLocation.storageName

Definition at line 213 of file butlerLocation.py.

usedDataId

lsst.daf.persistence.butlerLocation.ButlerLocation.usedDataId

Definition at line 221 of file butlerLocation.py.

yaml_dumper

lsst.daf.persistence.butlerLocation.ButlerLocation.yaml_dumper = yaml.Dumper

static

Definition at line 200 of file butlerLocation.py.

yaml_loader

lsst.daf.persistence.butlerLocation.ButlerLocation.yaml_loader = yaml.UnsafeLoader

static

Definition at line 197 of file butlerLocation.py.

yaml_tag

string lsst.daf.persistence.butlerLocation.ButlerLocation.yaml_tag = u"!ButlerLocation"

static

Definition at line 194 of file butlerLocation.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/daf_persistence/22.0.1-4-g243d05b+871c1b8305/python/lsst/daf/persistence/butlerLocation.py