f3-data-models 0.1.7__tar.gz → 0.1.8__tar.gz

{f3_data_models-0.1.7 → f3_data_models-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: f3-data-models
-Version: 0.1.7
+Version: 0.1.8
 Summary: The data schema and models for F3 Nation applications.
 Home-page: https://github.com/F3-Nation/f3-data-models
 License: MIT
@@ -56,11 +56,26 @@ If you would like to make a change, you will need to:
 source .env && alembic revision --autogenerate -m "Your Message Here"
 ```
 3. Make any edits to the migration script in `alembic/versions`
-4. The github pages documentation will be updated when you push to `main`, but if you would like to preview locally, run:
+4. Run the upgrade on your local db:
+```sh
+source .env && alembic upgrade head
+```
+5. Bump the version on `pyproject.toml`:
+```sh
+poetry version patch[minor][major]
+```
+6. Tag your final commit and make sure to push those tags to trigger the pypi package build:
+```sh
+git tag <new_version> -a -m "Your message here"
+git push origin --tags
+```
+> [!NOTE] The github pages documentation will be updated when you push to `main`, but if you would like to preview locally, run:
+
 ```sh
 poetry run sphinx-build -b html docs docs/_build/html
 cd docs
 poetry run python -m http.server --directory _build/html
 ```
+
 > [!TIP]  
 > Adding new fields as nullable (ie `Optional[]`) has the best chance of reducing breaking changes to the apps.

{f3_data_models-0.1.7 → f3_data_models-0.1.8}/README.md

@@ -27,11 +27,26 @@ If you would like to make a change, you will need to:
 source .env && alembic revision --autogenerate -m "Your Message Here"
 ```
 3. Make any edits to the migration script in `alembic/versions`
-4. The github pages documentation will be updated when you push to `main`, but if you would like to preview locally, run:
+4. Run the upgrade on your local db:
+```sh
+source .env && alembic upgrade head
+```
+5. Bump the version on `pyproject.toml`:
+```sh
+poetry version patch[minor][major]
+```
+6. Tag your final commit and make sure to push those tags to trigger the pypi package build:
+```sh
+git tag <new_version> -a -m "Your message here"
+git push origin --tags
+```
+> [!NOTE] The github pages documentation will be updated when you push to `main`, but if you would like to preview locally, run:
+
 ```sh
 poetry run sphinx-build -b html docs docs/_build/html
 cd docs
 poetry run python -m http.server --directory _build/html
 ```
+
 > [!TIP]  
 > Adding new fields as nullable (ie `Optional[]`) has the best chance of reducing breaking changes to the apps.

{f3_data_models-0.1.7 → f3_data_models-0.1.8}/f3_data_models/models.py

@@ -1,14 +1,16 @@
 from datetime import datetime, date, time
-from typing import Any, Dict, Optional
+from typing import Any, Dict, List, Optional
 from sqlalchemy import (
     JSON,
     TEXT,
     TIME,
     VARCHAR,
     Boolean,
+    Column,
     DateTime,
     ForeignKey,
     Integer,
+    Table,
     func,
     UniqueConstraint,
 )
@@ -17,6 +19,7 @@ from sqlalchemy.orm import (
     DeclarativeBase,
     mapped_column,
     Mapped,
+    relationship,
 )
 
 # Custom Annotations
@@ -256,6 +259,30 @@ class Role_x_User_x_Org(Base):
     org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
 
 
+event_type_x_org_table = Table(
+    "event_types_x_org",
+    Base.metadata,
+    Column("event_type_id", Integer, ForeignKey("event_types.id"), primary_key=True),
+    Column("org_id", Integer, ForeignKey("orgs.id"), primary_key=True),
+    Column("is_default", Boolean, default=False, nullable=False),
+)
+
+event_tag_x_org_table = Table(
+    "event_tags_x_org",
+    Base.metadata,
+    Column("event_tag_id", Integer, ForeignKey("event_tags.id"), primary_key=True),
+    Column("org_id", Integer, ForeignKey("orgs.id"), primary_key=True),
+    Column("color_override", VARCHAR),
+)
+
+achievement_x_org_table = Table(
+    "achievements_x_org",
+    Base.metadata,
+    Column("achievement_id", Integer, ForeignKey("achievements.id"), primary_key=True),
+    Column("org_id", Integer, ForeignKey("orgs.id"), primary_key=True),
+)
+
+
 class Org(Base):
     """
     Model representing an organization. The same model is used for all levels of organization (AOs, Regions, etc.).
@@ -282,7 +309,7 @@ class Org(Base):
 
     __tablename__ = "orgs"
 
-    id: Mapped[intpk]
+    id: Mapped[int] = mapped_column(Integer, primary_key=True, autoincrement=True)
     parent_id: Mapped[Optional[int]] = mapped_column(ForeignKey("orgs.id"))
     org_type_id: Mapped[int] = mapped_column(ForeignKey("org_types.id"))
     default_location_id: Mapped[Optional[int]]
@@ -300,6 +327,19 @@ class Org(Base):
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
+    event_types: Mapped[Optional[List["EventType"]]] = relationship(
+        "EventType", secondary=event_type_x_org_table, cascade="expunge"
+    )
+    event_tags: Mapped[Optional[List["EventTag"]]] = relationship(
+        "EventTag", secondary=event_tag_x_org_table, cascade="expunge"
+    )
+    achievements: Mapped[Optional[List["Achievement"]]] = relationship(
+        "Achievement", secondary=achievement_x_org_table, cascade="expunge"
+    )
+    parent_org: Mapped[Optional["Org"]] = relationship(
+        "Org", remote_side=[id], cascade="expunge"
+    )
+
 
 class EventType(Base):
     """
@@ -326,40 +366,40 @@ class EventType(Base):
     updated: Mapped[dt_update]
 
 
-class EventType_x_Event(Base):
-    """
-    Model representing the association between events and event types. The intention is that a single event can be associated with multiple event types.
+# class EventType_x_Event(Base):
+#     """
+#     Model representing the association between events and event types. The intention is that a single event can be associated with multiple event types.
 
-    Attributes:
-        event_id (int): The ID of the associated event.
-        event_type_id (int): The ID of the associated event type.
-    """
+#     Attributes:
+#         event_id (int): The ID of the associated event.
+#         event_type_id (int): The ID of the associated event type.
+#     """
 
-    __tablename__ = "events_x_event_types"
+#     __tablename__ = "events_x_event_types"
 
-    event_id: Mapped[int] = mapped_column(ForeignKey("events.id"), primary_key=True)
-    event_type_id: Mapped[int] = mapped_column(
-        ForeignKey("event_types.id"), primary_key=True
-    )
+#     event_id: Mapped[int] = mapped_column(ForeignKey("events.id"), primary_key=True)
+#     event_type_id: Mapped[int] = mapped_column(
+#         ForeignKey("event_types.id"), primary_key=True
+#     )
 
 
-class EventType_x_Org(Base):
-    """
-    Model representing the association between event types and organizations. This controls which event types are available for selection at the region level, as well as default types for each AO.
+# class EventType_x_Org(Base):
+#     """
+#     Model representing the association between event types and organizations. This controls which event types are available for selection at the region level, as well as default types for each AO.
 
-    Attributes:
-        event_type_id (int): The ID of the associated event type.
-        org_id (int): The ID of the associated organization.
-        is_default (bool): Whether this is the default event type for the organization. Default is False.
-    """
+#     Attributes:
+#         event_type_id (int): The ID of the associated event type.
+#         org_id (int): The ID of the associated organization.
+#         is_default (bool): Whether this is the default event type for the organization. Default is False.
+#     """
 
-    __tablename__ = "event_types_x_org"
+#     __tablename__ = "event_types_x_org"
 
-    event_type_id: Mapped[int] = mapped_column(
-        ForeignKey("event_types.id"), primary_key=True
-    )
-    org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
-    is_default: Mapped[bool] = mapped_column(Boolean, default=False)
+#     event_type_id: Mapped[int] = mapped_column(
+#         ForeignKey("event_types.id"), primary_key=True
+#     )
+#     org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
+#     is_default: Mapped[bool] = mapped_column(Boolean, default=False)
 
 
 class EventTag(Base):
@@ -385,40 +425,40 @@ class EventTag(Base):
     updated: Mapped[dt_update]
 
 
-class EventTag_x_Event(Base):
-    """
-    Model representing the association between event tags and events. The intention is that a single event can be associated with multiple event tags.
+# class EventTag_x_Event(Base):
+#     """
+#     Model representing the association between event tags and events. The intention is that a single event can be associated with multiple event tags.
 
-    Attributes:
-        event_id (int): The ID of the associated event.
-        event_tag_id (int): The ID of the associated event tag.
-    """
+#     Attributes:
+#         event_id (int): The ID of the associated event.
+#         event_tag_id (int): The ID of the associated event tag.
+#     """
 
-    __tablename__ = "event_tags_x_events"
+#     __tablename__ = "event_tags_x_events"
 
-    event_id: Mapped[int] = mapped_column(ForeignKey("events.id"), primary_key=True)
-    event_tag_id: Mapped[int] = mapped_column(
-        ForeignKey("event_tags.id"), primary_key=True
-    )
+#     event_id: Mapped[int] = mapped_column(ForeignKey("events.id"), primary_key=True)
+#     event_tag_id: Mapped[int] = mapped_column(
+#         ForeignKey("event_tags.id"), primary_key=True
+#     )
 
 
-class EventTag_x_Org(Base):
-    """
-    Model representing the association between event tags and organizations. Controls which event tags are available for selection at the region level.
+# class EventTag_x_Org(Base):
+#     """
+#     Model representing the association between event tags and organizations. Controls which event tags are available for selection at the region level.
 
-    Attributes:
-        event_tag_id (int): The ID of the associated event tag.
-        org_id (int): The ID of the associated organization.
-        color_override (Optional[str]): The calendar color override for the event tag (if the region wants to use something other than the default).
-    """
+#     Attributes:
+#         event_tag_id (int): The ID of the associated event tag.
+#         org_id (int): The ID of the associated organization.
+#         color_override (Optional[str]): The calendar color override for the event tag (if the region wants to use something other than the default).
+#     """
 
-    __tablename__ = "event_tags_x_org"
+#     __tablename__ = "event_tags_x_org"
 
-    event_tag_id: Mapped[int] = mapped_column(
-        ForeignKey("event_tags.id"), primary_key=True
-    )
-    org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
-    color_override: Mapped[Optional[str]]
+#     event_tag_id: Mapped[int] = mapped_column(
+#         ForeignKey("event_tags.id"), primary_key=True
+#     )
+#     org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
+#     color_override: Mapped[Optional[str]]
 
 
 class Org_x_SlackSpace(Base):
@@ -479,6 +519,21 @@ class Location(Base):
     updated: Mapped[dt_update]
 
 
+event_x_event_type_table = Table(
+    "events_x_event_types",
+    Base.metadata,
+    Column("event_id", Integer, ForeignKey("events.id"), primary_key=True),
+    Column("event_type_id", Integer, ForeignKey("event_types.id"), primary_key=True),
+)
+
+event_x_event_tag_table = Table(
+    "event_tags_x_events",
+    Base.metadata,
+    Column("event_id", Integer, ForeignKey("events.id"), primary_key=True),
+    Column("event_tag_id", Integer, ForeignKey("event_tags.id"), primary_key=True),
+)
+
+
 class Event(Base):
     """
     Model representing an event or series; the same model is used for both with a self-referential relationship for series.
@@ -545,6 +600,15 @@ class Event(Base):
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
+    org: Mapped[Org] = relationship(innerjoin=True, cascade="expunge")
+    location: Mapped[Location] = relationship(innerjoin=True, cascade="expunge")
+    event_types: Mapped[List[EventType]] = relationship(
+        secondary=event_x_event_type_table, innerjoin=True, cascade="expunge"
+    )
+    event_tags: Mapped[Optional[List[EventTag]]] = relationship(
+        secondary=event_x_event_tag_table, cascade="expunge"
+    )
+
 
 class AttendanceType(Base):
     """
@@ -738,21 +802,21 @@ class Achievement_x_User(Base):
     )
 
 
