Internal API reference

lsst.resources.utils Module

Functions

os2posix(ospath)

Convert a local path description to a POSIX path description.

posix2os(posix)

Convert a POSIX path description to a local path description.

Classes

NoTransaction()

A simple emulation of the DatastoreTransaction class.

TransactionProtocol(*args, **kwargs)

Protocol for type checking transaction interface.

Class Inheritance Diagram

digraph inheritanceee8d9e030d { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Generic" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Abstract base class for generic types."]; "NoTransaction" [URL="../../../py-api/lsst.resources.utils.NoTransaction.html#lsst.resources.utils.NoTransaction",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A simple emulation of the"]; "Protocol" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for protocol classes."]; "Generic" -> "Protocol" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TransactionProtocol" [URL="../../../py-api/lsst.resources.utils.TransactionProtocol.html#lsst.resources.utils.TransactionProtocol",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Protocol for type checking transaction interface."]; "Protocol" -> "TransactionProtocol" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

lsst.resources._resourceHandles._baseResourceHandle Module

Classes

BaseResourceHandle(mode, log, *[, newline])

Base class interface for the handle like interface of ResourcePath subclasses.

CloseStatus(value[, names, module, ...])

Enumerated closed/open status of a file handle, implementation detail that may be used by BaseResourceHandle children.

ResourceHandleProtocol(*args, **kwargs)

Defines the interface protocol that is compatible with children of BaseResourceHandle.

Class Inheritance Diagram

digraph inheritancefc0307e38d { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "BaseResourceHandle" [URL="../../../py-api/lsst.resources._resourceHandles._baseResourceHandle.BaseResourceHandle.html#lsst.resources._resourceHandles._baseResourceHandle.BaseResourceHandle",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class interface for the handle like interface of"]; "ABC" -> "BaseResourceHandle" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResourceHandleProtocol" -> "BaseResourceHandle" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CloseStatus" [URL="../../../py-api/lsst.resources._resourceHandles._baseResourceHandle.CloseStatus.html#lsst.resources._resourceHandles._baseResourceHandle.CloseStatus",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Enumerated closed/open status of a file handle, implementation detail"]; "Enum" -> "CloseStatus" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Enum" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Create a collection of name/value pairs."]; "Generic" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Abstract base class for generic types."]; "Protocol" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for protocol classes."]; "Generic" -> "Protocol" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResourceHandleProtocol" [URL="../../../py-api/lsst.resources._resourceHandles._baseResourceHandle.ResourceHandleProtocol.html#lsst.resources._resourceHandles._baseResourceHandle.ResourceHandleProtocol",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Defines the interface protocol that is compatible with children of"]; "Protocol" -> "ResourceHandleProtocol" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

lsst.resources._resourceHandles._fileResourceHandle Module

Classes

FileResourceHandle(mode, log, *, filename, ...)

File based specialization of BaseResourceHandle

Class Inheritance Diagram

digraph inheritance45adf7815a { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "BaseResourceHandle" [URL="../../../py-api/lsst.resources._resourceHandles._baseResourceHandle.BaseResourceHandle.html#lsst.resources._resourceHandles._baseResourceHandle.BaseResourceHandle",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class interface for the handle like interface of"]; "ABC" -> "BaseResourceHandle" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResourceHandleProtocol" -> "BaseResourceHandle" [arrowsize=0.5,style="setlinewidth(0.5)"]; "FileResourceHandle" [URL="../../../py-api/lsst.resources._resourceHandles._fileResourceHandle.FileResourceHandle.html#lsst.resources._resourceHandles._fileResourceHandle.FileResourceHandle",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="File based specialization of `.BaseResourceHandle`"]; "BaseResourceHandle" -> "FileResourceHandle" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Generic" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Abstract base class for generic types."]; "Protocol" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for protocol classes."]; "Generic" -> "Protocol" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResourceHandleProtocol" [URL="../../../py-api/lsst.resources._resourceHandles._baseResourceHandle.ResourceHandleProtocol.html#lsst.resources._resourceHandles._baseResourceHandle.ResourceHandleProtocol",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Defines the interface protocol that is compatible with children of"]; "Protocol" -> "ResourceHandleProtocol" [arrowsize=0.5,style="setlinewidth(0.5)"]; }