lsst.daf.persistence.repository.Repository Class Reference

Inheritance diagram for lsst.daf.persistence.repository.Repository:

Public Member Functions
def	__init__ (self, repoData)
def	write (self, butlerLocation, obj)
def	read (self, butlerLocation)
def	mappers (self)
	Mapper Access #. More...
def	getRegistry (self)
def	getKeys (self, args, kwargs)
def	map (self, args, kwargs)
def	queryMetadata (self, args, kwargs)
def	backup (self, args, kwargs)
def	getMapperDefaultLevel (self)
def	exists (self, location)

Detailed Description

Represents a repository of persisted data and has methods to access that data.

Definition at line 127 of file repository.py.

Constructor & Destructor Documentation

__init__()

def lsst.daf.persistence.repository.Repository.__init__	(		self,
			repoData
	)

Initialize a Repository with parameters input via RepoData.

Parameters
----------
repoData : RepoData
    Object that contains the parameters with which to init the Repository.

Definition at line 131 of file repository.py.

    def __init__(self, repoData):
        """Initialize a Repository with parameters input via RepoData.

        Parameters
        ----------
        repoData : RepoData
            Object that contains the parameters with which to init the Repository.
        """
        self._storage = Storage.makeFromURI(repoData.cfg.root)
        if repoData.cfg.dirty and not repoData.isV1Repository and repoData.cfgOrigin != 'nested':
            self._storage.putRepositoryCfg(repoData.cfg, repoData.cfgRoot)
        self._mapperArgs = repoData.cfg.mapperArgs  # keep for reference in matchesArgs
        self._initMapper(repoData)

Member Function Documentation

backup()

def lsst.daf.persistence.repository.Repository.backup	(		self,
			args,
			kwargs
	)

Perform mapper.backup.

See mapper.backup for more information about args and kwargs.

:param args: arguments to be passed on to mapper.backup
:param kwargs: keyword arguments to be passed on to mapper.backup
:return: None

Definition at line 263 of file repository.py.

    def backup(self, *args, **kwargs):
        """Perform mapper.backup.

        See mapper.backup for more information about args and kwargs.

        :param args: arguments to be passed on to mapper.backup
        :param kwargs: keyword arguments to be passed on to mapper.backup
        :return: None
        """
        if self._mapper is None:
            return None
        self._mapper.backup(*args, **kwargs)

exists()

def lsst.daf.persistence.repository.Repository.exists	(		self,
			location
	)

Check if location exists in storage.

Parameters
----------
location : ButlerLocation
    Desrcibes a location in storage to look for.

Returns
-------
bool
    True if location exists, False if not.

Definition at line 291 of file repository.py.

    def exists(self, location):
        """Check if location exists in storage.

        Parameters
        ----------
        location : ButlerLocation
            Desrcibes a location in storage to look for.

        Returns
        -------
        bool
            True if location exists, False if not.
        """
        butlerLocationStorage = location.getStorage()
        if butlerLocationStorage:
            return butlerLocationStorage.exists(location)
        else:
            return self._storage.exists(location)

getKeys()

def lsst.daf.persistence.repository.Repository.getKeys	(		self,
			args,
			kwargs
	)

Get the keys available in the repository/repositories.
:param args:
:param kwargs:
:return: A dict of {key:valueType}

Definition at line 219 of file repository.py.

    def getKeys(self, *args, **kwargs):
        """
        Get the keys available in the repository/repositories.
        :param args:
        :param kwargs:
        :return: A dict of {key:valueType}
        """
        # todo: getKeys is not in the mapper API
        if self._mapper is None:
            return None
        keys = self._mapper.getKeys(*args, **kwargs)
        return keys

getMapperDefaultLevel()

def lsst.daf.persistence.repository.Repository.getMapperDefaultLevel

(

self

)

Get the default level of the mapper.

This is typically used if no level is passed into butler methods that call repository.getKeys and/or
repository.queryMetadata. There is a bug in that code because it gets the default level from this
repository but then uses that value when searching all repositories. If this and other repositories
have dissimilar data, the default level value will be nonsensical. A good example of this issue is in
Butler.subset; it needs refactoring.

:return:

Definition at line 276 of file repository.py.

    def getMapperDefaultLevel(self):
        """Get the default level of the mapper.

        This is typically used if no level is passed into butler methods that call repository.getKeys and/or
        repository.queryMetadata. There is a bug in that code because it gets the default level from this
        repository but then uses that value when searching all repositories. If this and other repositories
        have dissimilar data, the default level value will be nonsensical. A good example of this issue is in
        Butler.subset; it needs refactoring.

        :return:
        """
        if self._mapper is None:
            return None
        return self._mapper.getDefaultLevel()

