Remove outdated filetransfer deprecations

Author: fqqb

yamcs-client/src/yamcs/filetransfer/client.py

@@ -172,12 +172,9 @@ def upload(
         bucket_name: str,
         object_name: str,
         remote_path: str,
-        source_entity: str,
-        destination_entity: str,
-        overwrite: bool,
-        parents: bool,
-        reliable: bool,
-        options: Mapping[str, Any],
+        source_entity: Optional[str],
+        destination_entity: Optional[str],
+        options: Optional[Mapping[str, Any]],
     ) -> Transfer:
         req = filetransfer_pb2.CreateTransferRequest()
         req.direction = filetransfer_pb2.TransferDirection.UPLOAD
@@ -188,14 +185,6 @@ def upload(
             req.source = source_entity
         if destination_entity:
             req.destination = destination_entity
-
-        # Old options for backwards compatibility
-        old_options = {
-            "overwrite": overwrite,
-            "createPath": parents,
-            "reliable": reliable,
-        }
-        req.options.update(old_options)
         if options:
             req.options.update(options)
 
@@ -209,13 +198,10 @@ def download(
         self,
         bucket_name: str,
         remote_path: str,
-        object_name: str,
-        source_entity: str,
-        destination_entity: str,
-        overwrite: bool,
-        parents: bool,
-        reliable: bool,
-        options: Mapping[str, Any],
+        object_name: Optional[str],
+        source_entity: Optional[str],
+        destination_entity: Optional[str],
+        options: Optional[Mapping[str, Any]],
     ) -> Transfer:
         req = filetransfer_pb2.CreateTransferRequest()
         req.direction = filetransfer_pb2.TransferDirection.DOWNLOAD
@@ -227,14 +213,6 @@ def download(
             req.source = source_entity
         if destination_entity:
             req.destination = destination_entity
-
-        # Old options for backwards compatibility
-        old_options = {
-            "overwrite": overwrite,
-            "createPath": parents,
-            "reliable": reliable,
-        }
-        req.options.update(old_options)
         if options:
             req.options.update(options)
 
@@ -247,9 +225,9 @@ def download(
     def fetch_filelist(
         self,
         remote_path: str,
-        source_entity: str,
-        destination_entity: str,
-        options: Mapping[str, Any],
+        source_entity: Optional[str],
+        destination_entity: Optional[str],
+        options: Optional[Mapping[str, Any]],
     ):
         req = filetransfer_pb2.ListFilesRequest()
         req.remotePath = remote_path
@@ -265,9 +243,9 @@ def fetch_filelist(
     def get_filelist(
         self,
         remote_path: str,
-        source_entity: str,
-        destination_entity: str,
-        options: Mapping[str, Any],
+        source_entity: Optional[str],
+        destination_entity: Optional[str],
+        options: Optional[Mapping[str, Any]],
     ) -> RemoteFileListing:
         params = {"remotePath": remote_path}
         if source_entity:

yamcs-client/src/yamcs/filetransfer/model.py

@@ -1,13 +1,16 @@
 import datetime
 import threading
-from typing import Any, Callable, List, Mapping, Optional
+from typing import TYPE_CHECKING, Any, Callable, List, Mapping, Optional
 
 from yamcs.core.helpers import parse_server_time
 from yamcs.protobuf.filetransfer import filetransfer_pb2
 
+if TYPE_CHECKING:
+    from yamcs.filetransfer.client import ServiceClient
+
 
 class Service:
-    def __init__(self, proto, service_client):
+    def __init__(self, proto, service_client: "ServiceClient"):
         self._proto = proto
         self._service_client = service_client
         self._local_entities = [EntityInfo(entity) for entity in proto.localEntities]
@@ -54,18 +57,11 @@ def upload(
         remote_path: str,
         source_entity: Optional[str] = None,
         destination_entity: Optional[str] = None,
-        overwrite: bool = True,
-        parents: bool = True,
-        reliable: bool = False,
         options: Optional[Mapping[str, Any]] = None,
     ) -> "Transfer":
         """
         Uploads a file located in a bucket to a remote destination path.
 
-        .. warning::
-            Prefer the use of ``options`` instead of the deprecated params
-            ``overwrite``, ``parents`` and ``reliable``.
-
         :param bucket_name:
             Name of the bucket containing the source object.
         :param object_name:
@@ -76,34 +72,15 @@ def upload(
             Use a specific source entity. (useful in case of multiples)
         :param destination_entity:
             Use a specific destination entity. (useful in case of multiples)
-        :param overwrite:
-            Replace file if it already exists.
-
-            .. deprecated:: 1.8.6
-                Use ``options`` instead (option name: ``overwrite``)
-        :param parents:
-            Create the remote path if it does not yet exist.
-
-            .. deprecated:: 1.8.6
-                Use ``options`` instead (option name: ``createPath``)
-        :param reliable:
-            Enable reliable transfers.
-
-            .. deprecated:: 1.8.6
-                Use ``options`` instead (option name: ``reliable``)
         :param options:
-            file transfer options dict (may overwrite "overwrite", "parents"
-            or "reliable" parameters if set in these options).
+            file transfer options
         """
         return self._service_client.upload(
             bucket_name=bucket_name,
             object_name=object_name,
             remote_path=remote_path,
             source_entity=source_entity,
             destination_entity=destination_entity,
-            overwrite=overwrite,
-            parents=parents,
-            reliable=reliable,
             options=options,
         )
 
@@ -114,18 +91,11 @@ def download(
         object_name: Optional[str] = None,
         source_entity: Optional[str] = None,
         destination_entity: Optional[str] = None,
-        overwrite: bool = True,
-        parents: bool = True,
-        reliable: bool = False,
         options: Optional[Mapping[str, Any]] = None,
     ) -> "Transfer":
         """
         Downloads a file from the source to a bucket.
 
-        .. warning::
-            Prefer the use of ``options`` instead of the deprecated
-            params ``overwrite``, ``parents`` and ``reliable``.
-
         :param bucket_name:
             Name of the bucket to receive the file.
         :param object_name:
@@ -136,34 +106,15 @@ def download(
             Use a specific source entity. (useful in case of multiples)
         :param destination_entity:
             Use a specific destination entity. (useful in case of multiples)
-        :param overwrite:
-            Replace file if it already exists.
-
-            .. deprecated:: 1.8.6
-                Use ``options`` instead (option name: ``overwrite``)
-        :param parents:
-            Create the remote path if it does not yet exist.
-
-            .. deprecated:: 1.8.6
-                Use ``options`` instead (option name: ``createPath``)
-        :param reliable:
-            Enable reliable transfers.
-
-            .. deprecated:: 1.8.6
-                Use ``options`` instead (option name: ``reliable``)
         :param options:
-            File transfer options dict (may overwrite ``overwrite``, ``parents``
-            or ``reliable`` parameters if set in these options).
+            File transfer options.
         """
         return self._service_client.download(
             bucket_name=bucket_name,
             remote_path=remote_path,
             object_name=object_name,
             source_entity=source_entity,
             destination_entity=destination_entity,
-            overwrite=overwrite,
-            parents=parents,
-            reliable=reliable,
             options=options,
         )