rucio 37.2.0__py3-none-any.whl → 37.4.0__py3-none-any.whl

rucio/client/ruleclient.py

@@ -54,27 +54,52 @@ class RuleClient(BaseClient):
         weight: Optional[int] = None,
     ) -> Any:
         """
-        :param dids:                       The data identifier set.
-        :param copies:                     The number of replicas.
-        :param rse_expression:             Boolean string expression to give the list of RSEs.
-        :param priority:                   Priority of the transfers.
-        :param lifetime:                   The lifetime of the replication rules (in seconds).
-        :param grouping:                   ALL -  All files will be replicated to the same RSE.
-                                           DATASET - All files in the same dataset will be replicated to the same RSE.
-                                           NONE - Files will be completely spread over all allowed RSEs without any grouping considerations at all.
-        :param notify:                     Notification setting for the rule (Y, N, C).
-        :param source_replica_expression:  RSE Expression for RSEs to be considered for source replicas.
-        :param activity:                   Transfer Activity to be passed to FTS.
-        :param account:                    The account owning the rule.
-        :param meta:                       Metadata, as dictionary.
-        :param ignore_availability:        Option to ignore the availability of RSEs.
-        :param purge_replicas:             When the rule gets deleted purge the associated replicas immediately.
-        :param ask_approval:               Ask for approval of this replication rule.
-        :param asynchronous:               Create rule asynchronously by judge-injector.
-        :param locked:                     If the rule is locked, it cannot be deleted.
-        :param delay_injection:
-        :param comment:                    Comment about the rule.
-        :param weight:                     If the weighting option of the replication rule is used, the choice of RSEs takes their weight into account.
+        Add a replication rule.
+
+        Parameters
+        ----------
+        dids :
+            The data identifier set.
+        copies :
+            The number of replicas.
+        rse_expression :
+            Boolean string expression to give the list of RSEs.
+        priority :
+            Priority of the transfers. Default is 3.
+        lifetime :
+            The lifetime of the replication rules (in seconds).
+        grouping :
+            ALL - All files will be replicated to the same RSE.
+            DATASET - All files in the same dataset will be replicated to the same RSE.
+            NONE - Files will be completely spread over all allowed RSEs without any grouping considerations at all.
+            Default is 'DATASET'.
+        notify :
+            Notification setting for the rule (Y, N, C). Default is 'N'.
+        source_replica_expression :
+            RSE Expression for RSEs to be considered for source replicas.
+        activity :
+            Transfer Activity to be passed to FTS.
+        account :
+            The account owning the rule.
+        meta :
+            Metadata, as dictionary.
+        ignore_availability :
+            Option to ignore the availability of RSEs. Default is False.
+        purge_replicas :
+            When the rule gets deleted purge the associated replicas immediately. Default is False.
+        ask_approval :
+            Ask for approval of this replication rule. Default is False.
+        asynchronous :
+            Create rule asynchronously by judge-injector. Default is False.
+        locked :
+            If the rule is locked, it cannot be deleted. Default is False.
+        delay_injection :
+            Delay the rule injection.
+        comment :
+            Comment about the rule.
+        weight :
+            If the weighting option of the replication rule is used, the choice of RSEs takes their weight into account.
+
         """
         path = self.RULE_BASEURL + '/'
         url = build_url(choice(self.list_hosts), path=path)
@@ -97,9 +122,17 @@ class RuleClient(BaseClient):
         """
         Deletes a replication rule and all associated locks.
 
-        :param rule_id:         The id of the rule to be deleted
-        :param purge_replicas:  Immediately delete the replicas.
-        :raises:                RuleNotFound, AccessDenied
+        Parameters
+        ----------
+        rule_id :
+            The id of the rule to be deleted.
+        purge_replicas :
+            Immediate delete the replicas
+
+        Raises
+        -------
+        RuleNotFound
+        AccessDenied
         """
 
         path = self.RULE_BASEURL + '/' + rule_id
