rucio-clients 34.2.0__tar.gz → 34.3.0__tar.gz

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rucio-clients
-Version: 34.2.0
+Version: 34.3.0
 Summary: Rucio Client Lite Package
 Home-page: https://rucio.cern.ch/
 Author: Rucio

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/bin/rucio

@@ -166,7 +166,7 @@ def exception_handler(function):
                     used_account = '%s (from rucio.cfg)' % config_get('client', 'account')
                 except:
                     pass
-                try:  # are we overriden by the environment?
+                try:  # are we overridden by the environment?
                     used_account = '%s (from RUCIO_ACCOUNT)' % os.environ['RUCIO_ACCOUNT']
                 except:
                     pass
@@ -1550,7 +1550,7 @@ def list_rse_attributes(args):
     """
     client = get_client(args)
     attributes = client.list_rse_attributes(rse=args.rse)
-    table = [(k + ':', str(v)) for (k, v) in sorted(attributes.items())]  # columns hav mixed datatypes
+    table = [(k + ':', str(v)) for (k, v) in sorted(attributes.items())]  # columns have mixed datatypes
     print(tabulate(table, tablefmt='plain', disable_numparse=True))  # disabling number parsing
     return SUCCESS
 

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/bin/rucio-admin

@@ -33,6 +33,7 @@ from tabulate import tabulate
 from rucio import version
 from rucio.client import Client
 from rucio.common.config import config_get
+from rucio.common.constants import RseAttr
 from rucio.common.exception import (
     AccessDenied,
     AccountNotFound,
@@ -385,7 +386,7 @@ def set_limits(args):
             try:
                 byte_limit = int(limit_input)
             except ValueError:
-                logger.error('The limit could not be set. Either you misspelled infinity or your input could not be converted to integer or you used a wrong pattern. Please use a format like 10GB with B,KB,MB,GB,TB,PB as units (not case sensistive)')
+                logger.error('The limit could not be set. Either you misspelled infinity or your input could not be converted to integer or you used a wrong pattern. Please use a format like 10GB with B,KB,MB,GB,TB,PB as units (not case sensitive)')
                 return FAILURE
 
     client.set_account_limit(account=args.account, rse=args.rse, bytes_=byte_limit, locality=locality)
@@ -1244,7 +1245,7 @@ def list_pfns(args):
                 if not rse_info['deterministic']:
                     logger.warning('This is a non-deterministic site, so the real PFN might be different from the on suggested')
                     rse_attr = client.list_rse_attributes(rse)
-                    naming_convention = rse_attr.get('naming_convention', None)
+                    naming_convention = rse_attr.get(RseAttr.NAMING_CONVENTION, None)
                     parents = [did for did in client.list_parent_dids(scope, name)]
                     if len(parents) > 1:
                         logger.warning('The file has multiple parents')
@@ -1383,7 +1384,7 @@ def get_parser():
     oparser.add_argument('--oidc-refresh-lifetime', dest='oidc_refresh_lifetime', default=None, help='Max lifetime in hours for this an access token will be refreshed by asynchronous Rucio daemon. '
                          + 'If not specified, refresh will be stopped after 4 days. This option is effective only if --oidc-scope includes offline_access scope for a refresh token to be granted to Rucio.')  # NOQA: W503
     oparser.add_argument('--oidc-issuer', dest='oidc_issuer', default=None,
-                         help='Defines which Identity Provider is goign to be used. The issuer string must correspond '
+                         help='Defines which Identity Provider is going to be used. The issuer string must correspond '
                          + 'to the keys configured in the /etc/idpsecrets.json auth server configuration file.')  # NOQA: W503
 
     # Options for the x509  auth_strategy
@@ -1432,7 +1433,7 @@ def get_parser():
                                                               '"""""""""""""\n'
                                                               '::\n'
                                                               '\n'
-                                                              '    $ rucio-admin account list --type \'user\'\n'
+                                                              '    $ rucio-admin account list --type USER\n'
                                                               '\n')
     list_account_parser.add_argument('--type', dest='account_type', action='store', help='Account Type (USER, GROUP, SERVICE)')
     list_account_parser.add_argument('--id', dest='identity', action='store', help='Identity (e.g. DN)')
@@ -1708,7 +1709,7 @@ def get_parser():
                                                                   '    $ rucio-admin identity delete --account jdoe --type X509 --id \'CN=Joe Doe,CN=707658,CN=jdoe,OU=Users,OU=Organic Units,DC=cern,DC=ch\'\n'
                                                                   '    Deleted identity: CN=Joe Doe,CN=707658,CN=jdoe,OU=Users,OU=Organic Units,DC=cern,DC=ch\n'
                                                                   '\n'
-                                                                  'Note: if the identity was accidentaly deleted, use add option.\n'
+                                                                  'Note: if the identity was accidentally deleted, use add option.\n'
                                                                   '\n')
     identity_delete_parser.set_defaults(which='identity_delete')
     identity_delete_parser.add_argument('--account', dest='account', action='store', help='Account name', required=True)
@@ -1956,7 +1957,7 @@ def get_parser():
                                                               '    $ rucio-admin rse add-protocol --hostname jdoes.test.org --scheme gsiftp --prefix \'/atlasdatadisk/rucio/\' --port 8443 JDOE_DATADISK\n'
                                                               '\n'
                                                               'Note: no printed stdout.\n'
-                                                              'Note: examples of optional parametres::\n'
+                                                              'Note: examples of optional parameters::\n'
                                                               '\n'
                                                               '    --space-token DATADISK\n'
                                                               '    --web-service-path \'/srm/managerv2?SFN=\'\n'
@@ -2110,7 +2111,7 @@ def get_parser():
 
     # The config subparser
     config_parser = subparsers.add_parser('config',
-                                          help='Configuration methods. The global configuration of data mangement system can by modified.',
+                                          help='Configuration methods. The global configuration of data management system can by modified.',
                                           formatter_class=argparse.RawDescriptionHelpFormatter,
                                           epilog='''e.g. quotas, daemons, rses''')
     config_subparser = config_parser.add_subparsers(dest='config_subcommand', **required_arg)
@@ -2311,9 +2312,9 @@ def get_parser():
     declare_bad_file_replicas_parser.add_argument('--inputfile', dest='inputfile', nargs='?', action='store', help='File containing list of bad items')
     declare_bad_file_replicas_parser.add_argument('--allow-collection', dest='allow_collection', action='store_true', help='Allow passing a collection DID as bad item')
 
-    declare_bad_file_replicas_parser.add_argument('--lfns', dest='lfns', nargs='?', action='store', help='File cotaining list of LFNs for bad replicas. Requires --rse and --scope')
-    declare_bad_file_replicas_parser.add_argument('--scope', dest='scope', nargs='?', action='store', help='Common scope for bad replicas secified with LFN list, ignored wthout --lfns')
-    declare_bad_file_replicas_parser.add_argument('--rse', dest='rse', nargs='?', action='store', help='Common RSE for bad replicas secified with LFN list, ignored wthout --lfns')
+    declare_bad_file_replicas_parser.add_argument('--lfns', dest='lfns', nargs='?', action='store', help='File containing list of LFNs for bad replicas. Requires --rse and --scope')
+    declare_bad_file_replicas_parser.add_argument('--scope', dest='scope', nargs='?', action='store', help='Common scope for bad replicas specified with LFN list, ignored without --lfns')
+    declare_bad_file_replicas_parser.add_argument('--rse', dest='rse', nargs='?', action='store', help='Common RSE for bad replicas specified with LFN list, ignored without --lfns')
 
     # The declare-temporary-unavailable command
     declare_temporary_unavailable_replicas_parser = rep_subparser.add_parser('declare-temporary-unavailable',

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/lib/rucio/client/accountclient.py

@@ -112,7 +112,7 @@ class AccountClient(BaseClient):
 
         :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.

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/lib/rucio/client/baseclient.py

@@ -22,12 +22,13 @@ import os
 import secrets
 import sys
 import time
+from collections.abc import Generator
 from configparser import NoOptionError, NoSectionError
 from logging import Logger
 from os import environ, fdopen, geteuid, makedirs, path
 from shutil import move
 from tempfile import mkstemp
-from typing import Any, Generator, Optional
+from typing import Any, Optional
 from urllib.parse import urlparse
 
 import requests
@@ -235,7 +236,7 @@ class BaseClient:
         if self.auth_type == 'oidc':
             if not creds:
                 creds = {}
-            # if there are defautl values, check if rucio.cfg does not specify them, otherwise put default
+            # if there are default values, check if rucio.cfg does not specify them, otherwise put default
             if 'oidc_refresh_lifetime' not in creds or creds['oidc_refresh_lifetime'] is None:
                 creds['oidc_refresh_lifetime'] = config_get('client', 'oidc_refresh_lifetime', False, None)
             if 'oidc_issuer' not in creds or creds['oidc_issuer'] is None:
@@ -615,7 +616,7 @@ class BaseClient:
 
         else:
             print("\nAccording to the OAuth2/OIDC standard you should NOT be sharing \n"
-                  + "your password with any 3rd party appplication, therefore, \n"  # NOQA: W503
+                  + "your password with any 3rd party application, therefore, \n"  # NOQA: W503
                   + "we strongly discourage you from following this --oidc-auto approach.")  # NOQA: W503
             print("-------------------------------------------------------------------------")
             auth_res = self._send_request(auth_url, get_token=True)
@@ -658,7 +659,7 @@ class BaseClient:
 
         self.auth_token = result.headers['x-rucio-auth-token']
         if self.auth_oidc_refresh_active:
-            self.logger.debug("Reseting the token expiration epoch file content.")
+            self.logger.debug("Resetting the token expiration epoch file content.")
             # reset the token expiration epoch file content
             # at new CLI OIDC authentication
             self.token_exp_epoch = None

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/lib/rucio/client/didclient.py

@@ -47,7 +47,7 @@ class DIDClient(BaseClient):
         path = '/'.join([self.DIDS_BASEURL, quote_plus(scope), 'dids', 'search'])
 
         # stringify dates.
-        if isinstance(filters, dict):   # backwards compatability for filters as single {}
+        if isinstance(filters, dict):   # backwards compatibility for filters as single {}
             filters = [filters]
         for or_group in filters:
             for key, value in or_group.items():

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/lib/rucio/client/downloadclient.py

@@ -265,7 +265,7 @@ class DownloadClient:
             force_scheme                   - Optional: force a specific scheme to download this item. (Default: None)
             base_dir                       - Optional: base directory where the downloaded files will be stored. (Default: '.')
             no_subdir                      - Optional: If true, files are written directly into base_dir. (Default: False)
-            nrandom                        - Optional: if the DID addresses a dataset, nrandom files will be randomly choosen for download from the dataset
+            nrandom                        - Optional: if the DID addresses a dataset, nrandom files will be randomly chosen for download from the dataset
             ignore_checksum                - Optional: If true, skips the checksum validation between the downloaded file and the rucio catalouge. (Default: False)
             transfer_timeout               - Optional: Timeout time for the download protocols. (Default: None)
             transfer_speed_timeout         - Optional: Minimum allowed transfer speed (in KBps). Ignored if transfer_timeout set. Otherwise, used to compute default timeout (Default: 500)
@@ -671,10 +671,10 @@ class DownloadClient:
 
         # if the file was downloaded with success, it can be linked to pcache
         if pcache:
-            logger(logging.INFO, 'File %s is going to be registerred into pcache.' % dest_file_path)
+            logger(logging.INFO, 'File %s is going to be registered into pcache.' % dest_file_path)
             try:
                 pcache_state, hardlink_state = pcache.check_and_link(src=pfn, storage_root=storage_prefix, local_src=first_dest_file_path)
-                logger(logging.INFO, 'File %s is now registerred into pcache.' % first_dest_file_path)
+                logger(logging.INFO, 'File %s is now registered into pcache.' % first_dest_file_path)
             except Exception as e:
                 logger(logging.WARNING, 'Failed to load file to pcache: %s' % str(e))
 
@@ -741,7 +741,7 @@ class DownloadClient:
             rse                            - Optional: rse name (e.g. 'CERN-PROD_DATADISK') or rse expression from where to download
             base_dir                       - Optional: base directory where the downloaded files will be stored. (Default: '.')
             no_subdir                      - Optional: If true, files are written directly into base_dir. (Default: False)
-            nrandom                        - Optional: if the DID addresses a dataset, nrandom files will be randomly choosen for download from the dataset
+            nrandom                        - Optional: if the DID addresses a dataset, nrandom files will be randomly chosen for download from the dataset
             ignore_checksum                - Optional: If true, skips the checksum validation between the downloaded file and the rucio catalouge. (Default: False)
             check_local_with_filesize_only - Optional: If true, already downloaded files will not be validated by checksum.
 
@@ -798,7 +798,7 @@ class DownloadClient:
 
         :param rpc_secret: the secret for the RPC proxy
 
-        :returns: a tupel with the process and the rpc proxy objects
+        :returns: a tuple with the process and the rpc proxy objects
 
         :raises RucioException: if the process or the proxy could not be created
         """
