plain.models 0.33.1__tar.gz → 0.34.0__tar.gz

{plain_models-0.33.1 → plain_models-0.34.0}/.gitignore

@@ -6,9 +6,6 @@ __pycache__
 *.DS_Store
 .coverage
 
-# Symlinks to personal packages
-/ext
-
 # Test apps
 plain*/tests/.plain
 

{plain_models-0.33.1 → plain_models-0.34.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.models
-Version: 0.33.1
+Version: 0.34.0
 Summary: Database models for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE
@@ -71,19 +71,17 @@ To connect to a database, you can provide a `DATABASE_URL` environment variable.
 DATABASE_URL=postgresql://user:password@localhost:5432/dbname
 ```
 
-Or you can manually define the `DATABASES` setting.
+Or you can manually define the `DATABASE` setting.
 
 ```python
 # app/settings.py
-DATABASES = {
-    "default": {
-        "ENGINE": "plain.models.backends.postgresql",
-        "NAME": "dbname",
-        "USER": "user",
-        "PASSWORD": "password",
-        "HOST": "localhost",
-        "PORT": "5432",
-    }
+DATABASE = {
+    "ENGINE": "plain.models.backends.postgresql",
+    "NAME": "dbname",
+    "USER": "user",
+    "PASSWORD": "password",
+    "HOST": "localhost",
+    "PORT": "5432",
 }
 ```
 

plain_models-0.34.0/plain/models/CHANGELOG.md

@@ -0,0 +1,17 @@
+# plain-models changelog
+
+## [0.34.0](https://github.com/dropseed/plain/releases/plain-models@0.34.0) (2025-06-23)
+
+### What's changed
+
+- Switched to a single `DATABASE` setting instead of `DATABASES` and removed `DATABASE_ROUTERS`. A helper still automatically populates `DATABASE` from `DATABASE_URL` just like before ([d346d81](https://github.com/dropseed/plain/commit/d346d81)).
+- The `plain.models.db` module now exposes a `db_connection` object that lazily represents the active database connection. Previous `connections`, `router`, and `DEFAULT_DB_ALIAS` exports were removed ([d346d81](https://github.com/dropseed/plain/commit/d346d81)).
+
+### Upgrade instructions
+
+- Replace any `DATABASES` definition in your settings with a single `DATABASE` dict (keys are identical to the inner dict you were previously using).
+- Remove any `DATABASE_ROUTERS` configuration – multiple databases are no longer supported.
+- Update import sites:
+  - `from plain.models import connections` → `from plain.models import db_connection`
+  - `from plain.models import router` → (no longer needed; remove usage or switch to `db_connection` where appropriate)
+  - `from plain.models.connections import DEFAULT_DB_ALIAS` → (constant removed; default database is implicit)

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/README.md

@@ -60,19 +60,17 @@ To connect to a database, you can provide a `DATABASE_URL` environment variable.
 DATABASE_URL=postgresql://user:password@localhost:5432/dbname
 ```
 
-Or you can manually define the `DATABASES` setting.
+Or you can manually define the `DATABASE` setting.
 
 ```python
 # app/settings.py
-DATABASES = {
-    "default": {
-        "ENGINE": "plain.models.backends.postgresql",
-        "NAME": "dbname",
-        "USER": "user",
-        "PASSWORD": "password",
-        "HOST": "localhost",
-        "PORT": "5432",
-    }
+DATABASE = {
+    "ENGINE": "plain.models.backends.postgresql",
+    "NAME": "dbname",
+    "USER": "user",
+    "PASSWORD": "password",
+    "HOST": "localhost",
+    "PORT": "5432",
 }
 ```
 

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/__init__.py

@@ -8,7 +8,6 @@ from .aggregates import __all__ as aggregates_all
 from .constraints import *  # NOQA
 from .constraints import __all__ as constraints_all
 from .db import (
-    DEFAULT_DB_ALIAS,
     PLAIN_VERSION_PICKLE_KEY,
     DatabaseError,
     DataError,
@@ -20,9 +19,8 @@ from .db import (
     OperationalError,
     ProgrammingError,
     close_old_connections,
-    connections,
+    db_connection,
     reset_queries,
-    router,
 )
 from .deletion import (
     CASCADE,
@@ -127,8 +125,7 @@ __all__ += [
 
 # DB-related exports
 __all__ += [
-    "connections",
-    "router",
+    "db_connection",
     "reset_queries",
     "close_old_connections",
     "DatabaseError",
@@ -140,7 +137,6 @@ __all__ += [
     "Error",
     "InterfaceError",
     "OperationalError",
-    "DEFAULT_DB_ALIAS",
     "PLAIN_VERSION_PICKLE_KEY",
 ]
 

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/base/base.py

@@ -14,7 +14,6 @@ from plain.models.backends import utils
 from plain.models.backends.base.validation import BaseDatabaseValidation
 from plain.models.backends.utils import debug_transaction
 from plain.models.db import (
-    DEFAULT_DB_ALIAS,
     DatabaseError,
     DatabaseErrorWrapper,
     NotSupportedError,
@@ -22,8 +21,7 @@ from plain.models.db import (
 from plain.models.transaction import TransactionManagementError
 from plain.runtime import settings
 
-NO_DB_ALIAS = "__no_db__"
-RAN_DB_VERSION_CHECK = set()
+RAN_DB_VERSION_CHECK = False
 
 logger = logging.getLogger("plain.models.backends.base")
 
@@ -51,7 +49,7 @@ class BaseDatabaseWrapper:
 
     queries_limit = 9000
 
-    def __init__(self, settings_dict, alias=DEFAULT_DB_ALIAS):
+    def __init__(self, settings_dict):
         # Connection related attributes.
         # The underlying database connection.
         self.connection = None
@@ -59,7 +57,6 @@ class BaseDatabaseWrapper:
         # NAME, USER, etc. It's called `settings_dict` instead of `settings`
         # to disambiguate it from Plain settings modules.
         self.settings_dict = settings_dict
-        self.alias = alias
         # Query logging in debug mode or when explicitly enabled.
         self.queries_log = deque(maxlen=self.queries_limit)
         self.force_debug_cursor = False
@@ -120,10 +117,7 @@ class BaseDatabaseWrapper:
         self.validation = self.validation_class(self)
 
     def __repr__(self):
-        return (
-            f"<{self.__class__.__qualname__} "
-            f"vendor={self.vendor!r} alias={self.alias!r}>"
-        )
+        return f"<{self.__class__.__qualname__} vendor={self.vendor!r}>"
 
     def ensure_timezone(self):
         """
@@ -218,9 +212,9 @@ class BaseDatabaseWrapper:
     def init_connection_state(self):
         """Initialize the database connection settings."""
         global RAN_DB_VERSION_CHECK
-        if self.alias not in RAN_DB_VERSION_CHECK:
+        if not RAN_DB_VERSION_CHECK:
             self.check_database_version_supported()
-            RAN_DB_VERSION_CHECK.add(self.alias)
+            RAN_DB_VERSION_CHECK = True
 
     def create_cursor(self, name=None):
         """Create a cursor. Assume that a connection is established."""
@@ -593,8 +587,8 @@ class BaseDatabaseWrapper:
         if not (self.allow_thread_sharing or self._thread_ident == _thread.get_ident()):
             raise DatabaseError(
                 "DatabaseWrapper objects created in a "
-                "thread can only be used in that same thread. The object "
-                f"with alias '{self.alias}' was created in thread id {self._thread_ident} and this is "
+                "thread can only be used in that same thread. The connection "
+                f"was created in thread id {self._thread_ident} and this is "
                 f"thread id {_thread.get_ident()}."
             )
 
@@ -656,7 +650,7 @@ class BaseDatabaseWrapper:
         being exposed to potential child threads while (or after) the test
         database is destroyed. Refs #10868, #17786, #16969.
         """
-        conn = self.__class__({**self.settings_dict, "NAME": None}, alias=NO_DB_ALIAS)
+        conn = self.__class__({**self.settings_dict, "NAME": None})
         try:
             with conn.cursor() as cursor:
                 yield cursor
@@ -729,13 +723,11 @@ class BaseDatabaseWrapper:
         finally:
             self.execute_wrappers.pop()
 
-    def copy(self, alias=None):
+    def copy(self):
         """
         Return a copy of this connection.
 
         For tests that require two connections to the same database.
         """
         settings_dict = copy.deepcopy(self.settings_dict)
-        if alias is None:
-            alias = self.alias
-        return type(self)(settings_dict, alias)
+        return type(self)(settings_dict)

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/base/creation.py

@@ -45,7 +45,7 @@ class BaseDatabaseCreation:
         )
 
         self.connection.close()
-        settings.DATABASES[self.connection.alias]["NAME"] = test_database_name
+        settings.DATABASE["NAME"] = test_database_name
         self.connection.settings_dict["NAME"] = test_database_name
 
         # We report migrate messages at one level lower than that
@@ -54,7 +54,6 @@ class BaseDatabaseCreation:
         migrate.callback(
             package_label=None,
             migration_name=None,
-            database=self.connection.alias,
             fake=False,
             fake_initial=False,
             plan=False,
@@ -219,7 +218,7 @@ class BaseDatabaseCreation:
 
         # Restore the original database name
         if old_database_name is not None:
-            settings.DATABASES[self.connection.alias]["NAME"] = old_database_name
+            settings.DATABASE["NAME"] = old_database_name
             self.connection.settings_dict["NAME"] = old_database_name
 
     def _destroy_test_db(self, test_database_name, verbosity):
@@ -244,7 +243,7 @@ class BaseDatabaseCreation:
     def test_db_signature(self, prefix=""):
         """
         Return a tuple with elements of self.connection.settings_dict (a
-        DATABASES setting value) that uniquely identify a database
+        DATABASE setting value) that uniquely identify a database
         accordingly to the RDBMS particularities.
         """
         settings_dict = self.connection.settings_dict

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/base/introspection.py

@@ -79,14 +79,13 @@ class BaseDatabaseIntrospection:
 
     def get_migratable_models(self):
         from plain.models import models_registry
-        from plain.models.db import router
         from plain.packages import packages_registry
 
         return (
             model
             for package_config in packages_registry.get_package_configs()
-            for model in router.get_migratable_models(
-                models_registry, package_config.package_label, self.connection.alias
+            for model in models_registry.get_models(
+                package_label=package_config.package_label
             )
             if model._meta.can_migrate(self.connection)
         )

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/base/schema.py

@@ -152,7 +152,7 @@ class BaseDatabaseSchemaEditor:
     def __enter__(self):
         self.deferred_sql = []
         if self.atomic_migration:
-            self.atomic = atomic(self.connection.alias)
+            self.atomic = atomic()
             self.atomic.__enter__()
         return self
 
@@ -1247,7 +1247,6 @@ class BaseDatabaseSchemaEditor:
         fields=None,
         name=None,
         suffix="",
-        using="",
         col_suffixes=(),
         sql=None,
         opclasses=(),
@@ -1262,9 +1261,7 @@ class BaseDatabaseSchemaEditor:
         """
         fields = fields or []
         expressions = expressions or []
-        compiler = Query(model, alias_cols=False).get_compiler(
-            connection=self.connection,
-        )
+        compiler = Query(model, alias_cols=False).get_compiler()
         columns = [field.column for field in fields]
         sql_create_index = sql or self.sql_create_index
         table = model._meta.db_table
@@ -1279,7 +1276,6 @@ class BaseDatabaseSchemaEditor:
             sql_create_index,
             table=Table(table, self.quote_name),
             name=IndexName(table, columns, suffix, create_index_name),
-            using=using,
             columns=(
                 self._index_columns(table, columns, col_suffixes, opclasses)
                 if columns
@@ -1473,9 +1469,7 @@ class BaseDatabaseSchemaEditor:
         ):
             return None
 
-        compiler = Query(model, alias_cols=False).get_compiler(
-            connection=self.connection
-        )
+        compiler = Query(model, alias_cols=False).get_compiler()
         table = model._meta.db_table
         columns = [field.column for field in fields]
         if name is None:

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/mysql/validation.py

@@ -14,7 +14,7 @@ class DatabaseValidation(BaseDatabaseValidation):
         ):
             return [
                 preflight.Warning(
-                    f"{self.connection.display_name} Strict Mode is not set for database connection '{self.connection.alias}'",
+                    f"{self.connection.display_name} Strict Mode is not set for the database connection",
                     hint=(
                         f"{self.connection.display_name}'s Strict Mode fixes many data integrity problems in "
                         f"{self.connection.display_name}, such as data truncation upon insertion, by "

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/postgresql/base.py

@@ -15,7 +15,7 @@ from plain.exceptions import ImproperlyConfigured
 from plain.models.backends.base.base import BaseDatabaseWrapper
 from plain.models.backends.utils import CursorDebugWrapper as BaseCursorDebugWrapper
 from plain.models.db import DatabaseError as WrappedDatabaseError
-from plain.models.db import connections
+from plain.models.db import db_connection
 
 # Some of these import psycopg, so import them after checking if it's installed.
 from .client import DatabaseClient  # NOQA isort:skip
@@ -185,14 +185,14 @@ class DatabaseWrapper(BaseDatabaseWrapper):
             "service"
         ):
             raise ImproperlyConfigured(
-                "settings.DATABASES is improperly configured. "
+                "settings.DATABASE is improperly configured. "
                 "Please supply the NAME or OPTIONS['service'] value."
             )
         if len(settings_dict["NAME"] or "") > self.ops.max_name_length():
             raise ImproperlyConfigured(
                 "The database name '%s' (%d characters) is longer than "  # noqa: UP031
                 "PostgreSQL's limit of %d characters. Supply a shorter NAME "
-                "in settings.DATABASES."
+                "in settings.DATABASE."
                 % (
                     settings_dict["NAME"],
                     len(settings_dict["NAME"]),
@@ -374,26 +374,18 @@ class DatabaseWrapper(BaseDatabaseWrapper):
                 "and will use the first PostgreSQL database instead.",
                 RuntimeWarning,
             )
-            for connection in connections.all():
-                if (
-                    connection.vendor == "postgresql"
-                    and connection.settings_dict["NAME"] != "postgres"
-                ):
-                    conn = self.__class__(
-                        {
-                            **self.settings_dict,
-                            "NAME": connection.settings_dict["NAME"],
-                        },
-                        alias=self.alias,
-                    )
-                    try:
-                        with conn.cursor() as cursor:
-                            yield cursor
-                    finally:
-                        conn.close()
-                    break
-            else:
-                raise
+            conn = self.__class__(
+                {
+                    **self.settings_dict,
+                    "NAME": db_connection.settings_dict["NAME"],
+                },
+                alias=self.alias,
+            )
+            try:
+                with conn.cursor() as cursor:
+                    yield cursor
+            finally:
+                conn.close()
 
     @cached_property
     def pg_version(self):

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/postgresql/schema.py

@@ -329,7 +329,6 @@ class DatabaseSchemaEditor(BaseDatabaseSchemaEditor):
         fields=None,
         name=None,
         suffix="",
-        using="",
         col_suffixes=(),
         sql=None,
         opclasses=(),
@@ -348,7 +347,6 @@ class DatabaseSchemaEditor(BaseDatabaseSchemaEditor):
             fields=fields,
             name=name,
             suffix=suffix,
-            using=using,
             col_suffixes=col_suffixes,
             sql=sql,
             opclasses=opclasses,

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/sqlite3/base.py

@@ -143,7 +143,7 @@ class DatabaseWrapper(BaseDatabaseWrapper):
         settings_dict = self.settings_dict
         if not settings_dict["NAME"]:
             raise ImproperlyConfigured(
-                "settings.DATABASES is improperly configured. "
+                "settings.DATABASE is improperly configured. "
                 "Please supply the NAME value."
             )
         kwargs = {

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/sqlite3/creation.py

@@ -16,7 +16,7 @@ class DatabaseCreation(BaseDatabaseCreation):
         raw_name = self.connection.settings_dict["TEST"]["NAME"] or ":memory:"
         # Special in-memory case
         if raw_name == ":memory:":
-            return f"file:memorydb_{self.connection.alias}?mode=memory&cache=shared"
+            return "file:memorydb?mode=memory&cache=shared"
 
         test_database_name = raw_name
 
@@ -68,7 +68,7 @@ class DatabaseCreation(BaseDatabaseCreation):
         test_database_name = self._get_test_db_name(prefix)
         sig = [self.connection.settings_dict["NAME"]]
         if self.is_in_memory_db(test_database_name):
-            sig.append(self.connection.alias)
+            sig.append(":memory:")
         else:
             sig.append(test_database_name)
         return tuple(sig)

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/sqlite3/features.py

@@ -40,7 +40,7 @@ class DatabaseFeatures(BaseDatabaseFeatures):
     def supports_json_field(self):
         with self.connection.cursor() as cursor:
             try:
-                with transaction.atomic(self.connection.alias):
+                with transaction.atomic():
                     cursor.execute('SELECT JSON(\'{"a": "b"}\')')
             except OperationalError:
                 return False

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/sqlite3/schema.py

@@ -136,7 +136,7 @@ class DatabaseSchemaEditor(BaseDatabaseSchemaEditor):
                     "supported on SQLite < 3.26 because it would break referential "
                     "integrity. Try adding `atomic = False` to the Migration class."
                 )
-            with atomic(self.connection.alias):
+            with atomic():
                 super().alter_field(model, old_field, new_field, strict=strict)
                 # Follow SQLite's documented procedure for performing changes
                 # that don't affect the on-disk content.

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backends/utils.py

@@ -129,16 +129,14 @@ class CursorDebugWrapper(CursorWrapper):
                 }
             )
             logger.debug(
-                "(%.3f) %s; args=%s; alias=%s",
+                "(%.3f) %s; args=%s",
                 duration,
                 sql,
                 params,
-                self.db.alias,
                 extra={
                     "duration": duration,
                     "sql": sql,
                     "params": params,
-                    "alias": self.db.alias,
                 },
             )
 
@@ -159,15 +157,13 @@ def debug_transaction(connection, sql):
                 }
             )
             logger.debug(
-                "(%.3f) %s; args=%s; alias=%s",
+                "(%.3f) %s; args=%s",
                 duration,
                 sql,
                 None,
-                connection.alias,
                 extra={
                     "duration": duration,
                     "sql": sql,
-                    "alias": connection.alias,
                 },
             )
 

{plain_models-0.33.1 → plain_models-0.34.0}/plain/models/backups/core.py

@@ -4,7 +4,7 @@ from pathlib import Path
 
 from plain.runtime import PLAIN_TEMP_PATH
 
-from .. import connections
+from .. import db_connection
 from .clients import PostgresBackupClient, SQLiteBackupClient
 
 
@@ -61,19 +61,17 @@ class DatabaseBackup:
     def create(self, **create_kwargs):
         self.path.mkdir(parents=True, exist_ok=True)
 
-        for connection_alias in connections:
-            connection = connections[connection_alias]
-            backup_path = self.path / f"{connection_alias}.backup"
+        backup_path = self.path / "default.backup"
 
-            if connection.vendor == "postgresql":
-                PostgresBackupClient(connection).create_backup(
-                    backup_path,
-                    pg_dump=create_kwargs.get("pg_dump", "pg_dump"),
-                )
-            elif connection.vendor == "sqlite":
-                SQLiteBackupClient(connection).create_backup(backup_path)
-            else:
-                raise Exception("Unsupported database vendor")
+        if db_connection.vendor == "postgresql":
+            PostgresBackupClient(db_connection).create_backup(
+                backup_path,
+                pg_dump=create_kwargs.get("pg_dump", "pg_dump"),
+            )
+        elif db_connection.vendor == "sqlite":
+            SQLiteBackupClient(db_connection).create_backup(backup_path)
+        else:
+            raise Exception("Unsupported database vendor")
 
         return self.path
 
@@ -87,18 +85,13 @@ class DatabaseBackup:
 
     def restore(self, **restore_kwargs):
         for backup_file in self.iter_files():
-            connection_alias = backup_file.stem
-            connection = connections[connection_alias]
-            if not connection:
-                raise Exception(f"Connection {connection_alias} not found")
-
-            if connection.vendor == "postgresql":
-                PostgresBackupClient(connection).restore_backup(
+            if db_connection.vendor == "postgresql":
+                PostgresBackupClient(db_connection).restore_backup(
                     backup_file,
                     pg_restore=restore_kwargs.get("pg_restore", "pg_restore"),
                 )
-            elif connection.vendor == "sqlite":
-                SQLiteBackupClient(connection).restore_backup(backup_file)
+            elif db_connection.vendor == "sqlite":
+                SQLiteBackupClient(db_connection).restore_backup(backup_file)
             else:
                 raise Exception("Unsupported database vendor")