Mock dependencies that are excluded in readthedocs
It seems preferable to import just fastecdsa. But if you do that, then some kind of side-effect doesn't happen, which means that `sec1` is not available as an attribute on `fastecdsa.encoding`. So we specifically mock the sub-modules as well.
This commit is contained in:
parent
3e5f883c50
commit
27ecd4b0ed
16
docs/conf.py
16
docs/conf.py
|
@ -286,3 +286,19 @@ doctest_default_flags = (0
|
||||||
| doctest.IGNORE_EXCEPTION_DETAIL
|
| doctest.IGNORE_EXCEPTION_DETAIL
|
||||||
| doctest.NORMALIZE_WHITESPACE
|
| doctest.NORMALIZE_WHITESPACE
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# -- Mocked dependencies ----------------------------------------
|
||||||
|
|
||||||
|
# Mock out dependencies that are unbuildable on readthedocs, as recommended here:
|
||||||
|
# https://docs.readthedocs.io/en/rel/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
|
||||||
|
|
||||||
|
import sys
|
||||||
|
from unittest.mock import MagicMock
|
||||||
|
|
||||||
|
# Add new modules to mock here (it should be the same list as those excluded in setup.py)
|
||||||
|
MOCK_MODULES = [
|
||||||
|
"fastecdsa",
|
||||||
|
"fastecdsa.encoding",
|
||||||
|
"fastecdsa.encoding.sec1",
|
||||||
|
]
|
||||||
|
sys.modules.update((mod_name, MagicMock()) for mod_name in MOCK_MODULES)
|
||||||
|
|
|
@ -1,12 +1,14 @@
|
||||||
from typing import Callable, Tuple, cast
|
from typing import Callable, Tuple, cast
|
||||||
|
|
||||||
from fastecdsa.encoding.util import int_bytelen
|
from fastecdsa.encoding import util
|
||||||
|
|
||||||
from libp2p.crypto.ecc import ECCPrivateKey, ECCPublicKey, create_new_key_pair
|
from libp2p.crypto.ecc import ECCPrivateKey, ECCPublicKey, create_new_key_pair
|
||||||
from libp2p.crypto.keys import PublicKey
|
from libp2p.crypto.keys import PublicKey
|
||||||
|
|
||||||
SharedKeyGenerator = Callable[[bytes], bytes]
|
SharedKeyGenerator = Callable[[bytes], bytes]
|
||||||
|
|
||||||
|
int_bytelen = util.int_bytelen
|
||||||
|
|
||||||
|
|
||||||
def create_ephemeral_key_pair(curve_type: str) -> Tuple[PublicKey, SharedKeyGenerator]:
|
def create_ephemeral_key_pair(curve_type: str) -> Tuple[PublicKey, SharedKeyGenerator]:
|
||||||
"""Facilitates ECDH key exchange."""
|
"""Facilitates ECDH key exchange."""
|
||||||
|
|
Loading…
Reference in New Issue
Block a user