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

rucio/client/subscriptionclient.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,16 @@
 # limitations under the License.
 
 from json import dumps
+from typing import TYPE_CHECKING, Any, Literal, Optional, Union
 
 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 SubscriptionClient(BaseClient):
 
@@ -28,29 +30,31 @@ class SubscriptionClient(BaseClient):
 
     SUB_BASEURL = 'subscriptions'
 
-    def add_subscription(self, name, account, filter_, replication_rules, comments, lifetime, retroactive, dry_run, priority=3):
+    def add_subscription(
+            self,
+            name: str,
+            account: str,
+            filter_: dict[str, Any],
+            replication_rules: dict[str, Any],
+            comments: str,
+            lifetime: Union[int, Literal[False]],
+            retroactive: bool,
+            dry_run: bool,
+            priority: int = 3
+    ) -> str:
         """
         Adds a new subscription which will be verified against every new added file and dataset
 
         :param name: Name of the subscription
-        :type:  String
         :param account: Account identifier
-        :type account:  String
         :param filter_: Dictionary of attributes by which the input data should be filtered
                        **Example**: ``{'dsn': 'data11_hi*.express_express.*,data11_hi*physics_MinBiasOverlay*', 'account': 'tzero'}``
-        :type filter_:  Dict
         :param replication_rules: Replication rules to be set : Dictionary with keys copies, rse_expression, weight, rse_expression
-        :type replication_rules:  Dict
         :param comments: Comments for the subscription
-        :type comments:  String
         :param lifetime: Subscription's lifetime (days); False if subscription has no lifetime
-        :type lifetime:  Integer or False
         :param retroactive: Flag to know if the subscription should be applied on previous data
-        :type retroactive:  Boolean
         :param dry_run: Just print the subscriptions actions without actually executing them (Useful if retroactive flag is set)
-        :type dry_run:  Boolean
         :param priority: The priority of the subscription (3 by default)
-        :type priority: Integer
         """
         path = self.SUB_BASEURL + '/' + account + '/' + name
         url = build_url(choice(self.list_hosts), path=path)
@@ -69,17 +73,18 @@ class SubscriptionClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=result.headers, status_code=result.status_code, data=result.content)
             raise exc_cls(exc_msg)
 
-    def list_subscriptions(self, name=None, account=None):
+    def list_subscriptions(
+            self,
+            name: Optional[str] = None,
+            account: Optional[dict[str, Any]] = None
+    ) -> Union["Iterator[dict[str, Any]]", list]:
         """
         Returns a dictionary with the subscription information :
         Examples: ``{'status': 'INACTIVE/ACTIVE/BROKEN', 'last_modified_date': ...}``
 
         :param name: Name of the subscription
-        :type:  String
         :param account: Account identifier
-        :type account:  String
         :returns: Dictionary containing subscription parameter
-        :rtype:   Dict
         :raises: exception.NotFound if subscription is not found
         """
         path = self.SUB_BASEURL
@@ -88,47 +93,50 @@ class SubscriptionClient(BaseClient):
             if name:
                 path += '/%s' % (name)
         elif name:
-            path += '/Name/%s' % (name)
+            path += '/name/%s' % (name)
         else:
             path += '/'
         url = build_url(choice(self.list_hosts), path=path)
         result = self._send_request(url, type_='GET')
         if result.status_code == codes.ok:   # pylint: disable=no-member
             return self._load_json_data(result)
-        else:
-            exc_cls, exc_msg = self._get_exception(headers=result.headers, status_code=result.status_code, data=result.content)
-            raise exc_cls(exc_msg)
-
-    def update_subscription(self, name, account=None, filter_=None, replication_rules=None, comments=None, lifetime=None, retroactive=None, dry_run=None, priority=None):
+        if result.status_code == codes.not_found:
+            return []
+        exc_cls, exc_msg = self._get_exception(headers=result.headers, status_code=result.status_code, data=result.content)
+        raise exc_cls(exc_msg)
+
+    def update_subscription(
+            self,
+            name,
+            account: Optional[str] = None,
+            filter_: Optional[dict[str, Any]] = None,
+            replication_rules: Optional[dict[str, Any]] = None,
+            comments: Optional[str] = None,
+            lifetime: Optional[Union[int, Literal[False]]] = None,
+            retroactive: Optional[bool] = None,
+            dry_run: Optional[bool] = None,
+            priority: Optional[int] = None
+    ) -> Literal[True]:
         """
         Updates a subscription
 
         :param name: Name of the subscription
-        :type:  String
         :param account: Account identifier
-        :type account:  String
         :param filter_: Dictionary of attributes by which the input data should be filtered
                        **Example**: ``{'dsn': 'data11_hi*.express_express.*,data11_hi*physics_MinBiasOverlay*', 'account': 'tzero'}``
-        :type filter_:  Dict
         :param replication_rules: Replication rules to be set : Dictionary with keys copies, rse_expression, weight, rse_expression
-        :type replication_rules:  Dict
         :param comments: Comments for the subscription
-        :type comments:  String
         :param lifetime: Subscription's lifetime (days); False if subscription has no lifetime
-        :type lifetime:  Integer or False
         :param retroactive: Flag to know if the subscription should be applied on previous data
-        :type retroactive:  Boolean
         :param dry_run: Just print the subscriptions actions without actually executing them (Useful if retroactive flag is set)
-        :type dry_run:  Boolean
         :param priority: The priority of the subscription
-        :type priority: Integer
         :raises: exception.NotFound if subscription is not found
         """
         if not account:
             account = self.account
         if retroactive:
             raise NotImplementedError('Retroactive mode is not implemented')
-        path = self.SUB_BASEURL + '/' + account + '/' + name
+        path = self.SUB_BASEURL + '/' + account + '/' + name  # type: ignore
         url = build_url(choice(self.list_hosts), path=path)
         if filter_ and not isinstance(filter_, dict):
             raise TypeError('filter should be a dict')
@@ -143,7 +151,11 @@ class SubscriptionClient(BaseClient):
             exc_cls, exc_msg = self._get_exception(headers=result.headers, status_code=result.status_code, data=result.content)
             raise exc_cls(exc_msg)
 
-    def list_subscription_rules(self, account, name):
+    def list_subscription_rules(
+            self,
+            account: str,
+            name: str
+    ) -> "Iterator[dict[str, Any]]":
         """
         List the associated rules of a subscription.
 
@@ -151,7 +163,7 @@ class SubscriptionClient(BaseClient):
         :param name:    Name of the subscription.
         """
 
-        path = '/'.join([self.SUB_BASEURL, account, name, 'Rules'])
+        path = '/'.join([self.SUB_BASEURL, account, name, 'rules'])
         url = build_url(choice(self.list_hosts), path=path)
         result = self._send_request(url, type_='GET')
         if result.status_code == codes.ok:   # pylint: disable=no-member

rucio/client/touchclient.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,11 +13,11 @@
 # limitations under the License.
 
 from json import dumps
+from typing import Optional
 
 from requests import post
 
-from rucio.client.baseclient import BaseClient
-from rucio.client.baseclient import choice
+from rucio.client.baseclient import BaseClient, choice
 from rucio.common.exception import RucioException, UnsupportedDIDType
 
 
@@ -32,7 +31,12 @@ class TouchClient(BaseClient):
     DIDS_BASEURL = 'dids'
     TRACES_BASEURL = 'traces'
 
-    def touch(self, scope, name, rse=None):
+    def touch(
+            self,
+            scope: str,
+            name: str,
+            rse: Optional[str] = None
+    ) -> None:
         """
         Sends a touch trace for a given file or dataset.