rename and doc

pcrespov · pcrespov · commit dde991452080 · 2025-03-07T10:40:54.000+01:00
diff --git a/packages/postgres-database/src/simcore_postgres_database/aiopg_errors.py b/packages/postgres-database/src/simcore_postgres_database/aiopg_errors.py
@@ -1,5 +1,8 @@
 """aiopg errors
 
+WARNING: these errors are not raised by asyncpg. Therefore all code using new sqlalchemy.ext.asyncio
+         MUST use instead import sqlalchemy.exc exceptions!!!!
+
 StandardError
 |__ Warning
 |__ Error
diff --git a/packages/postgres-database/src/simcore_postgres_database/utils_payments.py b/packages/postgres-database/src/simcore_postgres_database/utils_payments.py
@@ -8,7 +8,7 @@
 from aiopg.sa.connection import SAConnection
 from aiopg.sa.result import ResultProxy, RowProxy
 
-from . import errors
+from . import aiopg_errors
 from .models.payments_transactions import PaymentTransactionState, payments_transactions
 
 _logger = logging.getLogger(__name__)
@@ -29,16 +29,13 @@ def __bool__(self):
         return False
 
 
-class PaymentAlreadyExists(PaymentFailure):
-    ...
+class PaymentAlreadyExists(PaymentFailure): ...
 
 
-class PaymentNotFound(PaymentFailure):
-    ...
+class PaymentNotFound(PaymentFailure): ...
 
 
-class PaymentAlreadyAcked(PaymentFailure):
-    ...
+class PaymentAlreadyAcked(PaymentFailure): ...
 
 
 async def insert_init_payment_transaction(
@@ -69,7 +66,7 @@ async def insert_init_payment_transaction(
                 initiated_at=initiated_at,
             )
         )
-    except errors.UniqueViolation:
+    except aiopg_errors.UniqueViolation:
         return PaymentAlreadyExists(payment_id)
 
     return payment_id
diff --git a/packages/postgres-database/src/simcore_postgres_database/utils_projects_metadata.py b/packages/postgres-database/src/simcore_postgres_database/utils_projects_metadata.py
@@ -9,7 +9,7 @@
 from pydantic import BaseModel, ConfigDict
 from sqlalchemy.dialects.postgresql import insert as pg_insert
 
-from .errors import ForeignKeyViolation
+from .aiopg_errors import ForeignKeyViolation
 from .models.projects import projects
 from .models.projects_metadata import projects_metadata
 
@@ -33,11 +33,15 @@ class DBProjectInvalidAncestorsError(BaseProjectsMetadataError):
 
 
 class DBProjectInvalidParentProjectError(BaseProjectsMetadataError):
-    msg_template: str = "Project project_uuid={project_uuid!r} has invalid parent project uuid={parent_project_uuid!r}"
+    msg_template: str = (
+        "Project project_uuid={project_uuid!r} has invalid parent project uuid={parent_project_uuid!r}"
+    )
 
 
 class DBProjectInvalidParentNodeError(BaseProjectsMetadataError):
-    msg_template: str = "Project project_uuid={project_uuid!r} has invalid parent project uuid={parent_node_id!r}"
+    msg_template: str = (
+        "Project project_uuid={project_uuid!r} has invalid parent project uuid={parent_node_id!r}"
+    )
 
 
 #
diff --git a/packages/postgres-database/src/simcore_postgres_database/utils_projects_nodes.py b/packages/postgres-database/src/simcore_postgres_database/utils_projects_nodes.py
@@ -9,7 +9,7 @@
 from pydantic import BaseModel, ConfigDict, Field
 from sqlalchemy.dialects.postgresql import insert as pg_insert
 
-from .errors import ForeignKeyViolation, UniqueViolation
+from .aiopg_errors import ForeignKeyViolation, UniqueViolation
 from .models.projects_node_to_pricing_unit import projects_node_to_pricing_unit
 from .models.projects_nodes import projects_nodes
 
@@ -30,11 +30,15 @@ class ProjectNodesNodeNotFoundError(BaseProjectNodesError):
 
 
 class ProjectNodesNonUniqueNodeFoundError(BaseProjectNodesError):
-    msg_template: str = "Multiple project found containing node {node_id}. TIP: misuse, the same node ID was found in several projects."
+    msg_template: str = (
+        "Multiple project found containing node {node_id}. TIP: misuse, the same node ID was found in several projects."
+    )
 
 
 class ProjectNodesDuplicateNodeError(BaseProjectNodesError):
-    msg_template: str = "Project node already exists, you cannot have 2x the same node in the same project."
+    msg_template: str = (
+        "Project node already exists, you cannot have 2x the same node in the same project."
+    )
 
 
 class ProjectNodeCreate(BaseModel):
diff --git a/packages/postgres-database/src/simcore_postgres_database/utils_users.py b/packages/postgres-database/src/simcore_postgres_database/utils_users.py
@@ -12,7 +12,7 @@
 from aiopg.sa.result import RowProxy
 from sqlalchemy import Column
 
-from .errors import UniqueViolation
+from .aiopg_errors import UniqueViolation
 from .models.users import UserRole, UserStatus, users
 from .models.users_details import users_pre_registration_details
 
diff --git a/packages/postgres-database/tests/test_clusters.py b/packages/postgres-database/tests/test_clusters.py
@@ -9,7 +9,7 @@
 from aiopg.sa.engine import Engine
 from aiopg.sa.result import ResultProxy
 from pytest_simcore.helpers.faker_factories import random_user
-from simcore_postgres_database.errors import ForeignKeyViolation, NotNullViolation
+from simcore_postgres_database.aiopg_errors import ForeignKeyViolation, NotNullViolation
 from simcore_postgres_database.models.cluster_to_groups import cluster_to_groups
 from simcore_postgres_database.models.clusters import ClusterType, clusters
 from simcore_postgres_database.models.users import users
@@ -41,7 +41,7 @@ async def user_group_id(aiopg_engine: Engine, user_id: int) -> int:
 
 
 async def test_cluster_without_owner_forbidden(
-    create_fake_cluster: Callable[..., Awaitable[int]]
+    create_fake_cluster: Callable[..., Awaitable[int]],
 ):
     with pytest.raises(NotNullViolation):
         await create_fake_cluster()
diff --git a/packages/postgres-database/tests/test_models_payments_methods.py b/packages/postgres-database/tests/test_models_payments_methods.py
@@ -10,7 +10,7 @@
 from aiopg.sa.result import RowProxy
 from faker import Faker
 from pytest_simcore.helpers.faker_factories import random_payment_method
-from simcore_postgres_database.errors import UniqueViolation
+from simcore_postgres_database.aiopg_errors import UniqueViolation
 from simcore_postgres_database.models.payments_methods import (
     InitPromptAckFlowState,
     payments_methods,
diff --git a/packages/postgres-database/tests/test_services_consume_filetypes.py b/packages/postgres-database/tests/test_services_consume_filetypes.py
@@ -15,7 +15,7 @@
     FAKE_FILE_CONSUMER_SERVICES,
     list_supported_filetypes,
 )
-from simcore_postgres_database.errors import CheckViolation
+from simcore_postgres_database.aiopg_errors import CheckViolation
 from simcore_postgres_database.models.services import services_meta_data
 from simcore_postgres_database.models.services_consume_filetypes import (
     services_consume_filetypes,
diff --git a/packages/postgres-database/tests/test_users.py b/packages/postgres-database/tests/test_users.py
@@ -11,7 +11,10 @@
 from aiopg.sa.result import ResultProxy, RowProxy
 from faker import Faker
 from pytest_simcore.helpers.faker_factories import random_user
-from simcore_postgres_database.errors import InvalidTextRepresentation, UniqueViolation
+from simcore_postgres_database.aiopg_errors import (
+    InvalidTextRepresentation,
+    UniqueViolation,
+)
 from simcore_postgres_database.models.users import UserRole, UserStatus, users
 from simcore_postgres_database.utils_users import (
     UsersRepo,
diff --git a/services/api-server/src/simcore_service_api_server/db/repositories/api_keys.py b/services/api-server/src/simcore_service_api_server/db/repositories/api_keys.py
@@ -4,7 +4,7 @@
 import sqlalchemy as sa
 from models_library.products import ProductName
 from pydantic.types import PositiveInt
-from simcore_postgres_database.errors import DatabaseError
+from simcore_postgres_database.aiopg_errors import DatabaseError
 
 from .. import tables as tbl
 from ._base import BaseRepository
diff --git a/services/api-server/src/simcore_service_api_server/db/repositories/groups_extra_properties.py b/services/api-server/src/simcore_service_api_server/db/repositories/groups_extra_properties.py
@@ -1,7 +1,7 @@
 import logging
 
 from models_library.users import UserID
-from simcore_postgres_database.errors import DatabaseError
+from simcore_postgres_database.aiopg_errors import DatabaseError
 from simcore_postgres_database.utils_groups_extra_properties import (
     GroupExtraPropertiesRepo,
 )
diff --git a/services/director-v2/src/simcore_service_director_v2/modules/db/repositories/comp_runs.py b/services/director-v2/src/simcore_service_director_v2/modules/db/repositories/comp_runs.py
@@ -10,7 +10,7 @@
 from models_library.users import UserID
 from models_library.utils.fastapi_encoders import jsonable_encoder
 from pydantic import PositiveInt
-from simcore_postgres_database.errors import ForeignKeyViolation
+from simcore_postgres_database.aiopg_errors import ForeignKeyViolation
 from sqlalchemy.sql import or_
 from sqlalchemy.sql.elements import literal_column
 from sqlalchemy.sql.expression import desc
diff --git a/services/payments/src/simcore_service_payments/db/payments_methods_repo.py b/services/payments/src/simcore_service_payments/db/payments_methods_repo.py
@@ -1,6 +1,6 @@
 import datetime
 
-import simcore_postgres_database.errors as db_errors
+import simcore_postgres_database.aiopg_errors as db_errors
 import sqlalchemy as sa
 from arrow import utcnow
 from models_library.api_schemas_payments.errors import (
diff --git a/services/payments/src/simcore_service_payments/db/payments_transactions_repo.py b/services/payments/src/simcore_service_payments/db/payments_transactions_repo.py
@@ -13,7 +13,7 @@
 from models_library.users import UserID
 from models_library.wallets import WalletID
 from pydantic import HttpUrl, PositiveInt, TypeAdapter
-from simcore_postgres_database import errors as pg_errors
+from simcore_postgres_database import aiopg_errors as pg_errors
 from simcore_postgres_database.models.payments_transactions import (
     PaymentTransactionState,
     payments_transactions,
diff --git a/services/web/server/src/simcore_service_webserver/db/_aiopg.py b/services/web/server/src/simcore_service_webserver/db/_aiopg.py
@@ -15,7 +15,7 @@
 from servicelib.aiohttp.application_keys import APP_AIOPG_ENGINE_KEY
 from servicelib.logging_utils import log_context
 from servicelib.retry_policies import PostgresRetryPolicyUponInitialization
-from simcore_postgres_database.errors import DBAPIError
+from simcore_postgres_database.aiopg_errors import DBAPIError
 from simcore_postgres_database.utils_aiopg import (
     DBMigrationError,
     close_engine,
diff --git a/services/web/server/src/simcore_service_webserver/garbage_collector/_core_guests.py b/services/web/server/src/simcore_service_webserver/garbage_collector/_core_guests.py
@@ -8,7 +8,7 @@
 from models_library.users import UserID, UserNameID
 from redis.asyncio import Redis
 from servicelib.common_headers import UNDEFINED_DEFAULT_SIMCORE_USER_AGENT_VALUE
-from simcore_postgres_database.errors import DatabaseError
+from simcore_postgres_database.aiopg_errors import DatabaseError
 from simcore_postgres_database.models.users import UserRole
 
 from ..projects.db import ProjectDBAPI
diff --git a/services/web/server/src/simcore_service_webserver/garbage_collector/_core_utils.py b/services/web/server/src/simcore_service_webserver/garbage_collector/_core_utils.py
@@ -5,7 +5,7 @@
 from models_library.groups import Group, GroupID, GroupType
 from models_library.projects import ProjectID
 from models_library.users import UserID
-from simcore_postgres_database.errors import DatabaseError
+from simcore_postgres_database.aiopg_errors import DatabaseError
 
 from ..groups.api import get_group_from_gid
 from ..projects.api import (
diff --git a/services/web/server/src/simcore_service_webserver/groups/_groups_repository.py b/services/web/server/src/simcore_service_webserver/groups/_groups_repository.py
@@ -18,7 +18,7 @@
     StandardGroupUpdate,
 )
 from models_library.users import UserID
-from simcore_postgres_database.errors import UniqueViolation
+from simcore_postgres_database.aiopg_errors import UniqueViolation
 from simcore_postgres_database.models.users import users
 from simcore_postgres_database.utils_products import get_or_create_product_group
 from simcore_postgres_database.utils_repos import (
diff --git a/services/web/server/src/simcore_service_webserver/login/handlers_confirmation.py b/services/web/server/src/simcore_service_webserver/login/handlers_confirmation.py
@@ -23,7 +23,7 @@
 )
 from servicelib.logging_errors import create_troubleshotting_log_kwargs
 from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
-from simcore_postgres_database.errors import UniqueViolation
+from simcore_postgres_database.aiopg_errors import UniqueViolation
 from yarl import URL
 
 from ..products import products_web
diff --git a/services/web/server/src/simcore_service_webserver/payments/_methods_db.py b/services/web/server/src/simcore_service_webserver/payments/_methods_db.py
@@ -1,7 +1,7 @@
 import datetime
 import logging
 
-import simcore_postgres_database.errors as db_errors
+import simcore_postgres_database.aiopg_errors as db_errors
 import sqlalchemy as sa
 from aiohttp import web
 from aiopg.sa.result import ResultProxy
diff --git a/services/web/server/src/simcore_service_webserver/projects/db.py b/services/web/server/src/simcore_service_webserver/projects/db.py
@@ -1,7 +1,7 @@
-""" Database API
+"""Database API
 
-    - Adds a layer to the postgres API with a focus on the projects data
-    - Shall be used as entry point for all the queries to the database regarding projects
+- Adds a layer to the postgres API with a focus on the projects data
+- Shall be used as entry point for all the queries to the database regarding projects
 
 """
 
