rename GroupTyoe

Author: pcrespov

packages/common-library/src/common_library/groups_enums.py

@@ -1,7 +1,7 @@
 import enum
 
 
-class GroupTypeEnum(enum.Enum):
+class GroupType(enum.Enum):
     """
     standard: standard group, e.g. any group that is not a primary group or special group such as the everyone group
     primary: primary group, e.g. the primary group is the user own defined group that typically only contain the user (same as in linux)

packages/models-library/src/models_library/groups.py

@@ -1,7 +1,7 @@
 from typing import Annotated, Final, NamedTuple, TypeAlias
 
 from common_library.basic_types import DEFAULT_FACTORY
-from common_library.groups_enums import GroupTypeEnum as GroupTypeEnum
+from common_library.groups_enums import GroupType as GroupType
 from pydantic import BaseModel, ConfigDict, EmailStr, Field, field_validator
 from pydantic.types import PositiveInt
 from typing_extensions import TypedDict
@@ -14,14 +14,14 @@
 
 GroupID: TypeAlias = PositiveInt
 
-__all__: tuple[str, ...] = ("GroupTypeEnum",)
+__all__: tuple[str, ...] = ("GroupType",)
 
 
 class Group(BaseModel):
     gid: PositiveInt
     name: str
     description: str
-    group_type: Annotated[GroupTypeEnum, Field(alias="type")]
+    group_type: Annotated[GroupType, Field(alias="type")]
     thumbnail: str | None
 
     inclusion_rules: Annotated[
@@ -32,7 +32,7 @@ class Group(BaseModel):
     ] = DEFAULT_FACTORY
 
     _from_equivalent_enums = field_validator("group_type", mode="before")(
-        create_enums_pre_validator(GroupTypeEnum)
+        create_enums_pre_validator(GroupType)
     )
 
     model_config = ConfigDict(populate_by_name=True)

packages/postgres-database/src/simcore_postgres_database/models/groups.py

@@ -6,7 +6,7 @@
 
 
 import sqlalchemy as sa
-from common_library.groups_enums import GroupTypeEnum
+from common_library.groups_enums import GroupType
 from sqlalchemy.dialects.postgresql import JSONB
 from sqlalchemy.sql import func
 
@@ -27,7 +27,7 @@
     sa.Column("description", sa.String, nullable=False, doc="Short description"),
     sa.Column(
         "type",
-        sa.Enum(GroupTypeEnum),
+        sa.Enum(GroupType),
         nullable=False,
         server_default="STANDARD",
         doc="Classification of the group based on GroupType enum",

packages/postgres-database/src/simcore_postgres_database/utils_groups_extra_properties.py

@@ -7,7 +7,7 @@
 from aiopg.sa.connection import SAConnection
 from aiopg.sa.result import RowProxy
 
-from .models.groups import GroupTypeEnum, groups, user_to_groups
+from .models.groups import GroupType, groups, user_to_groups
 from .models.groups_extra_properties import groups_extra_properties
 from .utils_models import FromRowMixin
 
@@ -44,9 +44,9 @@ async def _list_table_entries_ordered_by_group_type(
             groups.c.type,
             sa.case(
                 # NOTE: the ordering is important for the aggregation afterwards
-                (groups.c.type == GroupTypeEnum.EVERYONE, sa.literal(3)),
-                (groups.c.type == GroupTypeEnum.STANDARD, sa.literal(2)),
-                (groups.c.type == GroupTypeEnum.PRIMARY, sa.literal(1)),
+                (groups.c.type == GroupType.EVERYONE, sa.literal(3)),
+                (groups.c.type == GroupType.STANDARD, sa.literal(2)),
+                (groups.c.type == GroupType.PRIMARY, sa.literal(1)),
                 else_=sa.literal(4),
             ).label("type_order"),
         )
@@ -124,10 +124,10 @@ async def get_aggregated_properties_for_user(
         for row in rows:
             group_extra_properties = GroupExtraProperties.from_row(row)
             match row.type:
-                case GroupTypeEnum.PRIMARY:
+                case GroupType.PRIMARY:
                     # this always has highest priority
                     return group_extra_properties
-                case GroupTypeEnum.STANDARD:
+                case GroupType.STANDARD:
                     if merged_standard_extra_properties:
                         merged_standard_extra_properties = (
                             _merge_extra_properties_booleans(
@@ -137,7 +137,7 @@ async def get_aggregated_properties_for_user(
                         )
                     else:
                         merged_standard_extra_properties = group_extra_properties
-                case GroupTypeEnum.EVERYONE:
+                case GroupType.EVERYONE:
                     # if there are standard properties, they take precedence
                     return (
                         merged_standard_extra_properties

packages/postgres-database/src/simcore_postgres_database/utils_products.py

@@ -7,7 +7,7 @@
 import sqlalchemy as sa
 
 from ._protocols import AiopgConnection, DBConnection
-from .models.groups import GroupTypeEnum, groups
+from .models.groups import GroupType, groups
 from .models.products import products
 
 # NOTE: outside this module, use instead packages/models-library/src/models_library/users.py
@@ -57,7 +57,7 @@ async def execute_get_or_create_product_group(conn, product_name: str) -> int:
             .values(
                 name=product_name,
                 description=f"{product_name} product group",
-                type=GroupTypeEnum.STANDARD,
+                type=GroupType.STANDARD,
             )
             .returning(groups.c.gid)
         )

packages/postgres-database/src/simcore_postgres_database/webserver_models.py

@@ -9,7 +9,7 @@
 from .models.comp_pipeline import StateType, comp_pipeline
 from .models.comp_tasks import DB_CHANNEL_NAME, NodeClass, comp_tasks
 from .models.confirmations import ConfirmationAction, confirmations
-from .models.groups import GroupTypeEnum, groups, user_to_groups
+from .models.groups import GroupType, groups, user_to_groups
 from .models.products import products
 from .models.projects import ProjectType, projects
 from .models.projects_tags import projects_tags
@@ -28,7 +28,7 @@
     "DB_CHANNEL_NAME",
     "group_classifiers",
     "groups",
-    "GroupTypeEnum",
+    "GroupType",
     "NodeClass",
     "products",
     "projects",

packages/postgres-database/tests/conftest.py

@@ -33,7 +33,7 @@
     ProjectNodesRepo,
 )
 from simcore_postgres_database.webserver_models import (
-    GroupTypeEnum,
+    GroupType,
     groups,
     user_to_groups,
     users,
@@ -237,7 +237,7 @@ def create_fake_group(
 
     async def _creator(conn: SAConnection, **overrides) -> RowProxy:
         if "type" not in overrides:
-            overrides["type"] = GroupTypeEnum.STANDARD
+            overrides["type"] = GroupType.STANDARD
         result: ResultProxy = await conn.execute(
             groups.insert()
             .values(**random_group(**overrides))
@@ -281,7 +281,7 @@ async def _creator(conn, group: RowProxy | None = None, **overrides) -> RowProxy
         created_ids.append(user.id)
 
         if group:
-            assert group.type == GroupTypeEnum.STANDARD.name
+            assert group.type == GroupType.STANDARD.name
             result = await conn.execute(
                 user_to_groups.insert().values(uid=user.id, gid=group.gid)
             )

packages/postgres-database/tests/products/test_utils_products.py

@@ -10,7 +10,7 @@
 import pytest
 import sqlalchemy as sa
 from aiopg.sa.engine import Engine
-from simcore_postgres_database.models.groups import GroupTypeEnum, groups
+from simcore_postgres_database.models.groups import GroupType, groups
 from simcore_postgres_database.models.products import products
 from simcore_postgres_database.utils_products import (
     get_default_product_name,
@@ -61,7 +61,7 @@ async def test_get_or_create_group_product(
             product_group = await result.first()
 
             # check product's group
-            assert product_group.type == GroupTypeEnum.STANDARD
+            assert product_group.type == GroupType.STANDARD
             assert product_group.name == product_row.name
             assert product_group.description == f"{product_row.name} product group"
 

packages/postgres-database/tests/test_models_groups.py

@@ -16,7 +16,7 @@
 from pytest_simcore.helpers.faker_factories import random_user
 from simcore_postgres_database.models.base import metadata
 from simcore_postgres_database.webserver_models import (
-    GroupTypeEnum,
+    GroupType,
     groups,
     user_to_groups,
     users,
@@ -74,7 +74,7 @@ async def test_all_group(
     assert groups_count == 1
 
     result = await connection.execute(
-        groups.select().where(groups.c.type == GroupTypeEnum.EVERYONE)
+        groups.select().where(groups.c.type == GroupType.EVERYONE)
     )
     all_group_gid = (await result.fetchone()).gid
     assert all_group_gid == 1  # it's the first group so it gets a 1
@@ -108,7 +108,7 @@ async def test_all_group(
     groups_count = await connection.scalar(select(func.count()).select_from(groups))
     assert groups_count == 1
     result = await connection.execute(
-        groups.select().where(groups.c.type == GroupTypeEnum.EVERYONE)
+        groups.select().where(groups.c.type == GroupType.EVERYONE)
     )
     all_group_gid = (await result.fetchone()).gid
     assert all_group_gid == 1  # it's the first group so it gets a 1
@@ -130,7 +130,7 @@ async def test_own_group(
 
     # now check there is a primary group
     result = await connection.execute(
-        groups.select().where(groups.c.type == GroupTypeEnum.PRIMARY)
+        groups.select().where(groups.c.type == GroupType.PRIMARY)
     )
     primary_group: RowProxy = await result.fetchone()
     assert primary_group.gid == user.primary_gid

packages/postgres-database/tests/test_utils_groups_extra_properties.py

@@ -11,11 +11,7 @@
 import sqlalchemy
 from aiopg.sa.result import RowProxy
 from faker import Faker
-from simcore_postgres_database.models.groups import (
-    GroupTypeEnum,
-    groups,
-    user_to_groups,
-)
+from simcore_postgres_database.models.groups import GroupType, groups, user_to_groups
 from simcore_postgres_database.models.groups_extra_properties import (
     groups_extra_properties,
 )
@@ -108,7 +104,7 @@ async def test_get(
 @pytest.fixture
 async def everyone_group_id(connection: aiopg.sa.connection.SAConnection) -> int:
     result = await connection.scalar(
-        sqlalchemy.select(groups.c.gid).where(groups.c.type == GroupTypeEnum.EVERYONE)
+        sqlalchemy.select(groups.c.gid).where(groups.c.type == GroupType.EVERYONE)
     )
     assert result
     return result