lsst.daf.butler

Changes

• Butler v24.1.0 2023-01-13
• Butler v24.0.0 2022-08-26
• Butler v23.0.0 2021-12-10
• Butler v22.0 2021-04-01

Using the Butler

• Configuring a Butler
• Datastore Configuration
• Storage Classes, Storage Class Delegates, and Formatters
• Organizing and identifying datasets
• Querying datasets
• Using the Butler in unit tests

This module provides an abstracted data access interface, known as the Butler. It can be used to read and write data without having to know the details of file formats or locations.

The Dimensions System

• Overview
• Dimension Relationships and Containers
• Data IDs
• Spatial and Temporal Dimensions

Concrete Storage Classes

• DataFrame

Butler Command-Line Reference

• Specifying Command-Line Options from a File
• Controlling Log Output from Command-Line Tooling
• butler

Design and Development

lsst.daf.butler is developed at https://github.com/lsst/daf_butler. You can find Jira issues for this module under the daf_butler component.

• Design notes for DataCoordinate

Butler Command Line Interface Development

• The Butler Command
• Butler Command Line Interface Utilities
• Adding Butler Subcommands
• Writing Other Commands

Python API reference

lsst.daf.butler Package

Functions

addDimensionForeignKey(tableSpec, dimension, ...)

Add a field and possibly a foreign key to a table specification.

Classes