@@ -36,7 +36,7 @@
 from pydantic.types import PositiveInt
 from servicelib.aiohttp.application_keys import APP_AIOPG_ENGINE_KEY
 from servicelib.logging_utils import get_log_record_extra, log_context
-from simcore_postgres_database.errors import UniqueViolation
+from simcore_postgres_database.aiopg_errors import UniqueViolation
 from simcore_postgres_database.models.groups import user_to_groups
 from simcore_postgres_database.models.project_to_groups import project_to_groups
 from simcore_postgres_database.models.projects_nodes import projects_nodes
diff --git a/services/web/server/src/simcore_service_webserver/security/_authz_policy.py b/services/web/server/src/simcore_service_webserver/security/_authz_policy.py
@@ -1,6 +1,4 @@
-""" AUTHoriZation (auth) policy
-
-"""
+"""AUTHoriZation (auth) policy"""
 
 import contextlib
 import logging
@@ -14,7 +12,7 @@
 )
 from models_library.products import ProductName
 from models_library.users import UserID
-from simcore_postgres_database.errors import DatabaseError
+from simcore_postgres_database.aiopg_errors import DatabaseError
 
 from ..db.plugin import get_database_engine
 from ._authz_access_model import (

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`FAKE_FILE_CONSUMER_SERVICES,`
`16`	`16`	`list_supported_filetypes,`
`17`	`17`	`)`
`18`		`-from simcore_postgres_database.errors import CheckViolation`
	`18`	`+from simcore_postgres_database.aiopg_errors import CheckViolation`
`19`	`19`	`from simcore_postgres_database.models.services import services_meta_data`
`20`	`20`	`from simcore_postgres_database.models.services_consume_filetypes import (`
`21`	`21`	`services_consume_filetypes,`