rucio 37.5.0__py3-none-any.whl → 37.7.0__py3-none-any.whl

rucio/gateway/did.py

@@ -16,7 +16,7 @@ from copy import deepcopy
 from typing import TYPE_CHECKING, Any, Optional
 
 import rucio.gateway.permission
-from rucio.common.constants import RESERVED_KEYS
+from rucio.common.constants import DEFAULT_VO, RESERVED_KEYS
 from rucio.common.exception import AccessDenied, InvalidObject, RucioException
 from rucio.common.schema import validate_schema
 from rucio.common.types import InternalAccount, InternalScope
@@ -40,14 +40,14 @@ def list_dids(
     offset: Optional[int] = None,
     long: bool = False,
     recursive: bool = False,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
-    List dids in a scope.
+    List DIDs in a scope.
 
     :param scope: The scope name.
     :param filters: Filter arguments in form supported by the filter engine.
-    :param did_type:  The type of the did: all(container, dataset, file), collection(dataset or container), dataset, container
+    :param did_type:  The type of the DID: all(container, dataset, file), collection(dataset or container), dataset, container
     :param ignore_case: Ignore case distinctions.
     :param limit: The maximum number of DIDs returned.
     :param offset: Offset number.
@@ -84,10 +84,10 @@ def add_did(
     lifetime: Optional[str] = None,
     dids: Optional['Sequence[dict[str, Any]]'] = None,
     rse: Optional[str] = None,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
-    Add data did.
+    Add data DID.
 
     :param scope: The scope name.
     :param name: The data identifier name.
@@ -96,7 +96,7 @@ def add_did(
     :param account: The account owner. If None, then issuer is selected as owner.
     :param statuses: Dictionary with statuses, e.g.g {'monotonic':True}.
     :meta: Meta-data associated with the data identifier is represented using key/value pairs in a dictionary.
-    :rules: Replication rules associated with the data did. A list of dictionaries, e.g., [{'copies': 2, 'rse_expression': 'TIERS1'}, ].
+    :rules: Replication rules associated with the data DID. A list of dictionaries, e.g., [{'copies': 2, 'rse_expression': 'TIERS1'}, ].
     :param lifetime: DID's lifetime (in seconds).
     :param dids: The content.
     :param rse: The RSE name when registering replicas.
@@ -152,12 +152,12 @@ def add_did(
 def add_dids(
     dids: 'Sequence[dict[str, Any]]',
     issuer: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
-    Bulk Add did.
+    Bulk Add DID.
 
-    :param dids: A list of dids.
+    :param dids: A list of DIDs.
     :param issuer: The issuer account.
     :param vo: The VO to act on.
     """
@@ -190,10 +190,10 @@ def attach_dids(
     name: str,
     attachment: dict[str, Any],
     issuer: str,
-    vo='def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
-    Append content to data did.
+    Append content to data DID.
 
     :param attachment: The attachment.
     :param issuer: The issuer account.
@@ -237,10 +237,10 @@ def attach_dids_to_dids(
     attachments: 'Sequence[dict[str, Any]]',
     issuer: str,
     ignore_duplicate: bool = False,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
-    Append content to dids.
+    Append content to DIDs.
 
     :param attachments: The contents.
     :param issuer: The issuer account.
@@ -279,7 +279,7 @@ def detach_dids(
     name: str,
     dids: 'Sequence[dict[str, Any]]',
     issuer: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Detach data identifier
@@ -309,7 +309,7 @@ def list_new_dids(
     thread: Optional[int] = None,
     total_threads: Optional[int] = None,
     chunk_size: int = 1000,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     List recent identifiers.
@@ -333,7 +333,7 @@ def list_new_dids(
 def set_new_dids(
     dids: 'Sequence[dict[str, Any]]',
     new_flag: bool = True,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> bool:
     """
     Set/reset the flag new
@@ -353,7 +353,7 @@ def set_new_dids(
 def list_content(
     scope: str,
     name: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     List data identifier contents.
@@ -374,7 +374,7 @@ def list_content(
 def list_content_history(
     scope: str,
     name: str,
-    vo='def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     List data identifier contents history.
@@ -396,7 +396,7 @@ def list_content_history(
 def bulk_list_files(
     dids: 'Iterable[dict[str, Any]]',
     long: bool = False,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     List file contents of a list of data identifiers.
@@ -418,7 +418,7 @@ def list_files(
     scope: str,
     name: str,
     long: bool,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     List data identifier file contents.
@@ -442,7 +442,7 @@ def scope_list(
     scope: str,
     name: Optional[str] = None,
     recursive: bool = False,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     List data identifiers in a scope.
@@ -466,17 +466,17 @@ def scope_list(
             yield ret_did
 
 
-def get_did(scope: str, name: str, dynamic_depth: Optional[DIDType] = None, vo: str = 'def') -> "dict[str, Any]":
+def get_did(scope: str, name: str, dynamic_depth: Optional[DIDType] = None, vo: str = DEFAULT_VO) -> "dict[str, Any]":
     """
-    Retrieve a single data did.
+    Retrieve a single data DID.
 
     :param scope: The scope name.
     :param name: The data identifier name.
     :param dynamic_depth: the DID type to use as source for estimation of this DIDs length/bytes.
-    If set to None, or to a value which doesn't make sense (ex: requesting depth = CONTAINER for a did of type DATASET)
+    If set to None, or to a value which doesn't make sense (ex: requesting depth = CONTAINER for a DID of type DATASET)
     will not compute the size dynamically.
     :param vo: The VO to act on.
-    :return did: Dictionary containing {'name', 'scope', 'type'}, Exception otherwise
+    :return DID: Dictionary containing {'name', 'scope', 'type'}, Exception otherwise
     """
 
     internal_scope = InternalScope(scope, vo=vo)
@@ -493,10 +493,10 @@ def set_metadata(
     value: Any,
     issuer: str,
     recursive: bool = False,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
-    Add metadata to data did.
+    Add metadata to data DID.
 
     :param scope: The scope name.
     :param name: The data identifier name.
@@ -526,10 +526,10 @@ def set_metadata_bulk(
     meta: dict[str, Any],
     issuer: str,
     recursive: bool = False,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
-    Add metadata to data did.
+    Add metadata to data DID.
 
     :param scope: The scope name.
     :param name: The data identifier name.
@@ -557,13 +557,13 @@ def set_dids_metadata_bulk(
     dids: 'Iterable[dict[str, Any]]',
     issuer: str,
     recursive: bool = False,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Add metadata to a list of data identifiers.
 
     :param issuer: The issuer account.
-    :param dids: A list of dids including metadata.
+    :param dids: A list of DIDs including metadata.
     :param recursive: Option to propagate the metadata update to content.
     :param vo: The VO to act on.
     """
@@ -587,7 +587,7 @@ def get_metadata(
     scope: str,
     name: str,
     plugin: str = 'DID_COLUMN',
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> dict[str, Any]:
     """
     Get data identifier metadata
@@ -609,11 +609,11 @@ def get_metadata_bulk(
     dids: 'Iterable[dict[str, Any]]',
     inherit: bool = False,
     plugin: str = 'DID_COLUMN',
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
-    Get metadata for a list of dids
-    :param dids:               A list of dids.
+    Get metadata for a list of DIDs
+    :param dids:               A list of DIDs.
     :param inherit:            A boolean. If set to true, the metadata of the parent are concatenated.
     :param plugin:             The metadata plugin to query, 'ALL' for all available plugins
     :param vo:                 The VO to act on.
@@ -633,13 +633,13 @@ def delete_metadata(
     scope: str,
     name: str,
     key: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Delete a key from the metadata column
 
-    :param scope: the scope of did
-    :param name: the name of the did
+    :param scope: the scope of DID
+    :param name: the name of the DID
     :param key: the key to be deleted
     :param vo: The VO to act on.
     """
@@ -653,7 +653,7 @@ def set_status(
     scope: str,
     name: str,
     issuer: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
     **kwargs
 ) -> None:
     """
@@ -678,14 +678,14 @@ def set_status(
 
 def get_dataset_by_guid(
     guid: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     Get the parent datasets for a given GUID.
     :param guid: The GUID.
     :param vo: The VO to act on.
 
-    :returns: A did
+    :returns: A DID
     """
     with db_session(DatabaseOperationType.READ) as session:
         dids = did.get_dataset_by_guid(guid=guid, session=session)
@@ -699,10 +699,10 @@ def get_dataset_by_guid(
 def list_parent_dids(
     scope: str,
     name: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
-    List parent datasets and containers of a did.
+    List parent datasets and containers of a DID.
 
     :param scope:   The scope.
     :param name:    The name.
@@ -725,7 +725,7 @@ def create_did_sample(
     output_name: str,
     issuer: str,
     nbfiles: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ):
     """
     Create a sample from an input collection.
@@ -758,12 +758,12 @@ def create_did_sample(
 def resurrect(
     dids: 'Iterable[dict[str, Any]]',
     issuer: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Resurrect DIDs.
 
-    :param dids: A list of dids.
+    :param dids: A list of DIDs.
     :param issuer: The issuer account.
     :param vo: The VO to act on.
     """
@@ -783,7 +783,7 @@ def resurrect(
 def list_archive_content(
     scope: str,
     name: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     List archive contents.
@@ -805,10 +805,10 @@ def add_did_to_followed(
     scope: str,
     name: str,
     account: str,
-    vo: str = 'def'
+    vo: str = DEFAULT_VO
 ) -> None:
     """
-    Mark a did as followed by the given account
+    Mark a DID as followed by the given account
 
     :param scope: The scope name.
     :param name: The data identifier name.
@@ -823,12 +823,12 @@ def add_did_to_followed(
 def add_dids_to_followed(
     dids: 'Iterable[Mapping[str, Any]]',
     account: str,
-    vo: str = 'def'
+    vo: str = DEFAULT_VO
 ) -> None:
     """
     Bulk mark datasets as followed
 
-    :param dids: A list of dids.
+    :param dids: A list of DIDs.
     :param account: The account owner.
     """
     internal_account = InternalAccount(account, vo=vo)
@@ -839,10 +839,10 @@ def add_dids_to_followed(
 def get_users_following_did(
     name: str,
     scope: str,
-    vo: str = 'def'
+    vo: str = DEFAULT_VO
 ) -> 'Iterator[dict[str, str]]':
     """
-    Return list of users following a did
+    Return list of users following a DID
 
     :param scope: The scope name.
     :param name: The data identifier name.
@@ -860,10 +860,10 @@ def remove_did_from_followed(
     name: str,
     account: str,
     issuer: str,
-    vo: str = 'def'
+    vo: str = DEFAULT_VO
 ) -> None:
     """
-    Mark a did as not followed
+    Mark a DID as not followed
 
     :param scope: The scope name.
     :param name: The data identifier name.
@@ -885,12 +885,12 @@ def remove_dids_from_followed(
     dids: 'Iterable[Mapping[str, Any]]',
     account: str,
     issuer: str,
-    vo: str = 'def'
+    vo: str = DEFAULT_VO
 ) -> None:
     """
     Bulk mark datasets as not followed
 
-    :param dids: A list of dids.
+    :param dids: A list of DIDs.
     :param account: The account owner.
     """
     kwargs = {'dids': dids, 'issuer': issuer}

rucio/gateway/dirac.py

@@ -14,6 +14,7 @@
 
 from typing import TYPE_CHECKING, Any, Optional
 
+from rucio.common.constants import DEFAULT_VO
 from rucio.common.exception import AccessDenied
 from rucio.common.types import InternalScope
 from rucio.common.utils import extract_scope
@@ -33,7 +34,7 @@ def add_files(
     issuer: str,
     ignore_availability: bool,
     parents_metadata: Optional[dict[str, Any]] = None,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Bulk add files :
@@ -63,7 +64,7 @@ def add_files(
                 rses[rse] = rse_id
             lfn['rse_id'] = rses[rse]
 
-        # Check if the issuer can add dids and use skip_availabitlity
+        # Check if the issuer can add DIDs and use skip_availabitlity
         for rse in rses:
             rse_id = rses[rse]
             kwargs = {'rse': rse, 'rse_id': rse_id}

rucio/gateway/exporter.py

@@ -15,6 +15,7 @@
 from typing import Any
 
 from rucio.common import exception
+from rucio.common.constants import DEFAULT_VO
 from rucio.core import exporter
 from rucio.core.rse import get_rse_name
 from rucio.db.sqla.constants import DatabaseOperationType
@@ -22,7 +23,7 @@ from rucio.db.sqla.session import db_session
 from rucio.gateway import permission
 
 
-def export_data(issuer: str, distance: bool = True, vo: str = 'def') -> dict[str, Any]:
+def export_data(issuer: str, distance: bool = True, vo: str = DEFAULT_VO) -> dict[str, Any]:
     """
     Export data from Rucio.
 

rucio/gateway/heartbeat.py

@@ -15,6 +15,7 @@
 from typing import TYPE_CHECKING, Optional
 
 from rucio.common import exception
+from rucio.common.constants import DEFAULT_VO
 from rucio.core import heartbeat
 from rucio.db.sqla.constants import DatabaseOperationType
 from rucio.db.sqla.session import db_session
@@ -24,7 +25,7 @@ if TYPE_CHECKING:
     from threading import Thread
 
 
-def list_heartbeats(issuer: str, vo: str = 'def') -> list["heartbeat.HeartbeatDict"]:
+def list_heartbeats(issuer: str, vo: str = DEFAULT_VO) -> list["heartbeat.HeartbeatDict"]:
     """
     Return a list of tuples of all heartbeats.
 
@@ -49,7 +50,7 @@ def create_heartbeat(
     payload: Optional[str],
     issuer: str,
     thread: Optional["Thread"] = None,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Creates a heartbeat.

rucio/gateway/identity.py

@@ -19,6 +19,7 @@ Interface for identity abstraction layer
 from typing import TYPE_CHECKING, Optional
 
 from rucio.common import exception
+from rucio.common.constants import DEFAULT_VO
 from rucio.common.types import InternalAccount
 from rucio.core import identity
 from rucio.db.sqla.constants import DatabaseOperationType, IdentityType
@@ -53,7 +54,7 @@ def del_identity(
     identity_key: str,
     id_type: str,
     issuer: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Deletes a user identity.
@@ -81,7 +82,7 @@ def add_account_identity(
     issuer: str,
     default: bool = False,
     password: Optional[str] = None,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Adds a membership association between identity and account.
@@ -124,7 +125,7 @@ def del_account_identity(
     id_type: str,
     account: str,
     issuer: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Removes a membership association between identity and account.

rucio/gateway/importer.py

@@ -15,6 +15,7 @@
 from typing import Any
 
 from rucio.common import exception
+from rucio.common.constants import DEFAULT_VO
 from rucio.common.schema import validate_schema
 from rucio.common.types import InternalAccount
 from rucio.core import importer
@@ -23,7 +24,7 @@ from rucio.db.sqla.session import db_session
 from rucio.gateway import permission
 
 
-def import_data(data: dict[str, Any], issuer: str, vo: str = 'def') -> None:
+def import_data(data: dict[str, Any], issuer: str, vo: str = DEFAULT_VO) -> None:
     """
     Import data to add/update/delete records in Rucio.
 

rucio/gateway/lifetime_exception.py

@@ -15,6 +15,7 @@
 from typing import TYPE_CHECKING, Any, Optional
 
 from rucio.common import exception
+from rucio.common.constants import DEFAULT_VO
 from rucio.common.types import InternalAccount, InternalScope
 from rucio.common.utils import gateway_update_return_dict
 from rucio.core import lifetime_exception
@@ -31,7 +32,7 @@ if TYPE_CHECKING:
 def list_exceptions(
     exception_id: Optional[str] = None,
     states: Optional["Iterable[LifetimeExceptionsState]"] = None,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     List exceptions to Lifetime Model.
@@ -54,12 +55,12 @@ def add_exception(
     pattern: str,
     comments: str,
     expires_at: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> dict[str, Any]:
     """
     Add exceptions to Lifetime Model.
 
-    :param dids:        The list of dids
+    :param dids:        The list of DIDs
     :param account:     The account of the requester.
     :param pattern:     The account.
     :param comments:    The comments associated to the exception.
@@ -94,7 +95,7 @@ def update_exception(
     exception_id: str,
     state: 'LifetimeExceptionsState',
     issuer: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Update exceptions state to Lifetime Model.

rucio/gateway/lock.py

@@ -15,6 +15,7 @@
 import logging
 from typing import TYPE_CHECKING, Any
 
+from rucio.common.constants import DEFAULT_VO
 from rucio.common.types import InternalScope
 from rucio.common.utils import gateway_update_return_dict
 from rucio.core import lock
@@ -33,7 +34,7 @@ LOGGER.setLevel(logging.DEBUG)
 def get_dataset_locks(
     scope: str,
     name: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     Get the dataset locks of a dataset.
@@ -55,7 +56,7 @@ def get_dataset_locks(
 
 def get_dataset_locks_bulk(
     dids: 'Iterable[dict[str, Any]]',
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     Get the dataset locks for multiple datasets or containers.
@@ -68,7 +69,7 @@ def get_dataset_locks_bulk(
     """
 
     if vo is None:
-        vo = "def"
+        vo = DEFAULT_VO
 
     dids_converted = []
     for did_in in dids:
@@ -100,7 +101,7 @@ def get_dataset_locks_bulk(
 
 def get_dataset_locks_by_rse(
     rse: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     Get the dataset locks of an RSE.
@@ -120,7 +121,7 @@ def get_dataset_locks_by_rse(
 
 def get_replica_locks_for_rule_id(
     rule_id: str,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> 'Iterator[dict[str, Any]]':
     """
     Get the replica locks for a rule_id.

rucio/gateway/meta_conventions.py

@@ -14,6 +14,7 @@
 
 from typing import TYPE_CHECKING, Optional, Union
 
+from rucio.common.constants import DEFAULT_VO
 from rucio.common.exception import AccessDenied
 from rucio.core import meta_conventions
 from rucio.db.sqla.constants import DatabaseOperationType
@@ -53,7 +54,7 @@ def add_key(
     issuer: "InternalAccount",
     value_type: Optional[str] = None,
     value_regexp: Optional[str] = None,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Add an allowed key for DID metadata (update the DID Metadata Conventions table with a new key).
@@ -73,7 +74,7 @@ def add_key(
         return meta_conventions.add_key(key=key, key_type=key_type, value_type=value_type, value_regexp=value_regexp, session=session)
 
 
-def add_value(key: str, value: str, issuer: "InternalAccount", vo: str = 'def') -> None:
+def add_value(key: str, value: str, issuer: "InternalAccount", vo: str = DEFAULT_VO) -> None:
     """
     Add an allowed value for DID metadata (update a key in DID Metadata Conventions table).
 

rucio/gateway/permission.py

@@ -15,6 +15,7 @@
 from copy import deepcopy
 from typing import TYPE_CHECKING, Any
 
+from rucio.common.constants import DEFAULT_VO
 from rucio.common.exception import RSENotFound
 from rucio.common.types import InternalAccount, InternalScope
 from rucio.core import permission
@@ -28,7 +29,7 @@ if TYPE_CHECKING:
 
 
 @read_session
-def has_permission(issuer: str, action: str, kwargs: dict[str, Any], vo: str = 'def', *, session: "Session") -> 'PermissionResult':
+def has_permission(issuer: str, action: str, kwargs: dict[str, Any], vo: str = DEFAULT_VO, *, session: "Session") -> 'PermissionResult':
     """
     Checks if an account has the specified permission to
     execute an action with parameters.

rucio/gateway/quarantined_replica.py

@@ -15,6 +15,7 @@
 from typing import TYPE_CHECKING, Any, Optional
 
 from rucio.common import exception
+from rucio.common.constants import DEFAULT_VO
 from rucio.common.types import InternalScope
 from rucio.core.quarantined_replica import add_quarantined_replicas
 from rucio.core.rse import get_rse_id
@@ -31,7 +32,7 @@ def quarantine_file_replicas(
     issuer: str,
     rse: Optional[str] = None,
     rse_id: Optional[str] = None,
-    vo: str = 'def',
+    vo: str = DEFAULT_VO,
 ) -> None:
     """
     Quarantine replicas.