plain.models 0.34.4__tar.gz → 0.36.0__tar.gz

{plain_models-0.34.4 → plain_models-0.36.0}/.gitignore

@@ -16,3 +16,6 @@ plain*/tests/.plain
 
 # Plain temp dirs
 .plain
+
+coverage.xml
+.vscode

{plain_models-0.34.4 → plain_models-0.36.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.models
-Version: 0.34.4
+Version: 0.36.0
 Summary: Database models for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE

{plain_models-0.34.4 → plain_models-0.36.0}/plain/models/CHANGELOG.md

@@ -1,5 +1,27 @@
 # plain-models changelog
 
+## [0.36.0](https://github.com/dropseed/plain/releases/plain-models@0.36.0) (2025-07-18)
+
+### What's changed
+
+- Removed the `--merge` option from the `makemigrations` command ([d366663](https://github.com/dropseed/plain/commit/d366663))
+- Improved error handling in the `restore-backup` command using Click's error system ([88f06c5](https://github.com/dropseed/plain/commit/88f06c5))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.35.0](https://github.com/dropseed/plain/releases/plain-models@0.35.0) (2025-07-07)
+
+### What's changed
+
+- Added the `plain models list` CLI command which prints a nicely formatted list of all installed models, including their table name, fields, and originating package. You can pass package labels to filter the output or use the `--app-only` flag to only show first-party app models ([1bc40ce](https://github.com/dropseed/plain/commit/1bc40ce)).
+- The MySQL backend no longer enforces a strict `mysqlclient >= 1.4.3` version check and had several unused constraint-handling methods removed, reducing boilerplate and improving compatibility with a wider range of `mysqlclient` versions ([6322400](https://github.com/dropseed/plain/commit/6322400), [67f21f6](https://github.com/dropseed/plain/commit/67f21f6)).
+
+### Upgrade instructions
+
+- No changes required
+
 ## [0.34.4](https://github.com/dropseed/plain/releases/plain-models@0.34.4) (2025-07-02)
 
 ### What's changed

{plain_models-0.34.4 → plain_models-0.36.0}/plain/models/backends/mysql/base.py

@@ -6,23 +6,16 @@ Requires mysqlclient: https://pypi.org/project/mysqlclient/
 
 from functools import cached_property
 
+import MySQLdb as Database
+from MySQLdb.constants import CLIENT, FIELD_TYPE
+from MySQLdb.converters import conversions
+
 from plain.exceptions import ImproperlyConfigured
 from plain.models.backends import utils as backend_utils
 from plain.models.backends.base.base import BaseDatabaseWrapper
 from plain.models.db import IntegrityError
 from plain.utils.regex_helper import _lazy_re_compile
 
-try:
-    import MySQLdb as Database
-except ImportError as err:
-    raise ImproperlyConfigured(
-        "Error loading MySQLdb module.\nDid you install mysqlclient?"
-    ) from err
-
-from MySQLdb.constants import CLIENT, FIELD_TYPE
-from MySQLdb.converters import conversions
-
-# Some of these import MySQLdb, so import them after checking if it's installed.
 from .client import DatabaseClient
 from .creation import DatabaseCreation
 from .features import DatabaseFeatures
@@ -31,13 +24,6 @@ from .operations import DatabaseOperations
 from .schema import DatabaseSchemaEditor
 from .validation import DatabaseValidation
 
-version = Database.version_info
-if version < (1, 4, 3):
-    raise ImproperlyConfigured(
-        f"mysqlclient 1.4.3 or newer is required; you have {Database.__version__}."
-    )
-
-
 # MySQLdb returns TIME columns as timedelta -- they are more like timedelta in
 # terms of actual behavior as they are signed and include days -- and Plain
 # expects time.
@@ -281,37 +267,8 @@ class DatabaseWrapper(BaseDatabaseWrapper):
         with self.wrap_database_errors:
             self.connection.autocommit(autocommit)
 
-    def disable_constraint_checking(self):
-        """
-        Disable foreign key checks, primarily for use in adding rows with
-        forward references. Always return True to indicate constraint checks
-        need to be re-enabled.
-        """
-        with self.cursor() as cursor:
-            cursor.execute("SET foreign_key_checks=0")
-        return True
-
-    def enable_constraint_checking(self):
-        """
-        Re-enable foreign key checks after they have been disabled.
-        """
-        # Override needs_rollback in case constraint_checks_disabled is
-        # nested inside transaction.atomic.
-        self.needs_rollback, needs_rollback = False, self.needs_rollback
-        try:
-            with self.cursor() as cursor:
-                cursor.execute("SET foreign_key_checks=1")
-        finally:
-            self.needs_rollback = needs_rollback
-
     def check_constraints(self, table_names=None):
-        """
-        Check each table name in `table_names` for rows with invalid foreign
-        key references. This method is intended to be used in conjunction with
-        `disable_constraint_checking()` and `enable_constraint_checking()`, to
-        determine if rows with invalid references were entered while constraint
-        checks were off.
-        """
+        """Check ``table_names`` for rows with invalid foreign key references."""
         with self.cursor() as cursor:
             if table_names is None:
                 table_names = self.introspection.table_names(cursor)

{plain_models-0.34.4 → plain_models-0.36.0}/plain/models/backends/mysql/schema.py

@@ -1,6 +1,8 @@
 from plain.models.backends.base.schema import BaseDatabaseSchemaEditor
 from plain.models.constants import LOOKUP_SEP
-from plain.models.fields import NOT_PROVIDED, F, UniqueConstraint
+from plain.models.constraints import UniqueConstraint
+from plain.models.expressions import F
+from plain.models.fields import NOT_PROVIDED
 
 
 class DatabaseSchemaEditor(BaseDatabaseSchemaEditor):

{plain_models-0.34.4 → plain_models-0.36.0}/plain/models/backups/cli.py

@@ -66,12 +66,10 @@ def restore_backup(backup_name, latest, pg_restore):
     backups_handler = DatabaseBackups()
 
     if backup_name and latest:
-        click.secho("Only one of --latest or backup_name is allowed", fg="red")
-        exit(1)
+        raise click.UsageError("Only one of --latest or backup_name is allowed")
 
     if not backup_name and not latest:
-        click.secho("Backup name or --latest is required", fg="red")
-        exit(1)
+        raise click.UsageError("Backup name or --latest is required")
 
     if not backup_name and latest:
         backup_name = backups_handler.find_backups()[0].name

{plain_models-0.34.4 → plain_models-0.36.0}/plain/models/cli.py

@@ -2,7 +2,6 @@ import os
 import subprocess
 import sys
 import time
-from itertools import takewhile
 
 import click
 
@@ -22,12 +21,10 @@ from .migrations.migration import Migration, SettingsTuple
 from .migrations.optimizer import MigrationOptimizer
 from .migrations.questioner import (
     InteractiveMigrationQuestioner,
-    MigrationQuestioner,
     NonInteractiveMigrationQuestioner,
 )
 from .migrations.recorder import MigrationRecorder
 from .migrations.state import ModelState, ProjectState
-from .migrations.utils import get_migration_name_timestamp
 from .migrations.writer import MigrationWriter
 from .registry import models_registry
 
@@ -92,10 +89,41 @@ def db_wait():
                 )
             time.sleep(1.5)
         else:
-            click.secho("Database ready", fg="green")
+            click.secho("✔ Database ready", fg="green")
             break
 
 
+@cli.command(name="list")
+@click.argument("package_labels", nargs=-1)
+@click.option(
+    "--app-only",
+    is_flag=True,
+    help="Only show models from packages that start with 'app'.",
+)
+def list_models(package_labels, app_only):
+    """List installed models."""
+
+    packages = set(package_labels)
+
+    for model in sorted(
+        models_registry.get_models(),
+        key=lambda m: (m._meta.package_label, m._meta.model_name),
+    ):
+        pkg = model._meta.package_label
+        pkg_name = packages_registry.get_package_config(pkg).name
+        if app_only and not pkg_name.startswith("app"):
+            continue
+        if packages and pkg not in packages:
+            continue
+        fields = ", ".join(f.name for f in model._meta.get_fields())
+        click.echo(
+            f"{click.style(pkg, fg='cyan')}.{click.style(model.__name__, fg='blue')}"
+        )
+        click.echo(f"  table: {model._meta.db_table}")
+        click.echo(f"  fields: {fields}")
+        click.echo(f"  package: {pkg_name}\n")
+
+
 @register_cli("makemigrations")
 @cli.command()
 @click.argument("package_labels", nargs=-1)
@@ -104,7 +132,6 @@ def db_wait():
     is_flag=True,
     help="Just show what migrations would be made; don't actually write them.",
 )
-@click.option("--merge", is_flag=True, help="Enable fixing of migration conflicts.")
 @click.option("--empty", is_flag=True, help="Create an empty migration.")
 @click.option(
     "--noinput",
@@ -126,9 +153,7 @@ def db_wait():
     default=1,
     help="Verbosity level; 0=minimal output, 1=normal output, 2=verbose output, 3=very verbose output",
 )
-def makemigrations(
-    package_labels, dry_run, merge, empty, no_input, name, check, verbosity
-):
+def makemigrations(package_labels, dry_run, empty, no_input, name, check, verbosity):
     """Creates new migration(s) for packages."""
 
     written_files = []
@@ -195,103 +220,6 @@ def makemigrations(
                     )
                     log(writer.as_string(), level=3)
 
-    def handle_merge(loader, conflicts):
-        """Handle merging conflicting migrations."""
-        if interactive:
-            questioner = InteractiveMigrationQuestioner()
-        else:
-            questioner = MigrationQuestioner(defaults={"ask_merge": True})
-
-        for package_label, migration_names in conflicts.items():
-            log(click.style(f"Merging {package_label}", fg="cyan", bold=True), level=1)
-
-            merge_migrations = []
-            for migration_name in migration_names:
-                migration = loader.get_migration(package_label, migration_name)
-                migration.ancestry = [
-                    mig
-                    for mig in loader.graph.forwards_plan(
-                        (package_label, migration_name)
-                    )
-                    if mig[0] == migration.package_label
-                ]
-                merge_migrations.append(migration)
-
-            def all_items_equal(seq):
-                return all(item == seq[0] for item in seq[1:])
-
-            merge_migrations_generations = zip(*(m.ancestry for m in merge_migrations))
-            common_ancestor_count = sum(
-                1 for _ in takewhile(all_items_equal, merge_migrations_generations)
-            )
-            if not common_ancestor_count:
-                raise ValueError(f"Could not find common ancestor of {migration_names}")
-
-            for migration in merge_migrations:
-                migration.branch = migration.ancestry[common_ancestor_count:]
-                migrations_ops = (
-                    loader.get_migration(node_package, node_name).operations
-                    for node_package, node_name in migration.branch
-                )
-                migration.merged_operations = sum(migrations_ops, [])
-
-            for migration in merge_migrations:
-                log(click.style(f"  Branch {migration.name}", fg="yellow"), level=1)
-                for operation in migration.merged_operations:
-                    log(f"    - {operation.describe()}", level=1)
-
-            if questioner.ask_merge(package_label):
-                numbers = [
-                    MigrationAutodetector.parse_number(migration.name)
-                    for migration in merge_migrations
-                ]
-                biggest_number = (
-                    max(x for x in numbers if x is not None) if numbers else 0
-                )
-
-                subclass = type(
-                    "Migration",
-                    (Migration,),
-                    {
-                        "dependencies": [
-                            (package_label, migration.name)
-                            for migration in merge_migrations
-                        ],
-                    },
-                )
-
-                parts = [f"{biggest_number + 1:04d}"]
-                if migration_name:
-                    parts.append(migration_name)
-                else:
-                    parts.append("merge")
-                    leaf_names = "_".join(
-                        sorted(migration.name for migration in merge_migrations)
-                    )
-                    if len(leaf_names) > 47:
-                        parts.append(get_migration_name_timestamp())
-                    else:
-                        parts.append(leaf_names)
-
-                new_migration_name = "_".join(parts)
-                new_migration = subclass(new_migration_name, package_label)
-                writer = MigrationWriter(new_migration)
-
-                if not dry_run:
-                    with open(writer.path, "w", encoding="utf-8") as fh:
-                        fh.write(writer.as_string())
-                    log(f"\nCreated new merge migration {writer.path}", level=1)
-                elif verbosity == 3:
-                    log(
-                        click.style(
-                            f"Full merge migrations file '{writer.filename}':",
-                            fg="cyan",
-                            bold=True,
-                        ),
-                        level=3,
-                    )
-                    log(writer.as_string(), level=3)
-
     # Validate package labels
     package_labels = set(package_labels)
     has_bad_labels = False
@@ -320,21 +248,16 @@ def makemigrations(
             if package_label in package_labels
         }
 
-    if conflicts and not merge:
+    if conflicts:
         name_str = "; ".join(
             "{} in {}".format(", ".join(names), package)
             for package, names in conflicts.items()
         )
         raise click.ClickException(
             f"Conflicting migrations detected; multiple leaf nodes in the "
-            f"migration graph: ({name_str}).\nTo fix them run "
-            f"'python manage.py makemigrations --merge'"
+            f"migration graph: ({name_str})."
         )
 
-    # Handle merge if requested
-    if merge and conflicts:
-        return handle_merge(loader, conflicts)
-
     # Set up questioner
     if interactive:
         questioner = InteractiveMigrationQuestioner(
@@ -502,8 +425,7 @@ def migrate(
         )
         raise click.ClickException(
             "Conflicting migrations detected; multiple leaf nodes in the "
-            f"migration graph: ({name_str}).\nTo fix them run "
-            "'python manage.py makemigrations --merge'"
+            f"migration graph: ({name_str})."
         )
 
     # If they supplied command line arguments, work out what they mean.

{plain_models-0.34.4 → plain_models-0.36.0}/plain/models/migrations/questioner.py

@@ -74,10 +74,6 @@ class MigrationQuestioner:
         """Was this model really renamed?"""
         return self.defaults.get("ask_rename_model", False)
 
-    def ask_merge(self, package_label):
-        """Should these migrations really be merged?"""
-        return self.defaults.get("ask_merge", False)
-
     def ask_auto_now_add_addition(self, field_name, model_name):
         """Adding an auto_now_add field to a model."""
         # None means quit
@@ -227,16 +223,6 @@ class InteractiveMigrationQuestioner(MigrationQuestioner):
             default=False,
         )
 
-    def ask_merge(self, package_label):
-        return self._boolean_input(
-            (
-                "\nMerging will only work if the operations printed above do not conflict\n"
-                "with each other (working on different fields or models)\n"
-                "Should these migration branches be merged?"
-            ),
-            default=False,
-        )
-
     def ask_auto_now_add_addition(self, field_name, model_name):
         """Adding an auto_now_add field to a model."""
         if not self.dry_run:

{plain_models-0.34.4 → plain_models-0.36.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.models"
-version = "0.34.4"
+version = "0.36.0"
 description = "Database models for Plain."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 readme = "README.md"

{plain_models-0.34.4 → plain_models-0.36.0}/tests/app/examples/models.py

@@ -47,10 +47,13 @@ class ChildSetNull(models.Model):
 
 @models.register_model
 class ChildSetDefault(models.Model):
+    def default_parent_pk():
+        return DeleteParent.objects.get(name="default").pk
+
     parent = models.ForeignKey(
         DeleteParent,
         on_delete=models.SET_DEFAULT,
-        default=1,
+        default=default_parent_pk,
     )
 
 

{plain_models-0.34.4 → plain_models-0.36.0}/tests/app/settings.py

@@ -4,7 +4,3 @@ INSTALLED_PACKAGES = [
     "plain.models",
     "app.examples",
 ]
-DATABASE = {
-    "ENGINE": "plain.models.backends.sqlite3",
-    "NAME": ":memory:",
-}

{plain_models-0.34.4 → plain_models-0.36.0}/tests/test_delete_behaviors.py

@@ -1,7 +1,6 @@
 import pytest
 from app.examples.models import (
     ChildCascade,
-    ChildDoNothing,
     ChildProtect,
     ChildRestrict,
     ChildSetDefault,
@@ -10,10 +9,8 @@ from app.examples.models import (
 )
 
 from plain.models import (
-    IntegrityError,
     ProtectedError,
     RestrictedError,
-    db_connection,
 )
 
 
@@ -66,11 +63,11 @@ def test_set_default_delete(db):
     assert child.parent_id == default_parent.pk
 
 
-def test_do_nothing_delete(db):
-    default_parent, parent = _create_parents()
-    child = ChildDoNothing.objects.create(parent=parent)
-    parent.delete()
-    with pytest.raises(IntegrityError):
-        db_connection.check_constraints()
-    child.parent = default_parent
-    child.save(clean_and_validate=False)
+# def test_do_nothing_delete(db):
+#     default_parent, parent = _create_parents()
+#     child = ChildDoNothing.objects.create(parent=parent)
+#     parent.delete()
+#     with pytest.raises(IntegrityError):
+#         db_connection.check_constraints()
+#     child.parent = default_parent
+#     child.save(clean_and_validate=False)