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

rucio/gateway/__init__.py

@@ -0,0 +1,13 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

rucio/{api → gateway}/account.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,14 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import TYPE_CHECKING
+from collections.abc import Iterator
+from typing import TYPE_CHECKING, Any, Optional
 
-import rucio.api.permission
 import rucio.common.exception
 import rucio.core.identity
+import rucio.gateway.permission
 from rucio.common.schema import validate_schema
 from rucio.common.types import InternalAccount
-from rucio.common.utils import api_update_return_dict
+from rucio.common.utils import gateway_update_return_dict
 from rucio.core import account as account_core
 from rucio.core.rse import get_rse_id
 from rucio.db.sqla.constants import AccountType
@@ -29,9 +29,20 @@ from rucio.db.sqla.session import read_session, stream_session, transactional_se
 if TYPE_CHECKING:
     from sqlalchemy.orm import Session
 
+    from rucio.common.types import AccountAttributesDict, IdentityDict, UsageDict
+    from rucio.db.sqla.models import Account
+
 
 @transactional_session
-def add_account(account, type_, email, issuer, vo='def', *, session: "Session"):
+def add_account(
+    account: str,
+    type_: str,
+    email: str,
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Creates an account with the provided account name, contact information, etc.
 
@@ -48,16 +59,22 @@ def add_account(account, type_, email, issuer, vo='def', *, session: "Session"):
     validate_schema(name='account', obj=account, vo=vo)
 
     kwargs = {'account': account, 'type': type_}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='add_account', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='add_account', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not add account' % (issuer))
 
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    account_core.add_account(account, AccountType[type_.upper()], email, session=session)
+    account_core.add_account(internal_account, AccountType[type_.upper()], email, session=session)
 
 
 @transactional_session
-def del_account(account, issuer, vo='def', *, session: "Session"):
+def del_account(
+    account: str,
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Disables an account with the provided account name.
 
@@ -68,16 +85,21 @@ def del_account(account, issuer, vo='def', *, session: "Session"):
 
     """
     kwargs = {'account': account}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='del_account', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='del_account', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not delete account' % (issuer))
 
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    account_core.del_account(account, session=session)
+    account_core.del_account(internal_account, session=session)
 
 
 @read_session
-def get_account_info(account, vo='def', *, session: "Session"):
+def get_account_info(
+    account: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> "Account":
     """
     Returns the info like the statistics information associated to an account_core.
 
@@ -87,15 +109,23 @@ def get_account_info(account, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
 
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    acc = account_core.get_account(account, session=session)
+    acc = account_core.get_account(internal_account, session=session)
     acc.account = acc.account.external
     return acc
 
 
 @transactional_session
-def update_account(account, key, value, issuer='root', vo='def', *, session: "Session"):
+def update_account(
+    account: str,
+    key: str,
+    value: Any,
+    issuer: str = 'root',
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """ Update a property of an account_core.
 
     :param account: Name of the account_core.
@@ -107,16 +137,16 @@ def update_account(account, key, value, issuer='root', vo='def', *, session: "Se
     """
     validate_schema(name='account', obj=account, vo=vo)
     kwargs = {}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='update_account', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='update_account', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not change %s  of the account' % (issuer, key))
 
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    return account_core.update_account(account, key, value, session=session)
+    return account_core.update_account(internal_account, key, value, session=session)
 
 
 @stream_session
-def list_accounts(filter_={}, vo='def', *, session: "Session"):
+def list_accounts(filter_: Optional[dict[str, Any]] = None, vo: str = 'def', *, session: "Session") -> Iterator[dict[str, Any]]:
     """
     Lists all the Rucio account names.
 
@@ -129,19 +159,23 @@ def list_accounts(filter_={}, vo='def', *, session: "Session"):
     :returns: List of all accounts.
     """
     # If filter is empty, create a new dict to avoid overwriting the function's default
-    if not filter_:
-        filter_ = {}
+    filter_ = filter_ or {}
 
     if 'account' in filter_:
         filter_['account'] = InternalAccount(filter_['account'], vo=vo)
     else:
         filter_['account'] = InternalAccount(account='*', vo=vo)
     for result in account_core.list_accounts(filter_=filter_, session=session):
-        yield api_update_return_dict(result, session=session)
+        yield gateway_update_return_dict(result, session=session)
 
 
 @read_session
-def account_exists(account, vo='def', *, session: "Session"):
+def account_exists(
+    account: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> bool:
     """
     Checks to see if account exists. This procedure does not check it's status.
 
@@ -151,13 +185,18 @@ def account_exists(account, vo='def', *, session: "Session"):
     :returns: True if found, otherwise false.
     """
 
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    return account_core.account_exists(account, session=session)
+    return account_core.account_exists(internal_account, session=session)
 
 
 @read_session
-def list_identities(account, vo='def', *, session: "Session"):
+def list_identities(
+    account: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> list["IdentityDict"]:
     """
     List all identities on an account_core.
 
@@ -166,13 +205,18 @@ def list_identities(account, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
 
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    return account_core.list_identities(account, session=session)
+    return account_core.list_identities(internal_account, session=session)
 
 
 @read_session
-def list_account_attributes(account, vo='def', *, session: "Session"):
+def list_account_attributes(
+    account: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> list["AccountAttributesDict"]:
     """
     Returns all the attributes for the given account.
 
@@ -181,13 +225,21 @@ def list_account_attributes(account, vo='def', *, session: "Session"):
     :param session: The database session in use.
     """
 
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    return account_core.list_account_attributes(account, session=session)
+    return account_core.list_account_attributes(internal_account, session=session)
 
 
 @transactional_session
-def add_account_attribute(key, value, account, issuer, vo='def', *, session: "Session"):
+def add_account_attribute(
+    key: str,
+    value: Any,
+    account: str,
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Add an attribute to an account.
 
@@ -202,16 +254,23 @@ def add_account_attribute(key, value, account, issuer, vo='def', *, session: "Se
     validate_schema(name='account_attribute', obj=value, vo=vo)
 
     kwargs = {'account': account, 'key': key, 'value': value}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='add_attribute', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='add_attribute', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not add attributes' % (issuer))
 
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    account_core.add_account_attribute(account, key, value, session=session)
+    account_core.add_account_attribute(internal_account, key, value, session=session)
 
 
 @transactional_session
-def del_account_attribute(key, account, issuer, vo='def', *, session: "Session"):
+def del_account_attribute(
+    key: str,
+    account: str,
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> None:
     """
     Delete an attribute to an account.
 
@@ -222,16 +281,23 @@ def del_account_attribute(key, account, issuer, vo='def', *, session: "Session")
     :param session: The database session in use.
     """
     kwargs = {'account': account, 'key': key}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='del_attribute', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='del_attribute', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not delete attribute' % (issuer))
 
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    account_core.del_account_attribute(account, key, session=session)
+    account_core.del_account_attribute(internal_account, key, session=session)
 
 
 @read_session
-def get_usage(rse, account, issuer, vo='def', *, session: "Session"):
+def get_usage(
+    rse: str,
+    account: str,
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> "UsageDict":
     """
     Returns current values of the specified counter, or raises CounterNotFound if the counter does not exist.
 
@@ -243,13 +309,20 @@ def get_usage(rse, account, issuer, vo='def', *, session: "Session"):
     :returns:                A dictionary with total and bytes.
     """
     rse_id = get_rse_id(rse=rse, vo=vo, session=session)
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    return account_core.get_usage(rse_id, account, session=session)
+    return account_core.get_usage(rse_id, internal_account, session=session)
 
 
 @read_session
-def get_usage_history(rse, account, issuer, vo='def', *, session: "Session"):
+def get_usage_history(
+    rse: str,
+    account: str,
+    issuer: str,
+    vo: str = 'def',
+    *,
+    session: "Session"
+) -> list["UsageDict"]:
     """
     Returns historical values of the specified counter, or raises CounterNotFound if the counter does not exist.
 
@@ -261,6 +334,6 @@ def get_usage_history(rse, account, issuer, vo='def', *, session: "Session"):
     :returns:                A dictionary with total and bytes.
     """
     rse_id = get_rse_id(rse=rse, vo=vo, session=session)
-    account = InternalAccount(account, vo=vo)
+    internal_account = InternalAccount(account, vo=vo)
 
-    return account_core.get_usage_history(rse_id, account, session=session)
+    return account_core.get_usage_history(rse_id, internal_account, session=session)

rucio/{api → gateway}/account_limit.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");
@@ -15,10 +14,10 @@
 
 from typing import TYPE_CHECKING
 
-import rucio.api.permission
 import rucio.common.exception
+import rucio.gateway.permission
 from rucio.common.types import InternalAccount
-from rucio.common.utils import api_update_return_dict
+from rucio.common.utils import gateway_update_return_dict
 from rucio.core import account_limit as account_limit_core
 from rucio.core.account import account_exists
 from rucio.core.rse import get_rse_id, get_rse_name
@@ -36,11 +35,11 @@ def get_rse_account_usage(rse, vo='def', *, session: "Session"):
     :param rse:      The RSE name.
     :param vo:       The VO to act on.
     :param session:  The database session in use.
-    :return:         List of dictionnaries.
+    :return:         List of dictionaries.
     """
     rse_id = get_rse_id(rse=rse, vo=vo, session=session)
 
-    return [api_update_return_dict(d, session=session) for d in account_limit_core.get_rse_account_usage(rse_id=rse_id, session=session)]
+    return [gateway_update_return_dict(d, session=session) for d in account_limit_core.get_rse_account_usage(rse_id=rse_id, session=session)]
 
 
 @read_session
@@ -142,7 +141,7 @@ def set_local_account_limit(account, rse, bytes_, issuer, vo='def', *, session:
     rse_id = get_rse_id(rse=rse, vo=vo, session=session)
 
     kwargs = {'account': account, 'rse': rse, 'rse_id': rse_id, 'bytes': bytes_}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='set_local_account_limit', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='set_local_account_limit', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not set account limits.' % (issuer))
 
     account = InternalAccount(account, vo=vo)
@@ -167,7 +166,7 @@ def set_global_account_limit(account, rse_expression, bytes_, issuer, vo='def',
     """
 
     kwargs = {'account': account, 'rse_expression': rse_expression, 'bytes': bytes_}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='set_global_account_limit', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='set_global_account_limit', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not set account limits.' % (issuer))
 
     account = InternalAccount(account, vo=vo)
@@ -194,7 +193,7 @@ def delete_local_account_limit(account, rse, issuer, vo='def', *, session: "Sess
 
     rse_id = get_rse_id(rse=rse, vo=vo, session=session)
     kwargs = {'account': account, 'rse': rse, 'rse_id': rse_id}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='delete_local_account_limit', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='delete_local_account_limit', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not delete account limits.' % (issuer))
 
     account = InternalAccount(account, vo=vo)
@@ -220,7 +219,7 @@ def delete_global_account_limit(account, rse_expression, issuer, vo='def', *, se
     """
 
     kwargs = {'account': account, 'rse_expression': rse_expression}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='delete_global_account_limit', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='delete_global_account_limit', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not delete global account limits.' % (issuer))
 
     account = InternalAccount(account, vo=vo)
@@ -250,7 +249,7 @@ def get_local_account_usage(account, rse, issuer, vo='def', *, session: "Session
     if rse:
         rse_id = get_rse_id(rse=rse, vo=vo, session=session)
     kwargs = {'account': account, 'rse': rse, 'rse_id': rse_id}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='get_local_account_usage', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='get_local_account_usage', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not list account usage.' % (issuer))
 
     account = InternalAccount(account, vo=vo)
@@ -258,7 +257,7 @@ def get_local_account_usage(account, rse, issuer, vo='def', *, session: "Session
     if not account_exists(account=account, session=session):
         raise rucio.common.exception.AccountNotFound('Account %s does not exist' % (account))
 
-    return [api_update_return_dict(d, session=session) for d in account_limit_core.get_local_account_usage(account=account, rse_id=rse_id, session=session)]
+    return [gateway_update_return_dict(d, session=session) for d in account_limit_core.get_local_account_usage(account=account, rse_id=rse_id, session=session)]
 
 
 @read_session
@@ -276,7 +275,7 @@ def get_global_account_usage(account, rse_expression, issuer, vo='def', *, sessi
     """
 
     kwargs = {'account': account, 'rse_expression': rse_expression}
-    if not rucio.api.permission.has_permission(issuer=issuer, vo=vo, action='get_global_account_usage', kwargs=kwargs, session=session):
+    if not rucio.gateway.permission.has_permission(issuer=issuer, vo=vo, action='get_global_account_usage', kwargs=kwargs, session=session):
         raise rucio.common.exception.AccessDenied('Account %s can not list global account usage.' % (issuer))
 
     account = InternalAccount(account, vo=vo)
@@ -284,4 +283,4 @@ def get_global_account_usage(account, rse_expression, issuer, vo='def', *, sessi
     if not account_exists(account=account, session=session):
         raise rucio.common.exception.AccountNotFound('Account %s does not exist' % (account))
 
-    return [api_update_return_dict(d, session=session) for d in account_limit_core.get_global_account_usage(account=account, rse_expression=rse_expression, session=session)]
+    return [gateway_update_return_dict(d, session=session) for d in account_limit_core.get_global_account_usage(account=account, rse_expression=rse_expression, session=session)]