@@ -958,7 +958,7 @@ class DownloadClient:
                 # workaround: only consider first dest file path for aria2c download
                 dest_file_path = next(iter(item['dest_file_paths']))
 
-                # ensure we didnt miss the active state (e.g. a very fast download)
+                # ensure we didn't miss the active state (e.g. a very fast download)
                 start_time = item.setdefault('transferStart', time.time())
                 end_time = item.setdefault('transferEnd', time.time())
 
@@ -1093,7 +1093,7 @@ class DownloadClient:
             self.extraction_tools = [tool for tool in self.extraction_tools if tool.is_useable()]
             if len(self.extraction_tools) < 1:
                 logger(logging.WARNING, 'Archive resolution is enabled but no extraction tool is available. '
-                                        'Sources whose protocol doesnt support extraction wont be considered for download.')
+                                        'Sources whose protocol does not support extraction will not be considered for download.')
 
         # if excluding tapes, we need to list them first
         tape_rses = []
@@ -1110,7 +1110,7 @@ class DownloadClient:
         for item in input_items:
             resolved_dids = list(self._resolve_one_item_dids(item))
             if not resolved_dids:
-                logger(logging.WARNING, 'An item didnt have any DIDs after resolving the input: %s.' % item.get('did', item))
+                logger(logging.WARNING, 'An item did not have any DIDs after resolving the input: %s.' % item.get('did', item))
             item['dids'] = resolved_dids
             for did in resolved_dids:
                 did_to_input_items.setdefault(DID(did), []).append(item)
