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

rucio/__init__.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/alembicrevision.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,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-ALEMBIC_REVISION = '27e3a68927fb'  # the current alembic head revision
+ALEMBIC_REVISION = 'b0070f3695c8'  # the current alembic head revision

rucio/client/__init__.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/accountclient.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,14 +13,17 @@
 # limitations under the License.
 
 from json import dumps
+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
+
 
 class AccountClient(BaseClient):
 
@@ -29,7 +31,7 @@ class AccountClient(BaseClient):
 
     ACCOUNTS_BASEURL = 'accounts'
 
-    def add_account(self, account, type_, email):
+    def add_account(self, account: str, type_: str, email: str) -> bool:
         """
         Sends the request to create a new account.
 
@@ -51,7 +53,7 @@ class AccountClient(BaseClient):
         exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
         raise exc_cls(exc_msg)
 
-    def delete_account(self, account):
+    def delete_account(self, account: str) -> bool:
         """
         Sends the request to disable an account.
 
@@ -70,7 +72,7 @@ class AccountClient(BaseClient):
         exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
         raise exc_cls(exc_msg)
 
-    def get_account(self, account):
+    def get_account(self, account: str) -> Optional[dict[str, Any]]:
         """
         Sends the request to get information about a given account.
 
@@ -89,7 +91,7 @@ class AccountClient(BaseClient):
         exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
         raise exc_cls(exc_msg)
 
-    def update_account(self, account, key, value):
+    def update_account(self, account: str, key: str, value: Any) -> bool:
         """ Update a property of an account.
 
         :param account: Name of the account.
@@ -108,13 +110,18 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def list_accounts(self, account_type=None, identity=None, filters=None):
+    def list_accounts(
+            self,
+            account_type: Optional[str] = None,
+            identity: Optional[str] = None,
+            filters: Optional[dict[str, Any]] = None
+    ) -> "Iterator[dict[str, Any]]":
         """
         Sends the request to list all rucio accounts.
 
         :param type: The account type
         :param identity: The identity key name. For example x509 DN, or a username.
-        :param filters: A dictionnary key:account attribute to use for the filtering
+        :param filters: A dictionary key:account attribute to use for the filtering
 
         :return: a list containing account info dictionary for all rucio accounts.
         :raises AccountNotFound: if account doesn't exist.
@@ -139,7 +146,7 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def whoami(self):
+    def whoami(self) -> Optional[dict[str, Any]]:
         """
         Get information about account whose token is used
 
@@ -148,7 +155,15 @@ class AccountClient(BaseClient):
         """
         return self.get_account('whoami')
 
-    def add_identity(self, account, identity, authtype, email, default=False, password=None):
+    def add_identity(
+            self,
+            account: str,
+            identity: str,
+            authtype: str,
+            email: str,
+            default: bool = False,
+            password: Optional[str] = None
+    ) -> bool:
         """
         Adds a membership association between identity and account.
 
@@ -173,7 +188,12 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def del_identity(self, account, identity, authtype):
+    def del_identity(
+            self,
+            account: str,
+            identity: str,
+            authtype: str
+    ) -> bool:
         """
         Delete an identity's membership association with an account.
 
@@ -196,7 +216,7 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def list_identities(self, account):
+    def list_identities(self, account: str) -> "Iterator[dict[str, Any]]":
         """
         List all identities on an account.
 
@@ -212,7 +232,7 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def list_account_rules(self, account):
+    def list_account_rules(self, account: str) -> "Iterator[dict[str, Any]]":
         """
         List the associated rules of an account.
 
@@ -228,7 +248,7 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def get_account_limits(self, account, rse_expression, locality):
+    def get_account_limits(self, account: str, rse_expression: str, locality: str) -> dict[str, Any]:
         """
         Return the correct account limits for the given locality.
 
@@ -245,7 +265,7 @@ class AccountClient(BaseClient):
             from rucio.common.exception import UnsupportedOperation
             raise UnsupportedOperation('The provided locality (%s) for the account limit was invalid' % locality)
 
-    def get_global_account_limit(self, account, rse_expression):
+    def get_global_account_limit(self, account: str, rse_expression: str) -> dict[str, Any]:
         """
         List the account limit for the specific RSE expression.
 
@@ -261,7 +281,7 @@ class AccountClient(BaseClient):
         exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
         raise exc_cls(exc_msg)
 
-    def get_global_account_limits(self, account):
+    def get_global_account_limits(self, account: str) -> dict[str, Any]:
         """
         List all RSE expression limits of this account.
 
@@ -276,7 +296,7 @@ class AccountClient(BaseClient):
         exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
         raise exc_cls(exc_msg)
 