@@ -118,8 +151,14 @@ class RuleClient(BaseClient):
         """
         Get a replication rule.
 
-        :param rule_id:  The id of the rule to be retrieved.
-        :raises:         RuleNotFound
+        Parameters
+        ----------
+        rule_id :
+            The id of the rule to be retrieved.
+
+        Raises
+        -------
+        RuleNotFound
         """
         path = self.RULE_BASEURL + '/' + rule_id
         url = build_url(choice(self.list_hosts), path=path)
@@ -132,9 +171,16 @@ class RuleClient(BaseClient):
 
     def update_replication_rule(self, rule_id: str, options: dict[str, Any]) -> Literal[True]:
         """
-        :param rule_id:   The id of the rule to be retrieved.
-        :param options:   Options dictionary.
-        :raises:          RuleNotFound
+        Parameters
+        ----------
+        rule_id :
+            The id of the rule to be retrieved.
+        options :
+            Options dictionary.
+
+        Raises
+        -------
+        RuleNotFound
         """
         path = self.RULE_BASEURL + '/' + rule_id
         url = build_url(choice(self.list_hosts), path=path)
@@ -152,10 +198,19 @@ class RuleClient(BaseClient):
         exclude_expression: Optional[str] = None
     ) -> Any:
         """
-        :param rule_id:             Rule to be reduced.
-        :param copies:              Number of copies of the new rule.
-        :param exclude_expression:  RSE Expression of RSEs to exclude.
-        :raises:                    RuleReplaceFailed, RuleNotFound
+        Parameters
+        ----------
+        rule_id :
+            The id of the rule to be reduced.
+        copies :
+            Number of copies of the new rule.
+        exclude_expression :
+            RSE Expression of RSEs to exclude.
+
+        Raises
+        -------
+        RuleNotFound
+        RuleReplaceFailed
         """
 
         path = self.RULE_BASEURL + '/' + rule_id + '/reduce'
@@ -176,10 +231,18 @@ class RuleClient(BaseClient):
         """
         Move a replication rule to another RSE and, once done, delete the original one.
 
-        :param rule_id:                    Rule to be moved.
-        :param rse_expression:             RSE expression of the new rule.
-        :param override:                   Configurations to update for the new rule.
-        :raises:                           RuleNotFound, RuleReplaceFailed
+        Parameters
+        ----------
+        rule_id :
+            Rule to be moved.
+        rse_expression :
+            RSE expression of the new rule.
+        override :
+            Configurations to update for the new rule.
+        Raises
+        -------
+        RuleNotFound
+        RuleReplaceFailed
         """
 
         path = self.RULE_BASEURL + '/' + rule_id + '/move'
@@ -197,8 +260,14 @@ class RuleClient(BaseClient):
 
     def approve_replication_rule(self, rule_id: str) -> Literal[True]:
         """
-        :param rule_id:             Rule to be approved.
-        :raises:                    RuleNotFound
+        Parameters
+        ----------
+        rule_id :
+            Rule to be approved.
+
+        Raises
+        -------
+        RuleNotFound
         """
 
         path = self.RULE_BASEURL + '/' + rule_id
@@ -212,9 +281,17 @@ class RuleClient(BaseClient):
 
     def deny_replication_rule(self, rule_id: str, reason: Optional[str] = None) -> Literal[True]:
         """
-        :param rule_id:             Rule to be denied.
-        :param reason:              Reason for denying the rule.
-        :raises:                    RuleNotFound
+        Parameters
+        ----------
+        rule_id :
+            Rule to be denied.
+        reason :
+            Reason for denying the rule.
+
+        Raises
+        -------
+        RuleNotFound
+
         """
 
         path = self.RULE_BASEURL + '/' + rule_id
@@ -235,8 +312,12 @@ class RuleClient(BaseClient):
         """
         List the rule history of a DID.
 
-        :param scope: The scope of the DID.
-        :param name: The name of the DID.
+        Parameters
+        ----------
+        scope :
+            The scope of the DID.
+        name :
+            The name of the DID.
         """
         path = '/'.join([self.RULE_BASEURL, quote_plus(scope), quote_plus(name), 'history'])
         url = build_url(choice(self.list_hosts), path=path)
