Merge pull request #245 from digital-asset/python-rename-pkgloader-aio

python: Move dazl/ledger/pkgloader_aio into dazl/ledger/aio.

Author: da-tanabe

VERSION

@@ -1 +1 @@
-7.5.0a5
+7.5.0

python/dazl/client/_network_client_impl.py

@@ -26,8 +26,8 @@
 from ..damlast.daml_lf_1 import PackageRef
 from ..damlast.lookup import MultiPackageLookup
 from ..damlast.pkgfile import get_dar_package_ids
+from ..ledger.aio import PackageService
 from ..ledger.grpc.codec_aio import Codec
-from ..ledger.pkgloader_aio import PackageService
 from ..metrics import MetricEvents
 from ..prim import Party, TimeDeltaLike, to_timedelta
 from ..protocols import LedgerNetwork

python/dazl/client/ledger.py

@@ -8,7 +8,7 @@
 from typing import TYPE_CHECKING
 import warnings
 
-from ..ledger.pkgloader_aio import PackageLoader
+from ..ledger.aio import PackageLoader
 from ..protocols.serializers import Serializer
 
 if TYPE_CHECKING:

python/dazl/client/pkg_loader.py

@@ -3,10 +3,10 @@
 
 import warnings
 
-from ..ledger.pkgloader_aio_compat import PackageLoader, SyncPackageService
+from ..ledger.aio.pkgloader_compat import PackageLoader, SyncPackageService
 
 warnings.warn(
-    "dazl.client.pkg_loader is deprecated; use dazl.protocols.pkgloader_aio instead.",
+    "dazl.client.pkg_loader is deprecated; use dazl.ledger.aio instead.",
     DeprecationWarning,
     stacklevel=2,
 )

python/dazl/ledger/__init__.py

@@ -41,6 +41,9 @@
     "ExerciseCommand",
     "ExerciseResponse",
     "PartyInfo",
+    "PackageService",
+    "Connection",
+    "QueryStream",
 ]
 
 
@@ -63,8 +66,35 @@ def connect(*, blocking=False, **kwargs):
     return GrpcConnection(cfg)
 
 
+class PackageService(Protocol):
+    """
+    Protocol that describe a service that provides package information. The :class:`Connection`
+    protocol extends this interface.
+    """
+
+    def get_package(self, __package_id):
+        """
+        Given a package ID, fetch the binary data for the corresponding DALF.
+
+        :param __package_id:
+            The package ID of the DALF to retrieve.
+
+            Note that future versions of dazl reserve the right to rename this parameter name at any
+            time; it should be passed in as a positional parameter and never by name.
+        :return:
+            The byte array contents of the DALF associated with the package ID.
+        """
+        raise NotImplementedError
+
+    def list_package_ids(self):
+        """
+        Fetch a list of all known package IDs.
+        """
+        raise NotImplementedError
+
+
 @runtime_checkable
-class Connection(Protocol):
+class Connection(PackageService, Protocol):
     """
     Protocol that describes a connection to a ledger. You will typically work with the more specific
     protocols :class:`dazl.ledger.aio.Connection` or :class:`dazl.ledger.blocking.Connection` that
@@ -453,26 +483,6 @@ def list_known_parties(self):
         """
         raise NotImplementedError
 