AbstractDatastoreCacheManager(config, universe)	An abstract base class for managing caching in a Datastore.
AmbiguousDatasetError	Raised when a DatasetRef is not resolved but should be.
Butler([config, butler, collections, run, ...])	Main entry point for the data access system.
ButlerConfig([other, searchPaths])	Contains the configuration for a Butler
ButlerLogRecords(*, __root__)	Class representing a collection of ButlerLogRecord.
ButlerRepoIndex()	Index of all known butler repositories.
ButlerValidationError	There is a problem with the Butler configuration.
CollectionSearch(*, __root__)	An ordered search path of collections.
CollectionType(value)	Enumeration used to label different types of collections.
CompositesConfig([other, validate, ...])	Configuration specifics for Composites.
CompositesMap(config, *, universe)	Determine whether something should be disassembled.
Config([other])	Implements a datatype that is used by Butler for configuration.
ConfigSubset([other, validate, ...])	Config representing a subset of a more general configuration.
Constraints(config, *, universe)	Determine whether an entity is allowed to be handled.
ConstraintsConfig([other])	Configuration information for Constraints.
ConstraintsValidationError	Thrown when a constraints list has mutually exclusive definitions.
DataCoordinate()	Data ID dictionary.
DataCoordinateIterable()	An abstract base class for homogeneous iterables of data IDs.
DataCoordinateSequence(dataIds, graph, *[, ...])	Iterable supporting the full Sequence interface.
DataCoordinateSet(dataIds, graph, *[, ...])	Iterable iteration that is set-like.
DatabaseDimension(name, storage, *, ...)	A Dimension class that maps directly to a database table or query.
DatabaseDimensionCombination(name, storage, ...)	A combination class that maps directly to a database table or query.
DatabaseDimensionElement(name, storage, *, ...)	An intermediate base class for DimensionElement database classes.
DatabaseTopologicalFamily(name, space, *, ...)	Database topological family implementation.
DatasetAssociation(ref, collection, timespan)	Class representing the membership of a dataset in a single collection.
DatasetComponent(name, storageClass, component)	Component of a dataset and associated information.
DatasetIdGenEnum(value)	This enum is used to specify dataset ID generation options for insert() method.
DatasetRef(datasetType, dataId, *[, id, ...])	Reference to a Dataset in a Registry.
DatasetRefURIs([primaryURI, componentURIs])	Represents the primary and component ResourcePath(s) associated with a DatasetRef.
DatasetType(name, dimensions, storageClass)	A named category of Datasets.
DatasetTypeNotSupportedError	A DatasetType is not handled by this routine.
Datastore(config, bridgeManager[, butlerRoot])	Datastore interface.
DatastoreCacheManager(config, universe)	A class for managing caching in a Datastore using local files.
DatastoreCacheManagerConfig([other, ...])	Configuration information for DatastoreCacheManager.
DatastoreConfig([other, validate, ...])	Configuration for Datastores.
DatastoreDisabledCacheManager(config, universe)	A variant of the datastore cache where no cache is enabled.
DatastoreRecordData(records, ...)	A struct that represents a tabular data export from a single datastore.
DatastoreValidationError	There is a problem with the Datastore configuration.
DeferredDatasetHandle(butler, ref, parameters)	Proxy class that provides deferred loading of datasets from a butler.
Dimension()	A dimension.
DimensionCombination()	Element with extra information.
DimensionConfig([other, validate, searchPaths])	Configuration that defines a DimensionUniverse.
DimensionElement()	A label and/or metadata in the dimensions system.
DimensionGraph(universe[, dimensions, ...])	An immutable, dependency-complete collection of dimensions.
DimensionPacker(fixed, dimensions)	Class for going from DataCoordinate to packed integer ID and back.
DimensionRecord(**kwargs)	Base class for the Python representation of database records.
DimensionRecordsAccumulator()	Class used to accumulate dimension records for serialization.
DimensionUniverse([config, version, ...])	Self-consistent set of dimensions.
FileDataset(path, refs, *[, formatter])	A struct that represents a dataset exported to a file.
FileDescriptor(location, storageClass[, ...])	Describes a particular file.
FileTemplate(template)	Format a path template into a fully expanded path.
FileTemplateValidationError	Exception for file template inconsistent with associated DatasetType.
FileTemplates(config[, default])	Collection of FileTemplate templates.
FileTemplatesConfig([other])	Configuration information for FileTemplates.
Formatter(fileDescriptor, dataId[, ...])	Interface for reading and writing Datasets.
FormatterFactory()	Factory for Formatter instances.
GovernorDimension(name, storage, *, ...)	Governor dimension.
Location(datastoreRootUri, path)	Identifies a location within the Datastore.
LocationFactory(datastoreRoot)	Factory for Location instances.
LookupKey([name, dimensions, dataId, universe])	Representation of key that can be used to lookup information.
MappingFactory(refType)	Register the mapping of some key to a python type and retrieve instances.
NameMappingSetView(mapping)	A lightweight implementation of NamedValueAbstractSet.
NamedKeyDict(*args)	Dictionary wrapper for named keys.
NamedKeyMapping()	Custom mapping class.
NamedValueAbstractSet()	Custom sets with named elements.
NamedValueMutableSet()	Mutable variant of NamedValueAbstractSet.
NamedValueSet([elements])	Custom mutable set class.
Progress(name[, level])	Public interface for reporting incremental progress in the butler and related tools.
PruneCollectionsArgsError	Base class for errors relating to Butler.pruneCollections input arguments.
PurgeUnsupportedPruneCollectionsError(...)	Raised when purge is True but is not supported for the given collection.
PurgeWithoutUnstorePruneCollectionsError()	Raised when purge and unstore are both required to be True, and purge is True but unstore is False.
Quantum(*[, taskName, taskClass, dataId, ...])	Class representing a discrete unit of work.
QuantumBackedButler(quantum, dimensions, ...)	An implementation of LimitedButler intended to back execution of a single Quantum.
QuantumProvenanceData(*, predicted_inputs, ...)	A serializable struct for per-quantum provenance information and datastore records.
Registry()	Abstract Registry interface.
RegistryConfig([other, validate, ...])
RunWithoutPurgePruneCollectionsError(...)	Raised when pruning a RUN collection but purge is False.
SerializedDataCoordinate(*, dataId[, records])	Simplified model for serializing a DataCoordinate.
SerializedDatasetRef(*[, id, datasetType, ...])	Simplified model of a DatasetRef suitable for serialization.
SerializedDatasetType(*, name[, ...])	Simplified model of a DatasetType suitable for serialization.
SerializedDatastoreRecordData(*, ...)	Representation of a DatastoreRecordData suitable for serialization.
SerializedDimensionGraph(*, names)	Simplified model of a DimensionGraph suitable for serialization.
SerializedDimensionRecord(*, definition, record)	Simplified model for serializing a DimensionRecord.
SerializedQuantum(*, taskName[, dataId, ...])	Simplified model of a Quantum suitable for serialization.
SimpleQuery()	A struct that combines SQLAlchemy objects.
SkyPixDimension(system, level)	Special dimension for sky pixelizations.
SkyPixSystem(name, *, maxLevel, ...)	Class for hierarchical pixelization of the sky.
SpatialRegionDatabaseRepresentation(column, name)	Class reflecting how spatial regions are represented inside the DB.
StorageClass([name, pytype, components, ...])	Class describing how a label maps to a particular Python type.
StorageClassConfig([other, validate, ...])	Configuration class for defining Storage Classes.
StorageClassDelegate(storageClass)	Delegate class for StorageClass components and parameters.
StorageClassFactory()	Factory for StorageClass instances.
StoredDatastoreItemInfo()	Internal information associated with a stored dataset in a Datastore.
StoredFileInfo(formatter, path, ...)	Datastore-private metadata associated with a Datastore file.
Timespan(begin, end[, padInstantaneous, _nsec])	A half-open time interval with nanosecond precision.
TimespanDatabaseRepresentation()	Representation of a time span within a database engine.
TopologicalExtentDatabaseRepresentation()	Mapping of in-memory representation of a region to DB representation.
TopologicalFamily(name, space)	A grouping of TopologicalRelationshipEndpoint objects.
TopologicalRelationshipEndpoint()	Representation of a logical table that can participate in overlap joins.
TopologicalSpace(value)	Enumeration of continuous-variable relationships for dimensions.
ValidationError	Some sort of validation error has occurred.
YamlRepoExportBackend(stream, universe)	A repository export implementation that saves to a YAML file.
YamlRepoImportBackend(stream, registry)	A repository import implementation that reads from a YAML file.

