NumericString type¶
-
class
pyasn1.type.char.
NumericString
(value=NoValue(), tagSet=TagSet(), subtypeSpec=ConstraintsIntersection(), encoding='us-ascii')¶ Creates NumericString type or object.
NumericString objects are immutable and duck-type Python 2
unicode
or Python 3str
. When used in octet-stream context, NumericString type assumes “us-ascii” encoding.Parameters: - value (
unicode
,str
,bytes
or NumericString object) – unicode object (Python 2) or string (Python 3), alternatively string (Python 2) or bytes (Python 3) representing octet-stream of serialized unicode string (note encoding parameter) or NumericString class instance. - tagSet (
TagSet
) – Object representing non-default ASN.1 tag(s) - subtypeSpec (
ConstraintsIntersection
) – Object representing non-default ASN.1 subtype constraint(s) - encoding (
str
) – Unicode codec ID to encode/decodeunicode
(Python 2) orstr
(Python 3) the payload when NumericString object is used in octet-stream context.
Raises: : :py:class:`pyasn1.error.PyAsn1Error` – On constraint violation or bad initializer.
Note
The NumericString models character string that can be entered from a telephone handset.
-
clone
(value=NoValue(), tagSet=TagSet(), subtypeSpec=ConstraintsIntersection(), encoding='us-ascii')¶ Creates a copy of a NumericString type or object.
Any parameters to the clone() method will replace corresponding properties of the NumericString object.
Parameters: - value (
unicode
,str
,bytes
or NumericString object) – unicode object (Python 2) or string (Python 3), alternatively string (Python 2) or bytes (Python 3) representing octet-stream of serialized unicode string (note encoding parameter) or NumericString class instance. - tagSet (
TagSet
) – Object representing non-default ASN.1 tag(s) - subtypeSpec (
ConstraintsIntersection
) – Object representing non-default ASN.1 subtype constraint(s) - encoding (
str
) – Unicode codec ID to encode/decodeunicode
(Python 2) orstr
(Python 3) the payload when NumericString object is used in octet-stream context.
Returns: new instance of NumericString type/value
- value (
-
subtype
(value=NoValue(), implicitTag=Tag(), explicitTag=Tag(), subtypeSpec=ConstraintsIntersection(), encoding='us-ascii')¶ Creates a copy of a NumericString type or object.
Any parameters to the subtype() method will be added to the corresponding properties of the NumericString object.
Parameters: - value (
unicode
,str
,bytes
or NumericString object) – unicode object (Python 2) or string (Python 3), alternatively string (Python 2) or bytes (Python 3) representing octet-stream of serialized unicode string (note encoding parameter) or NumericString class instance. - implicitTag (
Tag
) – Implicitly apply given ASN.1 tag object to caller’sTagSet
, then use the result as new object’s ASN.1 tag(s). - explicitTag (
Tag
) – Explicitly apply given ASN.1 tag object to caller’sTagSet
, then use the result as new object’s ASN.1 tag(s). - subtypeSpec (
ConstraintsIntersection
) – Object representing non-default ASN.1 subtype constraint(s) - encoding (
str
) – Unicode codec ID to encode/decodeunicode
(Python 2) orstr
(Python 3) the payload when NumericString object is used in octet-stream context.
Returns: new instance of NumericString type/value
- value (
-
tagSet
= TagSet((), Tag(tagClass=0, tagFormat=0, tagId=18))¶ Set (on class, not on instance) or return a
TagSet
object representing ASN.1 tag(s) associated with NumericString type.
-
effectiveTagSet
¶ For NumericString type is equivalent to tagSet
-
isSameTypeWith
(other, matchTags=True, matchConstraints=True)¶ Examine NumericString 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: bool
–True
if other is NumericString type,False
otherwise.
-
isSuperTypeOf
(other, matchTags=True, matchConstraints=True)¶ Examine NumericString 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: bool
–True
if other is a subtype of NumericString type,False
otherwise.
-
isValue
¶ Indicate if NumericString object represents ASN.1 type or ASN.1 value.
In other words, if isValue is True, then the ASN.1 object is initialized.
Returns: bool
–True
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.
- value (