-    def get_package(self, __package_id):
-        """
-        Given a package ID, fetch the binary data for the corresponding DALF.
-
-        :param __package_id:
-            The package ID of the DALF to retrieve.
-
-            Note that future versions of dazl reserve the right to rename this parameter name at any
-            time; it should be passed in as a positional parameter and never by name.
-        :return:
-            The byte array contents of the DALF associated with the package ID.
-        """
-        raise NotImplementedError
-
-    def list_package_ids(self):
-        """
-        Fetch a list of all known package IDs.
-        """
-        raise NotImplementedError
-
     def upload_package(self, __contents):
         """
         Upload a byte array as a DAR file to the remote Daml ledger.

python/dazl/ledger/__init__.pyi

@@ -58,6 +58,9 @@ __all__ = [
     "ExerciseCommand",
     "ExerciseResponse",
     "PartyInfo",
+    "PackageService",
+    "Connection",
+    "QueryStream",
 ]
 
 CreateFn = TypeVar("CreateFn", bound=Callable[[CreateEvent], SubmitResponse])
@@ -180,8 +183,15 @@ def connect(
     logger_name: Optional[str] = None,
     log_level: Optional[str] = None,
 ) -> Connection: ...
+
+class PackageService(Protocol):
+    def get_package(self, package_id: PackageRef) -> Union[bytes, Awaitable[bytes]]: ...
+    def list_package_ids(
+        self,
+    ) -> Union[AbstractSet[PackageRef], Awaitable[AbstractSet[PackageRef]]]: ...
+
 @runtime_checkable
-class Connection(Protocol):
+class Connection(PackageService, Protocol):
     @property
     def config(self) -> Config: ...
     @property
@@ -257,10 +267,6 @@ class Connection(Protocol):
         self, *, identifier_hint: str = None, display_name: str = None
     ) -> Union[PartyInfo, Awaitable[PartyInfo]]: ...
     def list_known_parties(self) -> Union[Sequence[PartyInfo], Awaitable[Sequence[PartyInfo]]]: ...
-    def get_package(self, __package_id: PackageRef) -> Union[bytes, Awaitable[bytes]]: ...
-    def list_package_ids(
-        self,
-    ) -> Union[AbstractSet[PackageRef], Awaitable[AbstractSet[PackageRef]]]: ...
     def upload_package(self, __contents: bytes) -> Union[None, Awaitable[None]]: ...
 
 @runtime_checkable

python/dazl/ledger/aio/__init__.py

@@ -22,7 +22,7 @@
     from typing_extensions import Protocol, runtime_checkable
 
 
-__all__ = ["Connection", "QueryStream", "QueryStreamBase"]
+__all__ = ["PackageService", "Connection", "QueryStream", "QueryStreamBase", "PackageLoader"]
 
 Self = TypeVar("Self")
 Ret = Union[None, CreateEvent, ExerciseResponse]
@@ -33,6 +33,19 @@
 BOUNDARY = "boundary"
 
 
+class PackageService(Protocol):
+    """
+    Protocol that describe a service that provides package information. The :class:`Connection`
+    protocol extends this interface.
+    """
+
+    async def get_package(self, __package_id) -> bytes:
+        raise NotImplementedError
+
+    async def list_package_ids(self):
+        raise NotImplementedError
+
+
 @runtime_checkable
 class Connection(_Connection, Protocol):
     async def __aenter__(self):
@@ -198,3 +211,7 @@ def decorator(fn):
         return fn
 
     return decorator
+
+
+# Imports internal to this package are at the bottom of the file to avoid circular dependencies
+from .pkgloader import PackageLoader  # noqa

python/dazl/ledger/aio/__init__.pyi

@@ -3,6 +3,7 @@
 import abc
 import sys
 from typing import (
+    AbstractSet,
     Any,
     AsyncIterator,
     Awaitable,
@@ -16,8 +17,12 @@ from typing import (
     overload,
 )
 
-from .. import Connection as _Connection, QueryStream as _QueryStream
-from ...damlast.daml_lf_1 import TypeConName
+from .. import (
+    Connection as _Connection,
+    PackageService as _PackageService,
+    QueryStream as _QueryStream,
+)
+from ...damlast.daml_lf_1 import PackageRef, TypeConName
 from ...prim import ContractData, ContractId
 from ...query import Queries, Query
 from ..api_types import (
@@ -26,15 +31,17 @@ from ..api_types import (
     Command,
     CreateEvent,
     ExerciseResponse,
+    PartyInfo,
     SubmitResponse,
 )
+from .pkgloader import PackageLoader
 
 if sys.version_info >= (3, 8):
     from typing import Protocol, runtime_checkable
 else:
     from typing_extensions import Protocol, runtime_checkable
 
-__all__ = ["Connection", "QueryStream", "QueryStreamBase"]
+__all__ = ["PackageService", "Connection", "QueryStream", "QueryStreamBase", "PackageLoader"]
 
 Self = TypeVar("Self")
 CreateFn = TypeVar("CreateFn", bound=Callable[[CreateEvent], SubmitResponse])
@@ -72,8 +79,12 @@ class ABoundaryDecorator(Protocol):
     @overload
     def __call__(self, __fn: ABoundaryFn) -> ABoundaryFn: ...
 
+class PackageService(_PackageService, Protocol):
+    async def get_package(self, __package_id: PackageRef) -> bytes: ...
+    async def list_package_ids(self) -> AbstractSet[PackageRef]: ...
+
 @runtime_checkable
-class Connection(_Connection, Protocol):
+class Connection(_Connection, PackageService, Protocol):
     async def __aenter__(self: Self) -> Self: ...
     async def __aexit__(self, exc_type, exc_val, exc_tb) -> None: ...
     async def open(self) -> None: ...
@@ -143,6 +154,11 @@ class Connection(_Connection, Protocol):
         self, __template_id: str = "*", __query: Query = None, *, offset: Optional[str] = None
     ) -> QueryStream: ...
     def stream_many(self, *q: Queries, offset: Optional[str] = None) -> QueryStream: ...
+    async def allocate_party(
+        self, *, identifier_hint: Optional[str] = None, display_name: Optional[str] = None
+    ) -> PartyInfo: ...
+    async def list_known_parties(self) -> Sequence[PartyInfo]: ...
+    async def upload_package(self, contents: bytes) -> None: ...
 
 # PyCharm doesn't know what to make of these overloads with respect to the parent protocol,
 # but mypy understands that these type signatures do not conflict with the parent base class

python/dazl/ledger/pkgloader_aio.py python/dazl/ledger/aio/pkgloader.pypython/dazl/ledger/pkgloader_aio.py renamed to python/dazl/ledger/aio/pkgloader.py

@@ -1,25 +1,22 @@
 # Copyright (c) 2017-2021 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
+
 from asyncio import ensure_future, gather, get_event_loop, sleep, wait_for
 from concurrent.futures import ThreadPoolExecutor
 from datetime import timedelta
-import sys
-from typing import AbstractSet, Awaitable, Callable, Dict, Optional, Set, TypeVar
+from typing import Awaitable, Callable, Dict, Optional, Set, TypeVar
 import warnings
 
-from .. import LOG
-from ..damlast.daml_lf_1 import Archive, Package, PackageRef
-from ..damlast.errors import NameNotFoundError, PackageNotFoundError
-from ..damlast.lookup import MultiPackageLookup, validate_template
-from ..damlast.pkgfile import Dar
-from ..prim import DazlError
-
-if sys.version_info >= (3, 8):
-    from typing import Protocol
-else:
-    from typing_extensions import Protocol
+from . import PackageService
+from ... import LOG
+from ...damlast.daml_lf_1 import Archive, Package, PackageRef
+from ...damlast.errors import NameNotFoundError, PackageNotFoundError
+from ...damlast.lookup import MultiPackageLookup, validate_template
+from ...damlast.parse import parse_archive
+from ...damlast.pkgfile import Dar
+from ...prim import DazlError
 
-__all__ = ["PackageService", "PackageLoader", "DEFAULT_TIMEOUT"]
+__all__ = ["PackageLoader", "DEFAULT_TIMEOUT"]
 
 T = TypeVar("T")
 
@@ -28,18 +25,6 @@
 DEFAULT_TIMEOUT: timedelta = timedelta(seconds=30)
 
 
-class PackageService(Protocol):
-    """
-    A service that provides package information.
-    """
-
-    async def get_package(self, package_id: "PackageRef") -> bytes:
-        raise NotImplementedError("PackageService.get_package requires an implementation")
-
-    async def list_package_ids(self) -> "AbstractSet[PackageRef]":
-        raise NotImplementedError("PackageService.list_package_ids requires an implementation")
-
-
 class PackageLoader:
     """
     Loader for packages from a remote PackageService.