@@ -250,8 +331,13 @@ class RuleClient(BaseClient):
         """
         Examine a replication rule for errors during transfer.
 
-        :param rule_id:             Rule to be denied.
-        :raises:                    RuleNotFound
+        Parameters
+        ----------
+        rule_id :
+            The rule to be denied
+        Raises
+        -------
+        RuleNotFound
         """
         path = self.RULE_BASEURL + '/' + rule_id + '/analysis'
         url = build_url(choice(self.list_hosts), path=path)
@@ -265,8 +351,13 @@ class RuleClient(BaseClient):
         """
         List details of all replica locks for a rule.
 
-        :param rule_id:             Rule to be denied.
-        :raises:                    RuleNotFound
+        Parameters
+        ----------
+        rule_id :
+            The rule to be denied
+        Raises
+        -------
+        RuleNotFound
         """
         path = self.RULE_BASEURL + '/' + rule_id + '/locks'
         url = build_url(choice(self.list_hosts), path=path)
@@ -279,9 +370,14 @@ class RuleClient(BaseClient):
     def list_replication_rules(self, filters: Optional[dict[str, Any]] = None) -> "Iterator[dict[str, Any]]":
         """
         List all replication rules which match a filter
-        :param filters: dictionary of attributes by which the rules should be filtered
-
-        :returns: True if successful, otherwise false.
+        Parameters
+        ----------
+        filers:
+            dictionary of attributes by which the rules should be filtered
+
+        Returns
+        -------
+        True if successful, otherwise false.
         """
         filters = filters or {}
         path = self.RULE_BASEURL + '/'

rucio/client/scopeclient.py

@@ -35,11 +35,23 @@ class ScopeClient(BaseClient):
         """
         Sends the request to add a new scope.
 
-        :param account: the name of the account to add the scope to.
-        :param scope: the name of the new scope.
-        :return: True if scope was created successfully.
-        :raises Duplicate: if scope already exists.
-        :raises AccountNotFound: if account doesn't exist.
+        Parameters
+        ----------
+        account :
+            The name of the account to add the scope to.
+        scope :
+            The name of the new scope.
+
+        Returns
+        -------
+            True if scope was created successfully.
+
+        Raises
+        ------
+        Duplicate
+            If scope already exists.
+        AccountNotFound
+            If account doesn't exist.
         """
 
         path = '/'.join([self.SCOPE_BASEURL, account, 'scopes', quote_plus(scope)])
@@ -55,7 +67,9 @@ class ScopeClient(BaseClient):
         """
         Sends the request to list all scopes.
 
-        :return: a list containing the names of all scopes.
+        Returns
+        -------
+        A list containing the names of all scopes.
         """
 
         path = '/'.join(['scopes/'])
@@ -72,10 +86,21 @@ class ScopeClient(BaseClient):
         """
         Sends the request to list all scopes for a rucio account.
 
-        :param account: the rucio account to list scopes for.
-        :return: a list containing the names of all scopes for a rucio account.
-        :raises AccountNotFound: if account doesn't exist.
-        :raises ScopeNotFound: if no scopes exist for account.
+        Parameters
+        ----------
+        account :
+            The rucio account to list scopes for.
+
+        Returns
+        -------
+            A list containing the names of all scopes for a rucio account.
+
+        Raises
+        ------
+        AccountNotFound
+            If account doesn't exist.
+        ScopeNotFound
+            If no scopes exist for account.
         """
 
         path = '/'.join([self.SCOPE_BASEURL, account, 'scopes/'])

rucio/client/subscriptionclient.py