-class Achievement_x_Org(Base):
-    """
-    Model representing the association between achievements and organizations.
+# class Achievement_x_Org(Base):
+#     """
+#     Model representing the association between achievements and organizations.
 
-    Attributes:
-        achievement_id (int): The ID of the associated achievement.
-        org_id (int): The ID of the associated organization.
-    """
+#     Attributes:
+#         achievement_id (int): The ID of the associated achievement.
+#         org_id (int): The ID of the associated organization.
+#     """
 
-    __tablename__ = "achievements_x_org"
+#     __tablename__ = "achievements_x_org"
 
-    achievement_id: Mapped[int] = mapped_column(
-        ForeignKey("achievements.id"), primary_key=True
-    )
-    org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
+#     achievement_id: Mapped[int] = mapped_column(
+#         ForeignKey("achievements.id"), primary_key=True
+#     )
+#     org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
 
 
 class Position(Base):
@@ -894,3 +958,20 @@ class MagicLinkAuthSession(Base):
     session_token: Mapped[str]
     created: Mapped[dt_create]
     expiration: Mapped[dt_create]
+
+
+# class Org_x_SlackChannel(Base):
+#     """
+#     Model representing the association between organizations (specifically AOs) and Slack channels.
+
+#     Attributes:
+#         org_id (int): The ID of the associated organization.
+#         slack_channel_id (str): The Slack-internal ID of the associated Slack channel.
+#     """
+
+#     __tablename__ = "orgs_x_slack_channels"
+
+#     org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
+#     slack_channel_id: Mapped[str] = mapped_column(
+#         primary_key=True
+#     )  # Do we need a slack channel table?

