Merge pull request #12 from WoosterTech/app/mood

App/mood

Author: WoosterInitiative

.pre-commit-config.yaml

@@ -8,8 +8,16 @@ default_stages:
 
 exclude: ^docs/|/migrations/|devcontainer.json|/users/
 repos:
+  - repo: local
+    hooks:
+      - id: update-build-info
+        name: Update build_info.py
+        entry: python devtools/bump_build.py
+        language: system
+        pass_filenames: false
+        stages: [commit]
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
     - id: trailing-whitespace
     - id: end-of-file-fixer
@@ -31,11 +39,11 @@ repos:
     hooks:
     - id: check-json5
   - repo: https://github.com/fpgmaas/deptry.git
-    rev: 0.23.0
+    rev: 0.23.1
     hooks:
     - id: deptry
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.13
+    rev: v0.12.8
     hooks:
     - id: ruff-check
       args: [--fix]

.vscode/settings.json

@@ -11,5 +11,6 @@
             "source.organizeImports": "explicit"
         },
         "editor.formatOnSave": true,
+        "editor.rulers": [100]
     },
 }

config/settings/base.py

@@ -3,13 +3,18 @@
 """Base settings to build other settings files upon."""
 
 from pathlib import Path
+from typing import cast
 
 import environ
 from django.contrib.messages import constants as message_constants
 from loguru import logger
 
 from config.settings.drf_models import Spectacular
 from config.settings.settings_models import Databases, Logging
+from devtools.bump_build import BUILD_INFO_FILE, GitInfo
+from incredible_data import (
+    __version__,  # pyright: ignore[reportAttributeAccessIssue, reportUnknownVariableType]
+)
 
 BASE_DIR = Path(__file__).resolve(strict=True).parent.parent.parent
 # incredible_data/
@@ -18,6 +23,22 @@
     SOCIALACCOUNT_PROVIDERS=(dict, {}),
 )
 
+
+def get_git_info() -> GitInfo:
+    """Attempts to use git to collect versioning info, falling back to the build info file."""
+    try:
+        return GitInfo.get_info()
+    except RuntimeError:
+        return GitInfo.from_file(BUILD_INFO_FILE)
+
+
+git_info = get_git_info()
+
+VERSION = cast("str", __version__)
+BUILD_NUMBER = git_info.commit_hash
+
+logger.debug(f"Current version: {VERSION}+{BUILD_NUMBER}")
+
 READ_DOT_ENV_FILE = env.bool("DJANGO_READ_DOT_ENV_FILE", default=False)
 
 if READ_DOT_ENV_FILE:
@@ -56,13 +77,14 @@
 # DATABASES
 # ------------------------------------------------------------------------------
 # https://docs.djangoproject.com/en/dev/ref/settings/#databases
-# databases_obj = Databases.model_validate(
-#     {"default": env.db("DATABASE_URL", default="sqlite:///db.sqlite3")}
-# )
-# databases_obj["default"].atomic_requests = True
-DATABASES = {"default": env.db("DATABASE_URL", default="sqlite:///db.sqlite3")}
-DATABASES["default"]["ATOMIC_REQUESTS"] = True
-logger.debug(f"Databases settings: {DATABASES}")
+databases_obj = Databases.model_validate(
+    {"default": env.db("DATABASE_URL", default="sqlite:///db.sqlite3")}
+)
+databases_obj.default.atomic_requests = True
+DATABASES = databases_obj.render()
+# DATABASES = {"default": env.db("DATABASE_URL", default="sqlite:///db.sqlite3")}
+# DATABASES["default"]["ATOMIC_REQUESTS"] = True
+logger.debug(f"Default database engine: {databases_obj.default.engine_name}")
 # https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-DEFAULT_AUTO_FIELD
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
@@ -83,7 +105,7 @@
     "django.contrib.messages",
     "django.contrib.staticfiles",
     # "django.contrib.humanize", # Handy template tags
-    # "constance",
+    "constance",
     "django.contrib.admin",
     "django.forms",
 ]
@@ -238,6 +260,7 @@
                 "django.template.context_processors.static",
                 "django.template.context_processors.tz",
                 "django.contrib.messages.context_processors.messages",
+                "incredible_data.helpers.context_processors.version",
                 "incredible_data.users.context_processors.allauth_settings",
             ],
         },