@@ -45,16 +45,28 @@ class SubscriptionClient(BaseClient):
         """
         Adds a new subscription which will be verified against every new added file and dataset
 
-        :param name: Name of the subscription
-        :param account: Account identifier
-        :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'}``
-        :param replication_rules: Replication rules to be set : Dictionary with keys copies, rse_expression, weight, rse_expression
-        :param comments: Comments for the subscription
-        :param lifetime: Subscription's lifetime (days); False if subscription has no lifetime
-        :param retroactive: Flag to know if the subscription should be applied on previous data
-        :param dry_run: Just print the subscriptions actions without actually executing them (Useful if retroactive flag is set)
-        :param priority: The priority of the subscription (3 by default)
+        Parameters
+        ----------
+        name :
+            Name of the subscription
+        account :
+            Account identifier
+        filter_ :
+            Dictionary of attributes by which the input data should be filtered
+            Example: `{'dsn': 'data11_hi*.express_express.*,data11_hi*physics_MinBiasOverlay*', 'account': 'tzero'}`
+        replication_rules :
+            Replication rules to be set. Dictionary with keys copies, rse_expression, weight, rse_expression
+        comments :
+            Comments for the subscription
+        lifetime :
+            Subscription's lifetime (days); False if subscription has no lifetime
+        retroactive :
+            Flag to know if the subscription should be applied on previous data
+        dry_run :
+            Just print the subscriptions actions without actually executing them (Useful if retroactive flag is set)
+        priority :
+            The priority of the subscription (3 by default)
+
         """
         path = self.SUB_BASEURL + '/' + account + '/' + name
         url = build_url(choice(self.list_hosts), path=path)
@@ -82,10 +94,21 @@ class SubscriptionClient(BaseClient):
         Returns a dictionary with the subscription information :
         Examples: ``{'status': 'INACTIVE/ACTIVE/BROKEN', 'last_modified_date': ...}``
 
-        :param name: Name of the subscription
-        :param account: Account identifier
-        :returns: Dictionary containing subscription parameter
-        :raises: exception.NotFound if subscription is not found
+        Parameters
+        ----------
+        name :
+            Name of the subscription
+        account :
+            Account identifier
+
+        Returns
+        -------
+        Dictionary with the subscription information
+
+        Raises
+        -------
+        NotFound
+            If subscription is not found
         """
         path = self.SUB_BASEURL
         if account:
@@ -120,17 +143,23 @@ class SubscriptionClient(BaseClient):
         """
         Updates a subscription
 
-        :param name: Name of the subscription
-        :param account: Account identifier
-        :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'}``
-        :param replication_rules: Replication rules to be set : Dictionary with keys copies, rse_expression, weight, rse_expression
-        :param comments: Comments for the subscription
-        :param lifetime: Subscription's lifetime (days); False if subscription has no lifetime
-        :param retroactive: Flag to know if the subscription should be applied on previous data
-        :param dry_run: Just print the subscriptions actions without actually executing them (Useful if retroactive flag is set)
-        :param priority: The priority of the subscription
-        :raises: exception.NotFound if subscription is not found
+        Parameters
+        ----------
+        name : Name of the subscription
+        account : Account identifier
+        filter_ : Dictionary of attributes by which the input data should be filtered
+            Example: `{'dsn': 'data11_hi*.express_express.*,data11_hi*physics_MinBiasOverlay*', 'account': 'tzero'}`
+        replication_rules : Replication rules to be set. Dictionary with keys copies, rse_expression, weight, rse_expression
+        comments : Comments for the subscription
+        lifetime : Subscription's lifetime (days); False if subscription has no lifetime
+        retroactive : Flag to know if the subscription should be applied on previous data
+        dry_run : Just print the subscriptions actions without actually executing them (Useful if retroactive flag is set)
+        priority : The priority of the subscription
+
+        Raises
+        ------
+        NotFound
+            If subscription is not found
         """
         if not account:
             account = self.account
@@ -159,8 +188,12 @@ class SubscriptionClient(BaseClient):
         """
         List the associated rules of a subscription.
 
-        :param account: Account of the subscription.
-        :param name:    Name of the subscription.
+        Parameters
+        ----------
+        account :
+            Account of the subscription.
+        name :
+            Name of the subscription.
         """
 
         path = '/'.join([self.SUB_BASEURL, account, name, 'rules'])

rucio/client/touchclient.py

@@ -40,13 +40,22 @@ class TouchClient(BaseClient):
         """
         Sends a touch trace for a given file or dataset.
 