{f3_data_models-0.1.7 → f3_data_models-0.1.8}/f3_data_models/utils.py

@@ -3,11 +3,11 @@ from dataclasses import dataclass
 from typing import List, Optional, Tuple, TypeVar
 
 import sqlalchemy
-from sqlalchemy import and_, select
+from sqlalchemy import Select, and_, select
 
 from sqlalchemy.dialects.postgresql import insert
 from sqlalchemy.engine import Engine
-from sqlalchemy.orm import sessionmaker
+from sqlalchemy.orm import sessionmaker, joinedload
 
 from f3_data_models.models import Base
 
@@ -76,30 +76,35 @@ def close_session(session):
 T = TypeVar("T")
 
 
-class DbManager:
-    def get_record(cls: T, id) -> T:
-        session = get_session()
-        try:
-            x = session.query(cls).filter(cls.get_id() == id).first()
-            if x:
-                session.expunge(x)
-            return x
-        finally:
-            session.rollback()
-            close_session(session)
+def _joinedloads(cls: T, query: Select, joinedloads: list | str) -> Select:
+    if joinedloads == "all":
+        joinedloads = [
+            getattr(cls, relationship.key)
+            for relationship in cls.__mapper__.relationships
+        ]
+    return query.options(*[joinedload(load) for load in joinedloads])
+
 