@@ -402,15 +425,24 @@
 CURRENCIES = ("USD",)
 DEFAULT_CURRENCY = "USD"
 
+## Constance
+
 # CONSTANCE_REDIS_CONNECTION = env.cache_url("REDIS_URL")
+CONSTANCE_BACKEND = "constance.backends.database.DatabaseBackend"
+
+CONSTANCE_CONFIG = {
+    # "Morning Start": (dt.time(6, 0), "hello"),
+    # "Morning End": (dt.time(12, 0), "hello"),
+    # "Afternoon Start": (dt.time(12, 0), "hello"),
+    # "Afternoon End": (dt.time(18, 0), "hello"),
+    # "Evening Start": (dt.time(18, 0), "hello"),
+    # "Evening End": (dt.time(21, 0), "hello"),
+}
 
-# CONSTANCE_CONFIG = {
-#     "AZURE_ENDPOINT": (
-#         "Set Azure Endpoint",
-#         "Azure Endpoint assigned to project for receipt ML.",
-#         str,
-#     ),
-#     "AZURE_KEY": ("must set azure key", "Unique Key for receipt ML", str),
+# CONSTANCE_CONFIG_FIELDSETS = {
+#     "Morning": ("Morning Start", "Morning End"),
+#     "Afternoon": ("Afternoon Start", "Afternoon End"),
+#     "Evening": ("Evening Start", "Evening End"),
 # }
 
 AZURE_ENDPOINT = env.str("DJANGO_AZURE_ENDPOINT", "")

config/settings/settings_models.py

@@ -4,7 +4,8 @@
 
 from attrmagic import ClassBase, SimpleDict
 from attrmagic.sentinels import MISSING, Missing
-from pydantic import ConfigDict, Field, SecretStr, model_serializer
+from loguru import logger
+from pydantic import ConfigDict, Field, SecretStr, field_validator, model_serializer
 
 
 def serialize_missing(self: ClassBase) -> dict[str, Any]:  # pyright: ignore[reportExplicitAny]
@@ -108,12 +109,29 @@ class Database(ClassBase):
     conn_health_checks: bool | Missing = MISSING
     options: DatabaseOptions | Missing = MISSING
     password: SecretStr | Missing = MISSING
-    port: Annotated[int | Missing, Field(ge=0, le=65535)] = MISSING
+    port: Annotated[int, Field(ge=0, le=65535)] | Missing = MISSING
     time_zone: str | Missing = MISSING
     disable_server_side_cursors: bool | Missing = MISSING
     user: str | Missing = MISSING
     test: TestDatabase | Missing = MISSING
 
+    @field_validator("engine", mode="before")
+    @classmethod
+    def validate_builtin_engine(cls, v: Any) -> Any:  # pyright: ignore[reportAny, reportExplicitAny]
+        try:
+            return BuiltInEngine(v)
+        except KeyError:
+            logger.warning(f"Unknown database engine: {v}")
+
+        return v  # pyright: ignore[reportAny]
+
+    @field_validator("port", mode="before")
+    @classmethod
+    def validate_empty_port(cls, v: Any) -> Any:  # pyright: ignore[reportAny, reportExplicitAny]
+        if v in ("",):
+            return MISSING
+        return v  # pyright: ignore[reportAny]
+
     @model_serializer
     def serialize_missing(self) -> dict[str, Any]:  # pyright: ignore[reportExplicitAny]
         output: dict[str, Any] = {}  # pyright: ignore[reportExplicitAny]
@@ -128,6 +146,16 @@ def serialize_missing(self) -> dict[str, Any]:  # pyright: ignore[reportExplicit
 
         return output
 
+    @property
+    def engine_name(self) -> str | None:
+        try:
+            return self.engine.name  # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType, reportAttributeAccessIssue]
+
+        except AttributeError:
+            if self.engine is MISSING:
+                return None
+            return self.engine
+
 
 class Databases(SimpleDict[str, Database]):
     def render(self) -> dict[str, dict[str, Any]]:  # pyright: ignore[reportExplicitAny]
