igs-slm 0.1.4b0__py3-none-any.whl → 0.1.5b1__py3-none-any.whl

slm/defines/SiteFileUploadStatus.py

@@ -13,30 +13,13 @@ class SiteFileUploadStatus(IntegerChoices, p("help")):
 
     _symmetric_builtins_ = [s("name", case_fold=True)]
 
-    UNPUBLISHED = (
-        1,
-        _("Unpublished File"),
-        _("The file is pending moderation before it will be made public."),
-    )
-
-    PUBLISHED = (
-        2,
-        _("Published File"),
-        _(
-            "The file is published and is publicly available as an attachment "
-            "to the site."
-        ),
-    )
-
-    INVALID = (3, _("Invalid Site Log"), _("The file did not pass validation."))
-
-    WARNINGS = (
-        4,
-        _("Warnings Site Log"),
-        _("The file is valid but has some warnings."),
-    )
-
-    VALID = (5, _("Valid Site Log"), _("The file is valid."))
+    # fmt: off
+    UNPUBLISHED = 1, _("Unpublished File"),  _("The file is pending moderation before it will be made public.")
+    PUBLISHED   = 2, _("Published File"),    _("The file is published and is publicly available as an attachment to the site.")
+    INVALID     = 3, _("Invalid Site Log"),  _("The file did not pass validation.")
+    WARNINGS    = 4, _("Warnings Site Log"), _("The file is valid but has some warnings.")
+    VALID       = 5, _("Valid Site Log"),    _("The file is valid.")
+    # fmt: on
 
     @classmethod
     def status_by_filetype(cls, filetype):

slm/defines/SiteLogFormat.py

@@ -9,41 +9,17 @@ class SiteLogFormat(
     p("icon"),
     s("ext", case_fold=True),
     s("alts", case_fold=True),
+    s("alt_exts", case_fold=True),
 ):
     _symmetric_builtins_ = [s("name", case_fold=True)]
 
-    LEGACY = (
-        1,
-        _("Legacy (ASCII)"),
-        "text/plain",
-        "bi bi-file-text",
-        "log",
-        ["text", "txt", "legacy"],
-    )
-    GEODESY_ML = (
-        2,
-        _("GeodesyML"),
-        "application/xml",
-        "bi bi-filetype-xml",
-        "xml",
-        ["xml"],
-    )
-    JSON = (
-        3,
-        _("JSON"),
-        "application/json",
-        "bi bi-filetype-json",
-        "json",
-        ["json", "js"],
-    )
-    ASCII_9CHAR = (
-        4,
-        _("ASCII (9-Char)"),
-        "text/plain",
-        "bi bi-file-text",
-        "log",
-        ["text", "txt", "9char"],
-    )
+    # fmt: off
+    # name       value     label             mimetype             icon                ext             alts                  alt_exts
+    LEGACY      = 1, _("Legacy (ASCII)"), "text/plain",       "bi bi-file-text",     "log",  ["text", "txt", "legacy"], ["txt", "sitelog"]
+    GEODESY_ML  = 2, _("GeodesyML"),      "application/xml",  "bi bi-filetype-xml",  "xml",  ["xml"],                   ["gml"]
+    JSON        = 3, _("JSON"),           "application/json", "bi bi-filetype-json", "json", ["json", "js"],            ["js"]
+    ASCII_9CHAR = 4, _("ASCII (9-Char)"), "text/plain",       "bi bi-file-text",     "log",  ["text", "txt", "9char"],  ["txt", "sitelog"]
+    # fmt: on
 
     def __str__(self):
         return str(self.label)

slm/defines/SiteLogStatus.py

@@ -6,37 +6,18 @@ from enum_properties import p, s
 class SiteLogStatus(IntegerChoices, p("help")):
     _symmetric_builtins_ = [s("name", case_fold=True)]
 