@@ -1342,7 +1342,7 @@ class DownloadClient:
             file_item['dest_file_paths'] = list(dest_file_paths)
             file_item['temp_file_path'] = '%s.part' % file_item['dest_file_paths'][0]
 
-            # the file did str ist not an unique key for this dict because multiple calls of list_replicas
+            # the file did str is not an unique key for this dict because multiple calls of list_replicas
             # could result in the same DID multiple times. So we're using the id of the dictionary objects
             fiid = id(file_item)
             fiid_to_file_item[fiid] = file_item
@@ -1500,7 +1500,7 @@ class DownloadClient:
         Splits a given DID string (e.g. 'scope1:name.file') into its scope and name part
         (This function is meant to be used as class internal only)
 
-        :param did_str: the DID string that will be splitted
+        :param did_str: the DID string that will be split
 
         :returns: the scope- and name part of the given DID
 
@@ -1538,7 +1538,7 @@ class DownloadClient:
         :param dest_dir_name: name of the destination directory
         :param no_subdir: if no subdirectory should be created
 
-        :returns: the absolut path of the destination directory
+        :returns: the absolute path of the destination directory
         """
         # append dest_dir_name, if subdir should be used
         if dest_dir_name.startswith('/'):

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/lib/rucio/client/rseclient.py

@@ -83,7 +83,7 @@ class RSEClient(BaseClient):
         Update RSE properties like availability or name.
 
         :param rse: the name of the new rse.
-        :param  parameters: A dictionnary with property (name, read, write, delete as keys).
+        :param  parameters: A dictionary with property (name, read, write, delete as keys).
         """
         path = 'rses/' + rse
         url = build_url(choice(self.list_hosts), path=path)