Class Inheritance Diagram

class lsst.daf.butler.ButlerURI(uri)

ButlerURI implementation. Exists for backwards compatibility. New code should use lsst.resources.ResourcePath.

lsst.daf.butler.registry Package

Classes

ArgumentError	Exception raised when method arguments are invalid or inconsistent.
CollectionError	Exception raised for collection-related errors.
CollectionExpressionError	Exception raised for an incorrect collection expression.
CollectionSearch(*, __root__)	An ordered search path of collections.
CollectionType(value)	Enumeration used to label different types of collections.
CollectionTypeError	Exception raised when type of a collection is incorrect.
ConflictingDefinitionError	Exception raised when trying to insert a database record when a conflicting record already exists.
DataIdError	Exception raised for incorrect data IDs, this is a base class for other specific error types.
DataIdValueError	Exception raised when a value specified in a data ID does not exist.
DatasetIdGenEnum(value)	This enum is used to specify dataset ID generation options for insert() method.
DatasetTypeError	Exception raised for problems with dataset types.
DatasetTypeExpressionError	Exception raised for an incorrect dataset type expression.
DbAuth([path, envVar, authList])	Retrieves authentication information for database connections.
DbAuthError	Exception raised when a problem has occurred retrieving database authentication information.
DbAuthPermissionsError	Credentials file has incorrect permissions.
DimensionNameError	Exception raised when a dimension specified in a data ID does not exist or required dimension is not provided.
InconsistentDataIdError	Exception raised when a data ID contains contradictory key-value pairs, according to dimension relationships.
MissingCollectionError	Exception raised when an operation attempts to use a collection that does not exist.
NoDefaultCollectionError	Exception raised when a collection is needed, but collection argument is not provided and default collection is not defined in registry.
OrphanedRecordError	Exception raised when trying to remove or modify a database record that is still being used in some other table.
Registry()	Abstract Registry interface.
RegistryConfig([other, validate, ...])
RegistryDefaults([collections, run, infer])	A struct used to provide the default collections searched or written to by a Registry or Butler instance.
RegistryError	Base class for many exception classes produced by Registry methods.
UnsupportedIdGeneratorError	Exception raised when an unsupported DatasetIdGenEnum option is used for insert/import.
UserExpressionError	Exception raised for problems with user expression.
UserExpressionSyntaxError	Exception raised when a user query expression cannot be parsed.

