rucio-clients 32.8.6__py3-none-any.whl → 35.8.0__py3-none-any.whl

rucio/client/lifetimeclient.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright European Organization for Nuclear Research (CERN) since 2012
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,13 +13,19 @@
 # limitations under the License.
 
 from json import loads
+from typing import TYPE_CHECKING, Any, Optional
 
 from requests.status_codes import codes
 
-from rucio.client.baseclient import BaseClient
-from rucio.client.baseclient import choice
+from rucio.client.baseclient import BaseClient, choice
 from rucio.common.utils import build_url, render_json
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator, Sequence
+    from datetime import datetime
+
+    from rucio.db.sqla.constants import LifetimeExceptionsState
+
 
 class LifetimeClient(BaseClient):
 
@@ -28,7 +33,11 @@ class LifetimeClient(BaseClient):
 
     LIFETIME_BASEURL = 'lifetime_exceptions'
 
-    def list_exceptions(self, exception_id=None, states=None):
+    def list_exceptions(
+            self,
+            exception_id: Optional[str] = None,
+            states: Optional['Sequence[LifetimeExceptionsState]'] = None
+    ) -> 'Iterator[dict[str, Any]]':
         """
         List exceptions to Lifetime Model.
 
@@ -52,7 +61,14 @@ class LifetimeClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=result.headers, status_code=result.status_code)
             raise exc_cls(exc_msg)
 
-    def add_exception(self, dids, account, pattern, comments, expires_at):
+    def add_exception(
+            self,
+            dids: list[dict[str, Any]],
+            account: str,
+            pattern: str,
+            comments: str,
+            expires_at: 'datetime'
+    ) -> dict[str, Any]:
         """
         Add exceptions to Lifetime Model.
 

rucio/client/lockclient.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright European Organization for Nuclear Research (CERN) since 2012
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,14 +12,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import TYPE_CHECKING, Any
 from urllib.parse import quote_plus
 
 from requests.status_codes import codes
 
-from rucio.client.baseclient import BaseClient
-from rucio.client.baseclient import choice
+from rucio.client.baseclient import BaseClient, choice
 from rucio.common.utils import build_url, render_json
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator, Mapping
+
 
 class LockClient(BaseClient):
 
@@ -28,7 +30,11 @@ class LockClient(BaseClient):
 
     LOCKS_BASEURL = 'locks'
 
-    def get_dataset_locks(self, scope, name):
+    def get_dataset_locks(
+            self,
+            scope: str,
+            name: str
+    ) -> "Iterator[dict[str, Any]]":
         """
         Get a dataset locks of the specified dataset.
 
@@ -48,7 +54,11 @@ class LockClient(BaseClient):
                                                    status_code=result.status_code)
             raise exc_cls(exc_msg)
 
-    def get_locks_for_dids(self, dids, **filter_args):
+    def get_locks_for_dids(
+            self,
+            dids: list["Mapping[str, Any]"],
+            **filter_args: dict[str, Any]
+    ) -> list[dict[str, Any]]:
         """
         Get list of locks for for all the files found, recursively, in the listed datasets or containers.
 
@@ -59,8 +69,8 @@ class LockClient(BaseClient):
         """
 
         # convert did list to list of dictionaries
-
-        assert all(did.get("type", "dataset") in ("dataset", "container") for did in dids), "did type can be either 'container' or 'dataset'"
+        if not all(did.get("type", "dataset") in ("dataset", "container") for did in dids):
+            raise ValueError("DID type can be either 'container' or 'dataset'")
 
         path = '/'.join([self.LOCKS_BASEURL, "bulk_locks_for_dids"])
         url = build_url(choice(self.list_hosts), path=path)
@@ -78,7 +88,7 @@ class LockClient(BaseClient):
                                                    status_code=result.status_code)
             raise exc_cls(exc_msg)
 
-    def get_dataset_locks_by_rse(self, rse):
+    def get_dataset_locks_by_rse(self, rse: str) -> "Iterator[dict[str, Any]]":
         """
         Get all dataset locks of the specified rse.
 

rucio/client/{metaclient.py → metaconventionsclient.py}

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright European Organization for Nuclear Research (CERN) since 2012
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,24 +13,27 @@
 # limitations under the License.
 
 from json import dumps, loads
+from typing import TYPE_CHECKING, Optional, Union
 from urllib.parse import quote_plus
 
 from requests.status_codes import codes
 
