plain.models 0.34.4__py3-none-any.whl → 0.35.0__py3-none-any.whl

plain/models/CHANGELOG.md

@@ -1,5 +1,16 @@
 # plain-models changelog
 
+## [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/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/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/cli.py

@@ -96,6 +96,37 @@ def db_wait():
             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)

{plain_models-0.34.4.dist-info → plain_models-0.35.0.dist-info}/METADATA

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

{plain_models-0.34.4.dist-info → plain_models-0.35.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
-plain/models/CHANGELOG.md,sha256=23hduuGGlZJVuZaW57q7mDNH3eJme2JBkyqooogAQVk,3260
+plain/models/CHANGELOG.md,sha256=bUinpgx_HxNjgItauzHyszRtwU7F3Zm33u0mMAZBoDs,4127
 plain/models/README.md,sha256=vsZPev3Fna-Irdcs3-wrOcAoII5LOhXdcWLBMT87CS0,1626
 plain/models/__init__.py,sha256=dnU6MOXs3lGoK31nLWjCqbf7zigkaUccomchz9lNDJ8,2950
 plain/models/aggregates.py,sha256=P0mhsMl1VZt2CVHMuCHnNI8SxZ9citjDLEgioN6NOpo,7240
 plain/models/base.py,sha256=8-F9DvSF5s2_zoGyEmZU5xg9GdEigthVT0HENv9iigI,67952
-plain/models/cli.py,sha256=-K5ZrMbwL-fcUOze64_U4uOPpCuppa-ibdoOaCFvBF4,43966
+plain/models/cli.py,sha256=4iZRHRPXxUCrsW-SzeimIE_lrSkWkLhgYOSk4BxUF_8,44985
 plain/models/config.py,sha256=OF7eIEtXNZyGwgc3eMEpb5uEAup5RXeT-0um60dfBeU,636
 plain/models/connections.py,sha256=RBNa2FZ0x3C9un6PaYL-IYzH_OesRSpdHNGKvYHGiOM,2276
 plain/models/constants.py,sha256=ndnj9TOTKW0p4YcIPLOLEbsH6mOgFi6B1-rIzr_iwwU,210
@@ -40,14 +40,14 @@ plain/models/backends/base/operations.py,sha256=Y08cS7IZwYXMKVUoEpBCjyOTh1PW2OSh
 plain/models/backends/base/schema.py,sha256=1dLiVNz1huv8xJo1JphgfWfhXXZ-YGw_MgZ6eWazKQA,65016
 plain/models/backends/base/validation.py,sha256=2zpI11hyUJr0I0cA1xmvoFwQVdZ-7_1T2F11TpQ0Rkk,1067
 plain/models/backends/mysql/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-plain/models/backends/mysql/base.py,sha256=9PEaRvRcU9MBfir-s_rNooemDmjQQpfzB1DxJJdmC14,15985
+plain/models/backends/mysql/base.py,sha256=BfFi7QipjpW38LJquRINdUnm6cIBKEDVgiApMuWo1OQ,14421
 plain/models/backends/mysql/client.py,sha256=YGjk4f5VOuIKcj5SOOJeBqiSDF0Ft9m1aUPOmLzdD6c,2973
 plain/models/backends/mysql/compiler.py,sha256=NaYgcGyFUZ2lTOXXJj87hLMMMnXRAS1jUYkJq1NoCv4,3289
 plain/models/backends/mysql/creation.py,sha256=ozuc3mz65bjFz6sn5BFLRRGQsUYaxwIGjQyKod31c1Y,952
 plain/models/backends/mysql/features.py,sha256=OPHaiqPmAFAUZqnZdLOqbCmxmuGMnIqa62fJqAkYQ0o,5875
 plain/models/backends/mysql/introspection.py,sha256=nKhuFDi8xxj0DZH8_45F-XOARiHxWBoW21_2lTFARUc,14131
 plain/models/backends/mysql/operations.py,sha256=zLtg50k7WzqO3eZjLAknhKg29bxm0-ysd1_NydlDlzQ,16665
-plain/models/backends/mysql/schema.py,sha256=W6sV2DLdGAeM7ZX80m1XCRtV95DDhyochy8oJ18bet8,9870
+plain/models/backends/mysql/schema.py,sha256=LmP62COVuhpbH4gYulcSQNJgGuolc3RTFGsudoohJOQ,9942
 plain/models/backends/mysql/validation.py,sha256=TFYpuRoy3yG3SGfMFtRewaWq5gISN6FBaq-AD0DY7SI,1946
 plain/models/backends/postgresql/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 plain/models/backends/postgresql/base.py,sha256=SE6wmmxOtCnMDwycUs9yn_WATl97eV-4t8AaiK41E20,16053
@@ -113,8 +113,8 @@ plain/models/sql/where.py,sha256=ezE9Clt2BmKo-I7ARsgqZ_aVA-1UdayCwr6ULSWZL6c,126
 plain/models/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 plain/models/test/pytest.py,sha256=5mxY1MHqfCFJ7G39W1DuE0vCHfsfehQQmOyE6vI6caw,3323
 plain/models/test/utils.py,sha256=MxBNWoGMtwAtka7LbxWgilgzv7T5qqJL8ystF2SDJrs,345
-plain_models-0.34.4.dist-info/METADATA,sha256=lIwA7kJww6io4OCqeWiM0THgYzG7Qf-7hlDtl6IainA,1921
-plain_models-0.34.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain_models-0.34.4.dist-info/entry_points.txt,sha256=IYJAW9MpL3PXyXFWmKmALagAGXC_5rzBn2eEGJlcV04,112
-plain_models-0.34.4.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
-plain_models-0.34.4.dist-info/RECORD,,
+plain_models-0.35.0.dist-info/METADATA,sha256=v8A_EGrAuBGpAa_7thYuC1eim5Alt7jdfLskHWfUerg,1921
+plain_models-0.35.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain_models-0.35.0.dist-info/entry_points.txt,sha256=IYJAW9MpL3PXyXFWmKmALagAGXC_5rzBn2eEGJlcV04,112
+plain_models-0.35.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
+plain_models-0.35.0.dist-info/RECORD,,