@@ -341,7 +341,7 @@ class RSEClient(BaseClient):
 
         :param rse: the RSE name.
         :param scheme: identifier of the protocol.
-        :param data: A dict providing the new values of the protocol attibutes.
+        :param data: A dict providing the new values of the protocol attributes.
                      Keys must match column names in database.
         :param hostname: hostname of the protocol.
         :param port: port of the protocol.
@@ -512,7 +512,7 @@ class RSEClient(BaseClient):
         :param rse: The RSE name.
         :param filters: dictionary of attributes by which the results should be filtered.
 
-        :returns:  list of dictionnaries.
+        :returns:  list of dictionaries.
         """
         path = [self.RSE_BASEURL, rse, 'usage', 'history']
         path = '/'.join(path)
@@ -593,7 +593,7 @@ class RSEClient(BaseClient):
 
         :param source: The source.
         :param destination: The destination.
-        :param parameters: A dictionnary with property.
+        :param parameters: A dictionary with property.
         """
         path = [self.RSE_BASEURL, source, 'distances', destination]
         path = '/'.join(path)
@@ -612,7 +612,7 @@ class RSEClient(BaseClient):
 
         :param source: The source.
         :param destination: The destination.
-        :param parameters: A dictionnary with property.
+        :param parameters: A dictionary with property.
         """
         path = [self.RSE_BASEURL, source, 'distances', destination]
         path = '/'.join(path)

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/lib/rucio/client/ruleclient.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from collections.abc import Sequence
 from json import dumps, loads
 from typing import Any, Optional, Union
 from urllib.parse import quote_plus
@@ -30,7 +31,7 @@ class RuleClient(BaseClient):
 
     def add_replication_rule(
         self,
-        dids: list[str],
+        dids: Sequence[dict[str, str]],
         copies: int,
         rse_expression: str,
         priority: int = 3,

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/lib/rucio/client/uploadclient.py

@@ -25,6 +25,7 @@ import time
 from rucio import version
 from rucio.client.client import Client
 from rucio.common.config import config_get, config_get_bool, config_get_int
+from rucio.common.constants import RseAttr
 from rucio.common.exception import (
     DataIdentifierAlreadyExists,
     DataIdentifierNotFound,
@@ -195,8 +196,8 @@ class UploadClient:
                 rse_attributes = self.client.list_rse_attributes(rse)
             except:
                 logger(logging.WARNING, 'Attributes of the RSE: %s not available.' % rse)
-            if (self.client_location and 'lan' in rse_settings['domain'] and 'site' in rse_attributes):
-                if self.client_location['site'] == rse_attributes['site']:
+            if (self.client_location and 'lan' in rse_settings['domain'] and RseAttr.SITE in rse_attributes):
+                if self.client_location['site'] == rse_attributes[RseAttr.SITE]:
                     domain = 'lan'
             logger(logging.DEBUG, '{} domain is used for the upload'.format(domain))
 
@@ -458,7 +459,7 @@ class UploadClient:
             try:
                 guid = output.splitlines()[-1].split()[0].replace('-', '').lower()
             except Exception:
-                raise RucioException('Error extracting GUID from ouput of pool_extractFileIdentifier')
+                raise RucioException('Error extracting GUID from output of pool_extractFileIdentifier')
         elif guid:
             guid = guid.replace('-', '')
         else:
@@ -674,7 +675,7 @@ class UploadClient:
             raise RSEOperationNotSupported(str(error))
 
         # Is stat after that upload allowed?
-        skip_upload_stat = rse_attributes.get('skip_upload_stat', False)
+        skip_upload_stat = rse_attributes.get(RseAttr.SKIP_UPLOAD_STAT, False)
         self.logger(logging.DEBUG, 'skip_upload_stat=%s', skip_upload_stat)
 
         # Checksum verification, obsolete, see Gabriele changes.
@@ -740,7 +741,7 @@ class UploadClient:
 
     def _create_protocol(self, rse_settings, operation, impl=None, force_scheme=None, domain='wan'):
         """