Class Inheritance Diagram

lsst.daf.butler.registry.interfaces Package

Classes

ButlerAttributeExistsError	Exception raised when trying to update existing attribute without specifying force option.
ButlerAttributeManager()	An interface for managing butler attributes in a Registry.
ChainedCollectionRecord(key, name, universe)	A subclass of CollectionRecord that adds the list of child collections in a CHAINED collection.
CollectionManager()	An interface for managing the collections (including runs) in a Registry.
CollectionRecord(key, name, type)	A struct used to represent a collection in internal Registry APIs.
Database(*, origin, engine[, namespace])	An abstract interface that represents a particular database engine's representation of a single schema/namespace/database.
DatabaseConflictError	Exception raised when database content (row values or schema entities) are inconsistent with what this client expects.
DatabaseDimensionOverlapStorage()	A base class for objects that manage overlaps between a pair of database-backed dimensions.
DatabaseDimensionRecordStorage()	Intermediate interface for DimensionRecordStorage objects that provide storage for DatabaseDimensionElement instances.
DatasetIdGenEnum(value)	This enum is used to specify dataset ID generation options for insert() method.
DatasetRecordStorage(datasetType)	An interface that manages the records associated with a particular DatasetType.
DatasetRecordStorageManager()	An interface that manages the tables that describe datasets.
DatastoreRegistryBridge(datastoreName)	An abstract base class that defines the interface that a Datastore uses to communicate with a Registry.
DatastoreRegistryBridgeManager(*, opaque, ...)	An abstract base class that defines the interface between Registry and Datastore when a new Datastore is constructed.
DimensionRecordStorage()	An abstract base class that represents a way of storing the records associated with a single DimensionElement.
DimensionRecordStorageManager(*, universe)	An interface for managing the dimension records in a Registry.
FakeDatasetRef(id)	A fake DatasetRef that can be used internally by butler where only the dataset ID is available.
GovernorDimensionRecordStorage()	Intermediate interface for DimensionRecordStorage objects that provide storage for GovernorDimension instances.
OpaqueTableStorage(name)	An interface that manages the records associated with a particular opaque table in a Registry.
OpaqueTableStorageManager()	An interface that manages the opaque tables in a Registry.
ReadOnlyDatabaseError	Exception raised when a write operation is called on a read-only Database.
RunRecord(key, name, type)	A subclass of CollectionRecord that adds execution information and an interface for updating it.
SchemaAlreadyDefinedError	Exception raised when trying to initialize database schema when some tables already exist.
SkyPixDimensionRecordStorage()	Intermediate interface for DimensionRecordStorage objects that provide storage for SkyPixDimension instances.
StaticTablesContext(db, connection)	Helper class used to declare the static schema for a registry layer in a database.
VersionTuple(major, minor, patch)	Class representing a version number.
VersionedExtension()	Interface for extension classes with versions.

Class Inheritance Diagram

lsst.daf.butler.registry.queries Package

Classes