-    FORMER = (
-        1,
-        _("Former"),
-        _("Site is no longer maintained and logs are not published."),
-    )
-
-    PROPOSED = (
-        2,
-        _("Proposed"),
-        _("This is a new Site that has never been published."),
-    )
-
-    UPDATED = (3, _("Updated"), _("Site log or section has unpublished updates."))
-
-    PUBLISHED = (
-        4,
-        _("Published"),
-        _("Site log or section is published with no unpublished changes."),
-    )
-
-    EMPTY = (5, _("Empty"), _("Site log section is empty or deleted."))
-
-    SUSPENDED = (
-        6,
-        _("Suspended"),
-        _("Site has been temporarily suspended and does not appear in public" " data."),
-    )
+    # fmt: off
+    FORMER    = 1, _("Former"),    _("Site is no longer maintained and logs are not published.")
+    PROPOSED  = 2, _("Proposed"),  _("This is a new Site that has never been published.")
+    UPDATED   = 3, _("Updated"),   _("Site log or section has unpublished updates.")
+    PUBLISHED = 4, _("Published"), _("Site log or section is published with no unpublished changes.")
+    EMPTY     = 5, _("Empty"),     _("Site log section is empty or deleted.")
+    SUSPENDED = 6, _("Suspended"), _("Site has been temporarily suspended and does not appear in public data.")
+    # fmt: on
 
     @property
     def css(self):
-        return f'slm-status-{self.label.lower().replace(" ", "-")}'
+        return f"slm-status-{self.label.lower().replace(' ', '-')}"
 
     @property
     def color(self):

slm/defines/TectonicPlates.py

@@ -5,24 +5,26 @@ from enum_properties import s
 class TectonicPlates(TextChoices):
     _symmetric_builtins_ = [s("name", case_fold=True), s("label", case_fold=True)]
 
-    AFRICAN = "AF", "African"
-    ANTARCTIC = "AN", "Antarctic"
-    ARABIAN = "AR", "Arabian"
-    AUSTRALIAN = "AU", "Australian"
-    CARIBBEAN = "CA", "Caribbean"
-    COCOS = "CO", "Cocos"
-    EURASIAN = "EU", "Eurasian"
-    INDIAN = "IN", "Indian"
-    JUAN_DE_FUCA = "JU", "Juan de Fuca"
-    NAZCA = "NZ", "Nazca"
+    # fmt: off
+    AFRICAN        = "AF", "African"
+    ANTARCTIC      = "AN", "Antarctic"
+    ARABIAN        = "AR", "Arabian"
+    AUSTRALIAN     = "AU", "Australian"
+    CARIBBEAN      = "CA", "Caribbean"
+    COCOS          = "CO", "Cocos"
+    EURASIAN       = "EU", "Eurasian"
+    INDIAN         = "IN", "Indian"
+    JUAN_DE_FUCA   = "JU", "Juan de Fuca"
+    NAZCA          = "NZ", "Nazca"
     NORTH_AMERICAN = "NA", "North American"
-    PACIFIC = "PA", "Pacific"
-    PHILIPPINE = "PH", "Philippine"
-    SCOTIA = "SC", "Scotia"
+    PACIFIC        = "PA", "Pacific"
+    PHILIPPINE     = "PH", "Philippine"
+    SCOTIA         = "SC", "Scotia"
     SOUTH_AMERICAN = "SA", "South American"
-    NUBIA = "NU", "Nubia"
-    SOMALIA = "SO", "Somalia"
-    MARIANA = "MA", "Mariana"
+    NUBIA          = "NU", "Nubia"
+    SOMALIA        = "SO", "Somalia"
+    MARIANA        = "MA", "Mariana"
+    # fmt: on
 
     def __str__(self):
         return str(self.label)

slm/manage.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+
+import os
+import sys
+
+from django.core.management import execute_from_command_line
+
+
+def main():
+    """Run administrative tasks."""
+
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "slm.settings.root")
+    # We use a slightly different logger config if we're running a management command vs serving
+    if len(sys.argv) > 1:
+        subcommand = sys.argv[1]
+        if subcommand != "runserver":
+            os.environ["SLM_MANAGEMENT_FLAG"] = "ON"
+        ##################################################
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

slm/management/commands/check_upgrade.py

