CollectionSearch¶
- class lsst.daf.butler.registry.CollectionSearch(*, __root__: Tuple[str, ...])¶
Bases:
BaseModel
,Sequence
[str
]An ordered search path of collections.
The
fromExpression
method should almost always be used to construct instances, as the regular constructor performs no checking of inputs (and that can lead to confusing error messages downstream).- Parameters:
Notes
A
CollectionSearch
is used to find a single dataset (or set of datasets with different dataset types or data IDs) according to its dataset type and data ID, giving preference to collections in the order in which they are specified. ACollectionQuery
can be constructed from a broader range of expressions but does not order the collections to be searched.CollectionSearch
is an immutable sequence ofstr
collection names.A
CollectionSearch
instance constructed properly (e.g. viafromExpression
) is a unique representation of a particular search path; it is exactly the same internally and compares as equal to anyCollectionSearch
constructed from an equivalent expression, regardless of how different the original expressions appear.Methods Summary
construct
([_fields_set])Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
copy
(*[, include, exclude, update, deep])Duplicate a model, optionally choose which fields to include, exclude and change.
count
(value)dict
(*[, include, exclude, by_alias, ...])Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
Iterate over collection names that were specified explicitly.
fromExpression
(expression)Process a general expression to construct a
CollectionSearch
instance.from_orm
(obj)index
(value, [start, [stop]])Raises ValueError if the value is not present.
iter
(manager, *[, datasetType, ...])Iterate over collection records that match this instance and the given criteria, in order.
json
(*[, include, exclude, by_alias, ...])Generate a JSON representation of the model,
include
andexclude
arguments as perdict()
.parse_file
(path, *[, content_type, ...])parse_obj
(obj)parse_raw
(b, *[, content_type, encoding, ...])schema
([by_alias, ref_template])schema_json
(*[, by_alias, ref_template])update_forward_refs
(**localns)Try to update ForwardRefs on fields based on this Model, globalns and localns.
validate
(value)Methods Documentation
- classmethod construct(_fields_set: SetStr | None = None, **values: Any) Model ¶
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if
Config.extra = 'allow'
was set since it adds all passed values
- copy(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, update: DictStrAny | None = None, deep: bool = False) Model ¶
Duplicate a model, optionally choose which fields to include, exclude and change.
- Parameters:
include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to
True
to make a deep copy of the model
- Returns:
new model instance
- count(value) integer -- return number of occurrences of value ¶
- dict(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, by_alias: bool = False, skip_defaults: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) DictStrAny ¶
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- classmethod fromExpression(expression: Any) CollectionSearch ¶
Process a general expression to construct a
CollectionSearch
instance.- Parameters:
- expression
- May be:
a
str
collection name;an iterable of
str
collection names;another
CollectionSearch
instance (passed through unchanged).
Duplicate entries will be removed (preserving the first appearance of each collection name).
- Returns
- ——-
- collections
CollectionSearch
A
CollectionSearch
instance.
- index(value[, start[, stop]]) integer -- return first index of value. ¶
Raises ValueError if the value is not present.
Supporting start and stop arguments is optional, but recommended.
- iter(manager: CollectionManager, *, datasetType: DatasetType | None = None, collectionTypes: AbstractSet[CollectionType] = frozenset({CollectionType.RUN, CollectionType.TAGGED, CollectionType.CHAINED, CollectionType.CALIBRATION}), done: Set[str] | None = None, flattenChains: bool = True, includeChains: bool | None = None) Iterator[CollectionRecord] ¶
Iterate over collection records that match this instance and the given criteria, in order.
This method is primarily intended for internal use by
Registry
; other callers should generally preferRegistry.findDatasets
or otherRegistry
query methods.- Parameters:
- manager
CollectionManager
Object responsible for managing the collection tables in a
Registry
.- collectionTypes
AbstractSet
[CollectionType
], optional If provided, only yield collections of these types.
- done
set
, optional A
set
containing the names of all collections already yielded; any collections whose names are already present in this set will not be yielded again, and those yielded will be added to it while iterating. If not provided, an emptyset
will be created and used internally to avoid duplicates.- flattenChains
bool
, optional If
True
(default) recursively yield the child collections ofCHAINED
collections.- includeChains
bool
, optional If
False
, return records forCHAINED
collections themselves. The default is the opposite offlattenChains
: either return records for CHAINED collections or their children, but not both.
- manager
- Yields:
- record
CollectionRecord
Matching collection records.
- record
- json(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, by_alias: bool = False, skip_defaults: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Callable[[Any], Any] | None = None, models_as_dict: bool = True, **dumps_kwargs: Any) unicode ¶
Generate a JSON representation of the model,
include
andexclude
arguments as perdict()
.encoder
is an optional function to supply asdefault
to json.dumps(), other arguments as perjson.dumps()
.
- classmethod parse_file(path: str | Path, *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model ¶
- classmethod parse_raw(b: str | bytes, *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model ¶
- classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') DictStrAny ¶
- classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) unicode ¶