ChainedDatasetQueryResults(chain[, doomed_by])	A DatasetQueryResults implementation that simply chains together other results objects, each for a different parent dataset type.
DataCoordinateQueryResults(db, ...[, ...])	An enhanced implementation of DataCoordinateIterable that represents data IDs retrieved from a database query.
DatabaseDimensionRecordQueryResults(dataIds, ...)	Implementation of DimensionRecordQueryResults using database query.
DatasetQueryResults()	An interface for objects that represent the results of queries for datasets.
DimensionRecordQueryResults()	An interface for objects that represent the results of queries for dimension records.
ParentDatasetQueryResults(db, query, *, ...)	An object that represents results from a query for datasets with a single parent DatasetType.
Query(*, graph, whereRegion, managers[, ...])	An abstract base class for queries that return some combination of DatasetRef and DataCoordinate objects.
QueryBuilder(summary, managers[, doomed_by])	A builder for potentially complex queries that join tables based on dimension relationships.
QuerySummary(requested, *[, dataId, ...])	A struct that holds and categorizes the dimensions involved in a query.
RegistryManagers(collections, datasets, ...)	Struct used to pass around the manager objects that back a Registry and are used internally by the query system.

Class Inheritance Diagram

lsst.daf.butler.registry.summaries Module

Classes

CollectionSummary(datasetTypes, dimensions)	A summary of the datasets that can be found in a collection.
GovernorDimensionRestriction(mapping)	A custom mapping that represents a restriction on the values one or more governor dimensions may take in some context.

Class Inheritance Diagram

lsst.daf.butler.registry.wildcards Module

Classes

CategorizedWildcard(strings, patterns, items)	The results of preprocessing a wildcard expression to separate match patterns from strings.
CollectionQuery([search, patterns])	An unordered query for collections and dataset type restrictions.
CollectionSearch(*, __root__)	An ordered search path of collections.

Class Inheritance Diagram

Example datastores

lsst.daf.butler.datastores.chainedDatastore Module

Classes

ChainedDatastore(config, bridgeManager[, ...])

Chained Datastores to allow read and writes from multiple datastores.

Class Inheritance Diagram

lsst.daf.butler.datastores.inMemoryDatastore Module

Classes

StoredMemoryItemInfo(timestamp, ...)	Internal InMemoryDatastore Metadata associated with a stored DatasetRef.
InMemoryDatastore(config, bridgeManager[, ...])	Basic Datastore for writing to an in memory cache.

Class Inheritance Diagram

lsst.daf.butler.datastores.fileDatastore Module

Classes

FileDatastore(config, bridgeManager[, ...])

Generic Datastore for file-based implementations.

Class Inheritance Diagram

Example formatters

lsst.daf.butler.formatters.file Module

Classes

FileFormatter(fileDescriptor, dataId[, ...])

Interface for reading and writing files on a POSIX file system.

Class Inheritance Diagram

lsst.daf.butler.formatters.json Module

Classes

JsonFormatter(fileDescriptor, dataId[, ...])

Formatter implementation for JSON files.

Class Inheritance Diagram

lsst.daf.butler.formatters.matplotlib Module

Classes

MatplotlibFormatter(fileDescriptor, dataId)

Interface for writing matplotlib figures.

Class Inheritance Diagram

lsst.daf.butler.formatters.parquet Module

Classes

ParquetFormatter(fileDescriptor, dataId[, ...])

Interface for reading and writing Pandas DataFrames to and from Parquet files.

Class Inheritance Diagram

lsst.daf.butler.formatters.pickle Module

Classes

PickleFormatter(fileDescriptor, dataId[, ...])

Interface for reading and writing Python objects to and from pickle files.

Class Inheritance Diagram

lsst.daf.butler.formatters.yaml Module

Classes

YamlFormatter(fileDescriptor, dataId[, ...])

Formatter implementation for YAML files.

Class Inheritance Diagram

Database backends

lsst.daf.butler.registry.databases.sqlite Module

Classes

SqliteDatabase(*, engine, origin[, ...])

An implementation of the Database interface for SQLite3.

Class Inheritance Diagram

lsst.daf.butler.registry.databases.postgresql Module

Classes

PostgresqlDatabase(*, engine, origin[, ...])

An implementation of the Database interface for PostgreSQL.

Class Inheritance Diagram

Support API

lsst.daf.butler.core.utils Module

Functions

stripIfNotNone(s)	Strip leading and trailing whitespace if the given object is not None.
transactional(func)	Decorate a method and makes it transactional.