-        :param scope: the scope of the file/dataset to update.
-        :param name: the name of file/dataset to update.
-        :param rse: optional parameter if a specific replica should be touched.
-        :raises DataIdentifierNotFound: if given dids does not exist.
-        :raises RSENotFound: if rse is not None and given rse does not exist.
-        :raises UnsupportedDIDType: if type of the given DID is not FILE or DATASET.
-        :raises RucioException: if trace could not be sent successfully.
+        Parameters
+        ----------
+        scope : The scope of the file/dataset to update.
+        name : The name of file/dataset to update.
+        rse : Optional parameter if a specific replica should be touched.
+
+        Raises
+        ------
+        DataIdentifierNotFound
+            If given dids does not exist.
+        RSENotFound
+            If rse is not None and given rse does not exist.
+        UnsupportedDIDType
+            If type of the given DID is not FILE or DATASET.
+        RucioException
+            If trace could not be sent successfully.
         """
 
         trace = {}

rucio/common/plugins.py

@@ -156,7 +156,7 @@ class PolicyPackageAlgorithms:
             # import from utils here to avoid circular import
 
             env_name = 'RUCIO_POLICY_PACKAGE' + ('' if not vo else '_' + vo.upper())
-            package = getattr(os.environ, env_name, "")
+            package = os.getenv(env_name, "")
             if not package:
                 package = str(config.config_get('policy', 'package' + ('' if not vo else '-' + vo)))
 

rucio/core/did.py

@@ -15,7 +15,6 @@
 import logging
 import random
 from datetime import datetime, timedelta
-from enum import Enum
 from hashlib import md5
 from re import match
 from typing import TYPE_CHECKING, Any, Literal, Optional, Union
@@ -1349,7 +1348,7 @@ def list_new_dids(
             select_stmt = select_stmt.where(
                 models.DataIdentifier.did_type == DIDType[did_type]
             )
-        elif isinstance(did_type, Enum):
+        elif isinstance(did_type, DIDType):
             select_stmt = select_stmt.where(
                 models.DataIdentifier.did_type == did_type
             )
@@ -2297,7 +2296,7 @@ def set_status(
 @read_session
 def list_dids(
     scope: "InternalScope",
-    filters: "Mapping[Any, Any]",
+    filters: "Iterable[dict[Any, Any]]",
     did_type: Literal['all', 'collection', 'dataset', 'container', 'file'] = 'collection',
     ignore_case: bool = False,
     limit: Optional[int] = None,

rucio/core/permission/generic.py

@@ -121,7 +121,10 @@ def has_permission(issuer: "InternalAccount", action: str, kwargs: dict[str, Any
             'del_identity': perm_del_identity,
             'remove_did_from_followed': perm_remove_did_from_followed,
             'remove_dids_from_followed': perm_remove_dids_from_followed,
-            'export': perm_export}
+            'export': perm_export,
+            'list_transfer_limits': perm_list_transfer_limits,
+            'set_transfer_limit': perm_set_transfer_limit,
+            'delete_transfer_limit': perm_delete_transfer_limit}
 
     return perm.get(action, perm_default)(issuer=issuer, kwargs=kwargs, session=session)
 
@@ -1122,3 +1125,36 @@ def perm_export(issuer: "InternalAccount", kwargs: dict[str, Any], *, session: "
     :returns: True if account is allowed, otherwise False
     """
     return _is_root(issuer)
+
+def perm_list_transfer_limits(issuer: "InternalAccount", kwargs: dict[str, Any], *, session: "Optional[Session]" = None) -> bool:
+    """
+    Checks if an account can list transfer limits.
+
+    :param issuer: Account identifier which issues the command.
+    :param kwargs: List of arguments for the action.
+    :param session: The DB session to use
+    :returns: True if account is allowed, otherwise False
+    """
+    return _is_root(issuer) or has_account_attribute(account=issuer, key='admin', session=session)
+
+def perm_set_transfer_limit(issuer: "InternalAccount", kwargs: dict[str, Any], *, session: "Optional[Session]" = None) -> bool:
+    """
+    Checks if an account can set transfer limits.
+
+    :param issuer: Account identifier which issues the command.
+    :param kwargs: List of arguments for the action.
+    :param session: The DB session to use
+    :returns: True if account is allowed, otherwise False
+    """
+    return _is_root(issuer) or has_account_attribute(account=issuer, key='admin', session=session)
+
+def perm_delete_transfer_limit(issuer: "InternalAccount", kwargs: dict[str, Any], *, session: "Optional[Session]" = None) -> bool:
+    """
+    Checks if an account can delete transfer limits.
+
+    :param issuer: Account identifier which issues the command.
+    :param kwargs: List of arguments for the action.
+    :param session: The DB session to use
+    :returns: True if account is allowed, otherwise False
+    """
+    return _is_root(issuer) or has_account_attribute(account=issuer, key='admin', session=session)

