CollectionSearch

class lsst.daf.butler.registry.wildcards.CollectionSearch

Bases: pydantic.main.BaseModel, collections.abc.Sequence

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:
collections : tuple [ str ]

Tuple of collection names, ordered from the first searched to the last searched.

Deprecated since version v25.0: Tuples of string collection names are now preferred. Will be removed after v26.

Attributes Summary

copy Duplicate a model, optionally choose which fields to include, exclude and change.
dict Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
json Generate a JSON representation of the model, include and exclude arguments as per dict().

Methods Summary

construct(_fields_set, None] = None, **values) Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
count(value)
explicitNames() 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.
parse_file(path, pathlib.Path], *, …)
parse_obj(obj)
parse_raw(b, bytes], *, content_type, …)
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)

Attributes Documentation

copy

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
dict

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

json

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Methods Documentation

classmethod construct(_fields_set: Optional[SetStr, None] = None, **values) → 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

count(value) → integer -- return number of occurrences of value
explicitNames() → collections.abc.Iterator[str]

Iterate over collection names that were specified explicitly.

classmethod fromExpression(expression: Any) → lsst.daf.butler.registry.wildcards.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.
classmethod from_orm(obj: Any) → Model
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.

classmethod parse_file(path: Union[str, pathlib.Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: pydantic.parse.Protocol = None, allow_pickle: bool = False) → Model
classmethod parse_obj(obj: Any) → Model
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: pydantic.parse.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) → unicode
classmethod update_forward_refs(**localns) → None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

classmethod validate(value: Any) → Model