Skip to content

Commit 1c2be1c

Browse files
committed
fix: adding __all__ for rfc7515 and rfc7516
1 parent b9379f7 commit 1c2be1c

10 files changed

Lines changed: 74 additions & 0 deletions

File tree

docs/changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Changelog
2424
- Use ``joserfc.jws.deserialize_compact`` instead of ``joserfc.rfc7797.deserialize_compact``
2525
- Use ``joserfc.jws.serialize_json`` instead of ``joserfc.rfc7797.serialize_json``
2626
- Use ``joserfc.jws.deserialize_json`` instead of ``joserfc.rfc7797.deserialize_json``
27+
- Convert ``joserfc.rfcXXXX`` to private modules ``joserfc._rfcXXXX``.
2728

2829
1.1.0
2930
-----

src/joserfc/_rfc7515/compact.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@
1111
urlsafe_b64decode,
1212
)
1313

14+
__all__ = [
15+
'sign_compact',
16+
'verify_compact',
17+
'detach_compact_content',
18+
'decode_header',
19+
]
20+
1421

1522
def sign_compact(obj: CompactSignature, alg: JWSAlgModel, key: t.Any) -> bytes:
1623
header_segment = json_b64encode(obj.headers())

src/joserfc/_rfc7515/json.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@
2020
)
2121
from ..errors import DecodeError
2222

23+
__all__ = [
24+
'FindKey',
25+
'sign_general_json',
26+
'sign_flattened_json',
27+
'sign_json_member',
28+
'extract_general_json',
29+
'verify_general_json',
30+
'verify_flattened_json',
31+
'detach_json_content',
32+
]
33+
2334
FindKey = t.Callable[[HeaderMember], t.Any]
2435

2536

src/joserfc/_rfc7515/model.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
from ..errors import InvalidKeyTypeError
66
from ..registry import Header
77

8+
__all__ = [
9+
'HeaderMember',
10+
'CompactSignature',
11+
'FlattenedJSONSignature',
12+
'GeneralJSONSignature',
13+
'JWSAlgModel',
14+
]
15+
816

917
class HeaderMember:
1018
"""A header member of the JSON signature. It is combined with protected header,

src/joserfc/_rfc7515/registry.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@
1111
check_supported_header,
1212
)
1313

14+
__all__ = [
15+
'JWSRegistry',
16+
'construct_registry',
17+
'default_registry',
18+
]
19+
1420

1521
class JWSRegistry:
1622
"""A registry for JSON Web Signature to keep all the supported algorithms.

src/joserfc/_rfc7516/compact.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
urlsafe_b64decode,
1212
)
1313

14+
__all__ = [
15+
'represent_compact',
16+
'extract_compact',
17+
]
18+
1419

1520
def represent_compact(obj: CompactEncryption) -> bytes:
1621
assert obj.recipient is not None

src/joserfc/_rfc7516/json.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222
from .._keys import Key
2323

2424

25+
__all__ = [
26+
'represent_general_json',
27+
'represent_flattened_json',
28+
'extract_general_json',
29+
'extract_flattened_json',
30+
]
31+
32+
2533
def represent_general_json(obj: GeneralJSONEncryption) -> GeneralJSONSerialization:
2634
data = __represent_json_serialization(obj)
2735
recipients = []

src/joserfc/_rfc7516/message.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@
2626
urlsafe_b64encode,
2727
)
2828

29+
__all__ = [
30+
'EncryptionData',
31+
'perform_encrypt',
32+
'perform_decrypt',
33+
]
34+
2935
EncryptionData = t.Union[CompactEncryption, GeneralJSONEncryption, FlattenedJSONEncryption]
3036

3137

src/joserfc/_rfc7516/models.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,22 @@
66
from ..errors import InvalidKeyTypeError, InvalidKeyLengthError
77
from .._keys import Key, ECKey, OctKey
88

9+
__all__ = [
10+
'Recipient',
11+
'CompactEncryption',
12+
'BaseJSONEncryption',
13+
'GeneralJSONEncryption',
14+
'FlattenedJSONEncryption',
15+
'JWEEncModel',
16+
'JWEZipModel',
17+
'KeyManagement',
18+
'JWEDirectEncryption',
19+
'JWEKeyEncryption',
20+
'JWEKeyWrapping',
21+
'JWEKeyAgreement',
22+
'JWEAlgModel',
23+
]
24+
925
KeyType = t.TypeVar("KeyType")
1026

1127

src/joserfc/_rfc7516/registry.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@
1111
check_crit_header,
1212
)
1313

14+
__all__ = [
15+
'JWEAlgorithm',
16+
'JWERegistry',
17+
'default_registry',
18+
]
19+
1420
JWEAlgorithm = t.Union[JWEAlgModel, JWEEncModel, JWEZipModel]
1521

1622
AlgorithmsDict = t.TypedDict(

0 commit comments

Comments
 (0)