1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
Classes
=======
.. py:currentmodule:: pgpy
:py:class:`PGPKey`
------------------
.. autoclass:: PGPKey
:members:
.. py:attribute:: ascii_headers
:annotation:
An :py:obj:`~collections.OrderedDict` of headers that appear, in order, in the ASCII-armored form of this object.
.. py:classmethod:: from_file(filename)
Create a new :py:obj:`PGPKey` object, with contents loaded from a file. May be binary or ASCII armored.
:param filename: The path to the file to load.
:type filename: ``str``
:raises: :py:exc:`ValueError` if a properly formed PGP block was not found in the file at ``filename``
:raises: :py:exc:`~exceptions.PGPError` if de-armoring or parsing failed
:returns: A two element ``tuple`` of :py:obj:`PGPKey`, :py:obj:`~collections.OrderedDict`.
The :py:obj:`~collections.OrderedDict` has the following format::
key, others = PGPKey.from_file('path/to/keyfile')
# others: { (Fingerprint, bool(key.is_public)): PGPKey }
.. py:classmethod:: from_blob(blob)
Create a new :py:obj:`PGPKey` object, with contents loaded from a blob. May be binary or ASCII armored.
:param blob: The data to load.
:type blob: ``str``, ``bytes``, ``unicode``, ``bytearray``
:raises: :py:exc:`TypeError` if blob is not in the expected types above
:raises: :py:exc:`ValueError` if a properly formed PGP block was not found in ``blob``
:raises: :py:exc:`~exceptions.PGPError` if de-armoring or parsing failed
:returns: A two element ``tuple`` of :py:obj:`PGPKey`, :py:obj:`~collections.OrderedDict`.
The :py:obj:`~collections.OrderedDict` has the following format::
key, others = PGPKey.from_file('path/to/keyfile')
# others: { (Fingerprint, bool(key.is_public)): PGPKey }
:py:class:`PGPKeyring`
----------------------
.. autoclass:: PGPKeyring()
:members:
.. py:attribute:: ascii_headers
An :py:obj:`~collections.OrderedDict` of headers that appear, in order, in the ASCII-armored form of this object.
:py:class:`PGPMessage`
----------------------
.. autoclass:: PGPMessage
:members:
.. py:attribute:: ascii_headers
An :py:obj:`~collections.OrderedDict` of headers that appear, in order, in the ASCII-armored form of this object.
.. py:classmethod:: from_file(filename)
Create a new :py:obj:`PGPMessage` object, with contents loaded from a file. May be binary or ASCII armored.
:param filename: The path to the file to load.
:type filename: ``str``
:raises: :py:exc:`ValueError` if a properly formed PGP block was not found in the file at ``filename``
:raises: :py:exc:`~exceptions.PGPError` if de-armoring or parsing failed
:returns: :py:obj:`PGPMessage`
.. py:classmethod:: from_blob(blob)
Create a new :py:obj:`PGPMessage` object, with contents loaded from a blob. May be binary or ASCII armored.
:param blob: The data to load.
:type blob: ``str``, ``bytes``, ``unicode``, ``bytearray``
:raises: :py:exc:`TypeError` if blob is not in the expected types above
:raises: :py:exc:`ValueError` if a properly formed PGP block was not found in ``blob``
:raises: :py:exc:`~exceptions.PGPError` if de-armoring or parsing failed
:returns: :py:obj:`PGPMessage`
:py:class:`PGPSignature`
------------------------
.. autoclass:: PGPSignature
:members:
.. py:attribute:: ascii_headers
An :py:obj:`~collections.OrderedDict` of headers that appear, in order, in the ASCII-armored form of this object.
.. py:classmethod:: from_file(filename)
Create a new :py:obj:`PGPSignature` object, with contents loaded from a file. May be binary or ASCII armored.
:param filename: The path to the file to load.
:type filename: ``str``
:raises: :py:exc:`ValueError` if a properly formed PGP block was not found in the file at ``filename``
:raises: :py:exc:`~exceptions.PGPError` if de-armoring or parsing failed
:returns: :py:obj:`PGPSignature`
.. py:classmethod:: from_blob(blob)
Create a new :py:obj:`PGPSignature` object, with contents loaded from a blob. May be binary or ASCII armored.
:param blob: The data to load.
:type blob: ``str``, ``bytes``, ``unicode``, ``bytearray``
:raises: :py:exc:`TypeError` if blob is not in the expected types above
:raises: :py:exc:`ValueError` if a properly formed PGP block was not found in ``blob``
:raises: :py:exc:`~exceptions.PGPError` if de-armoring or parsing failed
:returns: :py:obj:`PGPSignature`
:py:class:`PGPUID`
------------------
.. autoclass:: PGPUID
:members:
Other Objects
=============
.. py:currentmodule:: pgpy.types
These are objects that are returned during certain operations, but are probably not useful to instantiate directly.
:py:class:`~types.SignatureVerification`
----------------------------------------
.. autoclass:: SignatureVerification
:members:
:py:class:`~types.Fingerprint`
------------------------------
.. autoclass:: Fingerprint
:members:
|