lsst.daf.butler.core.repoRelocation Module

Functions

replaceRoot(configRoot, butlerRoot)

Update a configuration root with the butler root location.

Variables

BUTLER_ROOT_TAG

The special string to be used in configuration files to indicate that the butler root location should be used.

Test utilities

lsst.daf.butler.tests Package

Functions

addDataIdValue(butler, dimension, value, ...)	Add the records that back a new data ID to a repository.
addDatasetType(butler, name, dimensions, ...)	Add a new dataset type to a repository.
expandUniqueId(butler, partialId)	Return a complete data ID matching some criterion.
makeTestCollection(repo[, uniqueId])	Create a read/write Butler to a fresh collection.
makeTestRepo(root[, dataIds, config])	Create an empty test repository.
registerMetricsExample(butler)	Modify a repository to support reading and writing MetricsExample objects.

Classes

BadNoWriteFormatter(fileDescriptor, dataId)	A formatter that always fails without writing anything.
BadWriteFormatter(fileDescriptor, dataId[, ...])	A formatter that never works but does leave a file behind.
CliCmdTestBase()	A test case base that is used to verify click command functions import and call their respective script functions correctly.
CliLogTestBase()	Tests log initialization, reset, and setting log levels.
DatasetTestHelper()	Helper methods for Datasets
DatastoreMock()	Mocks a butler datastore.
DatastoreTestHelper()	Helper methods for Datastore tests
DummyRegistry()	Dummy Registry, for Datastore test purposes.
ListDelegate(storageClass)	Parameter handler for list parameters
MetricsDelegate(storageClass)	Parameter handler for parameters using Metrics
MetricsExample([summary, output, data])	Smorgasboard of information that might be the result of some processing.
MetricsExampleModel(*[, summary, output, data])	A variant of MetricsExample based on model.
MultiDetectorFormatter(fileDescriptor, dataId)

Command Line Inteface API

Warning

The command line interface API (everything in lsst.daf.butler.cli) is for only for developer use to write command line interfaces, and is not intended for general use.

lsst.daf.butler.cli.butler Module

Functions

main()

Classes

LoaderCLI(*args, **kwargs)	Extends click.MultiCommand, which dispatches to subcommands, to load subcommands at runtime.
ButlerCLI(*args, **kwargs)

Class Inheritance Diagram

lsst.daf.butler.cli.cmd Package

Variables

associate	Add existing datasets to a tagged collection; searches for datasets with the options and adds them to the named COLLECTION.
butler_import	Import data into a butler repository.
certify_calibrations	Certify calibrations in a repository.
create	Create an empty Gen3 Butler repository.
collection_chain	Define a collection chain.
config_dump	Dump either a subset or full Butler configuration to standard output.
config_validate	Validate the configuration files for a Gen3 Butler repository.
export_calibs	Export calibrations from the butler for import elsewhere.
ingest_files	Ingest files from table file.
prune_collection	Remove a collection and possibly prune datasets within it.
prune_datasets	Query for and remove one or more datasets from a collection and/or storage.
query_collections	Get the collections whose names match an expression.
query_data_ids	List the data IDs in a repository.
query_dataset_types	Get the dataset types in a repository.
query_datasets	List the datasets in a repository.
query_dimension_records	Query for dimension information.
register_dataset_type	Register a new dataset type with this butler repository.
retrieve_artifacts	Retrieve file artifacts associated with datasets in a repository.
remove_collections	Remove one or more non-RUN collections.
remove_runs	Remove one or more RUN collections.
remove_dataset_type	Remove a dataset type definition from a repository.
transfer_datasets	Transfer datasets from a source butler to a destination butler.

lsst.daf.butler.cli.opt Package

Classes

CollectionTypeCallback()
query_datasets_options([repo, showUri, ...])

Variables