@@ -0,0 +1,142 @@
+"""
+Occasionally it is helpful to delete all the migration files and start anew with one
+simple initial migration. Changes accumulate over time, or old migration files may
+cause errors on new software stacks. This command facilitates a transition back to
+one initial migration file on a version upgrade. One side effect of this is that you
+may need to migrate through multiple versions instead of being able to make one big
+jump. This command will check for these cases and fail if the migration from the
+current software version is unsafe on the current database version.
+"""
+
+import bisect
+import typing as t
+
+import typer
+from django.core.management import CommandError
+from django.db import connection
+from django.db.migrations.loader import MigrationLoader
+from django.utils.translation import gettext as _
+from django_typer.management import TyperCommand, command
+from packaging.version import InvalidVersion, Version, parse
+from typing_extensions import Annotated
+
+from slm import __version__ as slm_version
+from slm.models import SLMVersion
+
+
+def parse_version(version: str) -> Version:
+    try:
+        parse(version)
+    except InvalidVersion as verr:
+        raise typer.BadParameter(
+            f"{version} is not a valid Python package version string."
+        ) from verr
+
+
+def get_ordered_migration_paths(app_label):
+    loader = MigrationLoader(connection)
+    graph = loader.graph
+
+    app_migrations = [key for key in graph.nodes.keys() if key[0] == app_label]
+
+    if not app_migrations:
+        raise ValueError(f"No migrations found for app '{app_label}'")
+
+    latest_keys = graph.leaf_nodes(app_label)
+
+    # Get the full dependency plan (in order)
+    plan = []
+    for latest in latest_keys:
+        plan.extend(graph.forwards_plan(latest))
+
+    # De-duplicate and filter only this app's migrations
+    seen = set()
+    ordered_keys = [
+        m for m in plan if m[0] == app_label and not (m in seen or seen.add(m))
+    ]
+
+    return [loader.get_migration(app, name) for app, name in ordered_keys]
+
+
+class Command(TyperCommand):
+    help = _(
+        "Make sure the attempted upgrade is safe. And if it is, make any migration table "
+        "edits that are necessary."
+    )
+
+    # when upgrading the SLM it is required that an upgrade run through
+    # these specific versions. These versions are points at which the migration
+    # files were remade - meaning the database state may not be migrated correctly
+    # if it was not first updated to be state consistent with these specific versions.
+    VERSION_WAYPOINTS = list(sorted([parse("0.1.5b")]))
+
+    requires_migrations_checks = False
+    requires_system_checks = []
+
+    def closest_waypoint_gte(self, version: Version) -> t.Optional[Version]:
+        idx = bisect.bisect_left(self.VERSION_WAYPOINTS, version)
+        if idx < len(self.VERSION_WAYPOINTS):
+            return self.VERSION_WAYPOINTS[idx]
+        return None
+
+    def closest_waypoint_lte(self, version: Version) -> t.Optional[Version]:
+        idx = bisect.bisect_right(self.VERSION_WAYPOINTS, version)
+        if idx > 0:
+            return self.VERSION_WAYPOINTS[idx - 1]
+        return None
+
+    @command(
+        help="Check that it is safe to run migrations from the installed version of igs-slm."
+    )
+    def is_safe(self):
+        db_version: Version = SLMVersion.load().version or parse("0.1.4b")
+        if db_version > slm_version:
+            # downgrades are possible with reversible migrations - we only
+            # balk if the downgrade would travel through a migration waypoint
+            nearest_waypoint = self.closest_waypoint_lte(db_version)
+            if nearest_waypoint and nearest_waypoint > slm_version:
+                raise CommandError(
+                    f"Unable to downgrade from {db_version} to {slm_version}. "
+                    f"Traverses version waypoint: {nearest_waypoint}. "
+                    f"It is recommended that you restore from a database backup."
+                )
+        elif db_version < slm_version:
+            # Upgrades must pass through all waypoints between the database code version and
+            # the installed version of igs-slm
+            nearest_waypoint = self.closest_waypoint_gte(db_version)
+            if nearest_waypoint and nearest_waypoint < slm_version:
+                raise CommandError(
+                    f"Unable to upgrade from {db_version} to {slm_version}. "
+                    f"Traverses version waypoint: {nearest_waypoint}. "
+                    f"You must first install and upgrade SLM at the waypoint: "
+                    f"pip install igs-slm=={nearest_waypoint}."
+                )
+
+    @command(
+        help="Force the database igs-slm version to the installed igs-slm version or the given value."
+    )
+    def set_db_version(
+        self,
+        version: Annotated[
+            Version,
+            typer.Option(
+                help="The version string to set in the database if different than installed.",
+                parser=parse_version,
+            ),
+        ],
+    ):
+        from slm import __version__ as slm_version
+
+        version = version or parse_version(slm_version)
+        if version != SLMVersion.load().version:
+            confirm = typer.confirm(
+                _(
+                    "You are about to force the database to record the version of the igs-slm "
+                    f"software it is structurally synchronized to "
+                    f"({SLMVersion.load().version} -> {version}). Are you sure you want to do this?"
+                )
+            )
+            if not confirm:
+                self.secho(_("Aborted."), fg="red")
+                raise typer.Exit(code=1)
+            SLMVersion.update(version=version)