rucio/core/replica.py

@@ -42,7 +42,7 @@ from rucio.common import exception
 from rucio.common.cache import MemcacheRegion
 from rucio.common.config import config_get, config_get_bool
 from rucio.common.constants import RseAttr, SuspiciousAvailability
-from rucio.common.types import InternalAccount, InternalScope, LFNDict, is_str_list
+from rucio.common.types import InternalAccount, InternalScope, IPDict, LFNDict, is_str_list
 from rucio.common.utils import add_url_query, chunks, clean_pfns, str_to_date
 from rucio.core.credential import get_signed_url
 from rucio.core.message import add_messages
@@ -243,7 +243,7 @@ def __exist_replicas(
 
 @read_session
 def list_bad_replicas_status(
-    state: BadFilesStatus = BadFilesStatus.BAD,
+    state: Optional[BadFilesStatus] = BadFilesStatus.BAD,
     rse_id: Optional[str] = None,
     younger_than: Optional[datetime] = None,
     older_than: Optional[datetime] = None,
@@ -943,7 +943,7 @@ def _build_list_replicas_pfn(
         path: str,
         sign_urls: bool,
         signature_lifetime: Optional[int],
-        client_location: Optional[dict[str, Any]],
+        client_location: Optional[IPDict],
         logger: "LoggerFunction" = logging.log,
         *,
         session: "Session",
@@ -1024,7 +1024,7 @@ def _list_replicas(
         show_pfns: bool,
         schemes: Optional[list[str]],
         files_wo_replica: "Iterable[dict[str, Any]]",
-        client_location: Optional[dict[str, Any]],
+        client_location: Optional[IPDict],
         domain: Optional[str],
         sign_urls: bool,
         signature_lifetime: Optional[int],
@@ -1200,7 +1200,7 @@ def list_replicas(
         all_states: bool = False,
         pfns: bool = True,
         rse_expression: Optional[str] = None,
-        client_location: Optional[dict[str, Any]] = None,
+        client_location: Optional[IPDict] = None,
         domain: Optional[str] = None,
         sign_urls: bool = False,
         signature_lifetime: "Optional[int]" = None,
@@ -4176,7 +4176,7 @@ def get_replicas_state(
 
 @read_session
 def get_suspicious_files(
-    rse_expression: str,
+    rse_expression: Optional[str],
     available_elsewhere: int,
     filter_: Optional[dict[str, Any]] = None,
     logger: "LoggerFunction" = logging.log,

rucio/core/rule.py

@@ -2056,7 +2056,8 @@ def re_evaluate_did(
     name: str,
     rule_evaluation_action: DIDReEvaluation,
     *,
-    session: "Session"
+    session: "Session",
+    logger: LoggerFunction = logging.log
 ) -> None:
     """
     Re-Evaluates a did.
@@ -2065,6 +2066,7 @@ def re_evaluate_did(
     :param name:                    The name of the did to be re-evaluated.
     :param rule_evaluation_action:  The Rule evaluation action.
     :param session:                 The database session in use.
+    :param logger:                  Optional decorated logger that can be passed from the calling daemons or servers.
     :raises:                        DataIdentifierNotFound
     """
 
@@ -2080,9 +2082,9 @@ def re_evaluate_did(
         raise DataIdentifierNotFound() from exc
 
     if rule_evaluation_action == DIDReEvaluation.ATTACH:
-        __evaluate_did_attach(did, session=session)
+        __evaluate_did_attach(did, session=session, logger=logger)
     else:
-        __evaluate_did_detach(did, session=session)
+        __evaluate_did_detach(did, session=session, logger=logger)
 
     # Update size and length of did
     if session.bind.dialect.name == 'oracle':