From 294a432f7a97f56792f40696e3a524e668d40803 Mon Sep 17 00:00:00 2001 From: Darko Kulic Date: Wed, 22 Feb 2023 09:31:45 +0100 Subject: [PATCH 1/5] Export key components of the library --- didcomm/__init__.py | 39 +++++++++++++++++++ tests/demo/test_demo.py | 7 +--- tests/demo/test_demo_advanced_params.py | 11 +++--- tests/demo/test_demo_attachments.py | 13 +++++-- tests/demo/test_demo_mediators.py | 5 +-- tests/demo/test_demo_rotate_keys.py | 13 ++++--- tests/performance/test_performance.py | 3 +- tests/test_vectors/common.py | 2 +- tests/test_vectors/did_doc/did_doc_alice.py | 5 ++- tests/test_vectors/did_doc/did_doc_bob.py | 6 ++- tests/test_vectors/did_doc/did_doc_charlie.py | 6 ++- .../test_vectors/did_doc/did_doc_mediator1.py | 5 ++- .../test_vectors/did_doc/did_doc_mediator2.py | 6 ++- .../test_vectors/did_doc/mock_did_resolver.py | 2 +- .../test_vectors/didcomm_messages/messages.py | 2 +- .../spec/spec_test_vectors_anon_encrypted.py | 3 +- .../spec/spec_test_vectors_auth_encrypted.py | 3 +- .../spec/spec_test_vectors_plaintext.py | 2 +- .../spec/spec_test_vectors_signed.py | 3 +- .../tests/test_vectors_plaintext_positive.py | 2 +- .../secrets/mock_secrets_resolver.py | 3 +- .../secrets/mock_secrets_resolver_alice.py | 4 +- .../secrets/mock_secrets_resolver_bob.py | 4 +- .../secrets/mock_secrets_resolver_charlie.py | 4 +- .../mock_secrets_resolver_mediator1.py | 4 +- .../mock_secrets_resolver_mediator2.py | 4 +- tests/test_vectors/utils.py | 4 +- .../test_pack_encrypted_helpers.py | 15 +++---- 28 files changed, 107 insertions(+), 73 deletions(-) diff --git a/didcomm/__init__.py b/didcomm/__init__.py index 493f741..513def1 100644 --- a/didcomm/__init__.py +++ b/didcomm/__init__.py @@ -1 +1,40 @@ __version__ = "0.3.0" + +from didcomm.common.algorithms import AnonCryptAlg, AuthCryptAlg, SignAlg +from didcomm.common.resolvers import DIDResolver, ResolversConfig, SecretsResolver +from didcomm.common.types import ( + DIDCommMessageMediaTypes, + DIDCommMessageProtocolTypes, + DIDCommMessageTypes, + DIDDocServiceTypes, + VerificationMethodType, + VerificationMaterial, + VerificationMaterialFormat, +) +from didcomm.did_doc.did_doc import DIDDoc, DIDCommService, VerificationMethod +from didcomm.did_doc.did_resolver_in_memory import DIDResolverInMemory +from didcomm.message import ( + Attachment, + AttachmentDataBase64, + AttachmentDataJson, + AttachmentDataLinks, + FromPrior, + GenericMessage, + Message, +) +from didcomm import pack_encrypted as pack_encrypted_module +from didcomm.pack_encrypted import pack_encrypted, PackEncryptedConfig, PackEncryptedParameters, PackEncryptedResult +from didcomm.pack_plaintext import pack_plaintext, PackPlaintextParameters, PackPlaintextResult +from didcomm.pack_signed import pack_signed, PackSignedParameters, PackSignedResult +from didcomm.protocols.routing.forward import ( + is_forward, + unpack_forward, + wrap_in_forward, + ForwardBody, + ForwardMessage, + ForwardPackResult, + ForwardResult, +) +from didcomm.unpack import unpack, Metadata, UnpackConfig, UnpackResult +from didcomm.secrets.secrets_resolver import Secret, SecretsResolver +from didcomm.secrets.secrets_resolver_in_memory import SecretsResolverInMemory diff --git a/tests/demo/test_demo.py b/tests/demo/test_demo.py index 24d1952..d340b4a 100644 --- a/tests/demo/test_demo.py +++ b/tests/demo/test_demo.py @@ -1,11 +1,6 @@ import pytest as pytest -from didcomm.message import Message -from didcomm.pack_encrypted import pack_encrypted, PackEncryptedConfig -from didcomm.pack_plaintext import pack_plaintext -from didcomm.pack_signed import pack_signed -from didcomm.protocols.routing.forward import unpack_forward -from didcomm.unpack import unpack +from didcomm import Message, pack_encrypted, PackEncryptedConfig, pack_plaintext, pack_signed, unpack_forward, unpack from tests.test_vectors.common import ALICE_DID, BOB_DID, CHARLIE_DID diff --git a/tests/demo/test_demo_advanced_params.py b/tests/demo/test_demo_advanced_params.py index 33780f7..693e0c1 100644 --- a/tests/demo/test_demo_advanced_params.py +++ b/tests/demo/test_demo_advanced_params.py @@ -1,14 +1,15 @@ import pytest as pytest -from didcomm.common.algorithms import AnonCryptAlg -from didcomm.message import Message -from didcomm.pack_encrypted import ( +from didcomm import ( + AnonCryptAlg, + Message, PackEncryptedConfig, PackEncryptedParameters, pack_encrypted, + unpack_forward, + unpack, + UnpackConfig, ) -from didcomm.protocols.routing.forward import unpack_forward -from didcomm.unpack import unpack, UnpackConfig from tests.test_vectors.common import ALICE_DID, BOB_DID diff --git a/tests/demo/test_demo_attachments.py b/tests/demo/test_demo_attachments.py index 06fba14..a995ffb 100644 --- a/tests/demo/test_demo_attachments.py +++ b/tests/demo/test_demo_attachments.py @@ -1,9 +1,14 @@ import pytest as pytest -from didcomm.message import Attachment, Message, AttachmentDataJson -from didcomm.pack_encrypted import pack_encrypted, PackEncryptedConfig -from didcomm.protocols.routing.forward import unpack_forward -from didcomm.unpack import unpack +from didcomm import ( + Attachment, + Message, + AttachmentDataJson, + pack_encrypted, + PackEncryptedConfig, + unpack_forward, + unpack, +) from tests.test_vectors.common import ALICE_DID, BOB_DID diff --git a/tests/demo/test_demo_mediators.py b/tests/demo/test_demo_mediators.py index 4873e21..7757262 100644 --- a/tests/demo/test_demo_mediators.py +++ b/tests/demo/test_demo_mediators.py @@ -1,10 +1,7 @@ import pytest as pytest +from didcomm import Message, pack_encrypted, unpack_forward, wrap_in_forward, unpack, UnpackConfig from didcomm.core.serialization import dict_to_json -from didcomm.message import Message -from didcomm.pack_encrypted import pack_encrypted -from didcomm.protocols.routing.forward import unpack_forward, wrap_in_forward -from didcomm.unpack import unpack, UnpackConfig from tests.test_vectors.common import ALICE_DID, BOB_DID diff --git a/tests/demo/test_demo_rotate_keys.py b/tests/demo/test_demo_rotate_keys.py index 7970ae2..3bbc8fb 100644 --- a/tests/demo/test_demo_rotate_keys.py +++ b/tests/demo/test_demo_rotate_keys.py @@ -1,15 +1,16 @@ import pytest as pytest -from didcomm.common.resolvers import ResolversConfig -from didcomm.message import Message, FromPrior -from didcomm.pack_encrypted import ( +from didcomm import ( + ResolversConfig, + Message, + FromPrior, pack_encrypted, PackEncryptedConfig, PackEncryptedParameters, + unpack_forward, + SecretsResolverInMemory, + unpack, ) -from didcomm.protocols.routing.forward import unpack_forward -from didcomm.secrets.secrets_resolver_in_memory import SecretsResolverInMemory -from didcomm.unpack import unpack from tests.test_vectors.common import CHARLIE_DID, BOB_DID, ALICE_DID from tests.test_vectors.secrets.mock_secrets_resolver_alice import ( MockSecretsResolverAlice, diff --git a/tests/performance/test_performance.py b/tests/performance/test_performance.py index 011a5fa..5a7760e 100644 --- a/tests/performance/test_performance.py +++ b/tests/performance/test_performance.py @@ -3,8 +3,7 @@ import pytest import pytest_asyncio -from didcomm.pack_encrypted import PackEncryptedConfig, pack_encrypted -from didcomm.unpack import unpack, UnpackConfig +from didcomm import PackEncryptedConfig, pack_encrypted, unpack, UnpackConfig from tests.test_vectors.common import BOB_DID, ALICE_DID from tests.test_vectors.didcomm_messages.messages import TEST_MESSAGE diff --git a/tests/test_vectors/common.py b/tests/test_vectors/common.py index 9432ff9..42095d5 100644 --- a/tests/test_vectors/common.py +++ b/tests/test_vectors/common.py @@ -2,7 +2,7 @@ from typing import Any from didcomm.common.types import JSON -from didcomm.unpack import Metadata +from didcomm import Metadata ALICE_DID = "did:example:alice" BOB_DID = "did:example:bob" diff --git a/tests/test_vectors/did_doc/did_doc_alice.py b/tests/test_vectors/did_doc/did_doc_alice.py index 4507de5..788f875 100644 --- a/tests/test_vectors/did_doc/did_doc_alice.py +++ b/tests/test_vectors/did_doc/did_doc_alice.py @@ -1,11 +1,12 @@ from authlib.common.encoding import json_dumps -from didcomm.common.types import ( +from didcomm import ( VerificationMethodType, VerificationMaterial, VerificationMaterialFormat, + VerificationMethod, + DIDDoc, ) -from didcomm.did_doc.did_doc import VerificationMethod, DIDDoc ALICE_VERIFICATION_METHOD_KEY_AGREEM_X25519_NOT_IN_SECRET = VerificationMethod( id="did:example:alice#key-x25519-not-in-secrets-1", diff --git a/tests/test_vectors/did_doc/did_doc_bob.py b/tests/test_vectors/did_doc/did_doc_bob.py index 77b7c50..4364ed6 100644 --- a/tests/test_vectors/did_doc/did_doc_bob.py +++ b/tests/test_vectors/did_doc/did_doc_bob.py @@ -1,11 +1,13 @@ from authlib.common.encoding import json_dumps -from didcomm.common.types import ( +from didcomm import ( + DIDDoc, + DIDCommService, VerificationMethodType, VerificationMaterial, VerificationMaterialFormat, + VerificationMethod, ) -from didcomm.did_doc.did_doc import VerificationMethod, DIDDoc, DIDCommService from didcomm.protocols.routing.forward import ( PROFILE_DIDCOMM_V2, PROFILE_DIDCOMM_AIP2_ENV_RFC587, diff --git a/tests/test_vectors/did_doc/did_doc_charlie.py b/tests/test_vectors/did_doc/did_doc_charlie.py index 153cc9b..c0a64e8 100644 --- a/tests/test_vectors/did_doc/did_doc_charlie.py +++ b/tests/test_vectors/did_doc/did_doc_charlie.py @@ -1,11 +1,13 @@ from authlib.common.encoding import json_dumps -from didcomm.common.types import ( +from didcomm import ( + DIDDoc, + DIDCommService, VerificationMethodType, VerificationMaterial, VerificationMaterialFormat, + VerificationMethod, ) -from didcomm.did_doc.did_doc import DIDDoc, VerificationMethod, DIDCommService from didcomm.protocols.routing.forward import ( PROFILE_DIDCOMM_V2, PROFILE_DIDCOMM_AIP2_ENV_RFC587, diff --git a/tests/test_vectors/did_doc/did_doc_mediator1.py b/tests/test_vectors/did_doc/did_doc_mediator1.py index d4421a5..4cdf081 100644 --- a/tests/test_vectors/did_doc/did_doc_mediator1.py +++ b/tests/test_vectors/did_doc/did_doc_mediator1.py @@ -1,11 +1,12 @@ from authlib.common.encoding import json_dumps -from didcomm.common.types import ( +from didcomm import ( + DIDDoc, VerificationMethodType, VerificationMaterial, VerificationMaterialFormat, + VerificationMethod, ) -from didcomm.did_doc.did_doc import VerificationMethod, DIDDoc # FIXME build verification material # (currently it's a copy-paste from Bob's ones) diff --git a/tests/test_vectors/did_doc/did_doc_mediator2.py b/tests/test_vectors/did_doc/did_doc_mediator2.py index 5ba253a..7712480 100644 --- a/tests/test_vectors/did_doc/did_doc_mediator2.py +++ b/tests/test_vectors/did_doc/did_doc_mediator2.py @@ -1,11 +1,13 @@ from authlib.common.encoding import json_dumps -from didcomm.common.types import ( +from didcomm import ( + DIDDoc, + DIDCommService, VerificationMethodType, VerificationMaterial, VerificationMaterialFormat, + VerificationMethod, ) -from didcomm.did_doc.did_doc import VerificationMethod, DIDDoc, DIDCommService # FIXME build verification material # (currently it's a copy-paste from Bob's ones) diff --git a/tests/test_vectors/did_doc/mock_did_resolver.py b/tests/test_vectors/did_doc/mock_did_resolver.py index 56b0ddc..e932bf9 100644 --- a/tests/test_vectors/did_doc/mock_did_resolver.py +++ b/tests/test_vectors/did_doc/mock_did_resolver.py @@ -1,4 +1,4 @@ -from didcomm.did_doc.did_resolver_in_memory import DIDResolverInMemory +from didcomm import DIDResolverInMemory from tests.test_vectors.did_doc import ( DID_DOC_ALICE_WITH_NO_SECRETS, DID_DOC_ALICE_SPEC_TEST_VECTORS, diff --git a/tests/test_vectors/didcomm_messages/messages.py b/tests/test_vectors/didcomm_messages/messages.py index 2e10109..495d5b3 100644 --- a/tests/test_vectors/didcomm_messages/messages.py +++ b/tests/test_vectors/didcomm_messages/messages.py @@ -1,7 +1,7 @@ import copy from didcomm.errors import DIDCommValueError -from didcomm.message import ( +from didcomm import ( Message, Attachment, AttachmentDataBase64, diff --git a/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_anon_encrypted.py b/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_anon_encrypted.py index e6fb1e7..4e1974b 100644 --- a/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_anon_encrypted.py +++ b/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_anon_encrypted.py @@ -1,7 +1,6 @@ from authlib.common.encoding import json_dumps -from didcomm.common.algorithms import AnonCryptAlg -from didcomm.unpack import Metadata +from didcomm import AnonCryptAlg, Metadata from tests.test_vectors.common import TTestVector TEST_ENCRYPTED_DIDCOMM_MESSAGE_ANON_XC20P_1 = json_dumps( diff --git a/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_auth_encrypted.py b/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_auth_encrypted.py index ab7232b..08e56a2 100644 --- a/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_auth_encrypted.py +++ b/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_auth_encrypted.py @@ -1,7 +1,6 @@ from authlib.common.encoding import json_dumps -from didcomm.common.algorithms import AuthCryptAlg, SignAlg, AnonCryptAlg -from didcomm.unpack import Metadata +from didcomm import AuthCryptAlg, SignAlg, AnonCryptAlg, Metadata from tests.test_vectors.common import TTestVector TEST_ENCRYPTED_DIDCOMM_MESSAGE_AUTH_X25519 = json_dumps( diff --git a/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_plaintext.py b/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_plaintext.py index 626e995..5dd2d9b 100644 --- a/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_plaintext.py +++ b/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_plaintext.py @@ -1,6 +1,6 @@ from authlib.common.encoding import json_dumps -from didcomm.unpack import Metadata +from didcomm import Metadata PLAINTEXT_EXPECTED_METADATA = Metadata( encrypted=False, diff --git a/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_signed.py b/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_signed.py index 91c1bce..3aa0ebc 100644 --- a/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_signed.py +++ b/tests/test_vectors/didcomm_messages/spec/spec_test_vectors_signed.py @@ -2,8 +2,7 @@ from authlib.common.encoding import json_dumps -from didcomm.common.algorithms import SignAlg -from didcomm.unpack import Metadata +from didcomm import SignAlg, Metadata from tests.test_vectors.common import TTestVector TEST_SIGNED_DIDCOMM_MESSAGE_ALICE_KEY_1 = json_dumps( diff --git a/tests/test_vectors/didcomm_messages/tests/test_vectors_plaintext_positive.py b/tests/test_vectors/didcomm_messages/tests/test_vectors_plaintext_positive.py index 0a4945f..a520beb 100644 --- a/tests/test_vectors/didcomm_messages/tests/test_vectors_plaintext_positive.py +++ b/tests/test_vectors/didcomm_messages/tests/test_vectors_plaintext_positive.py @@ -1,6 +1,6 @@ from authlib.common.encoding import json_dumps -from didcomm.unpack import Metadata +from didcomm import Metadata PLAINTEXT_EXPECTED_METADATA = Metadata( encrypted=False, diff --git a/tests/test_vectors/secrets/mock_secrets_resolver.py b/tests/test_vectors/secrets/mock_secrets_resolver.py index da64011..1ff83e3 100644 --- a/tests/test_vectors/secrets/mock_secrets_resolver.py +++ b/tests/test_vectors/secrets/mock_secrets_resolver.py @@ -1,8 +1,7 @@ from typing import List, Optional from didcomm.common.types import DID_URL -from didcomm.secrets.secrets_resolver import Secret -from didcomm.secrets.secrets_resolver_in_memory import SecretsResolverInMemory +from didcomm import Secret, SecretsResolverInMemory class MockSecretsResolverInMemory(SecretsResolverInMemory): diff --git a/tests/test_vectors/secrets/mock_secrets_resolver_alice.py b/tests/test_vectors/secrets/mock_secrets_resolver_alice.py index 3014fb4..a637e47 100644 --- a/tests/test_vectors/secrets/mock_secrets_resolver_alice.py +++ b/tests/test_vectors/secrets/mock_secrets_resolver_alice.py @@ -1,11 +1,11 @@ from authlib.common.encoding import json_dumps -from didcomm.common.types import ( +from didcomm import ( VerificationMethodType, VerificationMaterial, VerificationMaterialFormat, + Secret, ) -from didcomm.secrets.secrets_resolver import Secret from tests.test_vectors.secrets.mock_secrets_resolver import MockSecretsResolverInMemory ALICE_SECRET_AUTH_KEY_ED25519 = Secret( diff --git a/tests/test_vectors/secrets/mock_secrets_resolver_bob.py b/tests/test_vectors/secrets/mock_secrets_resolver_bob.py index 45c9a13..bbea453 100644 --- a/tests/test_vectors/secrets/mock_secrets_resolver_bob.py +++ b/tests/test_vectors/secrets/mock_secrets_resolver_bob.py @@ -1,11 +1,11 @@ from authlib.common.encoding import json_dumps -from didcomm.common.types import ( +from didcomm import ( VerificationMethodType, VerificationMaterial, VerificationMaterialFormat, + Secret, ) -from didcomm.secrets.secrets_resolver import Secret from tests.test_vectors.secrets.mock_secrets_resolver import MockSecretsResolverInMemory BOB_SECRET_KEY_AGREEMENT_KEY_X25519_1 = Secret( diff --git a/tests/test_vectors/secrets/mock_secrets_resolver_charlie.py b/tests/test_vectors/secrets/mock_secrets_resolver_charlie.py index 477dbc4..8bf2b2b 100644 --- a/tests/test_vectors/secrets/mock_secrets_resolver_charlie.py +++ b/tests/test_vectors/secrets/mock_secrets_resolver_charlie.py @@ -1,11 +1,11 @@ from authlib.common.encoding import json_dumps -from didcomm.common.types import ( +from didcomm import ( VerificationMethodType, VerificationMaterial, VerificationMaterialFormat, + Secret, ) -from didcomm.secrets.secrets_resolver import Secret from tests.test_vectors.secrets.mock_secrets_resolver import MockSecretsResolverInMemory CHARLIE_SECRET_KEY_AGREEMENT_KEY_X25519 = Secret( diff --git a/tests/test_vectors/secrets/mock_secrets_resolver_mediator1.py b/tests/test_vectors/secrets/mock_secrets_resolver_mediator1.py index 4cfcdae..67083a2 100644 --- a/tests/test_vectors/secrets/mock_secrets_resolver_mediator1.py +++ b/tests/test_vectors/secrets/mock_secrets_resolver_mediator1.py @@ -1,11 +1,11 @@ from authlib.common.encoding import json_dumps -from didcomm.common.types import ( +from didcomm import ( VerificationMethodType, VerificationMaterial, VerificationMaterialFormat, + Secret, ) -from didcomm.secrets.secrets_resolver import Secret from tests.test_vectors.secrets.mock_secrets_resolver import MockSecretsResolverInMemory # FIXME build verification material diff --git a/tests/test_vectors/secrets/mock_secrets_resolver_mediator2.py b/tests/test_vectors/secrets/mock_secrets_resolver_mediator2.py index 29b245b..476f0a7 100644 --- a/tests/test_vectors/secrets/mock_secrets_resolver_mediator2.py +++ b/tests/test_vectors/secrets/mock_secrets_resolver_mediator2.py @@ -1,11 +1,11 @@ from authlib.common.encoding import json_dumps -from didcomm.common.types import ( +from didcomm import ( VerificationMethodType, VerificationMaterial, VerificationMaterialFormat, + Secret, ) -from didcomm.secrets.secrets_resolver import Secret from tests.test_vectors.secrets.mock_secrets_resolver import MockSecretsResolverInMemory # FIXME build verification material diff --git a/tests/test_vectors/utils.py b/tests/test_vectors/utils.py index d659a97..23dd68b 100644 --- a/tests/test_vectors/utils.py +++ b/tests/test_vectors/utils.py @@ -1,11 +1,9 @@ from enum import Enum from typing import List, Union -from didcomm.common.types import VerificationMethodType, VerificationMaterialFormat +from didcomm import VerificationMethodType, VerificationMaterialFormat, VerificationMethod, Secret from didcomm.core.serialization import json_str_to_dict -from didcomm.did_doc.did_doc import VerificationMethod from didcomm.errors import DIDCommValueError -from didcomm.secrets.secrets_resolver import Secret from tests.test_vectors.did_doc import ( DID_DOC_ALICE_WITH_NO_SECRETS, DID_DOC_BOB_WITH_NO_SECRETS, diff --git a/tests/unit/pack_encrypted/test_pack_encrypted_helpers.py b/tests/unit/pack_encrypted/test_pack_encrypted_helpers.py index 66549bf..e035188 100644 --- a/tests/unit/pack_encrypted/test_pack_encrypted_helpers.py +++ b/tests/unit/pack_encrypted/test_pack_encrypted_helpers.py @@ -1,18 +1,13 @@ +import sys + import pytest import attr from typing import List from didcomm.common.types import JSON_OBJ, DID_OR_DID_URL -from didcomm.did_doc.did_doc import DIDDoc, DIDCommService -from didcomm.common.resolvers import ResolversConfig -from didcomm.common.algorithms import AnonCryptAlg +from didcomm import DIDDoc, DIDCommService, ResolversConfig, AnonCryptAlg, PackEncryptedConfig, PackEncryptedParameters -from didcomm import pack_encrypted -from didcomm.pack_encrypted import ( - PackEncryptedConfig, - PackEncryptedParameters, - __forward_if_needed, -) +from didcomm.pack_encrypted import __forward_if_needed from tests import mock_module @@ -24,7 +19,7 @@ def did_doc(did) -> DIDDoc: @pytest.fixture def wrap_in_forward_mock(mocker) -> mock_module.AsyncMock: - return mocker.patch.object(pack_encrypted, "wrap_in_forward") + return mocker.patch.object(sys.modules['didcomm.pack_encrypted'], "wrap_in_forward") @attr.s(auto_attribs=True) From 98fa3522b97f1f0767adb66478e3c71bf631770a Mon Sep 17 00:00:00 2001 From: Darko Kulic Date: Wed, 22 Feb 2023 10:09:13 +0100 Subject: [PATCH 2/5] Linter problems --- didcomm/__init__.py | 19 ++++++++++++++++--- tests/demo/test_demo.py | 10 +++++++++- tests/demo/test_demo_mediators.py | 9 ++++++++- tests/test_vectors/utils.py | 7 ++++++- .../test_pack_encrypted_helpers.py | 11 +++++++++-- 5 files changed, 48 insertions(+), 8 deletions(-) diff --git a/didcomm/__init__.py b/didcomm/__init__.py index 513def1..2dcb917 100644 --- a/didcomm/__init__.py +++ b/didcomm/__init__.py @@ -1,7 +1,10 @@ __version__ = "0.3.0" +# ignore 'Module imported but unused (F401)' +# flake8: noqa: F401 + from didcomm.common.algorithms import AnonCryptAlg, AuthCryptAlg, SignAlg -from didcomm.common.resolvers import DIDResolver, ResolversConfig, SecretsResolver +from didcomm.common.resolvers import ResolversConfig from didcomm.common.types import ( DIDCommMessageMediaTypes, DIDCommMessageProtocolTypes, @@ -12,6 +15,7 @@ VerificationMaterialFormat, ) from didcomm.did_doc.did_doc import DIDDoc, DIDCommService, VerificationMethod +from didcomm.did_doc.did_resolver import DIDResolver from didcomm.did_doc.did_resolver_in_memory import DIDResolverInMemory from didcomm.message import ( Attachment, @@ -23,8 +27,17 @@ Message, ) from didcomm import pack_encrypted as pack_encrypted_module -from didcomm.pack_encrypted import pack_encrypted, PackEncryptedConfig, PackEncryptedParameters, PackEncryptedResult -from didcomm.pack_plaintext import pack_plaintext, PackPlaintextParameters, PackPlaintextResult +from didcomm.pack_encrypted import ( + pack_encrypted, + PackEncryptedConfig, + PackEncryptedParameters, + PackEncryptedResult, +) +from didcomm.pack_plaintext import ( + pack_plaintext, + PackPlaintextParameters, + PackPlaintextResult, +) from didcomm.pack_signed import pack_signed, PackSignedParameters, PackSignedResult from didcomm.protocols.routing.forward import ( is_forward, diff --git a/tests/demo/test_demo.py b/tests/demo/test_demo.py index d340b4a..74c8b42 100644 --- a/tests/demo/test_demo.py +++ b/tests/demo/test_demo.py @@ -1,6 +1,14 @@ import pytest as pytest -from didcomm import Message, pack_encrypted, PackEncryptedConfig, pack_plaintext, pack_signed, unpack_forward, unpack +from didcomm import ( + Message, + pack_encrypted, + PackEncryptedConfig, + pack_plaintext, + pack_signed, + unpack_forward, + unpack, +) from tests.test_vectors.common import ALICE_DID, BOB_DID, CHARLIE_DID diff --git a/tests/demo/test_demo_mediators.py b/tests/demo/test_demo_mediators.py index 7757262..6290ab5 100644 --- a/tests/demo/test_demo_mediators.py +++ b/tests/demo/test_demo_mediators.py @@ -1,6 +1,13 @@ import pytest as pytest -from didcomm import Message, pack_encrypted, unpack_forward, wrap_in_forward, unpack, UnpackConfig +from didcomm import ( + Message, + pack_encrypted, + unpack_forward, + wrap_in_forward, + unpack, + UnpackConfig, +) from didcomm.core.serialization import dict_to_json from tests.test_vectors.common import ALICE_DID, BOB_DID diff --git a/tests/test_vectors/utils.py b/tests/test_vectors/utils.py index 23dd68b..c021a64 100644 --- a/tests/test_vectors/utils.py +++ b/tests/test_vectors/utils.py @@ -1,7 +1,12 @@ from enum import Enum from typing import List, Union -from didcomm import VerificationMethodType, VerificationMaterialFormat, VerificationMethod, Secret +from didcomm import ( + VerificationMethodType, + VerificationMaterialFormat, + VerificationMethod, + Secret, +) from didcomm.core.serialization import json_str_to_dict from didcomm.errors import DIDCommValueError from tests.test_vectors.did_doc import ( diff --git a/tests/unit/pack_encrypted/test_pack_encrypted_helpers.py b/tests/unit/pack_encrypted/test_pack_encrypted_helpers.py index e035188..8470eae 100644 --- a/tests/unit/pack_encrypted/test_pack_encrypted_helpers.py +++ b/tests/unit/pack_encrypted/test_pack_encrypted_helpers.py @@ -5,7 +5,14 @@ from typing import List from didcomm.common.types import JSON_OBJ, DID_OR_DID_URL -from didcomm import DIDDoc, DIDCommService, ResolversConfig, AnonCryptAlg, PackEncryptedConfig, PackEncryptedParameters +from didcomm import ( + DIDDoc, + DIDCommService, + ResolversConfig, + AnonCryptAlg, + PackEncryptedConfig, + PackEncryptedParameters, +) from didcomm.pack_encrypted import __forward_if_needed @@ -19,7 +26,7 @@ def did_doc(did) -> DIDDoc: @pytest.fixture def wrap_in_forward_mock(mocker) -> mock_module.AsyncMock: - return mocker.patch.object(sys.modules['didcomm.pack_encrypted'], "wrap_in_forward") + return mocker.patch.object(sys.modules["didcomm.pack_encrypted"], "wrap_in_forward") @attr.s(auto_attribs=True) From f8a947f87814f1966fc58e447835625d86755f05 Mon Sep 17 00:00:00 2001 From: Darko Kulic Date: Thu, 23 Feb 2023 16:40:59 +0100 Subject: [PATCH 3/5] Add __all__ list to __init__.py --- didcomm/__init__.py | 65 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 64 insertions(+), 1 deletion(-) diff --git a/didcomm/__init__.py b/didcomm/__init__.py index 2dcb917..ac2547b 100644 --- a/didcomm/__init__.py +++ b/didcomm/__init__.py @@ -26,7 +26,6 @@ GenericMessage, Message, ) -from didcomm import pack_encrypted as pack_encrypted_module from didcomm.pack_encrypted import ( pack_encrypted, PackEncryptedConfig, @@ -51,3 +50,67 @@ from didcomm.unpack import unpack, Metadata, UnpackConfig, UnpackResult from didcomm.secrets.secrets_resolver import Secret, SecretsResolver from didcomm.secrets.secrets_resolver_in_memory import SecretsResolverInMemory + +__all__ = [ + # didcomm.common.algorithms + "AnonCryptAlg", + "AuthCryptAlg", + "SignAlg", + # didcomm.common.resolvers + "ResolversConfig", + # didcomm.common.types + "DIDCommMessageMediaTypes", + "DIDCommMessageProtocolTypes", + "DIDCommMessageTypes", + "DIDDocServiceTypes", + "VerificationMethodType", + "VerificationMaterial", + "VerificationMaterialFormat", + # didcomm.did_doc.did_doc + "DIDDoc", + "DIDCommService", + "VerificationMethod", + # didcomm.did_doc.did_resolver + "DIDResolver", + # did_resolver_in_memory + "DIDResolverInMemory", + # didcomm.message + "Attachment", + "AttachmentDataBase64", + "AttachmentDataJson", + "AttachmentDataLinks", + "FromPrior", + "GenericMessage", + "Message", + # didcomm.pack_encrypted + "pack_encrypted", + "PackEncryptedConfig", + "PackEncryptedParameters", + "PackEncryptedResult", + # didcomm.pack_plaintext + "pack_plaintext", + "PackPlaintextParameters", + "PackPlaintextResult", + # didcomm.pack_signed + "pack_signed", + "PackSignedParameters", + "PackSignedResult", + # didcomm.protocols.routing.forward + "is_forward", + "unpack_forward", + "wrap_in_forward", + "ForwardBody", + "ForwardMessage", + "ForwardPackResult", + "ForwardResult", + # didcomm.unpack + "unpack", + "Metadata", + "UnpackConfig", + "UnpackResult", + # didcomm.secrets.secrets_resolver + "Secret", + "SecretsResolver", + # didcomm.secrets.secrets_resolver_in_memory + "SecretsResolverInMemory", +] From 546f1b733c5df1a4628515b42b6c205d9f73d092 Mon Sep 17 00:00:00 2001 From: Darko Kulic Date: Thu, 23 Feb 2023 16:51:50 +0100 Subject: [PATCH 4/5] Remove unneeded flake8 directive --- didcomm/__init__.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/didcomm/__init__.py b/didcomm/__init__.py index ac2547b..4ee59d6 100644 --- a/didcomm/__init__.py +++ b/didcomm/__init__.py @@ -1,8 +1,5 @@ __version__ = "0.3.0" -# ignore 'Module imported but unused (F401)' -# flake8: noqa: F401 - from didcomm.common.algorithms import AnonCryptAlg, AuthCryptAlg, SignAlg from didcomm.common.resolvers import ResolversConfig from didcomm.common.types import ( From 3dba76ff9ab82cff35216a8e241e4ad26787ab47 Mon Sep 17 00:00:00 2001 From: Darko Kulic Date: Thu, 23 Feb 2023 16:53:57 +0100 Subject: [PATCH 5/5] Fix wrong version --- didcomm/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/didcomm/__init__.py b/didcomm/__init__.py index 4ee59d6..50cb3d7 100644 --- a/didcomm/__init__.py +++ b/didcomm/__init__.py @@ -1,4 +1,4 @@ -__version__ = "0.3.0" +__version__ = "0.3.1" from didcomm.common.algorithms import AnonCryptAlg, AuthCryptAlg, SignAlg from didcomm.common.resolvers import ResolversConfig