-    def get_local_account_limits(self, account):
+    def get_local_account_limits(self, account: str) -> dict[str, Any]:
         """
         List the account rse limits of this account.
 
@@ -291,7 +311,7 @@ class AccountClient(BaseClient):
         exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
         raise exc_cls(exc_msg)
 
-    def get_local_account_limit(self, account, rse):
+    def get_local_account_limit(self, account: str, rse: str) -> dict[str, Any]:
         """
         List the account rse limits of this account for the specific rse.
 
@@ -307,7 +327,7 @@ class AccountClient(BaseClient):
         exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
         raise exc_cls(exc_msg)
 
-    def get_local_account_usage(self, account, rse=None):
+    def get_local_account_usage(self, account: str, rse: Optional[str] = None) -> "Iterator[dict[str, Any]]":
         """
         List the account usage for one or all rses of this account.
 
@@ -326,7 +346,7 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def get_global_account_usage(self, account, rse_expression=None):
+    def get_global_account_usage(self, account: str, rse_expression: Optional[str] = None) -> "Iterator[dict[str, Any]]":
         """
         List the account usage for one or all RSE expressions of this account.
 
@@ -345,7 +365,7 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def get_account_usage_history(self, account, rse):
+    def get_account_usage_history(self, account: str, rse: str) -> dict[str, Any]:
         """
         List the account usage history of this account on rse.
 
@@ -361,7 +381,7 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def list_account_attributes(self, account):
+    def list_account_attributes(self, account: str) -> "Iterator[dict[dict[str, Any], Any]]":
         """
         List the attributes for an account.
 
@@ -376,7 +396,7 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def add_account_attribute(self, account, key, value):
+    def add_account_attribute(self, account: str, key: str, value: Any) -> bool:
         """
         Adds an attribute to an account.
 
@@ -395,7 +415,7 @@ class AccountClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=res.headers, status_code=res.status_code, data=res.content)
             raise exc_cls(exc_msg)
 
-    def delete_account_attribute(self, account, key):
+    def delete_account_attribute(self, account: str, key: str) -> bool:
         """
         Delete an attribute for an account.
 

rucio/client/accountlimitclient.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,12 +13,12 @@
 # limitations under the License.
 
 from json import dumps
+from typing import Literal
 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
 
 
@@ -29,7 +28,13 @@ class AccountLimitClient(BaseClient):
 
     ACCOUNTLIMIT_BASEURL = 'accountlimits'
 
-    def set_account_limit(self, account, rse, bytes_, locality):
+    def set_account_limit(
+            self,
+            account: str,
+            rse: str,
+            bytes_: int,
+            locality: Literal['local', 'global']
+    ) -> bool:
         """
         Sets an account limit for a given limit scope.
 
@@ -48,7 +53,12 @@ class AccountLimitClient(BaseClient):
             from rucio.common.exception import UnsupportedOperation
             raise UnsupportedOperation('The provided scope (%s) for the account limit was invalid' % locality)
 
-    def delete_account_limit(self, account, rse, locality):
+    def delete_account_limit(
+            self,
+            account: str,
+            rse: str,
+            locality: Literal['local', 'global']
+    ) -> bool:
         """
         Deletes an account limit for a given limit scope.
 
@@ -66,7 +76,12 @@ class AccountLimitClient(BaseClient):
             from rucio.common.exception import UnsupportedOperation
             raise UnsupportedOperation('The provided scope (%s) for the account limit was invalid' % locality)
 
-    def set_local_account_limit(self, account, rse, bytes_):
+    def set_local_account_limit(
+            self,
+            account: str,
+            rse: str,
+            bytes_: int
+    ) -> bool:
         """
         Sends the request to set an account limit for an account.
 
@@ -88,7 +103,11 @@ class AccountLimitClient(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 delete_local_account_limit(self, account, rse):
+    def delete_local_account_limit(
+            self,
+            account: str,
+            rse: str
+    ) -> bool:
         """
         Sends the request to remove an account limit.
 
@@ -110,7 +129,12 @@ class AccountLimitClient(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 set_global_account_limit(self, account, rse_expression, bytes_):
+    def set_global_account_limit(
+            self,
+            account: str,
+            rse_expression: str,
+            bytes_: int
+    ) -> bool:
         """
         Sends the request to set a global account limit for an account.
 
@@ -132,7 +156,11 @@ class AccountLimitClient(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 delete_global_account_limit(self, account, rse_expression):
+    def delete_global_account_limit(
+            self,
+            account: str,
+            rse_expression: str
+    ) -> bool:
         """
         Sends the request to remove a global account limit.