diff options
author | Ilya Etingof <etingof@gmail.com> | 2019-07-13 18:58:17 +0200 |
---|---|---|
committer | Ilya Etingof <etingof@gmail.com> | 2019-07-13 18:58:17 +0200 |
commit | 2f7535c697c3ca9f7c930a5ea79293f0b8d4313b (patch) | |
tree | d5013853b379f4d19ee58a64aa724fbb255c0255 /docs | |
parent | 18974828b048383f15cab77e2e3c181a373ace1a (diff) | |
download | pyasn1-git-2f7535c697c3ca9f7c930a5ea79293f0b8d4313b.tar.gz |
Document base ASN.1 types
Also many fixes here and there to docs and docstrings.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/pyasn1/contents.rst | 1 | ||||
-rw-r--r-- | docs/source/pyasn1/type/base/asn1type.rst | 10 | ||||
-rw-r--r-- | docs/source/pyasn1/type/base/constructedasn1type.rst | 10 | ||||
-rw-r--r-- | docs/source/pyasn1/type/base/contents.rst | 20 | ||||
-rw-r--r-- | docs/source/pyasn1/type/base/novalue.rst | 6 | ||||
-rw-r--r-- | docs/source/pyasn1/type/base/simpleasn1type.rst | 10 | ||||
-rw-r--r-- | docs/source/pyasn1/type/univ/contents.rst | 4 |
7 files changed, 57 insertions, 4 deletions
diff --git a/docs/source/pyasn1/contents.rst b/docs/source/pyasn1/contents.rst index 554ebe9..eaa7835 100644 --- a/docs/source/pyasn1/contents.rst +++ b/docs/source/pyasn1/contents.rst @@ -139,6 +139,7 @@ type's values. .. toctree:: :maxdepth: 2 + /pyasn1/type/base/contents /pyasn1/type/univ/contents /pyasn1/type/char/contents /pyasn1/type/useful/contents diff --git a/docs/source/pyasn1/type/base/asn1type.rst b/docs/source/pyasn1/type/base/asn1type.rst new file mode 100644 index 0000000..94fe04d --- /dev/null +++ b/docs/source/pyasn1/type/base/asn1type.rst @@ -0,0 +1,10 @@ + +.. _base.Asn1Type: + +.. |ASN.1| replace:: Asn1Type + +|ASN.1| type +------------ + +.. autoclass:: pyasn1.type.base.Asn1Type(tagSet=TagSet(), subtypeSpec=ConstraintsIntersection()) + :members: isSameTypeWith, isSuperTypeOf, tagSet, effectiveTagSet, tagMap, subtypeSpec diff --git a/docs/source/pyasn1/type/base/constructedasn1type.rst b/docs/source/pyasn1/type/base/constructedasn1type.rst new file mode 100644 index 0000000..a6ced17 --- /dev/null +++ b/docs/source/pyasn1/type/base/constructedasn1type.rst @@ -0,0 +1,10 @@ + +.. _base.ConstructedAsn1Type: + +.. |ASN.1| replace:: ConstructedAsn1Type + +|ASN.1| type +------------ + +.. autoclass:: pyasn1.type.base.ConstructedAsn1Type(tagSet=TagSet(), subtypeSpec=ConstraintsIntersection(), sizeSpec=ConstraintsIntersection(), componentType=None) + :members: isValue, isSameTypeWith, isSuperTypeOf, tagSet, effectiveTagSet, tagMap, subtypeSpec diff --git a/docs/source/pyasn1/type/base/contents.rst b/docs/source/pyasn1/type/base/contents.rst new file mode 100644 index 0000000..ffb325c --- /dev/null +++ b/docs/source/pyasn1/type/base/contents.rst @@ -0,0 +1,20 @@ + +.. _type.base: + +ASN.1 type system +----------------- + +The ASN.1 language defines a collection of data types such as *INTEGER* +or *SET*. With pyasn1, ASN.1 types are represented by Python classes. +The base classes are described in this part of the documentation. + +User code might not need to use them directly, except for figuring out +if given object belongs to ASN.1 type or not. + +.. toctree:: + :maxdepth: 2 + + /pyasn1/type/base/asn1type + /pyasn1/type/base/simpleasn1type + /pyasn1/type/base/constructedasn1type + /pyasn1/type/base/novalue diff --git a/docs/source/pyasn1/type/base/novalue.rst b/docs/source/pyasn1/type/base/novalue.rst new file mode 100644 index 0000000..6e34792 --- /dev/null +++ b/docs/source/pyasn1/type/base/novalue.rst @@ -0,0 +1,6 @@ +.. _type.base.NoValue: + +NoValue sentinel +---------------- + +.. autoclass:: pyasn1.type.base.NoValue() diff --git a/docs/source/pyasn1/type/base/simpleasn1type.rst b/docs/source/pyasn1/type/base/simpleasn1type.rst new file mode 100644 index 0000000..03a960d --- /dev/null +++ b/docs/source/pyasn1/type/base/simpleasn1type.rst @@ -0,0 +1,10 @@ + +.. _base.SimpleAsn1Type: + +.. |ASN.1| replace:: SimpleAsn1Type + +|ASN.1| type +------------ + +.. autoclass:: pyasn1.type.base.SimpleAsn1Type(value=NoValue(), tagSet=TagSet(), subtypeSpec=ConstraintsIntersection()) + :members: isValue, isSameTypeWith, isSuperTypeOf, tagSet, effectiveTagSet, tagMap, subtypeSpec diff --git a/docs/source/pyasn1/type/univ/contents.rst b/docs/source/pyasn1/type/univ/contents.rst index 2a5ba25..d546e1c 100644 --- a/docs/source/pyasn1/type/univ/contents.rst +++ b/docs/source/pyasn1/type/univ/contents.rst @@ -32,7 +32,3 @@ and constructed. /pyasn1/type/univ/set /pyasn1/type/univ/sequence /pyasn1/type/univ/choice - -.. _univ.noValue: - -.. autoclass:: pyasn1.type.univ.NoValue() |