plain.models 0.38.0__tar.gz → 0.39.1__tar.gz

{plain_models-0.38.0 → plain_models-0.39.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.models
-Version: 0.38.0
+Version: 0.39.1
 Summary: Database models for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE
@@ -30,6 +30,9 @@ class User(models.Model):
         return self.email
 ```
 
+Every model automatically includes an `id` field which serves as the primary
+key. The name `id` is reserved and can't be used for other fields.
+
 Create, update, and delete instances of your models:
 
 ```python
@@ -114,3 +117,31 @@ TODO
 ## Forms
 
 TODO
+
+## Sharing fields across models
+
+To share common fields across multiple models, use Python classes as mixins. The final, registered model must inherit directly from `models.Model` and the mixins should not.
+
+```python
+from plain import models
+
+
+# Regular Python class for shared fields
+class TimestampedMixin:
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+
+# Models inherit from the mixin AND models.Model
+@models.register_model
+class User(TimestampedMixin, models.Model):
+    email = models.EmailField()
+    password = PasswordField()
+    is_admin = models.BooleanField(default=False)
+
+
+@models.register_model
+class Note(TimestampedMixin, models.Model):
+    content = models.TextField(max_length=1024)
+    liked = models.BooleanField(default=False)
+```

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/CHANGELOG.md

@@ -1,5 +1,36 @@
 # plain-models changelog
 
+## [0.39.1](https://github.com/dropseed/plain/releases/plain-models@0.39.1) (2025-07-22)
+
+### What's changed
+
+- Added documentation for sharing fields across models using Python class mixins ([cad3af01d2](https://github.com/dropseed/plain/commit/cad3af01d2))
+- Added note about `PrimaryKeyField()` replacement requirement for migrations ([70ea931660](https://github.com/dropseed/plain/commit/70ea931660))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.39.0](https://github.com/dropseed/plain/releases/plain-models@0.39.0) (2025-07-22)
+
+### What's changed
+
+- Models now use a single automatic `id` field as the primary key, replacing the previous `pk` alias and automatic field system ([4b8fa6a](https://github.com/dropseed/plain/commit/4b8fa6a))
+- Removed the `to_field` option for ForeignKey - foreign keys now always reference the primary key of the related model ([7fc3c88](https://github.com/dropseed/plain/commit/7fc3c88))
+- Removed the internal `from_fields` and `to_fields` system used for multi-column foreign keys ([0e9eda3](https://github.com/dropseed/plain/commit/0e9eda3))
+- Removed the `parent_link` parameter on ForeignKey and ForeignObject ([6658647](https://github.com/dropseed/plain/commit/6658647))
+- Removed `InlineForeignKeyField` from forms ([ede6265](https://github.com/dropseed/plain/commit/ede6265))
+- Merged ForeignObject functionality into ForeignKey, simplifying the foreign key implementation ([e6d9aaa](https://github.com/dropseed/plain/commit/e6d9aaa))
+- Cleaned up unused code in ForeignKey and fixed ForeignObjectRel imports ([b656ee6](https://github.com/dropseed/plain/commit/b656ee6))
+
+### Upgrade instructions
+
+- Replace any direct references to `pk` with `id` in your models and queries (e.g., `user.pk` becomes `user.id`)
+- Remove any `to_field` arguments from ForeignKey definitions - they are no longer supported
+- Remove any `parent_link=True` arguments from ForeignKey definitions - they are no longer supported
+- Replace any usage of `InlineForeignKeyField` in forms with standard form fields
+- `models.BigAutoField(auto_created=True, primary_key=True)` need to be replaced with `models.PrimaryKeyField()` in migrations
+
 ## [0.38.0](https://github.com/dropseed/plain/releases/plain-models@0.38.0) (2025-07-21)
 
 ### What's changed

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/README.md

@@ -19,6 +19,9 @@ class User(models.Model):
         return self.email
 ```
 
+Every model automatically includes an `id` field which serves as the primary
+key. The name `id` is reserved and can't be used for other fields.
+
 Create, update, and delete instances of your models:
 
 ```python
@@ -103,3 +106,31 @@ TODO
 ## Forms
 
 TODO
+
+## Sharing fields across models
+
+To share common fields across multiple models, use Python classes as mixins. The final, registered model must inherit directly from `models.Model` and the mixins should not.
+
+```python
+from plain import models
+
+
+# Regular Python class for shared fields
+class TimestampedMixin:
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+
+# Models inherit from the mixin AND models.Model
+@models.register_model
+class User(TimestampedMixin, models.Model):
+    email = models.EmailField()
+    password = PasswordField()
+    is_admin = models.BooleanField(default=False)
+
+
+@models.register_model
+class Note(TimestampedMixin, models.Model):
+    content = models.TextField(max_length=1024)
+    liked = models.BooleanField(default=False)
+```

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/__init__.py

@@ -68,8 +68,9 @@ from .registry import models_registry, register_model
 from .base import DEFERRED, Model  # isort:skip
 from .fields.related import (  # isort:skip
     ForeignKey,
-    ForeignObject,
     ManyToManyField,
+)
+from .fields.reverse_related import (  # isort:skip
     ForeignObjectRel,
     ManyToOneRel,
     ManyToManyRel,
@@ -116,7 +117,6 @@ __all__ += [
     "Model",
     "FilteredRelation",
     "ForeignKey",
-    "ForeignObject",
     "ManyToManyField",
     "ForeignObjectRel",
     "ManyToOneRel",

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/base/creation.py

@@ -96,7 +96,7 @@ class BaseDatabaseCreation:
     #                     ) and router.allow_migrate_model(self.connection.alias, model):
     #                         queryset = model._base_manager.using(
     #                             self.connection.alias,
-    #                         ).order_by(model._meta.pk.name)
+    #                         ).order_by("id")
     #                         yield from queryset.iterator()
 
     #     # Serialize to a string

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/base/operations.py

@@ -28,9 +28,7 @@ class BaseDatabaseOperations:
         "PositiveBigIntegerField": (0, 9223372036854775807),
         "PositiveSmallIntegerField": (0, 32767),
         "PositiveIntegerField": (0, 2147483647),
-        "SmallAutoField": (-32768, 32767),
-        "AutoField": (-2147483648, 2147483647),
-        "BigAutoField": (-9223372036854775808, 9223372036854775807),
+        "PrimaryKeyField": (-9223372036854775808, 9223372036854775807),
     }
     set_operators = {
         "union": "UNION",

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/base/schema.py

@@ -29,11 +29,11 @@ def _is_relevant_relation(relation, altered_field):
     if field.many_to_many:
         # M2M reverse field
         return False
-    if altered_field.primary_key and field.to_fields == [None]:
+    if altered_field.primary_key:
         # Foreign key constraint on the primary key, which is being altered.
         return True
-    # Is the constraint targeting the field being altered?
-    return altered_field.name in field.to_fields
+    # ForeignKey always targets 'id'
+    return altered_field.name == "id"
 
 
 def _all_related_fields(model):
@@ -239,11 +239,7 @@ class BaseDatabaseSchemaEditor:
             column_sqls.append(f"{self.quote_name(field.column)} {definition}")
             # Autoincrement SQL (for backends with post table definition
             # variant).
-            if field.get_internal_type() in (
-                "AutoField",
-                "BigAutoField",
-                "SmallAutoField",
-            ):
+            if field.get_internal_type() in ("PrimaryKeyField",):
                 autoinc_sql = self.connection.ops.autoinc_sql(
                     model._meta.db_table, field.column
                 )

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/mysql/base.py

@@ -91,8 +91,7 @@ class DatabaseWrapper(BaseDatabaseWrapper):
     # be interpolated against the values of Field.__dict__ before being output.
     # If a column type is set to None, it won't be included in the output.
     data_types = {
-        "AutoField": "integer AUTO_INCREMENT",
-        "BigAutoField": "bigint AUTO_INCREMENT",
+        "PrimaryKeyField": "bigint AUTO_INCREMENT",
         "BinaryField": "longblob",
         "BooleanField": "bool",
         "CharField": "varchar(%(max_length)s)",
@@ -109,7 +108,6 @@ class DatabaseWrapper(BaseDatabaseWrapper):
         "PositiveBigIntegerField": "bigint UNSIGNED",
         "PositiveIntegerField": "integer UNSIGNED",
         "PositiveSmallIntegerField": "smallint UNSIGNED",
-        "SmallAutoField": "smallint AUTO_INCREMENT",
         "SmallIntegerField": "smallint",
         "TextField": "longtext",
         "TimeField": "time(6)",

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/mysql/introspection.py

@@ -49,12 +49,8 @@ class DatabaseIntrospection(BaseDatabaseIntrospection):
     def get_field_type(self, data_type, description):
         field_type = super().get_field_type(data_type, description)
         if "auto_increment" in description.extra:
-            if field_type == "IntegerField":
-                return "AutoField"
-            elif field_type == "BigIntegerField":
-                return "BigAutoField"
-            elif field_type == "SmallIntegerField":
-                return "SmallAutoField"
+            if field_type == "BigIntegerField":
+                return "PrimaryKeyField"
         if description.is_unsigned:
             if field_type == "BigIntegerField":
                 return "PositiveBigIntegerField"

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/mysql/operations.py

@@ -21,9 +21,7 @@ class DatabaseOperations(BaseDatabaseOperations):
         "PositiveBigIntegerField": (0, 18446744073709551615),
     }
     cast_data_types = {
-        "AutoField": "signed integer",
-        "BigAutoField": "signed integer",
-        "SmallAutoField": "signed integer",
+        "PrimaryKeyField": "signed integer",
         "CharField": "char(%(max_length)s)",
         "DecimalField": "decimal(%(max_digits)s, %(decimal_places)s)",
         "TextField": "char",
@@ -201,7 +199,7 @@ class DatabaseOperations(BaseDatabaseOperations):
         # NO_AUTO_VALUE_ON_ZERO SQL mode.
         if value == 0 and not self.connection.features.allows_auto_pk_0:
             raise ValueError(
-                "The database backend does not accept 0 as a value for AutoField."
+                "The database backend does not accept 0 as a value for PrimaryKeyField."
             )
         return value
 

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/postgresql/base.py

@@ -89,8 +89,7 @@ class DatabaseWrapper(BaseDatabaseWrapper):
     # be interpolated against the values of Field.__dict__ before being output.
     # If a column type is set to None, it won't be included in the output.
     data_types = {
-        "AutoField": "integer",
-        "BigAutoField": "bigint",
+        "PrimaryKeyField": "bigint",
         "BinaryField": "bytea",
         "BooleanField": "boolean",
         "CharField": _get_varchar_column,
@@ -107,7 +106,6 @@ class DatabaseWrapper(BaseDatabaseWrapper):
         "PositiveBigIntegerField": "bigint",
         "PositiveIntegerField": "integer",
         "PositiveSmallIntegerField": "smallint",
-        "SmallAutoField": "smallint",
         "SmallIntegerField": "smallint",
         "TextField": "text",
         "TimeField": "time",
@@ -119,9 +117,7 @@ class DatabaseWrapper(BaseDatabaseWrapper):
         "PositiveSmallIntegerField": '"%(column)s" >= 0',
     }
     data_types_suffix = {
-        "AutoField": "GENERATED BY DEFAULT AS IDENTITY",
-        "BigAutoField": "GENERATED BY DEFAULT AS IDENTITY",
-        "SmallAutoField": "GENERATED BY DEFAULT AS IDENTITY",
+        "PrimaryKeyField": "GENERATED BY DEFAULT AS IDENTITY",
     }
     operators = {
         "exact": "= %s",

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/postgresql/introspection.py

@@ -44,12 +44,8 @@ class DatabaseIntrospection(BaseDatabaseIntrospection):
             # Required for pre-Plain 4.1 serial columns.
             description.default and "nextval" in description.default
         ):
-            if field_type == "IntegerField":
-                return "AutoField"
-            elif field_type == "BigIntegerField":
-                return "BigAutoField"
-            elif field_type == "SmallIntegerField":
-                return "SmallAutoField"
+            if field_type == "BigIntegerField":
+                return "PrimaryKeyField"
         return field_type
 
     def get_table_list(self, cursor):

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/postgresql/operations.py

@@ -35,9 +35,7 @@ class DatabaseOperations(BaseDatabaseOperations):
         ]
     )
     cast_data_types = {
-        "AutoField": "integer",
-        "BigAutoField": "bigint",
-        "SmallAutoField": "smallint",
+        "PrimaryKeyField": "bigint",
     }
 
     integerfield_type_map = {

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/postgresql/schema.py

@@ -166,11 +166,7 @@ class DatabaseSchemaEditor(BaseDatabaseSchemaEditor):
         old_internal_type = old_field.get_internal_type()
         # Make ALTER TYPE with IDENTITY make sense.
         table = strip_quotes(model._meta.db_table)
-        auto_field_types = {
-            "AutoField",
-            "BigAutoField",
-            "SmallAutoField",
-        }
+        auto_field_types = {"PrimaryKeyField"}
         old_is_auto = old_internal_type in auto_field_types
         new_is_auto = new_internal_type in auto_field_types
         if new_is_auto and not old_is_auto:
@@ -229,11 +225,7 @@ class DatabaseSchemaEditor(BaseDatabaseSchemaEditor):
                 model, old_field, new_field, new_type, old_collation, new_collation
             )
             column = strip_quotes(new_field.column)
-            db_types = {
-                "AutoField": "integer",
-                "BigAutoField": "bigint",
-                "SmallAutoField": "smallint",
-            }
+            db_types = {"PrimaryKeyField": "bigint"}
             # Alter the sequence type if exists (Plain 4.1+ identity columns
             # don't have it).
             other_actions = []

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/sqlite3/base.py

@@ -57,8 +57,7 @@ class DatabaseWrapper(BaseDatabaseWrapper):
     # thing" given more verbose field definitions, so leave them as is so that
     # schema inspection is more useful.
     data_types = {
-        "AutoField": "integer",
-        "BigAutoField": "integer",
+        "PrimaryKeyField": "integer",
         "BinaryField": "BLOB",
         "BooleanField": "bool",
         "CharField": "varchar(%(max_length)s)",
@@ -75,7 +74,6 @@ class DatabaseWrapper(BaseDatabaseWrapper):
         "PositiveBigIntegerField": "bigint unsigned",
         "PositiveIntegerField": "integer unsigned",
         "PositiveSmallIntegerField": "smallint unsigned",
-        "SmallAutoField": "integer",
         "SmallIntegerField": "smallint",
         "TextField": "text",
         "TimeField": "time",
@@ -88,9 +86,7 @@ class DatabaseWrapper(BaseDatabaseWrapper):
         "PositiveSmallIntegerField": '"%(column)s" >= 0',
     }
     data_types_suffix = {
-        "AutoField": "AUTOINCREMENT",
-        "BigAutoField": "AUTOINCREMENT",
-        "SmallAutoField": "AUTOINCREMENT",
+        "PrimaryKeyField": "AUTOINCREMENT",
     }
     # SQLite requires LIKE statements to include an ESCAPE clause if the value
     # being escaped has a percent or underscore in it.

{plain_models-0.38.0 → plain_models-0.39.1}/plain/models/backends/sqlite3/introspection.py

@@ -63,14 +63,8 @@ class DatabaseIntrospection(BaseDatabaseIntrospection):
 
     def get_field_type(self, data_type, description):
         field_type = super().get_field_type(data_type, description)
-        if description.pk and field_type in {
-            "BigIntegerField",
-            "IntegerField",
-            "SmallIntegerField",
-        }:
-            # No support for BigAutoField or SmallAutoField as SQLite treats
-            # all integer primary keys as signed 64-bit integers.
-            return "AutoField"
+        if description.pk and field_type == "BigIntegerField":
+            return "PrimaryKeyField"
         if description.has_json_constraint:
             return "JSONField"
         return field_type