SetOf type¶
- class pyasn1.type.univ.SetOf(componentType=NoValue(), tagSet=TagSet(), subtypeSpec=ConstraintsIntersection())¶
Create SetOf schema or value object.
SetOf class is based on
ConstructedAsn1Type
, its objects are mutable and duck-type Pythonlist
objects.- Keyword Arguments:
componentType (
PyAsn1Item
derivative) – A pyasn1 object representing ASN.1 type allowed within SetOf typetagSet (
TagSet
) – Object representing non-default ASN.1 tag(s)subtypeSpec (
ConstraintsIntersection
) – Object representing non-default ASN.1 subtype constraint(s). Constraints verification for SetOf type can only occur on explicit .isInconsistent call.
Examples
class LotteryDraw(SequenceOf): # SetOf is similar ''' ASN.1 specification: LotteryDraw ::= SEQUENCE OF INTEGER ''' componentType = Integer() lotteryDraw = LotteryDraw() lotteryDraw.extend([123, 456, 789])
Note
The SetOf type models a collection of elements of a single ASN.1 type. Ordering of the components is not preserved upon de/serialisation.
- clone(componentType=NoValue(), tagSet=TagSet(), subtypeSpec=ConstraintsIntersection())¶
Create a modified version of SetOf schema object.
The clone() method accepts the same set arguments as SetOf class takes on instantiation except that all arguments of the clone() method are optional.
Whatever arguments are supplied, they are used to create a copy of self taking precedence over the ones used to instantiate self.
Possible values of self are never copied over thus clone() can only create a new schema object.
- Returns:
new instance of SetOf type/value
Note
Due to the mutable nature of the SetOf object, even if no arguments are supplied, a new SetOf object will be created and returned.
- subtype(componentType=NoValue(), implicitTag=Tag(), explicitTag=Tag(), subtypeSpec=ConstraintsIntersection())¶
Create a specialization of SetOf schema object.
The subtype() method accepts the same set arguments as SetOf class takes on instantiation except that all parameters of the subtype() method are optional.
With the exception of the arguments described below, the rest of supplied arguments they are used to create a copy of self taking precedence over the ones used to instantiate self.
The following arguments to subtype() create a ASN.1 subtype out of SetOf type.
- Other Parameters:
implicitTag (
Tag
) – Implicitly apply given ASN.1 tag object to self’sTagSet
, then use the result as new object’s ASN.1 tag(s).explicitTag (
Tag
) – Explicitly apply given ASN.1 tag object to self’sTagSet
, then use the result as new object’s ASN.1 tag(s).subtypeSpec (
ConstraintsIntersection
) – Add ASN.1 constraints object to one of the self’s, then use the result as new object’s ASN.1 constraints.
- Returns:
new instance of SetOf type/value
Note
Due to the mutable nature of the SetOf object, even if no arguments are supplied, a new SetOf object will be created and returned.
- tagSet = <TagSet object, tags 0:32:17>¶
Set (on class, not on instance) or return a
TagSet
object representing ASN.1 tag(s) associated with SetOf type.
- componentType = None¶
Default
PyAsn1Item
derivative object representing ASN.1 type allowed within SetOf type
- subtypeSpec = <ConstraintsIntersection object>¶
Set (on class, not on instance) or return a
ConstraintsIntersection
object imposing constraints on SetOf type initialization values.
- property isValue¶
Indicate that SetOf object represents ASN.1 value.
If isValue is
False
then this object represents just ASN.1 schema.If isValue is
True
then, in addition to its ASN.1 schema features, this object can also be used like a Python built-in object (e.g.int
,str
,dict
etc.).- Returns:
bool
–False
if object represents just ASN.1 schema.True
if object represents ASN.1 schema and can be used as a normal value.
Note
There is an important distinction between PyASN1 schema and value objects. The PyASN1 schema objects can only participate in ASN.1 schema-related operations (e.g. defining or testing the structure of the data). Most obvious uses of ASN.1 schema is to guide serialisation codecs whilst encoding/decoding serialised ASN.1 contents.
The PyASN1 value objects can additionally participate in many operations involving regular Python objects (e.g. arithmetic, comprehension etc).
- isSameTypeWith(other, matchTags=True, matchConstraints=True)¶
Examine SetOf type for equality with other ASN.1 type.
ASN.1 tags (
tag
) and constraints (constraint
) are examined when carrying out ASN.1 types comparison.Python class inheritance relationship is NOT considered.
- isSuperTypeOf(other, matchTags=True, matchConstraints=True)¶
Examine SetOf type for subtype relationship with other ASN.1 type.
ASN.1 tags (
tag
) and constraints (constraint
) are examined when carrying out ASN.1 types comparison.Python class inheritance relationship is NOT considered.
- property effectiveTagSet¶
For SetOf type is equivalent to tagSet
- getComponentByPosition(idx, default=<NoValue object>, instantiate=True)¶
Return SetOf type component value by position.
Equivalent to Python sequence subscription operation (e.g. []).
- Parameters:
idx (
int
) – Component index (zero-based). Must either refer to an existing component or to N+1 component (if componentType is set). In the latter case a new component type gets instantiated and appended to the SetOf sequence.- Keyword Arguments:
- Returns:
PyAsn1Item
– Instantiate SetOf component type or return existing component value
Examples
# can also be SetOf class MySequenceOf(SequenceOf): componentType = OctetString() s = MySequenceOf() # returns component #0 with `.isValue` property False s.getComponentByPosition(0) # returns None s.getComponentByPosition(0, default=None) s.clear() # returns noValue s.getComponentByPosition(0, instantiate=False) # sets component #0 to OctetString() ASN.1 schema # object and returns it s.getComponentByPosition(0, instantiate=True) # sets component #0 to ASN.1 value object s.setComponentByPosition(0, 'ABCD') # returns OctetString('ABCD') value object s.getComponentByPosition(0, instantiate=False) s.clear() # returns noValue s.getComponentByPosition(0, instantiate=False)
- setComponentByPosition(idx, value=<NoValue object>, verifyConstraints=True, matchTags=True, matchConstraints=True)¶
Assign SetOf type component by position.
Equivalent to Python sequence item assignment operation (e.g. []) or list.append() (when idx == len(self)).
- Parameters:
idx (
int
) – Component index (zero-based). Must either refer to existing component or to N+1 component. In the latter case a new component type gets instantiated (if componentType is set, or given ASN.1 object is taken otherwise) and appended to the SetOf sequence.- Keyword Arguments:
value (
object
orPyAsn1Item
derivative) – A Python value to initialize SetOf component with (if componentType is set) or ASN.1 value object to assign to SetOf component. If value is not given, schema object will be set as a component.verifyConstraints (
bool
) – IfFalse
, skip constraints validationmatchConstraints (
bool
) – IfFalse
, skip component constraints matching
- Returns:
self
- Raises:
ValueConstraintError, PyAsn1Error – On constraint violation or bad initializer
IndexError – When idx > len(self)
- clear()¶
Remove all components and become an empty SetOf value object.
Has the same effect on SetOf object as it does on
list
built-in.
- reset()¶
Remove all components and become a SetOf schema object.
See
isValue()
property for more information on the distinction between value and schema objects.
- property isInconsistent¶
Run necessary checks to ensure SetOf object consistency.
Default action is to verify SetOf object against constraints imposed by subtypeSpec.
- Raises:
PyAsn1tError –