getRegistry()

def lsst.daf.persistence.repository.Repository.getRegistry

(

self

)

Get the registry from the mapper

Returns
-------
Registry or None
    The registry from the mapper or None if the mapper does not have one.

Definition at line 207 of file repository.py.

    def getRegistry(self):
        """Get the registry from the mapper

        Returns
        -------
        Registry or None
            The registry from the mapper or None if the mapper does not have one.
        """
        if self._mapper is None:
            return None
        return self._mapper.getRegistry()

map()

def lsst.daf.persistence.repository.Repository.map	(		self,
			args,
			kwargs
	)

Find a butler location for the given arguments.
See mapper.map for more information about args and kwargs.

:param args: arguments to be passed on to mapper.map
:param kwargs: keyword arguments to be passed on to mapper.map
:return: The type of item is dependent on the mapper being used but is typically a ButlerLocation.

Definition at line 232 of file repository.py.

    def map(self, *args, **kwargs):
        """Find a butler location for the given arguments.
        See mapper.map for more information about args and kwargs.

        :param args: arguments to be passed on to mapper.map
        :param kwargs: keyword arguments to be passed on to mapper.map
        :return: The type of item is dependent on the mapper being used but is typically a ButlerLocation.
        """
        if self._mapper is None:
            raise RuntimeError("No mapper assigned to Repository")
        loc = self._mapper.map(*args, **kwargs)
        if not loc:
            return None
        loc.setRepository(self)
        return loc

mappers()

def lsst.daf.persistence.repository.Repository.mappers

(

self

)

Mapper Access #.

Definition at line 204 of file repository.py.

    def mappers(self):
        return (self._mapper, )

queryMetadata()

def lsst.daf.persistence.repository.Repository.queryMetadata	(		self,
			args,
			kwargs
	)

Gets possible values for keys given a partial data id.

See mapper documentation for more explanation about queryMetadata.

:param args: arguments to be passed on to mapper.queryMetadata
:param kwargs: keyword arguments to be passed on to mapper.queryMetadata
:return:The type of item is dependent on the mapper being used but is typically a set that contains
available values for the keys in the format input argument.

Definition at line 248 of file repository.py.

    def queryMetadata(self, *args, **kwargs):
        """Gets possible values for keys given a partial data id.

        See mapper documentation for more explanation about queryMetadata.

        :param args: arguments to be passed on to mapper.queryMetadata
        :param kwargs: keyword arguments to be passed on to mapper.queryMetadata
        :return:The type of item is dependent on the mapper being used but is typically a set that contains
        available values for the keys in the format input argument.
        """
        if self._mapper is None:
            return None
        ret = self._mapper.queryMetadata(*args, **kwargs)
        return ret

read()

def lsst.daf.persistence.repository.Repository.read	(		self,
			butlerLocation
	)

Read a dataset from Storage.

:param butlerLocation: Contains the details needed to find the desired dataset.
:return: An instance of the dataset requested by butlerLocation.

Definition at line 189 of file repository.py.

    def read(self, butlerLocation):
        """Read a dataset from Storage.

        :param butlerLocation: Contains the details needed to find the desired dataset.
        :return: An instance of the dataset requested by butlerLocation.
        """
        butlerLocationStorage = butlerLocation.getStorage()
        if butlerLocationStorage:
            return butlerLocationStorage.read(butlerLocation)
        else:
            return self._storage.read(butlerLocation)

write()

def lsst.daf.persistence.repository.Repository.write	(		self,
			butlerLocation,
			obj
	)

Write a dataset to Storage.

:param butlerLocation: Contains the details needed to find the desired dataset.
:param dataset: The dataset to be written.
:return:

Definition at line 176 of file repository.py.

    def write(self, butlerLocation, obj):
        """Write a dataset to Storage.

        :param butlerLocation: Contains the details needed to find the desired dataset.
        :param dataset: The dataset to be written.
        :return:
        """
        butlerLocationStorage = butlerLocation.getStorage()
        if butlerLocationStorage:
            return butlerLocationStorage.write(butlerLocation, obj)
        else:
            return self._storage.write(butlerLocation, obj)

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/daf_persistence/17.0.1-1-gfc6fb1f+20/python/lsst/daf/persistence/repository.py

---

Generated on Sat Jun 8 2019 08:10:02 for LSSTApplications by   1.8.13