-    def get(cls: T, id: int) -> T:
+class DbManager:
+    def get(cls: T, id: int, joinedloads: list | str = []) -> T:
         session = get_session()
         try:
-            return session.scalars(select(cls).filter(cls.id == id)).one()
+            query = select(cls).filter(cls.id == id)
+            query = _joinedloads(cls, query, joinedloads)
+            return session.scalars(query).unique().one()
         finally:
             session.rollback()
             close_session(session)
 
-    def find_records(cls: T, filters: Optional[List]) -> List[T]:
-        session = get_session()
+    def find_records(
+        cls: T, filters: Optional[List], joinedloads: List | str = []
+    ) -> List[T]:
+        session = get_session(echo=True)
         try:
-            records = session.scalars(select(cls).filter(*filters)).all()
+            query = select(cls)
+            query = _joinedloads(cls, query, joinedloads)
+            query = query.filter(*filters)
+            records = session.scalars(query).unique().all()
             for r in records:
                 session.expunge(r)
             return records
@@ -107,10 +112,15 @@ class DbManager:
             session.rollback()
             close_session(session)
 
-    def find_first_record(cls: T, filters: Optional[List]) -> T:
+    def find_first_record(
+        cls: T, filters: Optional[List], joinedloads: List | str = []
+    ) -> T:
         session = get_session()
         try:
-            record = session.scalars(select(cls).filter(*filters)).first()
+            query = select(cls)
+            query = _joinedloads(cls, query, joinedloads)
+            query = query.filter(*filters)
+            record = session.scalars(query).unique().first()
             if record:
                 session.expunge(record)
             return record

{f3_data_models-0.1.7 → f3_data_models-0.1.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "f3-data-models"
-version = "0.1.7"
+version = "0.1.8"
 description = "The data schema and models for F3 Nation applications."
 authors = ["Evan Petzoldt <evan.petzoldt@protonmail.com>"]
 readme = "README.md"