@@ -136,6 +164,11 @@ def render(self) -> dict[str, dict[str, Any]]:  # pyright: ignore[reportExplicit
         """
         return {db_name: db.model_dump(by_alias=True) for db_name, db in self.items()}
 
+    @property
+    def default(self) -> Database:
+        assert "default" in self.root
+        return self["default"]
+
 
 if __name__ == "__main__":
     # This block is for testing purposes only

devtools/__init__.py

@@ -0,0 +1,106 @@
+import re
+import subprocess
+from enum import StrEnum
+from pathlib import Path
+from typing import ClassVar, Self
+
+from attrmagic import ClassBase
+
+PROJECT_BASE_PATH = Path(__file__).parent.parent / "incredible_data"
+
+VERSION_FILE = PROJECT_BASE_PATH / "__init__.py"
+BUILD_INFO_FILE = PROJECT_BASE_PATH / "build_info.py"
+
+assert VERSION_FILE.exists(), "Version file does not exist, check the path"
+
+
+def bump_build():
+    text = VERSION_FILE.read_text()
+    value_pattern = r"__build__\s*=\s*(\d+)"
+    match = re.search(value_pattern, text)
+
+    if not match:
+        msg = "Could not find __build__ in version file"
+        raise ValueError(msg)
+
+    build_number = int(match.group(1)) + 1
+
+    replace_pattern = r"(__build__\s*=\s*)(\d+)"
+    new_text = re.sub(replace_pattern, rf"\1{build_number}", text)
+
+    _ = VERSION_FILE.write_text(new_text)
+
+
+class GitCommand(StrEnum):
+    REV_LIST = "rev-list"
+    REV_PARSE = "rev-parse"
+
+
+def git_output(command: GitCommand, *options: str, commit: str = "HEAD") -> str:
+    result = subprocess.check_output(  # noqa: S603
+        ["git", command, *options, commit],  # noqa: S607
+        stderr=subprocess.DEVNULL,
+    )
+    return result.decode("utf-8").strip()
+
+
+class GitInfo(ClassBase):
+    commit_count: int
+    commit_hash: str
+
+    build_number_variable_name: ClassVar[str] = "BUILD_NUMBER"
+    commit_hash_variable_name: ClassVar[str] = "COMMIT_HASH"
+
+    @classmethod
+    def get_info(cls) -> Self:
+        try:
+            commit_count = git_output(GitCommand.REV_LIST, "--count")
+            commit_hash = git_output(GitCommand.REV_PARSE, "--short")
+            return cls(commit_count=commit_count, commit_hash=commit_hash)  # pyright: ignore[reportArgumentType]
+        except subprocess.CalledProcessError:
+            msg = "Failed to get git info, is git installed?"
+            raise RuntimeError(msg) from None
+
+    def write_file(self, file_path: Path) -> None:
+        content = (
+            f'BUILD_NUMBER = {self.commit_count}\nCOMMIT_HASH = "{self.commit_hash}"\n'
+        )
+        _ = file_path.write_text(content)
+
+    @classmethod
+    def _build_build_number_pattern(cls) -> "re.Pattern[str]":
+        return re.compile(rf"^{cls.build_number_variable_name}\s*=\s*(\d+)")
+
+    @classmethod
+    def _build_commit_hash_pattern(cls) -> "re.Pattern[str]":
+        return re.compile(rf"^{cls.commit_hash_variable_name}\s*=\s*\"([0-9a-f]+)\"")
+
+    @classmethod
+    def from_file(cls, file_path: Path) -> Self:
+        content = file_path.read_text()
+        build_number_matches = cls._build_build_number_pattern().search(content)
+        commit_hash_matches = cls._build_commit_hash_pattern().search(content)
+
+        if not build_number_matches or not commit_hash_matches:
+            msg = "Failed to parse build info file"
+            raise ValueError(msg)
+
+        build_number = int(build_number_matches.group(1))
+        commit_hash = commit_hash_matches.group(1)
+
+        return cls(commit_count=build_number, commit_hash=commit_hash)
+
+
+def _stage_file(file_path: Path) -> None:
+    file_path_str = str(file_path)
+    _ = subprocess.run(["git", "add", file_path_str], check=False)  # noqa: S603, S607
+
+
+def update_build_info():
+    git_info = GitInfo.get_info()
+    git_info.write_file(BUILD_INFO_FILE)
+    _stage_file(BUILD_INFO_FILE)
+
+
+if __name__ == "__main__":
+    update_build_info()

devtools/bump_build.py

@@ -0,0 +1,2 @@
+BUILD_NUMBER = 175
+COMMIT_HASH = "0543f4e"