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

rucio/{api → gateway}/quarantined_replica.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,21 +12,31 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Optional
 
-from rucio.api import permission
 from rucio.common import exception
 from rucio.common.types import InternalScope
 from rucio.core.quarantined_replica import add_quarantined_replicas
 from rucio.core.rse import get_rse_id
 from rucio.db.sqla.session import transactional_session
+from rucio.gateway import permission
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable
+
     from sqlalchemy.orm import Session
 
 
 @transactional_session
-def quarantine_file_replicas(replicas, issuer, rse=None, rse_id=None, vo='def', *, session: "Session"):
+def quarantine_file_replicas(
+    replicas: "Iterable[dict[str, Any]]",
+    issuer: str,
+    rse: Optional[str] = None,
+    rse_id: Optional[str] = None,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Quarantine replicas.
 

rucio/{api → gateway}/replica.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright European Organization for Nuclear Research (CERN) since 2012
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,18 +13,19 @@
 # limitations under the License.
 
 import datetime
-from typing import TYPE_CHECKING
+from collections.abc import Iterator
+from typing import TYPE_CHECKING, Any, Optional
 
-from rucio.api import permission
 from rucio.common import exception
 from rucio.common.constants import SuspiciousAvailability
 from rucio.common.schema import validate_schema
 from rucio.common.types import InternalAccount, InternalScope
-from rucio.common.utils import api_update_return_dict, invert_dict
+from rucio.common.utils import gateway_update_return_dict, invert_dict
 from rucio.core import replica
 from rucio.core.rse import get_rse_id, get_rse_name
 from rucio.db.sqla.constants import BadFilesStatus
 from rucio.db.sqla.session import read_session, stream_session, transactional_session
+from rucio.gateway import permission
 
 if TYPE_CHECKING:
     from sqlalchemy.orm import Session
@@ -42,7 +42,7 @@ def get_bad_replicas_summary(rse_expression=None, from_date=None, to_date=None,
     :param session: The database session in use.
     """
     replicas = replica.get_bad_replicas_summary(rse_expression=rse_expression, from_date=from_date, to_date=to_date, filter_={'vo': vo}, session=session)
-    return [api_update_return_dict(r, session=session) for r in replicas]
+    return [gateway_update_return_dict(r, session=session) for r in replicas]
 
 
 @read_session
@@ -63,7 +63,7 @@ def list_bad_replicas_status(state=BadFilesStatus.BAD, rse=None, younger_than=No
 
     replicas = replica.list_bad_replicas_status(state=state, rse_id=rse_id, younger_than=younger_than,
                                                 older_than=older_than, limit=limit, list_pfns=list_pfns, vo=vo, session=session)
-    return [api_update_return_dict(r, session=session) for r in replicas]
+    return [gateway_update_return_dict(r, session=session) for r in replicas]
 
 
 @transactional_session
@@ -396,7 +396,7 @@ def list_dataset_replicas_bulk(dids, vo='def', *, session: "Session"):
     replicas = replica.list_dataset_replicas_bulk(names_by_intscope, session=session)
 
     for r in replicas:
-        yield api_update_return_dict(r, session=session)
+        yield gateway_update_return_dict(r, session=session)
 
 
 @stream_session
@@ -415,11 +415,11 @@ def list_dataset_replicas_vp(scope, name, deep=False, vo='def', *, session: "Ses
 
     scope = InternalScope(scope, vo=vo)
     for r in replica.list_dataset_replicas_vp(scope=scope, name=name, deep=deep, session=session):
-        yield api_update_return_dict(r, session=session)
+        yield gateway_update_return_dict(r, session=session)
 
 
 @stream_session
-def list_datasets_per_rse(rse, filters={}, limit=None, vo='def', *, session: "Session"):
+def list_datasets_per_rse(rse: str, filters: Optional[dict[str, Any]] = None, limit: Optional[int] = None, vo: str = 'def', *, session: "Session") -> Iterator[dict[str, Any]]:
     """
     :param scope: The scope of the dataset.
     :param name: The name of the dataset.
@@ -431,11 +431,12 @@ def list_datasets_per_rse(rse, filters={}, limit=None, vo='def', *, session: "Se
     :returns: A list of dict dataset replicas
     """
 
+    filters = filters or {}
     rse_id = get_rse_id(rse=rse, vo=vo, session=session)
     if 'scope' in filters:
         filters['scope'] = InternalScope(filters['scope'], vo=vo)
     for r in replica.list_datasets_per_rse(rse_id, filters=filters, limit=limit, session=session):
-        yield api_update_return_dict(r, session=session)
+        yield gateway_update_return_dict(r, session=session)
 
 
 @transactional_session
@@ -503,7 +504,7 @@ def get_suspicious_files(rse_expression, younger_than=None, nattempts=None, vo='
     """
     replicas = replica.get_suspicious_files(rse_expression=rse_expression, available_elsewhere=SuspiciousAvailability["ALL"].value,
                                             younger_than=younger_than, nattempts=nattempts, filter_={'vo': vo}, session=session)
-    return [api_update_return_dict(r, session=session) for r in replicas]
+    return [gateway_update_return_dict(r, session=session) for r in replicas]
 
 
 @transactional_session

rucio/{api → gateway}/request.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");
@@ -17,22 +16,32 @@
 Interface for the requests abstraction layer
 """
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Optional
 
-from rucio.api import permission
 from rucio.common import exception
-from rucio.common.types import InternalAccount, InternalScope
-from rucio.common.utils import api_update_return_dict
+from rucio.common.types import InternalAccount, InternalScope, RequestGatewayDict
+from rucio.common.utils import gateway_update_return_dict
 from rucio.core import request
 from rucio.core.rse import get_rse_id
 from rucio.db.sqla.session import read_session, stream_session, transactional_session
+from rucio.gateway import permission
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable, Iterator, Sequence
+
     from sqlalchemy.orm import Session
 
+    from rucio.db.sqla.constants import RequestState, RequestType
+
 
 @transactional_session
-def queue_requests(requests, issuer, vo='def', *, session: "Session"):
+def queue_requests(
+    requests: "Iterable[RequestGatewayDict]",
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> list[dict[str, Any]]:
     """
     Submit transfer or deletion requests on destination RSEs for data identifiers.
 
@@ -48,16 +57,23 @@ def queue_requests(requests, issuer, vo='def', *, session: "Session"):
         raise exception.AccessDenied(f'{issuer} can not queue request')
 
     for req in requests:
-        req['scope'] = InternalScope(req['scope'], vo=vo)
+        req['scope'] = InternalScope(req['scope'], vo=vo)  # type: ignore (type reassignment)
         if 'account' in req:
-            req['account'] = InternalAccount(req['account'], vo=vo)
+            req['account'] = InternalAccount(req['account'], vo=vo)  # type: ignore (type reassignment)
 
     new_requests = request.queue_requests(requests, session=session)
-    return [api_update_return_dict(r, session=session) for r in new_requests]
+    return [gateway_update_return_dict(r, session=session) for r in new_requests]
 
 
 @transactional_session
-def cancel_request(request_id, issuer, account, vo='def', *, session: "Session"):
+def cancel_request(
+    request_id: str,
+    issuer: str,
+    account: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Cancel a request.
 
@@ -76,7 +92,17 @@ def cancel_request(request_id, issuer, account, vo='def', *, session: "Session")
 
 
 @transactional_session
-def cancel_request_did(scope, name, dest_rse, request_type, issuer, account, vo='def', *, session: "Session"):
+def cancel_request_did(
+    scope: str,
+    name: str,
+    dest_rse: str,
+    request_type: str,
+    issuer: str,
+    account: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> dict[str, Any]:
     """
     Cancel a request based on a DID and request type.
 
@@ -96,12 +122,20 @@ def cancel_request_did(scope, name, dest_rse, request_type, issuer, account, vo=
     if not permission.has_permission(issuer=issuer, vo=vo, action='cancel_request_did', kwargs=kwargs, session=session):
         raise exception.AccessDenied(f'{account} cannot cancel {request_type} request for {scope}:{name}')
 
-    scope = InternalScope(scope, vo=vo)
-    return request.cancel_request_did(scope, name, dest_rse_id, request_type, session=session)
+    internal_scope = InternalScope(scope, vo=vo)
+    return request.cancel_request_did(internal_scope, name, dest_rse_id, request_type, session=session)
 
 
 @transactional_session
-def get_next(request_type, state, issuer, account, vo='def', *, session: "Session"):
+def get_next(
+    request_type: "RequestType",
+    state: "RequestState",
+    issuer: str,
+    account: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> list[dict[str, Any]]:
     """
     Retrieve the next request matching the request type and state.
 
@@ -119,11 +153,19 @@ def get_next(request_type, state, issuer, account, vo='def', *, session: "Sessio
         raise exception.AccessDenied(f'{account} cannot get the next request of type {request_type} in state {state}')
 
     reqs = request.get_and_mark_next(request_type, state, session=session)
-    return [api_update_return_dict(r, session=session) for r in reqs]
+    return [gateway_update_return_dict(r, session=session) for r in reqs]
 
 
 @read_session
-def get_request_by_did(scope, name, rse, issuer, vo='def', *, session: "Session"):
+def get_request_by_did(
+    scope: str,
+    name: str,
+    rse: str,
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> dict[str, Any]:
     """
     Retrieve a request by its DID for a destination RSE.
 
@@ -141,14 +183,22 @@ def get_request_by_did(scope, name, rse, issuer, vo='def', *, session: "Session"
     if not permission.has_permission(issuer=issuer, vo=vo, action='get_request_by_did', kwargs=kwargs, session=session):
         raise exception.AccessDenied(f'{issuer} cannot retrieve the request DID {scope}:{name} to RSE {rse}')
 
-    scope = InternalScope(scope, vo=vo)
-    req = request.get_request_by_did(scope, name, rse_id, session=session)
+    internal_scope = InternalScope(scope, vo=vo)
+    req = request.get_request_by_did(internal_scope, name, rse_id, session=session)
 
-    return api_update_return_dict(req, session=session)
+    return gateway_update_return_dict(req, session=session)
 
 
 @read_session
-def get_request_history_by_did(scope, name, rse, issuer, vo='def', *, session: "Session"):
+def get_request_history_by_did(
+    scope: str,
+    name: str,
+    rse: str,
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> dict[str, Any]:
     """
     Retrieve a historical request by its DID for a destination RSE.
 
@@ -166,14 +216,22 @@ def get_request_history_by_did(scope, name, rse, issuer, vo='def', *, session: "
     if not permission.has_permission(issuer=issuer, vo=vo, action='get_request_history_by_did', kwargs=kwargs, session=session):
         raise exception.AccessDenied(f'{issuer} cannot retrieve the request DID {scope}:{name} to RSE {rse}')
 
-    scope = InternalScope(scope, vo=vo)
-    req = request.get_request_history_by_did(scope, name, rse_id, session=session)
+    internal_scope = InternalScope(scope, vo=vo)
+    req = request.get_request_history_by_did(internal_scope, name, rse_id, session=session)
 
-    return api_update_return_dict(req, session=session)
+    return gateway_update_return_dict(req, session=session)
 
 
 @stream_session
-def list_requests(src_rses, dst_rses, states, issuer, vo='def', *, session: "Session"):
+def list_requests(
+    src_rses: "Iterable[str]",
+    dst_rses: "Iterable[str]",
+    states: "Sequence[RequestState]",
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> "Iterator[dict[str, Any]]":
     """
     List all requests in a specific state from a source RSE to a destination RSE.
 
@@ -192,14 +250,23 @@ def list_requests(src_rses, dst_rses, states, issuer, vo='def', *, session: "Ses
 
     for req in request.list_requests(src_rse_ids, dst_rse_ids, states, session=session):
         req = req.to_dict()
-        yield api_update_return_dict(req, session=session)
+        yield gateway_update_return_dict(req, session=session)
 
 
 @stream_session
-def list_requests_history(src_rses, dst_rses, states, issuer, vo='def', offset=None, limit=None, *, session: "Session"):
+def list_requests_history(
+    src_rses: "Iterable[str]",
+    dst_rses: "Iterable[str]",
+    states: "Sequence[RequestState]",
+    issuer: str,
+    vo: str = 'def',
+    offset: Optional[int] = None,
+    limit: Optional[int] = None,
+    *,
+    session: "Session"
+) -> "Iterator[dict[str, Any]]":
     """
     List all historical requests in a specific state from a source RSE to a destination RSE.
-
     :param src_rses: source RSEs.
     :param dst_rses: destination RSEs.
     :param states: list of request states.
@@ -217,4 +284,38 @@ def list_requests_history(src_rses, dst_rses, states, issuer, vo='def', offset=N
 
     for req in request.list_requests_history(src_rse_ids, dst_rse_ids, states, offset, limit, session=session):
         req = req.to_dict()
-        yield api_update_return_dict(req, session=session)
+        yield gateway_update_return_dict(req, session=session)
+
+
+@read_session
+def get_request_metrics(
+    src_rse: Optional[str],
+    dst_rse: Optional[str],
+    activity: Optional[str],
+    group_by_rse_attribute: Optional[str],
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> dict[str, Any]:
+    """
+    Get statistics of requests in a specific state grouped by source RSE, destination RSE, and activity.
+
+    :param src_rse: source RSE.
+    :param dst_rse: destination RSE.
+    :param activity: activity
+    :param group_by_rse_attribute: The parameter to group the RSEs by.
+    :param issuer: Issuing account as a string.
+    :param session: The database session in use.
+    """
+    src_rse_id = None
+    if src_rse:
+        src_rse_id = get_rse_id(rse=src_rse, vo=vo, session=session)
+    dst_rse_id = None
+    if dst_rse:
+        dst_rse_id = get_rse_id(rse=dst_rse, vo=vo, session=session)
+    kwargs = {'issuer': issuer}
+    if not permission.has_permission(issuer=issuer, vo=vo, action='get_request_metrics', kwargs=kwargs, session=session):
+        raise exception.AccessDenied(f'{issuer} cannot get request statistics')
+
+    return request.get_request_metrics(dest_rse_id=dst_rse_id, src_rse_id=src_rse_id, activity=activity, group_by_rse_attribute=group_by_rse_attribute, session=session)

rucio/{api → gateway}/rse.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,19 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
-from rucio.api import permission
 from rucio.common import exception
 from rucio.common.schema import validate_schema
-from rucio.common.utils import api_update_return_dict
+from rucio.common.utils import gateway_update_return_dict
 from rucio.core import distance as distance_module
 from rucio.core import rse as rse_module
 from rucio.core.rse_expression_parser import parse_expression
 from rucio.db.sqla.session import read_session, stream_session, transactional_session
+from rucio.gateway import permission
 
 if TYPE_CHECKING:
     from typing import Optional
+
     from sqlalchemy.orm import Session
 
 
@@ -109,7 +109,7 @@ def del_rse(rse, issuer, vo='def', *, session: "Session"):
 
 
 @read_session
-def list_rses(filters={}, vo='def', *, session: "Session"):
+def list_rses(filters: "Optional[dict[str, Any]]" = None, vo: str = 'def', *, session: "Session") -> list[dict[str, Any]]:
     """
     Lists all RSEs.
 
@@ -119,8 +119,7 @@ def list_rses(filters={}, vo='def', *, session: "Session"):
 
     :returns: List of all RSEs.
     """
-    if not filters:
-        filters = {}
+    filters = filters or {}
 
     filters['vo'] = vo
 
@@ -243,7 +242,7 @@ def get_rse_protocols(rse, issuer, vo='def', *, session: "Session"):
     :param vo: The VO to act on.
     :param session: The database session in use.
 
-    :returns: A dict with all supported protocols and their attibutes.
+    :returns: A dict with all supported protocols and their attributes.
     """
     rse_id = rse_module.get_rse_id(rse=rse, vo=vo, session=session)
     return rse_module.get_rse_protocols(rse_id, session=session)
@@ -338,7 +337,7 @@ def get_rse_usage(rse, issuer, source=None, per_account=False, vo='def', *, sess
         if 'account_usages' in u:
             for account_usage in u['account_usages']:
                 account_usage['account'] = account_usage['account'].external
-    return [api_update_return_dict(u, session=session) for u in usages]
+    return [gateway_update_return_dict(u, session=session) for u in usages]
 
 
 @stream_session
@@ -356,7 +355,7 @@ def list_rse_usage_history(rse, issuer, source=None, vo='def', *, session: "Sess
     """
     rse_id = rse_module.get_rse_id(rse=rse, vo=vo, session=session)
     for u in rse_module.list_rse_usage_history(rse_id=rse_id, source=source, session=session):
-        yield api_update_return_dict(u, session=session)
+        yield gateway_update_return_dict(u, session=session)
 
 
 @transactional_session
@@ -440,7 +439,7 @@ def update_rse(rse, parameters, issuer, vo='def', *, session: "Session"):
     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).
     :param issuer: The issuer account.
     :param vo: The VO to act on.
     :param session: The database session in use.
@@ -516,7 +515,7 @@ def get_distance(source, destination, issuer, vo='def', *, session: "Session"):
                                               dest_rse_id=rse_module.get_rse_id(destination, vo=vo, session=session),
                                               session=session)
 
-    return [api_update_return_dict(d, session=session) for d in distances]
+    return [gateway_update_return_dict(d, session=session) for d in distances]
 
 
 @transactional_session