collection_argument	Wraps the click.argument decorator to enable shared arguments to be declared.
collection_type_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
collections_argument	Wraps the click.argument decorator to enable shared arguments to be declared.
collections_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
components_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
config_file_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
config_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
confirm_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
dataset_type_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
datasets_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
destination_argument	Wraps the click.argument decorator to enable shared arguments to be declared.
dimensions_argument	Wraps the click.argument decorator to enable shared arguments to be declared.
directory_argument	Wraps the click.argument decorator to enable shared arguments to be declared.
element_argument	Wraps the click.argument decorator to enable shared arguments to be declared.
glob_argument	Wraps the click.argument decorator to enable shared arguments to be declared.
limit_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
locations_argument	Wraps the click.argument decorator to enable shared arguments to be declared.
log_file_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
log_label_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
log_level_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
log_tty_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
long_log_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
offset_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
options_file_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
order_by_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
processes_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
regex_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
register_dataset_types_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
repo_argument	Wraps the click.argument decorator to enable shared arguments to be declared.
run_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
transfer_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
verbose_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
where_option	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.

Class Inheritance Diagram

lsst.daf.butler.cli.utils Module

Functions

astropyTablesToStr(tables)	Render astropy tables to string as they are displayed in the CLI.
printAstropyTables(tables)	Print astropy tables to be displayed in the CLI.
textTypeStr(multiple)	Get the text type string for CLI help documentation.
clickResultMsg(result)	Get a standard assert message from a click result
command_test_env(runner, commandModule, ...)	A context manager that creates (and then cleans up) an environment that provides a CLI plugin command with the given name.
addArgumentHelp(doc, helpText)	Add a Click argument's help message to a function's documentation.
split_commas(context, param, values)	Process a tuple of values, where each value may contain comma-separated values, and return a single list of all the passed-in values.
split_kv(context, param, values[, choice, ...])	Process a tuple of values that are key-value pairs separated by a given separator.
to_upper(context, param, value)	Convert a value to upper case.
unwrap(val)	Remove newlines and leading whitespace from a multi-line string with a consistent indentation level.
yaml_presets(ctx, param, value)	Click callback that reads additional values from the supplied YAML file.
sortAstropyTable(table, dimensions[, sort_first])	Sort an astropy table, with prioritization given to columns in this order: 1.
catch_and_exit(func)	Decorator which catches all exceptions, prints an exception traceback and signals click to exit.

Classes

LogCliRunner([charset, env, echo_stdin, ...])	A test runner to use when the logging system will be initialized by code under test, calls CliLog.resetLog(), which undoes any logging setup that was done with the CliLog interface.
option_section(sectionText)	Decorator to add a section label between options in the help text of a command.
MWPath([exists, file_okay, dir_okay, ...])	Overrides click.Path to implement file-does-not-exist checking.
MWOption([param_decls, show_default, ...])	Overrides click.Option with desired behaviors.
MWArgument(param_decls[, required])	Overrides click.Argument with desired behaviors.
OptionSection(sectionName, sectionText)	Implements an Option that prints a section label in the help text and does not pass any value to the command function.
MWOptionDecorator(*param_decls, **kwargs)	Wraps the click.option decorator to enable shared options to be declared and allows inspection of the shared option.
MWArgumentDecorator(*param_decls, **kwargs)	Wraps the click.argument decorator to enable shared arguments to be declared.
MWCommand(*args, **kwargs)	Command subclass that stores a copy of the args list for use by the command.
ButlerCommand(*args, **kwargs)	Command subclass with butler-command specific overrides.
OptionGroup()	Base class for an option group decorator.
MWCtxObj()	Helper object for managing the click.Context.obj parameter, allows obj data to be managed in a consistent way.

Class Inheritance Diagram

lsst.daf.butler.cli.cliLog Module

Classes

PrecisionLogFormatter([fmt, datefmt, style, ...])	A log formatter that issues accurate timezone-aware timestamps.
CliLog()	Interface for managing python logging and lsst.log.

Class Inheritance Diagram

lsst.daf.butler.cli.progress Module

Classes

ClickProgressHandler(**kwargs)

A ProgressHandler implementation that delegates to click.progressbar.

Class Inheritance Diagram