NamedValueSet¶
- class lsst.daf.butler.NamedValueSet(elements: Iterable[K] = ())¶
Bases:
NameMappingSetView
[K
],NamedValueMutableSet
[K
]Custom mutable set class.
A custom mutable set class that requires elements to have a
.name
attribute, which can then be used as keys indict
-like lookup.Names and elements can both be used with the
in
anddel
operators,remove
, anddiscard
. Names (but not elements) can be used with[]
-based element retrieval (not assignment) and theget
method.- Parameters:
- elements
collections.abc.Iterable
Iterable over elements to include in the set.
- elements
- Raises:
- AttributeError
Raised if one or more elements do not have a
.name
attribute.
Notes
Iteration order is guaranteed to be the same as insertion order (with the same general behavior as
dict
ordering). Likedicts
, sets with the same elements will compare as equal even if their iterator order is not the same.Methods Summary
add
(element)Add an element to the set.
clear
()This is slow (creates N new iterators!) but effective.
copy
()Return a new
NamedValueSet
with the same elements.discard
(element)Remove an element from the set if it exists.
freeze
()Disable all mutators.
issubset
(other)issuperset
(other)pop
(*args)Remove and return an element from the set.
remove
(element)Remove an element from the set.
update
(elements)Add multiple new elements to the set.
Methods Documentation
- add(element: K) None ¶
Add an element to the set.
- Parameters:
- element
typing.Any
The element to add.
- element
- Raises:
- AttributeError
Raised if the element does not have a
.name
attribute.
- copy() NamedValueSet[K] ¶
Return a new
NamedValueSet
with the same elements.
- discard(element: str | K) Any ¶
Remove an element from the set if it exists.
Does nothing if no matching element is present.
- freeze() NamedValueAbstractSet[K] ¶
Disable all mutators.
Effectively transforming
self
into an immutable set.- Returns:
- self
NamedValueAbstractSet
While
self
is modified in-place, it is also returned with a type annotation that reflects its new, frozen state; assigning it to a new variable (and considering any previous references invalidated) should allow for more accurate static type checking.
- self
- pop(*args: str) K ¶
Remove and return an element from the set.
- Parameters:
- *args
str
, optional Name of the element to remove and return. Must be passed positionally. If not provided, an arbitrary element is removed and returned.
- *args
- Raises:
- KeyError
Raised if
name
is provided butdefault
is not, and no matching element exists.