Set type

class pyasn1.type.univ.Set(componentType=None, tagSet=TagSet(), subtypeSpec=ConstraintsIntersection(), sizeSpec=ConstraintsIntersection())

Create Set type.

Set objects are mutable and duck-type Python dict objects.

Parameters:
  • componentType (NamedType) – Object holding named ASN.1 types allowed within this collection
  • tagSet (TagSet) – Object representing non-default ASN.1 tag(s)
  • subtypeSpec (ConstraintsIntersection) – Object representing non-default ASN.1 subtype constraint(s)
  • sizeSpec (ConstraintsIntersection) – Object representing collection size constraint

Note

The Set type models a collection of named ASN.1 components. Ordering of the components is not preserved upon de/serialization.

clone(componentType=None, tagSet=TagSet(), subtypeSpec=ConstraintsIntersection())

Create a copy of a Set type or object.

Any parameters to the clone() method will replace corresponding properties of the Set object.

Parameters:
  • tagSet (TagSet) – Object representing non-default ASN.1 tag(s)
  • subtypeSpec (ConstraintsIntersection) – Object representing non-default ASN.1 subtype constraint(s)
  • sizeSpec (ConstraintsIntersection) – Object representing non-default ASN.1 size constraint(s)
Returns:

new instance of Set type/value

subtype(componentType=None, implicitTag=Tag(), explicitTag=Tag(), subtypeSpec=ConstraintsIntersection())

Create a copy of a Set type or object.

Any parameters to the subtype() method will be added to the corresponding properties of the Set object.

Parameters:
  • tagSet (TagSet) – Object representing non-default ASN.1 tag(s)
  • subtypeSpec (ConstraintsIntersection) – Object representing non-default ASN.1 subtype constraint(s)
  • sizeSpec (ConstraintsIntersection) – Object representing non-default ASN.1 size constraint(s)
Returns:

new instance of Set type/value

tagSet = TagSet((), Tag(tagClass=0, tagFormat=32, tagId=17))

Set (on class, not on instance) or return a TagSet object representing ASN.1 tag(s) associated with Set type.

componentType = NamedTypes()

Default collection of ASN.1 types of component (e.g. NamedType) object representing ASN.1 type allowed within Set type

subtypeSpec = ConstraintsIntersection()

Set (on class, not on instance) or return a ConstraintsIntersection object imposing constraints on Set type initialization values.

sizeSpec = ConstraintsIntersection()

Default ConstraintsIntersection object imposing constraints on Set objects

getComponentByType(tagSet, innerFlag=False)

Returns Set type component by ASN.1 tag.

Parameters:tagSet (TagSet) – Object representing ASN.1 tags to identify one of Set object component
Returns:PyAsn1Item – a pyasn1 object
setComponentByType(tagSet, value=NoValue(), verifyConstraints=True, matchTags=True, matchConstraints=True, innerFlag=False)

Assign Set type component by ASN.1 tag.

Parameters:
  • tagSet (TagSet) – Object representing ASN.1 tags to identify one of Set object component
  • value (object or PyAsn1Item derivative) – A Python value to initialize Set component with (if componentType is set) or ASN.1 value object to assign to Set component.
  • verifyConstraints (bool) – If False, skip constraints validation
  • matchTags (bool) – If False, skip component tags matching
  • matchConstraints (bool) – If False, skip component constraints matching
  • innerFlag (bool) – If True, search for matching tagSet recursively.
Returns:

self

effectiveTagSet

For Set type is equivalent to tagSet

getComponentByName(name)

Returns Set type component by name.

Equivalent to Python dict subscription operation (e.g. []).

Parameters:name (str) – Set type component name
Returns:PyAsn1Item – Instantiate Set component type or return existing component value
getComponentByPosition(idx)

Returns Set type component by index.

Equivalent to Python sequence subscription operation (e.g. []).

Parameters:idx (int) – Component index (zero-based). Must either refer to an existing component or (if componentType is set) new ASN.1 type object gets instantiated.
Returns:PyAsn1Item – a PyASN1 object
isSameTypeWith(other, matchTags=True, matchConstraints=True)

Examine Set type for equality with other ASN.1 type.

ASN.1 tags (tag) and constraints (constraint) are examined when carrying out ASN.1 types comparison.

No Python inheritance relationship between PyASN1 objects is considered.

Parameters:other (a pyasn1 type object) – Class instance representing ASN.1 type.
Returns:boolTrue if other is Set type, False otherwise.
isSuperTypeOf(other, matchTags=True, matchConstraints=True)

Examine Set 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.

No Python inheritance relationship between PyASN1 objects is considered.

Parameters:other (a pyasn1 type object) – Class instance representing ASN.1 type.
Returns:boolTrue if other is a subtype of Set type, False otherwise.
isValue

Indicate if Set object represents ASN.1 type or ASN.1 value.

In other words, if isValue is True, then the ASN.1 object is initialized.

For the purpose of check, the OPTIONAL and DEFAULT fields are unconditionally considered as initialized.

Returns:boolTrue if object represents ASN.1 value and type, False if object represents just ASN.1 type.

Note

There is an important distinction between PyASN1 type and value objects. The PyASN1 type objects can only participate in ASN.1 type operations (subtyping, comparison etc) and serve as a blueprint for serialization codecs to resolve ambiguous types.

The PyASN1 value objects can additionally participate in most of built-in Python operations.

setComponentByName(name, value=NoValue(), verifyConstraints=True, matchTags=True, matchConstraints=True)

Assign Set type component by name.

Equivalent to Python dict item assignment operation (e.g. []).

Parameters:
  • name (str) – Set type component name
  • value (object or PyAsn1Item derivative) – A Python value to initialize Set component with (if componentType is set) or ASN.1 value object to assign to Set component.
  • verifyConstraints (bool) – If False, skip constraints validation
  • matchTags (bool) – If False, skip component tags matching
  • matchConstraints (bool) – If False, skip component constraints matching
Returns:

self

setComponentByPosition(idx, value=NoValue(), verifyConstraints=True, matchTags=True, matchConstraints=True)

Assign Set type component by position.

Equivalent to Python sequence item assignment operation (e.g. []).

Parameters:
  • idx (int) – Component index (zero-based). Must either refer to existing component (if componentType is set) or to N+1 component otherwise. In the latter case a new component of given ASN.1 type gets instantiated and appended to Set sequence.
  • value (object or PyAsn1Item derivative) – A Python value to initialize Set component with (if componentType is set) or ASN.1 value object to assign to Set component.
  • verifyConstraints (bool) – If False, skip constraints validation
  • matchTags (bool) – If False, skip component tags matching
  • matchConstraints (bool) – If False, skip component constraints matching
Returns:

self

tagMap

Return a TagMap object mapping ASN.1 tags to ASN.1 objects within callee object.