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

rucio/{api → gateway}/did.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,27 +12,40 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from collections.abc import Iterable, Iterator, Mapping, Sequence
 from copy import deepcopy
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Optional
 
-import rucio.api.permission
+import rucio.gateway.permission
 from rucio.common.constants import RESERVED_KEYS
-from rucio.common.exception import RucioException
+from rucio.common.exception import AccessDenied, InvalidObject, RucioException
 from rucio.common.schema import validate_schema
 from rucio.common.types import InternalAccount, InternalScope
-from rucio.common.utils import api_update_return_dict
-from rucio.core import did, naming_convention, meta as meta_core
+from rucio.common.utils import gateway_update_return_dict
+from rucio.core import did, naming_convention
+from rucio.core import meta_conventions as meta_convention_core
 from rucio.core.rse import get_rse_id
 from rucio.db.sqla.constants import DIDType
 from rucio.db.sqla.session import read_session, stream_session, transactional_session
 
 if TYPE_CHECKING:
-    from typing import Any, Optional
     from sqlalchemy.orm import Session
 
 
 @stream_session
-def list_dids(scope, filters, did_type='collection', ignore_case=False, limit=None, offset=None, long=False, recursive=False, vo='def', *, session: "Session"):
+def list_dids(
+    scope: str,
+    filters: Mapping[Any, Any],
+    did_type: str = 'collection',
+    ignore_case: bool = False,
+    limit: Optional[int] = None,
+    offset: Optional[int] = None,
+    long: bool = False,
+    recursive: bool = False,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
     """
     List dids in a scope.
 
@@ -48,7 +60,7 @@ def list_dids(scope, filters, did_type='collection', ignore_case=False, limit=No
     :param vo: The VO to act on.
     :param session: The database session in use.
     """
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
 
     # replace account and scope in filters with internal representation
     for or_group in filters:
@@ -57,15 +69,30 @@ def list_dids(scope, filters, did_type='collection', ignore_case=False, limit=No
         if 'scope' in or_group:
             or_group['account'] = InternalScope(or_group['scope'], vo=vo)
 
-    result = did.list_dids(scope=scope, filters=filters, did_type=did_type, ignore_case=ignore_case,
+    result = did.list_dids(scope=internal_scope, filters=filters, did_type=did_type, ignore_case=ignore_case,
                            limit=limit, offset=offset, long=long, recursive=recursive, session=session)
 
     for d in result:
-        yield api_update_return_dict(d, session=session)
+        yield gateway_update_return_dict(d, session=session)
 
 
 @transactional_session
-def add_did(scope, name, did_type, issuer, account=None, statuses={}, meta={}, rules=[], lifetime=None, dids=[], rse=None, vo='def', *, session: "Session"):
+def add_did(
+    scope: str,
+    name: str,
+    did_type: str,
+    issuer: str,
+    account: Optional[str] = None,
+    statuses: Optional[dict[str, str]] = None,
+    meta: Optional[dict[str, str]] = None,
+    rules: Optional[Sequence[dict[str, Any]]] = None,
+    lifetime: Optional[str] = None,
+    dids: Optional[Sequence[dict[str, Any]]] = None,
+    rse: Optional[str] = None,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Add data did.
 
@@ -83,18 +110,21 @@ def add_did(scope, name, did_type, issuer, account=None, statuses={}, meta={}, r
     :param vo: The VO to act on.
     :param session: The database session in use.
     """
+    statuses = statuses or {}
+    meta = meta or {}
+    rules = rules or []
+    dids = dids or []
     v_did = {'name': name, 'type': did_type.upper(), 'scope': scope}
     validate_schema(name='did', obj=v_did, vo=vo)
     validate_schema(name='dids', obj=dids, vo=vo)
     validate_schema(name='rse', obj=rse, vo=vo)
     kwargs = {'scope': scope, 'name': name, 'type': did_type, 'issuer': issuer, 'account': account, 'statuses': statuses, 'meta': meta, 'rules': rules, 'lifetime': lifetime}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='add_did', kwargs=kwargs, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not add data identifier to scope %s' % (issuer, scope))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='add_did', kwargs=kwargs, session=session):
+        raise AccessDenied('Account %s can not add data identifier to scope %s' % (issuer, scope))
 
-    if account is not None:
-        account = InternalAccount(account, vo=vo)
-    issuer = InternalAccount(issuer, vo=vo)
-    scope = InternalScope(scope, vo=vo)
+    owner_account = None if account is None else InternalAccount(account, vo=vo)
+    issuer_account = InternalAccount(issuer, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
     for d in dids:
         d['scope'] = InternalScope(d['scope'], vo=vo)
     for r in rules:
@@ -106,7 +136,7 @@ def add_did(scope, name, did_type, issuer, account=None, statuses={}, meta={}, r
 
     if did_type == 'DATASET':
         # naming_convention validation
-        extra_meta = naming_convention.validate_name(scope=scope, name=name, did_type='D', session=session)
+        extra_meta = naming_convention.validate_name(scope=internal_scope, name=name, did_type='D', session=session)
 
         # merge extra_meta with meta
         for k in extra_meta or {}:
@@ -114,18 +144,24 @@ def add_did(scope, name, did_type, issuer, account=None, statuses={}, meta={}, r
                 meta[k] = extra_meta[k]
             elif meta[k] != extra_meta[k]:
                 print("Provided metadata %s doesn't match the naming convention: %s != %s" % (k, meta[k], extra_meta[k]))
-                raise rucio.common.exception.InvalidObject("Provided metadata %s doesn't match the naming convention: %s != %s" % (k, meta[k], extra_meta[k]))
+                raise InvalidObject("Provided metadata %s doesn't match the naming convention: %s != %s" % (k, meta[k], extra_meta[k]))
 
         # Validate metadata
-        meta_core.validate_meta(meta=meta, did_type=DIDType[did_type.upper()], session=session)
+        meta_convention_core.validate_meta(meta=meta, did_type=DIDType[did_type.upper()], session=session)
 
-    return did.add_did(scope=scope, name=name, did_type=DIDType[did_type.upper()], account=account or issuer,
+    return did.add_did(scope=internal_scope, name=name, did_type=DIDType[did_type.upper()], account=owner_account or issuer_account,
                        statuses=statuses, meta=meta, rules=rules, lifetime=lifetime,
                        dids=dids, rse_id=rse_id, session=session)
 
 
 @transactional_session
-def add_dids(dids, issuer, vo='def', *, session: "Session"):
+def add_dids(
+    dids: Sequence[dict[str, Any]],
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Bulk Add did.
 
@@ -142,10 +178,10 @@ def add_dids(dids, issuer, vo='def', *, session: "Session"):
             d['rse_id'] = rse_id
 
     kwargs = {'issuer': issuer, 'dids': dids}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='add_dids', kwargs=kwargs, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not bulk add data identifier' % (issuer))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='add_dids', kwargs=kwargs, session=session):
+        raise AccessDenied('Account %s can not bulk add data identifier' % (issuer))
 
-    issuer = InternalAccount(issuer, vo=vo)
+    issuer_account = InternalAccount(issuer, vo=vo)
     for d in dids:
         d['scope'] = InternalScope(d['scope'], vo=vo)
         if 'account' in d.keys():
@@ -153,11 +189,19 @@ def add_dids(dids, issuer, vo='def', *, session: "Session"):
         if 'dids' in d.keys():
             for child in d['dids']:
                 child['scope'] = InternalScope(child['scope'], vo=vo)
-    return did.add_dids(dids, account=issuer, session=session)
+    return did.add_dids(dids, account=issuer_account, session=session)
 
 
 @transactional_session
-def attach_dids(scope, name, attachment, issuer, vo='def', *, session: "Session"):
+def attach_dids(
+    scope: str,
+    name: str,
+    attachment: dict[str, Any],
+    issuer: str,
+    vo='def',
+    *,
+    session: "Session"
+) -> None:
     """
     Append content to data did.
 
@@ -175,11 +219,11 @@ def attach_dids(scope, name, attachment, issuer, vo='def', *, session: "Session"
         attachment['rse_id'] = rse_id
 
     kwargs = {'scope': scope, 'name': name, 'attachment': attachment}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='attach_dids', kwargs=kwargs, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not add data identifiers to %s:%s' % (issuer, scope, name))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='attach_dids', kwargs=kwargs, session=session):
+        raise AccessDenied('Account %s can not add data identifiers to %s:%s' % (issuer, scope, name))
 
-    scope = InternalScope(scope, vo=vo)
-    issuer = InternalAccount(issuer, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
+    issuer_account = InternalAccount(issuer, vo=vo)
     if 'account' in attachment.keys():
         attachment['account'] = InternalAccount(attachment['account'], vo=vo)
     for d in attachment['dids']:
@@ -188,17 +232,24 @@ def attach_dids(scope, name, attachment, issuer, vo='def', *, session: "Session"
             d['account'] = InternalAccount(d['account'], vo=vo)
 
     if rse_id is not None:
-        dids = did.attach_dids(scope=scope, name=name, dids=attachment['dids'],
-                               account=attachment.get('account', issuer), rse_id=rse_id, session=session)
+        dids = did.attach_dids(scope=internal_scope, name=name, dids=attachment['dids'],
+                               account=attachment.get('account', issuer_account), rse_id=rse_id, session=session)
     else:
-        dids = did.attach_dids(scope=scope, name=name, dids=attachment['dids'],
-                               account=attachment.get('account', issuer), session=session)
+        dids = did.attach_dids(scope=internal_scope, name=name, dids=attachment['dids'],
+                               account=attachment.get('account', issuer_account), session=session)
 
     return dids
 
 
 @transactional_session
-def attach_dids_to_dids(attachments, issuer, ignore_duplicate=False, vo='def', *, session: "Session"):
+def attach_dids_to_dids(
+    attachments: Sequence[dict[str, Any]],
+    issuer: str,
+    ignore_duplicate: bool = False,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Append content to dids.
 
@@ -217,10 +268,10 @@ def attach_dids_to_dids(attachments, issuer, ignore_duplicate=False, vo='def', *
                 rse_id = get_rse_id(rse=a['rse'], vo=vo, session=session)
             a['rse_id'] = rse_id
 
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='attach_dids_to_dids', kwargs={'attachments': attachments}, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not add data identifiers' % (issuer))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='attach_dids_to_dids', kwargs={'attachments': attachments}, session=session):
+        raise AccessDenied('Account %s can not add data identifiers' % (issuer))
 
-    issuer = InternalAccount(issuer, vo=vo)
+    issuer_account = InternalAccount(issuer, vo=vo)
     for attachment in attachments:
         attachment['scope'] = InternalScope(attachment['scope'], vo=vo)
         for d in attachment['dids']:
@@ -228,12 +279,20 @@ def attach_dids_to_dids(attachments, issuer, ignore_duplicate=False, vo='def', *
             if 'account' in d.keys():
                 d['account'] = InternalAccount(d['account'], vo=vo)
 
-    return did.attach_dids_to_dids(attachments=attachments, account=issuer,
+    return did.attach_dids_to_dids(attachments=attachments, account=issuer_account,
                                    ignore_duplicate=ignore_duplicate, session=session)
 
 
 @transactional_session
-def detach_dids(scope, name, dids, issuer, vo='def', *, session: "Session"):
+def detach_dids(
+    scope: str,
+    name: str,
+    dids: Sequence[dict[str, Any]],
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Detach data identifier
 
@@ -245,18 +304,26 @@ def detach_dids(scope, name, dids, issuer, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
     kwargs = {'scope': scope, 'name': name, 'dids': dids, 'issuer': issuer}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='detach_dids', kwargs=kwargs, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not detach data identifiers from %s:%s' % (issuer, scope, name))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='detach_dids', kwargs=kwargs, session=session):
+        raise AccessDenied('Account %s can not detach data identifiers from %s:%s' % (issuer, scope, name))
 
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
     for d in dids:
         d['scope'] = InternalScope(d['scope'], vo=vo)
 
-    return did.detach_dids(scope=scope, name=name, dids=dids, session=session)
+    return did.detach_dids(scope=internal_scope, name=name, dids=dids, session=session)
 
 
 @stream_session
-def list_new_dids(did_type=None, thread=None, total_threads=None, chunk_size=1000, vo='def', *, session: "Session"):
+def list_new_dids(
+    did_type: Optional[str] = None,
+    thread: Optional[int] = None,
+    total_threads: Optional[int] = None,
+    chunk_size: int = 1000,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
     """
     List recent identifiers.
 
@@ -270,11 +337,17 @@ def list_new_dids(did_type=None, thread=None, total_threads=None, chunk_size=100
     dids = did.list_new_dids(did_type=did_type and DIDType[did_type.upper()], thread=thread, total_threads=total_threads, chunk_size=chunk_size, session=session)
     for d in dids:
         if d['scope'].vo == vo:
-            yield api_update_return_dict(d, session=session)
+            yield gateway_update_return_dict(d, session=session)
 
 
 @transactional_session
-def set_new_dids(dids, new_flag=True, vo='def', *, session: "Session"):
+def set_new_dids(
+    dids: Sequence[dict[str, Any]],
+    new_flag: bool = True,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> bool:
     """
     Set/reset the flag new
 
@@ -291,7 +364,13 @@ def set_new_dids(dids, new_flag=True, vo='def', *, session: "Session"):
 
 
 @stream_session
-def list_content(scope, name, vo='def', *, session: "Session"):
+def list_content(
+    scope: str,
+    name: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
     """
     List data identifier contents.
 
@@ -301,15 +380,21 @@ def list_content(scope, name, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
 
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
 
-    dids = did.list_content(scope=scope, name=name, session=session)
+    dids = did.list_content(scope=internal_scope, name=name, session=session)
     for d in dids:
-        yield api_update_return_dict(d, session=session)
+        yield gateway_update_return_dict(d, session=session)
 
 
 @stream_session
-def list_content_history(scope, name, vo='def', *, session: "Session"):
+def list_content_history(
+    scope: str,
+    name: str,
+    vo='def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
     """
     List data identifier contents history.
 
@@ -319,16 +404,47 @@ def list_content_history(scope, name, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
 
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
 
-    dids = did.list_content_history(scope=scope, name=name, session=session)
+    dids = did.list_content_history(scope=internal_scope, name=name, session=session)
 
     for d in dids:
-        yield api_update_return_dict(d, session=session)
+        yield gateway_update_return_dict(d, session=session)
 
 
 @stream_session
-def list_files(scope, name, long, vo='def', *, session: "Session"):
+def bulk_list_files(
+    dids: Iterable[dict[str, Any]],
+    long: bool = False,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
+    """
+    List file contents of a list of data identifiers.
+
+    :param dids:       A list of DIDs.
+    :param long:       A boolean to choose if more metadata are returned or not.
+    :param vo:         The VO to act on.
+    :param session:    The database session in use.
+    """
+
+    for did_ in dids:
+        did_['scope'] = InternalScope(did_['scope'], vo=vo)
+
+    for file_ in did.bulk_list_files(dids=dids, long=long, session=session):
+        yield gateway_update_return_dict(file_, session=session)
+
+
+@stream_session
+def list_files(
+    scope: str,
+    name: str,
+    long: bool,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
     """
     List data identifier file contents.
 
@@ -339,16 +455,23 @@ def list_files(scope, name, long, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
 
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
 
-    dids = did.list_files(scope=scope, name=name, long=long, session=session)
+    dids = did.list_files(scope=internal_scope, name=name, long=long, session=session)
 
     for d in dids:
-        yield api_update_return_dict(d, session=session)
+        yield gateway_update_return_dict(d, session=session)
 
 
 @stream_session
-def scope_list(scope, name=None, recursive=False, vo='def', *, session: "Session"):
+def scope_list(
+    scope: str,
+    name: Optional[str] = None,
+    recursive: bool = False,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
     """
     List data identifiers in a scope.
 
@@ -359,9 +482,9 @@ def scope_list(scope, name=None, recursive=False, vo='def', *, session: "Session
     :param session: The database session in use.
     """
 
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
 
-    dids = did.scope_list(scope, name=name, recursive=recursive, session=session)
+    dids = did.scope_list(internal_scope, name=name, recursive=recursive, session=session)
 
     for d in dids:
         ret_did = deepcopy(d)
@@ -372,7 +495,7 @@ def scope_list(scope, name=None, recursive=False, vo='def', *, session: "Session
 
 
 @read_session
-def get_did(scope: str, name: str, dynamic_depth: "Optional[DIDType]" = None, vo: str = 'def', *, session: "Session") -> "dict[str, Any]":
+def get_did(scope: str, name: str, dynamic_depth: Optional[DIDType] = None, vo: str = 'def', *, session: "Session") -> "dict[str, Any]":
     """
     Retrieve a single data did.
 
@@ -386,14 +509,24 @@ def get_did(scope: str, name: str, dynamic_depth: "Optional[DIDType]" = None, vo
     :param session: The database session in use.
     """
 
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
 
-    d = did.get_did(scope=scope, name=name, dynamic_depth=dynamic_depth, session=session)
-    return api_update_return_dict(d, session=session)
+    d = did.get_did(scope=internal_scope, name=name, dynamic_depth=dynamic_depth, session=session)
+    return gateway_update_return_dict(d, session=session)
 
 
 @transactional_session
-def set_metadata(scope, name, key, value, issuer, recursive=False, vo='def', *, session: "Session"):
+def set_metadata(
+    scope: str,
+    name: str,
+    key: str,
+    value: Any,
+    issuer: str,
+    recursive: bool = False,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Add metadata to data did.
 
@@ -409,17 +542,26 @@ def set_metadata(scope, name, key, value, issuer, recursive=False, vo='def', *,
     kwargs = {'scope': scope, 'name': name, 'key': key, 'value': value, 'issuer': issuer}
 
     if key in RESERVED_KEYS:
-        raise rucio.common.exception.AccessDenied('Account %s can not change this metadata value to data identifier %s:%s' % (issuer, scope, name))
+        raise AccessDenied('Account %s can not change this metadata value to data identifier %s:%s' % (issuer, scope, name))
 
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='set_metadata', kwargs=kwargs, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not add metadata to data identifier %s:%s' % (issuer, scope, name))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='set_metadata', kwargs=kwargs, session=session):
+        raise AccessDenied('Account %s can not add metadata to data identifier %s:%s' % (issuer, scope, name))
 
-    scope = InternalScope(scope, vo=vo)
-    return did.set_metadata(scope=scope, name=name, key=key, value=value, recursive=recursive, session=session)
+    internal_scope = InternalScope(scope, vo=vo)
+    return did.set_metadata(scope=internal_scope, name=name, key=key, value=value, recursive=recursive, session=session)
 
 
 @transactional_session
-def set_metadata_bulk(scope, name, meta, issuer, recursive=False, vo='def', *, session: "Session"):
+def set_metadata_bulk(
+    scope: str,
+    name: str,
+    meta: dict[str, Any],
+    issuer: str,
+    recursive: bool = False,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Add metadata to data did.
 
@@ -435,17 +577,24 @@ def set_metadata_bulk(scope, name, meta, issuer, recursive=False, vo='def', *, s
 
     for key in meta:
         if key in RESERVED_KEYS:
-            raise rucio.common.exception.AccessDenied('Account %s can not change the value of the metadata key %s to data identifier %s:%s' % (issuer, key, scope, name))
+            raise AccessDenied('Account %s can not change the value of the metadata key %s to data identifier %s:%s' % (issuer, key, scope, name))
 
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='set_metadata_bulk', kwargs=kwargs, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not add metadata to data identifier %s:%s' % (issuer, scope, name))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='set_metadata_bulk', kwargs=kwargs, session=session):
+        raise AccessDenied('Account %s can not add metadata to data identifier %s:%s' % (issuer, scope, name))
 
-    scope = InternalScope(scope, vo=vo)
-    return did.set_metadata_bulk(scope=scope, name=name, meta=meta, recursive=recursive, session=session)
+    internal_scope = InternalScope(scope, vo=vo)
+    return did.set_metadata_bulk(scope=internal_scope, name=name, meta=meta, recursive=recursive, session=session)
 
 
 @transactional_session
-def set_dids_metadata_bulk(dids, issuer, recursive=False, vo='def', *, session: "Session"):
+def set_dids_metadata_bulk(
+    dids: Iterable[dict[str, Any]],
+    issuer: str,
+    recursive: bool = False,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Add metadata to a list of data identifiers.
 
@@ -458,19 +607,26 @@ def set_dids_metadata_bulk(dids, issuer, recursive=False, vo='def', *, session:
 
     for entry in dids:
         kwargs = {'scope': entry['scope'], 'name': entry['name'], 'meta': entry['meta'], 'issuer': issuer}
-        if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='set_metadata_bulk', kwargs=kwargs, session=session):
-            raise rucio.common.exception.AccessDenied('Account %s can not add metadata to data identifier %s:%s' % (issuer, entry['scope'], entry['name']))
+        if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='set_metadata_bulk', kwargs=kwargs, session=session):
+            raise AccessDenied('Account %s can not add metadata to data identifier %s:%s' % (issuer, entry['scope'], entry['name']))
         entry['scope'] = InternalScope(entry['scope'], vo=vo)
         meta = entry['meta']
         for key in meta:
             if key in RESERVED_KEYS:
-                raise rucio.common.exception.AccessDenied('Account %s can not change the value of the metadata key %s to data identifier %s:%s' % (issuer, key, entry['scope'], entry['name']))
+                raise AccessDenied('Account %s can not change the value of the metadata key %s to data identifier %s:%s' % (issuer, key, entry['scope'], entry['name']))
 
     return did.set_dids_metadata_bulk(dids=dids, recursive=recursive, session=session)
 
 
 @read_session
-def get_metadata(scope, name, plugin='DID_COLUMN', vo='def', *, session: "Session"):
+def get_metadata(
+    scope: str,
+    name: str,
+    plugin: str = 'DID_COLUMN',
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> dict[str, Any]:
     """
     Get data identifier metadata
 
@@ -480,14 +636,20 @@ def get_metadata(scope, name, plugin='DID_COLUMN', vo='def', *, session: "Sessio
     :param session: The database session in use.
     """
 
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
 
-    d = did.get_metadata(scope=scope, name=name, plugin=plugin, session=session)
-    return api_update_return_dict(d, session=session)
+    d = did.get_metadata(scope=internal_scope, name=name, plugin=plugin, session=session)
+    return gateway_update_return_dict(d, session=session)
 
 
 @stream_session
-def get_metadata_bulk(dids, inherit=False, vo='def', *, session: "Session"):
+def get_metadata_bulk(
+    dids: Iterable[dict[str, Any]],
+    inherit: bool = False,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
     """
     Get metadata for a list of dids
     :param dids:               A list of dids.
@@ -501,11 +663,18 @@ def get_metadata_bulk(dids, inherit=False, vo='def', *, session: "Session"):
         entry['scope'] = InternalScope(entry['scope'], vo=vo)
     meta = did.get_metadata_bulk(dids, inherit=inherit, session=session)
     for met in meta:
-        yield api_update_return_dict(met, session=session)
+        yield gateway_update_return_dict(met, session=session)
 
 
 @transactional_session
-def delete_metadata(scope, name, key, vo='def', *, session: "Session"):
+def delete_metadata(
+    scope: str,
+    name: str,
+    key: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Delete a key from the metadata column
 
@@ -516,12 +685,20 @@ def delete_metadata(scope, name, key, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
 
-    scope = InternalScope(scope, vo=vo)
-    return did.delete_metadata(scope=scope, name=name, key=key, session=session)
+    internal_scope = InternalScope(scope, vo=vo)
+    return did.delete_metadata(scope=internal_scope, name=name, key=key, session=session)
 
 
 @transactional_session
-def set_status(scope, name, issuer, vo='def', *, session: "Session", **kwargs):
+def set_status(
+    scope: str,
+    name: str,
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session",
+    **kwargs
+) -> None:
     """
     Set data identifier status
 
@@ -533,16 +710,21 @@ def set_status(scope, name, issuer, vo='def', *, session: "Session", **kwargs):
     :param session: The database session in use.
     """
 
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='set_status', kwargs={'scope': scope, 'name': name, 'issuer': issuer}, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not set status on data identifier %s:%s' % (issuer, scope, name))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='set_status', kwargs={'scope': scope, 'name': name, 'issuer': issuer}, session=session):
+        raise AccessDenied('Account %s can not set status on data identifier %s:%s' % (issuer, scope, name))
 
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
 
-    return did.set_status(scope=scope, name=name, session=session, **kwargs)
+    return did.set_status(scope=internal_scope, name=name, session=session, **kwargs)
 
 
 @stream_session
-def get_dataset_by_guid(guid, vo='def', *, session: "Session"):
+def get_dataset_by_guid(
+    guid: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
     """
     Get the parent datasets for a given GUID.
     :param guid: The GUID.
@@ -556,11 +738,17 @@ def get_dataset_by_guid(guid, vo='def', *, session: "Session"):
     for d in dids:
         if d['scope'].vo != vo:
             raise RucioException('GUID unavailable on VO {}'.format(vo))
-        yield api_update_return_dict(d, session=session)
+        yield gateway_update_return_dict(d, session=session)
 
 
 @stream_session
-def list_parent_dids(scope, name, vo='def', *, session: "Session"):
+def list_parent_dids(
+    scope: str,
+    name: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
     """
     List parent datasets and containers of a did.
 
@@ -570,16 +758,26 @@ def list_parent_dids(scope, name, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
 
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
 
-    dids = did.list_parent_dids(scope=scope, name=name, session=session)
+    dids = did.list_parent_dids(scope=internal_scope, name=name, session=session)
 
     for d in dids:
-        yield api_update_return_dict(d, session=session)
+        yield gateway_update_return_dict(d, session=session)
 
 
 @transactional_session
-def create_did_sample(input_scope, input_name, output_scope, output_name, issuer, nbfiles, vo='def', *, session: "Session"):
+def create_did_sample(
+    input_scope: str,
+    input_name: str,
+    output_scope: str,
+    output_name: str,
+    issuer: str,
+    nbfiles: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+):
     """
     Create a sample from an input collection.
 
@@ -594,20 +792,26 @@ def create_did_sample(input_scope, input_name, output_scope, output_name, issuer
     :param session: The database session in use.
     """
     kwargs = {'issuer': issuer, 'scope': output_scope}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='create_did_sample', kwargs=kwargs, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not bulk add data identifier' % (issuer))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='create_did_sample', kwargs=kwargs, session=session):
+        raise AccessDenied('Account %s can not bulk add data identifier' % (issuer))
 
-    input_scope = InternalScope(input_scope, vo=vo)
-    output_scope = InternalScope(output_scope, vo=vo)
+    input_internal_scope = InternalScope(input_scope, vo=vo)
+    output_internal_scope = InternalScope(output_scope, vo=vo)
 
-    issuer = InternalAccount(issuer, vo=vo)
+    issuer_account = InternalAccount(issuer, vo=vo)
 
-    return did.create_did_sample(input_scope=input_scope, input_name=input_name, output_scope=output_scope, output_name=output_name,
-                                 account=issuer, nbfiles=nbfiles, session=session)
+    return did.create_did_sample(input_scope=input_internal_scope, input_name=input_name, output_scope=output_internal_scope, output_name=output_name,
+                                 account=issuer_account, nbfiles=nbfiles, session=session)
 
 
 @transactional_session
-def resurrect(dids, issuer, vo='def', *, session: "Session"):
+def resurrect(
+    dids: Iterable[dict[str, Any]],
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Resurrect DIDs.
 
@@ -617,8 +821,8 @@ def resurrect(dids, issuer, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
     kwargs = {'issuer': issuer}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='resurrect', kwargs=kwargs, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not resurrect data identifiers' % (issuer))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='resurrect', kwargs=kwargs, session=session):
+        raise AccessDenied('Account %s can not resurrect data identifiers' % (issuer))
     validate_schema(name='dids', obj=dids, vo=vo)
 
     for d in dids:
@@ -628,7 +832,13 @@ def resurrect(dids, issuer, vo='def', *, session: "Session"):
 
 
 @stream_session
-def list_archive_content(scope, name, vo='def', *, session: "Session"):
+def list_archive_content(
+    scope: str,
+    name: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> Iterator[dict[str, Any]]:
     """
     List archive contents.
 
@@ -638,15 +848,22 @@ def list_archive_content(scope, name, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
 
-    scope = InternalScope(scope, vo=vo)
+    internal_scope = InternalScope(scope, vo=vo)
 
-    dids = did.list_archive_content(scope=scope, name=name, session=session)
+    dids = did.list_archive_content(scope=internal_scope, name=name, session=session)
     for d in dids:
-        yield api_update_return_dict(d, session=session)
+        yield gateway_update_return_dict(d, session=session)
 
 
 @transactional_session
-def add_did_to_followed(scope, name, account, *, session: "Session", vo='def'):
+def add_did_to_followed(
+    scope: str,
+    name: str,
+    account: str,
+    *,
+    session: "Session",
+    vo: str = 'def'
+) -> None:
     """
     Mark a did as followed by the given account
 
@@ -655,13 +872,19 @@ def add_did_to_followed(scope, name, account, *, session: "Session", vo='def'):
     :param account: The account owner.
     :param session: The database session in use.
     """
-    scope = InternalScope(scope, vo=vo)
-    account = InternalAccount(account, vo=vo)
-    return did.add_did_to_followed(scope=scope, name=name, account=account, session=session)
+    internal_scope = InternalScope(scope, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
+    return did.add_did_to_followed(scope=internal_scope, name=name, account=internal_account, session=session)
 
 
 @transactional_session
-def add_dids_to_followed(dids, account, *, session: "Session", vo='def'):
+def add_dids_to_followed(
+    dids: Iterable[Mapping[str, Any]],
+    account: str,
+    *,
+    session: "Session",
+    vo: str = 'def'
+) -> None:
     """
     Bulk mark datasets as followed
 
@@ -669,12 +892,18 @@ def add_dids_to_followed(dids, account, *, session: "Session", vo='def'):
     :param account: The account owner.
     :param session: The database session in use.
     """
-    account = InternalAccount(account, vo=vo)
-    return did.add_dids_to_followed(dids=dids, account=account, session=session)
+    internal_account = InternalAccount(account, vo=vo)
+    return did.add_dids_to_followed(dids=dids, account=internal_account, session=session)
 
 
 @stream_session
-def get_users_following_did(name, scope, *, session: "Session", vo='def'):
+def get_users_following_did(
+    name: str,
+    scope: str,
+    *,
+    session: "Session",
+    vo: str = 'def'
+) -> Iterator[dict[str, str]]:
     """
     Return list of users following a did
 
@@ -682,15 +911,23 @@ def get_users_following_did(name, scope, *, session: "Session", vo='def'):
     :param name: The data identifier name.
     :param session: The database session in use.
     """
-    scope = InternalScope(scope, vo=vo)
-    users = did.get_users_following_did(name=name, scope=scope, session=session)
+    internal_scope = InternalScope(scope, vo=vo)
+    users = did.get_users_following_did(name=name, scope=internal_scope, session=session)
     for user in users:
         user['user'] = user['user'].external
         yield user
 
 
 @transactional_session
-def remove_did_from_followed(scope, name, account, issuer, *, session: "Session", vo='def'):
+def remove_did_from_followed(
+    scope: str,
+    name: str,
+    account: str,
+    issuer: str,
+    *,
+    session: "Session",
+    vo: str = 'def'
+) -> None:
     """
     Mark a did as not followed
 
@@ -701,16 +938,23 @@ def remove_did_from_followed(scope, name, account, issuer, *, session: "Session"
     :param issuer: The issuer account
     """
     kwargs = {'scope': scope, 'issuer': issuer}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='remove_did_from_followed', kwargs=kwargs, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not remove data identifiers from followed table' % (issuer))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='remove_did_from_followed', kwargs=kwargs, session=session):
+        raise AccessDenied('Account %s can not remove data identifiers from followed table' % (issuer))
 
-    scope = InternalScope(scope, vo=vo)
-    account = InternalAccount(account, vo=vo)
-    return did.remove_did_from_followed(scope=scope, name=name, account=account, session=session)
+    internal_scope = InternalScope(scope, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
+    return did.remove_did_from_followed(scope=internal_scope, name=name, account=internal_account, session=session)
 
 
 @transactional_session
-def remove_dids_from_followed(dids, account, issuer, *, session: "Session", vo='def'):
+def remove_dids_from_followed(
+    dids: Iterable[Mapping[str, Any]],
+    account: str,
+    issuer: str,
+    *,
+    session: "Session",
+    vo: str = 'def'
+) -> None:
     """
     Bulk mark datasets as not followed
 
@@ -719,8 +963,8 @@ def remove_dids_from_followed(dids, account, issuer, *, session: "Session", vo='
     :param session: The database session in use.
     """
     kwargs = {'dids': dids, 'issuer': issuer}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='remove_dids_from_followed', kwargs=kwargs, session=session):
-        raise rucio.common.exception.AccessDenied('Account %s can not bulk remove data identifiers from followed table' % (issuer))
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='remove_dids_from_followed', kwargs=kwargs, session=session):
+        raise AccessDenied('Account %s can not bulk remove data identifiers from followed table' % (issuer))
 
-    account = InternalAccount(account, vo=vo)
-    return did.remove_dids_from_followed(dids=dids, account=account, session=session)
+    internal_account = InternalAccount(account, vo=vo)
+    return did.remove_dids_from_followed(dids=dids, account=internal_account, session=session)