-from rucio.client.baseclient import BaseClient
-from rucio.client.baseclient import choice
+from rucio.client.baseclient import BaseClient, choice
 from rucio.common.utils import build_url
 
+if TYPE_CHECKING:
+    from rucio.db.sqla.constants import KeyType
 
-class MetaClient(BaseClient):
 
-    """Meta client class for working with data identifier attributes"""
+class MetaConventionClient(BaseClient):
 
-    META_BASEURL = 'meta'
+    """Metadata client class for working with data identifier attributes"""
 
-    def add_key(self, key, key_type, value_type=None, value_regexp=None):
+    META_BASEURL = 'meta_conventions'
+
+    def add_key(self, key: str, key_type: Union['KeyType', str], value_type: Optional[str] = None, value_regexp: Optional[str] = None) -> Optional[bool]:
         """
-        Sends the request to add a new key.
+        Sends the request to add an allowed key for DID metadata (update the DID Metadata Conventions table with a new key).
 
         :param key: the name for the new key.
         :param key_type: the type of the key: all(container, dataset, file), collection(dataset or container), file, derived(compute from file for collection).
@@ -56,9 +58,9 @@ class MetaClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=r.headers, status_code=r.status_code, data=r.content)
             raise exc_cls(exc_msg)
 
-    def list_keys(self):
+    def list_keys(self) -> Optional[list[str]]:
         """
-        Sends the request to list all keys.
+        Sends the request to list all keys for DID Metadata Conventions.
 
         :return: a list containing the names of all keys.
         """
@@ -72,9 +74,10 @@ class MetaClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=r.headers, status_code=r.status_code, data=r.content)
             raise exc_cls(exc_msg)
 
-    def list_values(self, key):
+    def list_values(self, key: str) -> Optional[list[str]]:
         """
-        Sends the request to list all values for a key.
+        Sends the request to lists all allowed values for a DID key (all values for a key in DID Metadata Conventions).
+.
 
         :return: a list containing the names of all values for a key.
         """
@@ -88,9 +91,9 @@ class MetaClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=r.headers, status_code=r.status_code, data=r.content)
             raise exc_cls(exc_msg)
 
-    def add_value(self, key, value):
+    def add_value(self, key: str, value: str) -> Optional[bool]:
         """
-        Sends the request to add a value to a key.
+        Sends the request to add a value for a key in DID Metadata Convention.
 
         :param key: the name for key.
         :param value: the value.
@@ -111,7 +114,7 @@ class MetaClient(BaseClient):
 
     def del_value(self, key, value):
         """
-        Delete a value for a key.
+        Delete a key in the DID Metadata Conventions table.
 
         :param key: the name for key.
         :param value: the value.

rucio/client/pingclient.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright European Organization for Nuclear Research (CERN) since 2012
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

rucio/client/replicaclient.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright European Organization for Nuclear Research (CERN) since 2012
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,13 +14,13 @@
 
 from datetime import datetime
 from json import dumps, loads
+from typing import Any, Optional
 from urllib.parse import quote_plus
 
 from requests.status_codes import codes
 
-from rucio.client.baseclient import BaseClient
-from rucio.client.baseclient import choice
-from rucio.common.utils import build_url, render_json, chunks
+from rucio.client.baseclient import BaseClient, choice
+from rucio.common.utils import build_url, chunks, render_json
 
 
 class ReplicaClient(BaseClient):
@@ -235,7 +234,17 @@ class ReplicaClient(BaseClient):
         exc_cls, exc_msg = self._get_exception(headers=r.headers, status_code=r.status_code, data=r.content)
         raise exc_cls(exc_msg)
 
-    def add_replica(self, rse, scope, name, bytes_, adler32, pfn=None, md5=None, meta={}):
+    def add_replica(
+        self,
+        rse: str,
+        scope: str,
+        name: str,
+        bytes_: int,
+        adler32: str,
+        pfn: Optional[str] = None,
+        md5: Optional[str] = None,
+        meta: Optional[dict[str, Any]] = None
+    ) -> bool:
         """
         Add file replicas to a RSE.
 