-        Protol construction.
+        Protocol construction.
         :param rse_settings:        rse_settings
         :param operation:           activity, e.g. read, write, delete etc.
         :param force_scheme:        custom scheme

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/lib/rucio/common/cache.py

@@ -23,6 +23,8 @@ if TYPE_CHECKING:
     from collections.abc import Callable
     from typing import Optional
 
+    from dogpile.cache.region import CacheRegion
+
 CACHE_URL = config_get('cache', 'url', False, '127.0.0.1:11211', check_config_table=False)
 
 ENABLE_CACHING = True
@@ -47,7 +49,7 @@ def make_region_memcached(
         expiration_time: int,
         function_key_generator: "Optional[Callable]" = None,
         memcached_expire_time: "Optional[int]" = None
-):
+) -> "CacheRegion":
     """
     Make and configure a dogpile.cache.pymemcache region
     """

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/lib/rucio/common/config.py

@@ -18,7 +18,7 @@ import configparser
 import json
 import os
 from collections.abc import Callable
-from typing import TYPE_CHECKING, Optional, TypeVar, Union, overload
+from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, overload
 
 from rucio.common import exception
 from rucio.common.exception import ConfigNotFound, DatabaseException
@@ -30,7 +30,7 @@ if TYPE_CHECKING:
     from sqlalchemy.orm import Session
 
 
