python: Split apart the Command hierarchy into a backwards-compatible…

… version and a forward-looking one.

python/dazl/__init__.py

@@ -4,12 +4,43 @@
 """
 This module contains the Python API for interacting with the Ledger API.
 """
+from ast import literal_eval
+from configparser import ConfigParser
+from pathlib import Path
+
+import pkg_resources
+
+__all__ = [
+    "AIOPartyClient",
+    "Command",
+    "ContractData",
+    "ContractId",
+    "CreateAndExerciseCommand",
+    "CreateCommand",
+    "DazlError",
+    "ExerciseByKeyCommand",
+    "ExerciseCommand",
+    "LOG",
+    "Network",
+    "Party",
+    "SimplePartyClient",
+    "__version__",
+    "async_network",
+    "create",
+    "create_and_exercise",
+    "exercise",
+    "exercise_by_key",
+    "frozendict",
+    "run",
+    "setup_default_logger",
+    "simple_client",
+    "write_acs",
+]
+
+
 from ._logging import LOG
 from .client import AIOPartyClient, Network, SimplePartyClient, async_network, run, simple_client
-from .pretty.table import write_acs
-from .prim import ContractData, ContractId, DazlError, FrozenDict as frozendict, Party
-from .protocols.commands import (
-    Command,
+from .client.commands import (
     CreateAndExerciseCommand,
     CreateCommand,
     ExerciseByKeyCommand,
@@ -19,6 +50,9 @@
     exercise,
     exercise_by_key,
 )
+from .pretty.table import write_acs
+from .prim import ContractData, ContractId, DazlError, FrozenDict as frozendict, Party
+from .protocols.commands import Command
 from .util.logging import setup_default_logger
 
 try:
@@ -45,12 +79,6 @@ def _get_version() -> str:
      2. Use the value from the local pyproject.toml file (this is used when
         running dazl from source).
     """
-    from ast import literal_eval
-    from configparser import ConfigParser
-    from pathlib import Path
-
-    import pkg_resources
-
     try:
         return pkg_resources.require("dazl")[0].version
     except pkg_resources.DistributionNotFound:

python/dazl/client/_events.py

@@ -3,8 +3,8 @@
 
 from typing import Awaitable, Callable, TypeVar, Union
 
-from ..protocols.commands import EventHandlerResponse
 from ..protocols.events import BaseEvent
+from .commands import EventHandlerResponse
 
 E = TypeVar("E", bound=BaseEvent)
 T = TypeVar("T")

python/dazl/client/_party_client_impl.py

@@ -1,6 +1,5 @@
 # Copyright (c) 2017-2021 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
-
 from asyncio import Future, ensure_future, gather, get_event_loop, wait
 from concurrent.futures import ALL_COMPLETED
 from dataclasses import asdict, dataclass, field, fields, replace
@@ -20,17 +19,12 @@
     TypeVar,
 )
 import uuid
+import warnings
 
 from .. import LOG
 from ..damlast.daml_lf_1 import TypeConName
 from ..prim import ContractId, Party, TimeDeltaLike, to_timedelta
 from ..protocols import LedgerClient, LedgerNetwork
-from ..protocols.commands import (
-    CommandBuilder,
-    CommandDefaults,
-    CommandPayload,
-    EventHandlerResponse,
-)
 from ..protocols.events import (
     ActiveContractSetEvent,
     BaseEvent,
@@ -52,6 +46,7 @@
 from ._conn_settings import OAuthSettings, connection_settings
 from ._writer_verify import ValidateSerializer
 from .bots import Bot, BotCallback, BotCollection, BotFilter
+from .commands import CommandBuilder, CommandDefaults, CommandPayload, EventHandlerResponse
 from .config import NetworkConfig, PartyConfig
 from .ledger import LedgerMetadata
 from .state import (
@@ -455,7 +450,7 @@ def _process_transaction_stream_event(self, event: Any, raise_events: bool) -> F
 
     def write_commands(
         self,
-        commands: EventHandlerResponse,
+        commands: "EventHandlerResponse",
         ignore_errors: bool = False,
         workflow_id: "Optional[str]" = None,
         deduplication_time: "Optional[TimeDeltaLike]" = None,
@@ -481,7 +476,9 @@ def write_commands(
         """
         if workflow_id is None:
             workflow_id = uuid.uuid4().hex
-        cb = CommandBuilder.coerce(commands, atomic_default=True)
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            cb = CommandBuilder.coerce(commands, atomic_default=True)
         cb.defaults(
             workflow_id=workflow_id,
             deduplication_time=(

python/dazl/client/_writer_verify.py

@@ -2,17 +2,13 @@
 # SPDX-License-Identifier: Apache-2.0
 
 from typing import Any
+import warnings
 
 from ..damlast.daml_lf_1 import TypeConName
 from ..prim import ContractId
-from ..protocols.commands import (
-    AbstractSerializer,
-    CreateAndExerciseCommand,
-    CreateCommand,
-    ExerciseByKeyCommand,
-    ExerciseCommand,
-)
+from ..protocols.commands import AbstractSerializer
 from ..values import CanonicalMapper
+from .commands import CreateAndExerciseCommand, CreateCommand, ExerciseByKeyCommand, ExerciseCommand
 
 
 class ValidateSerializer(AbstractSerializer):
@@ -29,12 +25,16 @@ class ValidateSerializer(AbstractSerializer):
     def serialize_create_command(
         self, name: "TypeConName", template_args: "Any"
     ) -> "CreateCommand":
-        return CreateCommand(template=name, arguments=template_args)
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            return CreateCommand(template=name, arguments=template_args)
 
     def serialize_exercise_command(
         self, contract_id: "ContractId", choice_name: str, choice_args: "Any"
     ) -> "ExerciseCommand":
-        return ExerciseCommand(contract=contract_id, choice=choice_name, arguments=choice_args)
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            return ExerciseCommand(contract=contract_id, choice=choice_name, arguments=choice_args)
 
     def serialize_exercise_by_key_command(
         self,
@@ -43,12 +43,14 @@ def serialize_exercise_by_key_command(
         choice_name: str,
         choice_arguments: "Any",
     ) -> "ExerciseByKeyCommand":
-        return ExerciseByKeyCommand(
-            template=template_name,
-            contract_key=key_arguments,
-            choice=choice_name,
-            choice_argument=choice_arguments,
-        )
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            return ExerciseByKeyCommand(
+                template=template_name,
+                contract_key=key_arguments,
+                choice=choice_name,
+                choice_argument=choice_arguments,
+            )
 
     def serialize_create_and_exercise_command(
         self,
@@ -57,9 +59,11 @@ def serialize_create_and_exercise_command(
         choice_name: str,
         choice_arguments: "Any",
     ) -> "CreateAndExerciseCommand":
-        return CreateAndExerciseCommand(
-            template=template_name,
-            arguments=create_arguments,
-            choice=choice_name,
-            choice_argument=choice_arguments,
-        )
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            return CreateAndExerciseCommand(
+                template=template_name,
+                arguments=create_arguments,
+                choice=choice_name,
+                choice_argument=choice_arguments,
+            )

python/dazl/client/api.py

@@ -43,7 +43,6 @@
 from ..damlast.protocols import SymbolLookup
 from ..metrics import MetricEvents
 from ..prim import ContractData, ContractId, Party, TimeDeltaLike, to_party
-from ..protocols.commands import EventHandlerResponse
 from ..protocols.events import (
     ContractArchiveEvent,
     ContractCreateEvent,
@@ -70,6 +69,7 @@
 from ._network_client_impl import _NetworkImpl
 from ._party_client_impl import _PartyClientImpl
 from .bots import Bot, BotCollection
+from .commands import EventHandlerResponse
 from .config import AnonymousNetworkConfig, NetworkConfig, PartyConfig
 from .events import EventKey
 from .ledger import LedgerMetadata

python/dazl/client/bots.py

@@ -30,9 +30,10 @@
 
 from .. import LOG
 from ..prim import Party
-from ..protocols.commands import Command, CommandBuilder
+from ..protocols.commands import Command
 from ..protocols.events import BaseEvent
 from ..util.asyncio_util import LongRunningAwaitable, Signal, completed, failed, propagate
+from .commands import CommandBuilder
 from .events import EventKey
 
 if TYPE_CHECKING: