Inheritance diagram for lsst.daf.persistence.storageInterface.StorageInterface:

Public Member Functions
def	__init__ (self, uri, create)

def	getReadFormatter (cls, objType)

def	getWriteFormatter (cls, objType)

def	registerFormatters (cls, formatable, readFormatter=None, writeFormatter=None)

def	write (self, butlerLocation, obj)

def	read (self, butlerLocation)

def	getLocalFile (self, path)

def	exists (self, location)

def	instanceSearch (self, path)

def	search (cls, root, path)

def	copyFile (self, fromLocation, toLocation)

def	locationWithRoot (self, location)

def	getRepositoryCfg (cls, uri)

def	putRepositoryCfg (cls, cfg, loc=None)

def	getMapperClass (cls, root)

def	relativePath (cls, fromPath, toPath)

def	absolutePath (cls, fromPath, relativePath)

Detailed Description

Defines the interface for a connection to a Storage location.

Parameters
----------
uri : string
    URI or path that is used as the storage location.
create : bool
    If True The StorageInterface subclass should create a new
    repository at the root location. If False then a new repository
    will not be created.

Raises
------
NoRepositroyAtRoot
    If create is False and a repository does not exist at the root
    specified by uri then NoRepositroyAtRoot is raised.

Definition at line 31 of file storageInterface.py.

Constructor & Destructor Documentation

◆ init()

def lsst.daf.persistence.storageInterface.StorageInterface.__init__	(	self,
		uri,
		create
	)

initialzer

Definition at line 51 of file storageInterface.py.

Member Function Documentation

◆ absolutePath()

def lsst.daf.persistence.storageInterface.StorageInterface.absolutePath	(	cls,
		fromPath,
		relativePath
	)

Get an absolute path for the path from fromUri to toUri

Parameters
----------
fromPath : the starting location
    A location at which to start. It can be a relative path or an
    absolute path.
relativePath : the location relative to fromPath
    A relative path.

Returns
-------
string
    Path that is an absolute path representation of fromPath +
    relativePath, if one exists. If relativePath is absolute or if
    fromPath is not related to relativePath then relativePath will be
    returned.

Definition at line 373 of file storageInterface.py.

◆ copyFile()

def lsst.daf.persistence.storageInterface.StorageInterface.copyFile	(	self,
		fromLocation,
		toLocation
	)

Copy a file from one location to another on the local filesystem.

Parameters
----------
fromLocation : string
    Path and name of existing file.
 toLocation : string
    Path and name of new file.

Returns
-------
None

Definition at line 261 of file storageInterface.py.

◆ exists()

def lsst.daf.persistence.storageInterface.StorageInterface.exists	(	self,
		location
	)

Check if location exists.

Parameters
----------
location : ButlerLocation or string
    A a string or a ButlerLocation that describes the location of an
    object in this storage.

Returns
-------
bool
    True if exists, else False.

Definition at line 199 of file storageInterface.py.

◆ getLocalFile()

def lsst.daf.persistence.storageInterface.StorageInterface.getLocalFile	(	self,
		path
	)

Get a handle to a local copy of the file, downloading it to a
temporary if needed.

Parameters
----------
path : string
    A path to the the file in storage, relative to root.

Returns
-------
A handle to a local copy of the file. If storage is remote it will be
a temporary file. If storage is local it may be the original file or
a temporary file. The file name can be gotten via the 'name' property
of the returned object.

Definition at line 181 of file storageInterface.py.

◆ getMapperClass()

def lsst.daf.persistence.storageInterface.StorageInterface.getMapperClass	(	cls,
		root
	)

Get the mapper class associated with a repository root.

Parameters
----------
root : string
    The location of a persisted RepositoryCfg is (new style repos).

Returns
-------
A class object or a class instance, depending on the state of the
mapper when the repository was created.

Definition at line 333 of file storageInterface.py.

◆ getReadFormatter()

def lsst.daf.persistence.storageInterface.StorageInterface.getReadFormatter	(	cls,
		objType
	)

Search in the registered formatters for the objType read formatter.

Parameters
----------
objType : class type
    The type of class to find a formatter for.

Returns
-------
formatter callable
    The formatter callable used to read the object from the storageInterface.

Definition at line 86 of file storageInterface.py.

◆ getRepositoryCfg()

def lsst.daf.persistence.storageInterface.StorageInterface.getRepositoryCfg	(	cls,
		uri
	)

Get a persisted RepositoryCfg

Parameters
----------
uri : URI or path to a RepositoryCfg
    Description

Returns
-------
A RepositoryCfg instance or None

Definition at line 294 of file storageInterface.py.

◆ getWriteFormatter()

def lsst.daf.persistence.storageInterface.StorageInterface.getWriteFormatter	(	cls,
		objType
	)

Search in the registered formatters for the objType write formatter.

Parameters
----------
objType : class type
    The type of class to find a formatter for.