@@ -251,6 +260,7 @@ class ReplicaClient(BaseClient):
         :return: True if files were created successfully.
 
         """
+        meta = meta or {}
         dict_ = {'scope': scope, 'name': name, 'bytes': bytes_, 'meta': meta, 'adler32': adler32}
         if md5:
             dict_['md5'] = md5

rucio/client/requestclient.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright European Organization for Nuclear Research (CERN) since 2012
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,24 +12,31 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import TYPE_CHECKING, Any, Optional
 from urllib.parse import quote_plus
 
 from requests.status_codes import codes
 
-from rucio.client.baseclient import BaseClient
-from rucio.client.baseclient import choice
+from rucio.client.baseclient import BaseClient, choice
 from rucio.common.utils import build_url
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator, Sequence
+
 
 class RequestClient(BaseClient):
 
     REQUEST_BASEURL = 'requests'
 
-    def list_requests(self, src_rse, dst_rse, request_states):
+    def list_requests(
+            self,
+            src_rse: str,
+            dst_rse: str,
+            request_states: 'Sequence[str]'
+    ) -> 'Iterator[dict[str, Any]]':
         """Return latest request details
 
         :return: request information
-        :rtype: dict
         """
         path = '/'.join([self.REQUEST_BASEURL, 'list']) + '?' + '&'.join(['src_rse={}'.format(src_rse), 'dst_rse={}'.format(
             dst_rse), 'request_states={}'.format(request_states)])
@@ -43,11 +49,17 @@ class RequestClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=r.headers, status_code=r.status_code, data=r.content)
             raise exc_cls(exc_msg)
 
-    def list_requests_history(self, src_rse, dst_rse, request_states, offset=0, limit=100):
+    def list_requests_history(
+            self,
+            src_rse: str,
+            dst_rse: str,
+            request_states: 'Sequence[str]',
+            offset: int = 0,
+            limit: int = 100
+    ) -> 'Iterator[dict[str, Any]]':
         """Return historical request details
 
         :return: request information
-        :rtype: dict
         """
         path = '/'.join([self.REQUEST_BASEURL, 'history', 'list']) + '?' + '&'.join(['src_rse={}'.format(src_rse), 'dst_rse={}'.format(
             dst_rse), 'request_states={}'.format(request_states), 'offset={}'.format(offset), 'limit={}'.format(limit)])
@@ -60,21 +72,23 @@ class RequestClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=r.headers, status_code=r.status_code, data=r.content)
             raise exc_cls(exc_msg)
 
-    def list_request_by_did(self, name, rse, scope=None):
+    def list_request_by_did(
+            self,
+            name: str,
+            rse: str,
+            scope: Optional[str] = None
+    ) -> 'Iterator[dict[str, Any]]':
         """Return latest request details for a DID
 
         :param name: DID
-        :type name: str
         :param rse: Destination RSE name
-        :type rse: str
         :param scope: rucio scope, defaults to None
-        :param scope: str, optional
         :raises exc_cls: from BaseClient._get_exception
         :return: request information
-        :rtype: dict
         """
 
-        path = '/'.join([self.REQUEST_BASEURL, quote_plus(scope), quote_plus(name), rse])
+        if scope is not None:
+            path = '/'.join([self.REQUEST_BASEURL, quote_plus(scope), quote_plus(name), rse])
         url = build_url(choice(self.list_hosts), path=path)
         r = self._send_request(url, type_='GET')
 
@@ -84,21 +98,23 @@ class RequestClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=r.headers, status_code=r.status_code, data=r.content)
             raise exc_cls(exc_msg)
 
-    def list_request_history_by_did(self, name, rse, scope=None):
+    def list_request_history_by_did(
+            self,
+            name: str,
+            rse: str,
+            scope: Optional[str] = None
+    ) -> 'Iterator[dict[str, Any]]':
         """Return latest request details for a DID
 
         :param name: DID
-        :type name: str
         :param rse: Destination RSE name
-        :type rse: str
         :param scope: rucio scope, defaults to None
-        :param scope: str, optional
         :raises exc_cls: from BaseClient._get_exception
         :return: request information
-        :rtype: dict
         """
 
-        path = '/'.join([self.REQUEST_BASEURL, 'history', quote_plus(scope), quote_plus(name), rse])
+        if scope is not None:
+            path = '/'.join([self.REQUEST_BASEURL, 'history', quote_plus(scope), quote_plus(name), rse])
         url = build_url(choice(self.list_hosts), path=path)
         r = self._send_request(url, type_='GET')