-def convert_to_any_type(value) -> Union[bool, int, float, str]:
+def convert_to_any_type(value: str) -> Union[bool, int, float, str]:
     if value.lower() in ['true', 'yes', 'on']:
         return True
     elif value.lower() in ['false', 'no', 'off']:
@@ -45,7 +45,7 @@ def convert_to_any_type(value) -> Union[bool, int, float, str]:
     return value
 
 
-def _convert_to_boolean(value):
+def _convert_to_boolean(value: Union[str, bool]) -> bool:
     if isinstance(value, bool):
         return value
     if value.lower() in ['true', 'yes', 'on', '1']:
@@ -297,7 +297,7 @@ def config_get_int(
 def config_get_int(
         section: str,
         option: str,
-        raise_exception,
+        raise_exception: bool,
         default: _T = ...,
         *,
         check_config_table: bool = ...,
@@ -309,14 +309,14 @@ def config_get_int(
 
 
 def config_get_int(
-        section,
-        option,
-        raise_exception=True,
+        section: str,
+        option: str,
+        raise_exception: bool = True,
         default=None,
-        check_config_table=True,
-        session=None,
-        use_cache=True,
-        expiration_time=900,
+        check_config_table: bool = True,
+        session: "Optional[Session]" = None,
+        use_cache: bool = True,
+        expiration_time: int = 900,
 ):
     """
     Return the integer value for a given option in a section
@@ -395,14 +395,14 @@ def config_get_float(
 
 
 def config_get_float(
-        section,
-        option,
-        raise_exception=True,
+        section: str,
+        option: str,
+        raise_exception: bool = True,
         default=None,
-        check_config_table=True,
-        session=None,
-        use_cache=True,
-        expiration_time=900,
+        check_config_table: bool = True,
+        session: "Optional[Session]" = None,
+        use_cache: bool = True,
+        expiration_time: int = 900,
 ):
     """
     Return the floating point value for a given option in a section
@@ -482,14 +482,14 @@ def config_get_bool(
 
 
 def config_get_bool(
-        section,
-        option,
-        raise_exception=True,
+        section: str,
+        option: str,
+        raise_exception: bool = True,
         default=None,
-        check_config_table=True,
-        session=None,
-        use_cache=True,
-        expiration_time=900,
+        check_config_table: bool = True,
+        session: "Optional[Session]" = None,
+        use_cache: bool = True,
+        expiration_time: int = 900,
 ):
     """
     Return the boolean value for a given option in a section
@@ -569,14 +569,14 @@ def config_get_list(
 
 
 def config_get_list(
-        section,
-        option,
-        raise_exception=True,
+        section: str,
+        option: str,
+        raise_exception: bool = True,
         default=None,
-        check_config_table=True,
-        session=None,
-        use_cache=True,
-        expiration_time=900,
+        check_config_table: bool = True,
+        session: "Optional[Session]" = None,
+        use_cache: bool = True,
+        expiration_time: int = 900,
 ):
     """
     Return a list for a given option in a section
@@ -691,7 +691,7 @@ def config_remove_option(section: str, option: str) -> bool:
     return get_config().remove_option(section, option)
 
 
-def config_set(section: str, option: str, value: str):
+def config_set(section: str, option: str, value: str) -> None:
     """
     Set a configuration option in a given section.
 
@@ -704,7 +704,7 @@ def config_set(section: str, option: str, value: str):
     return get_config().set(section, option, value)
 
 
-def get_config_dirs():
+def get_config_dirs() -> list[str]:
     """
     Returns all available configuration directories in order:
     - $RUCIO_HOME/etc/
@@ -724,7 +724,7 @@ def get_config_dirs():
     return configdirs
 
 
-def get_lfn2pfn_algorithm_default():
+def get_lfn2pfn_algorithm_default() -> str:
     """Returns the default algorithm name for LFN2PFN translation for this server."""
     default_lfn2pfn = "hash"
     try:
@@ -734,7 +734,7 @@ def get_lfn2pfn_algorithm_default():
     return default_lfn2pfn
 
 
-def get_rse_credentials(path_to_credentials_file: Optional[Union[str, os.PathLike]] = None):
+def get_rse_credentials(path_to_credentials_file: Optional[Union[str, os.PathLike]] = None) -> dict[str, Any]:
     """ Returns credentials for RSEs. """
 
     path = ''
@@ -765,7 +765,7 @@ def get_config() -> configparser.ConfigParser:
     return __CONFIG.parser
 
 
-def clean_cached_config():
+def clean_cached_config() -> None:
     """Deletes the cached config singleton instance."""
     global __CONFIG
     __CONFIG = None

{rucio_clients-34.2.0 → rucio_clients-34.3.0}/lib/rucio/common/constants.py

@@ -14,6 +14,7 @@
 
 import enum
 from collections import namedtuple
+from typing import Literal, get_args
 
 from rucio.common.config import config_get_bool
 
@@ -47,7 +48,8 @@ if config_get_bool('transfers', 'srm_https_compatibility', raise_exception=False
     SCHEME_MAP['srm'].append('davs')
     SCHEME_MAP['davs'].append('srm')
 
-SUPPORTED_PROTOCOLS = ['gsiftp', 'srm', 'root', 'davs', 'http', 'https', 'file', 'storm', 'srm+https', 'scp', 'rsync', 'rclone', 'magnet']
+SUPPORTED_PROTOCOLS_LITERAL = Literal['gsiftp', 'srm', 'root', 'davs', 'http', 'https', 'file', 'storm', 'srm+https', 'scp', 'rsync', 'rclone', 'magnet']
+SUPPORTED_PROTOCOLS = list(get_args(SUPPORTED_PROTOCOLS_LITERAL))
 
 FTS_STATE = namedtuple('FTS_STATE', ['SUBMITTED', 'READY', 'ACTIVE', 'FAILED', 'FINISHED', 'FINISHEDDIRTY', 'NOT_USED',
                                      'CANCELED'])('SUBMITTED', 'READY', 'ACTIVE', 'FAILED', 'FINISHED', 'FINISHEDDIRTY',
@@ -89,3 +91,61 @@ class HermesService(str, enum.Enum):
     ELASTIC = "ELASTIC"
     EMAIL = "EMAIL"
     ACTIVEMQ = "ACTIVEMQ"
+
+
+class RseAttr:
+
+    """
+    List of functional RSE attributes.
+
+    This class acts as a namespace containing all RSE attributes referenced in
+    the Rucio source code. Setting them affects Rucio's behaviour in some way.
+    """
+
+    ARCHIVE_TIMEOUT = 'archive_timeout'
+    ASSOCIATED_SITES = 'associated_sites'
+    AUTO_APPROVE_BYTES = 'auto_approve_bytes'
+    AUTO_APPROVE_FILES = 'auto_approve_files'
+    BITTORRENT_TRACKER_ADDR = 'bittorrent_tracker_addr'
+    BLOCK_MANUAL_APPROVAL = 'block_manual_approval'
+    COUNTRY = 'country'
+    DECOMMISSION = 'decommission'
+    DEFAULT_ACCOUNT_LIMIT_BYTES = 'default_account_limit_bytes'
+    FTS = 'fts'
+    GLOBUS_ENDPOINT_ID = 'globus_endpoint_id'
+    GREEDYDELETION = 'greedyDeletion'
+    IS_OBJECT_STORE = 'is_object_store'
+    LFN2PFN_ALGORITHM = 'lfn2pfn_algorithm'
+    MAXIMUM_PIN_LIFETIME = 'maximum_pin_lifetime'
+    MULTIHOP_TOMBSTONE_DELAY = 'multihop_tombstone_delay'
+    NAMING_CONVENTION = 'naming_convention'
+    OIDC_BASE_PATH = 'oidc_base_path'
+    OIDC_SUPPORT = 'oidc_support'
+    PHYSGROUP = 'physgroup'
+    QBITTORRENT_MANAGEMENT_ADDRESS = 'qbittorrent_management_address'
+    RESTRICTED_READ = 'restricted_read'
+    RESTRICTED_WRITE = 'restricted_write'
+    RULE_APPROVERS = 'rule_approvers'
+    S3_URL_STYLE = 's3_url_style'
+    SIGN_URL = 'sign_url'
+    SIMULATE_MULTIRANGE = 'simulate_multirange'
+    SITE = 'site'
+    SKIP_UPLOAD_STAT = 'skip_upload_stat'
+    SOURCE_FOR_TOTAL_SPACE = 'source_for_total_space'
+    SOURCE_FOR_USED_SPACE = 'source_for_used_space'
+    STAGING_BUFFER = 'staging_buffer'
+    STAGING_REQUIRED = 'staging_required'
+    STRICT_COPY = 'strict_copy'
+    TOMBSTONE_DELAY = 'tombstone_delay'
+    TYPE = 'type'
+    USE_IPV4 = 'use_ipv4'
+    VERIFY_CHECKSUM = 'verify_checksum'
+
+    # The following RSE attributes are exclusively used in the permission layer
+    # and are likely VO-specific.
+
+    BLOCK_MANUAL_APPROVE = 'block_manual_approve'
+    CMS_TYPE = 'cms_type'
+    DEFAULT_LIMIT_FILES = 'default_limit_files'
+    QUOTA_APPROVERS = 'quota_approvers'
+    RULE_DELETERS = 'rule_deleters'