@@ -165,8 +150,6 @@ async def load(self, ref: "PackageRef") -> "Package":
         return package
 
     async def _load_and_parse_package(self, package_id: "PackageRef") -> "Package":
-        from ..damlast.parse import parse_archive
-
         LOG.info("Loading package: %s", package_id)
 
         loop = get_event_loop()

…thon/dazl/ledger/pkgloader_aio_compat.py …thon/dazl/ledger/aio/pkgloader_compat.pypython/dazl/ledger/pkgloader_aio_compat.py renamed to python/dazl/ledger/aio/pkgloader_compat.py python/dazl/ledger/pkgloader_aio_compat.py renamed to python/dazl/ledger/aio/pkgloader_compat.py

@@ -13,9 +13,10 @@
 from typing import AbstractSet, Optional
 import warnings
 
-from ..damlast.daml_lf_1 import PackageRef
-from ..damlast.lookup import MultiPackageLookup
-from .pkgloader_aio import DEFAULT_TIMEOUT, PackageLoader as NewPackageLoader
+from dazl.damlast.daml_lf_1 import PackageRef
+from dazl.damlast.lookup import MultiPackageLookup
+
+from .pkgloader import DEFAULT_TIMEOUT, PackageLoader as NewPackageLoader
 
 if sys.version_info >= (3, 8):
     from typing import Protocol