Returns
-------
formatter callable
    The formatter callable used to write the object to the storageInterface.

Definition at line 102 of file storageInterface.py.

◆ instanceSearch()

def lsst.daf.persistence.storageInterface.StorageInterface.instanceSearch	(	self,
		path
	)

Search for the given path in this storage instance.

If the path contains an HDU indicator (a number in brackets before the
dot, e.g. 'foo.fits[1]', this will be stripped when searching and so
will match filenames without the HDU indicator, e.g. 'foo.fits'. The
path returned WILL contain the indicator though, e.g. ['foo.fits[1]'].

Parameters
----------
path : string
    A filename (and optionally prefix path) to search for within root.

Returns
-------
string or None
    The location that was found, or None if no location was found.

Definition at line 215 of file storageInterface.py.

◆ locationWithRoot()

def lsst.daf.persistence.storageInterface.StorageInterface.locationWithRoot	(	self,
		location
	)

Get the full path to the location.

Parameters
----------
location : string
    Path to a location within the repository relative to repository
    root.

Returns
-------
string
    Absolute path to to the locaiton within the repository.

Definition at line 277 of file storageInterface.py.

◆ putRepositoryCfg()

def lsst.daf.persistence.storageInterface.StorageInterface.putRepositoryCfg	(	cls,
		cfg,
		loc = `None`
	)

Serialize a RepositoryCfg to a location.

When loc == cfg.root, the RepositoryCfg is to be written at the root
location of the repository. In that case, root is not written, it is
implicit in the location of the cfg. This allows the cfg to move from
machine to machine without modification.

Parameters
----------
cfg : RepositoryCfg instance
    The RepositoryCfg to be serailized.
loc : string, optional
    The URI location (can be relative path) to write the RepositoryCfg.
    If loc is None, the location will be read from the root parameter
    of loc.

Returns
-------
None

Definition at line 309 of file storageInterface.py.

◆ read()

def lsst.daf.persistence.storageInterface.StorageInterface.read	(	self,
		butlerLocation
	)

Read from a butlerLocation.

Parameters
----------
butlerLocation : ButlerLocation
    The location & formatting for the object(s) to be read.

Returns
-------
A list of objects as described by the butler location. One item for
each location in butlerLocation.getLocations()

Definition at line 166 of file storageInterface.py.

◆ registerFormatters()

def lsst.daf.persistence.storageInterface.StorageInterface.registerFormatters	(	cls,
		formatable,
		readFormatter = `None`,
		writeFormatter = `None`
	)

Register read and/or write formatters for a storageInterface subclass

Parameters
----------
cls : StorageInterface subclass
    The type of StorageInterface the formatter is being registered for.
formatable : class object
    The class object whose instances can be formatted by the formatter.
readFormatter : a read formatter callable
    The formatter function that can be used by the StorageInterface instance to read the object from
    the storage.
writeFormatter : a write formatter callable
    The formatter function that can be used by the StorageInterface instance to write the object to
    the storage.

Raises
------
RuntimeError
    For each object type and StorageInterface subclass the read and write formatters should only be
    registered once. If a second registration occurs for either a RuntimeError is raised.

Definition at line 118 of file storageInterface.py.

◆ relativePath()

def lsst.daf.persistence.storageInterface.StorageInterface.relativePath	(	cls,
		fromPath,
		toPath
	)

Get a relative path from a location to a location.

Parameters
----------
fromPath : string
    A path at which to start. It can be a relative path or an
    absolute path.
toPath : string
    A target location. It can be a relative path or an absolute path.

Returns
-------
string
    A relative path that describes the path from fromPath to toPath.

Definition at line 351 of file storageInterface.py.

◆ search()

def lsst.daf.persistence.storageInterface.StorageInterface.search	(	cls,
		root,
		path
	)

Look for the given path in the current root.

Also supports searching for the path in Butler v1 repositories by
following the Butler v1 _parent symlink

If the path contains an HDU indicator (a number in brackets, e.g.
'foo.fits[1]', this will be stripped when searching and so
will match filenames without the HDU indicator, e.g. 'foo.fits'. The
path returned WILL contain the indicator though, e.g. ['foo.fits[1]'].

Parameters
----------
root : string
    The path to the root directory.
path : string
    The path to the file within the root directory.

Returns
-------
string or None
    The location that was found, or None if no location was found.

Definition at line 236 of file storageInterface.py.

◆ write()

def lsst.daf.persistence.storageInterface.StorageInterface.write	(	self,
		butlerLocation,
		obj
	)

Writes an object to a location and persistence format specified by ButlerLocation

Parameters
----------
butlerLocation : ButlerLocation
    The location & formatting for the object to be written.
obj : object instance
    The object to be written.

Definition at line 154 of file storageInterface.py.

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

python/lsst/daf/persistence/storageInterface.py

Public Member Functions