Rename ForeignKey to ForeignKeyField

Author: davegaeddert

plain-api/plain/api/README.md

@@ -214,7 +214,7 @@ from plain.api.models import APIKey
 @models.register_model
 class User(models.Model):
     # other fields...
-    api_key = models.ForeignKey(
+    api_key = models.ForeignKeyField(
         APIKey,
         on_delete=models.CASCADE,
         allow_null=True,

plain-flags/plain/flags/migrations/0001_initial.py

@@ -59,7 +59,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name="flagresult",
             name="flag",
-            field=models.ForeignKey(
+            field=models.ForeignKeyField(
                 on_delete=plain.models.deletion.CASCADE, to="plainflags.flag"
             ),
         ),

plain-flags/plain/flags/models.py

@@ -17,7 +17,7 @@ def validate_flag_name(value: str) -> None:
 class FlagResult(models.Model):
     created_at: datetime = types.DateTimeField(auto_now_add=True)
     updated_at: datetime = types.DateTimeField(auto_now=True)
-    flag: Flag = types.ForeignKey("Flag", on_delete=models.CASCADE)
+    flag: Flag = types.ForeignKeyField("Flag", on_delete=models.CASCADE)
     key: str = types.CharField(max_length=255)
     value = types.JSONField()
 

plain-models/plain/models/README.md

@@ -159,7 +159,7 @@ class Product(models.Model):
     updated_at = models.DateTimeField(auto_now=True)
 
     # Relationships
-    category = models.ForeignKey("Category", on_delete=models.CASCADE)
+    category = models.ForeignKeyField("Category", on_delete=models.CASCADE)
     tags = models.ManyToManyField("Tag")
 ```
 
@@ -191,7 +191,7 @@ class Author(models.Model):
 @models.register_model
 class Book(models.Model):
     title = models.CharField(max_length=200)
-    author = models.ForeignKey(Author, on_delete=models.CASCADE)
+    author = models.ForeignKeyField(Author, on_delete=models.CASCADE)
 
 # Usage
 author = Author.query.get(name="Jane Doe")
@@ -255,7 +255,7 @@ published_at: datetime | None = types.DateTimeField(allow_null=True, required=Fa
 Foreign keys are typed with the related model:
 
 ```python
-author: Author = types.ForeignKey(Author, on_delete=models.CASCADE)
+author: Author = types.ForeignKeyField(Author, on_delete=models.CASCADE)
 ```
 
 All field types from the [Fields](#fields) section are available through [`types`](./types.py). Typed and untyped fields can be mixed in the same model. The database behavior is identical - typed fields only add type checking.

plain-models/plain/models/__init__.py

@@ -34,7 +34,7 @@
 )
 from .fields.json import JSONField
 from .fields.related import (
-    ForeignKey,
+    ForeignKeyField,
     ManyToManyField,
 )
 from .fields.reverse_descriptors import (
@@ -101,7 +101,7 @@
     # From base
     "Model",
     # From fields.related
-    "ForeignKey",
+    "ForeignKeyField",
     "ManyToManyField",
     # From fields.reverse_descriptors
     "ReverseForeignKey",

plain-models/plain/models/backends/base/features.py

@@ -67,7 +67,7 @@ class BaseDatabaseFeatures:
     # Can an object have an autoincrement primary key of 0?
     allows_auto_pk_0 = True
 
-    # Do we need to NULL a ForeignKey out, or can the constraint check be
+    # Do we need to NULL a ForeignKeyField out, or can the constraint check be
     # deferred
     can_defer_constraint_checks = False
 

plain-models/plain/models/backends/base/schema.py

@@ -21,7 +21,7 @@
 from plain.models.backends.utils import names_digest, split_identifier, truncate_name
 from plain.models.constraints import Deferrable
 from plain.models.fields import Field
-from plain.models.fields.related import ForeignKey, RelatedField
+from plain.models.fields.related import ForeignKeyField, RelatedField
 from plain.models.fields.reverse_related import ManyToManyRel
 from plain.models.indexes import Index
 from plain.models.sql import Query
@@ -35,7 +35,7 @@
     from plain.models.base import Model
     from plain.models.constraints import BaseConstraint
     from plain.models.fields import Field
-    from plain.models.fields.related import ForeignKey, ManyToManyField
+    from plain.models.fields.related import ForeignKeyField, ManyToManyField
     from plain.models.fields.reverse_related import ManyToManyRel
 
 logger = logging.getLogger("plain.models.backends.schema")
@@ -55,7 +55,7 @@ def _is_relevant_relation(relation: Any, altered_field: Field) -> bool:
     if altered_field.primary_key:
         # Foreign key constraint on the primary key, which is being altered.
         return True
-    # ForeignKey always targets 'id'
+    # ForeignKeyField always targets 'id'
     return altered_field.name == "id"
 
 
@@ -244,7 +244,7 @@ def table_sql(self, model: type[Model]) -> tuple[str, list[Any]]:
             if extra_params:
                 params.extend(extra_params)
             # FK.
-            if isinstance(field, ForeignKey) and field.db_constraint:
+            if isinstance(field, ForeignKeyField) and field.db_constraint:
                 to_table = field.remote_field.model.model_options.db_table
                 field_name = field.remote_field.field_name
                 if field_name is None:
@@ -586,7 +586,7 @@ def add_field(self, model: type[Model], field: Field) -> None:
         if db_params["check"]:
             definition += " " + self.sql_check_constraint % db_params
         if (
-            isinstance(field, ForeignKey)
+            isinstance(field, ForeignKeyField)
             and self.connection.features.supports_foreign_keys
             and field.db_constraint
         ):
@@ -768,7 +768,7 @@ def _alter_field(
         fks_dropped = set()
         if (
             self.connection.features.supports_foreign_keys
-            and isinstance(old_field, ForeignKey)
+            and isinstance(old_field, ForeignKeyField)
             and old_field.db_constraint
             and self._field_should_be_altered(
                 old_field,
@@ -839,11 +839,11 @@ def _alter_field(
         # True               | False            | False              | True
         # True               | False            | True               | True
         if (
-            isinstance(old_field, ForeignKey)
+            isinstance(old_field, ForeignKeyField)
             and old_field.db_index
             and not old_field.primary_key
             and (
-                not (isinstance(new_field, ForeignKey) and new_field.db_index)
+                not (isinstance(new_field, ForeignKeyField) and new_field.db_index)
                 or new_field.primary_key
             )
         ):
@@ -1007,10 +1007,10 @@ def _alter_field(
         # True               | True             | True               | False
         if (
             (
-                not (isinstance(old_field, ForeignKey) and old_field.db_index)
+                not (isinstance(old_field, ForeignKeyField) and old_field.db_index)
                 or old_field.primary_key
             )
-            and isinstance(new_field, ForeignKey)
+            and isinstance(new_field, ForeignKeyField)
             and new_field.db_index
             and not new_field.primary_key
         ):
@@ -1056,10 +1056,10 @@ def _alter_field(
         # Does it have a foreign key?
         if (
             self.connection.features.supports_foreign_keys
-            and isinstance(new_field, ForeignKey)
+            and isinstance(new_field, ForeignKeyField)
             and (
                 fks_dropped
-                or not isinstance(old_field, ForeignKey)
+                or not isinstance(old_field, ForeignKeyField)
                 or not old_field.db_constraint
             )
             and new_field.db_constraint
@@ -1070,7 +1070,7 @@ def _alter_field(
         # Rebuild FKs that pointed to us if we previously had to drop them
         if drop_foreign_keys:
             for _, rel in rels_to_update:
-                if isinstance(rel.field, ForeignKey) and rel.field.db_constraint:
+                if isinstance(rel.field, ForeignKeyField) and rel.field.db_constraint:
                     self.execute(
                         self._create_fk_sql(rel.related_model, rel.field, "_fk")
                     )
@@ -1462,7 +1462,7 @@ def _field_should_be_altered(
         ) or (old_path, old_args, old_kwargs) != (new_path, new_args, new_kwargs)
 
     def _field_should_be_indexed(self, model: type[Model], field: Field) -> bool:
-        if isinstance(field, ForeignKey):
+        if isinstance(field, ForeignKeyField):
             return bool(field.remote_field) and field.db_index and not field.primary_key
         return False
 
@@ -1480,7 +1480,7 @@ def _rename_field_sql(
         }
 
     def _create_fk_sql(
-        self, model: type[Model], field: ForeignKey, suffix: str
+        self, model: type[Model], field: ForeignKeyField, suffix: str
     ) -> Statement:
         table = Table(model.model_options.db_table, self.quote_name)
         name = self._fk_constraint_name(model, field, suffix)
@@ -1505,7 +1505,7 @@ def _create_fk_sql(
         )
 
     def _fk_constraint_name(
-        self, model: type[Model], field: ForeignKey, suffix: str
+        self, model: type[Model], field: ForeignKeyField, suffix: str
     ) -> ForeignKeyName:
         def create_fk_name(*args: Any, **kwargs: Any) -> str:
             return self.quote_name(self._create_index_name(*args, **kwargs))

plain-models/plain/models/backends/mysql/schema.py

@@ -7,7 +7,7 @@
 from plain.models.constraints import UniqueConstraint
 from plain.models.expressions import F
 from plain.models.fields import NOT_PROVIDED
-from plain.models.fields.related import ForeignKey
+from plain.models.fields.related import ForeignKeyField
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -161,12 +161,12 @@ def _field_should_be_indexed(self, model: type[Model], field: Field) -> bool:
         storage = self.connection.introspection.get_storage_engine(
             self.connection.cursor(), model.model_options.db_table
         )
-        # No need to create an index for ForeignKey fields except if
+        # No need to create an index for ForeignKeyField fields except if
         # db_constraint=False because the index from that constraint won't be
         # created.
         if (
             storage == "InnoDB"
-            and isinstance(field, ForeignKey)
+            and isinstance(field, ForeignKeyField)
             and field.db_constraint
         ):
             return False
@@ -203,7 +203,7 @@ def _create_missing_fk_index(
             return
 
         first_field = model._model_meta.get_forward_field(first_field_name)
-        if first_field.get_internal_type() == "ForeignKey":
+        if first_field.get_internal_type() == "ForeignKeyField":
             column = self.connection.introspection.identifier_converter(
                 first_field.column
             )

plain-models/plain/models/backends/postgresql/schema.py

@@ -8,7 +8,7 @@
 from plain.models.backends.base.schema import BaseDatabaseSchemaEditor
 from plain.models.backends.ddl_references import Columns, IndexColumns, Statement
 from plain.models.backends.utils import strip_quotes
-from plain.models.fields.related import ForeignKey, RelatedField
+from plain.models.fields.related import ForeignKeyField, RelatedField
 
 if TYPE_CHECKING:
     from plain.models.backends.postgresql.base import PostgreSQLDatabaseWrapper
@@ -282,10 +282,10 @@ def _alter_field(
         # Added an index? Create any PostgreSQL-specific indexes.
         if (
             not (
-                (isinstance(old_field, ForeignKey) and old_field.db_index)
+                (isinstance(old_field, ForeignKeyField) and old_field.db_index)
                 or old_field.primary_key
             )
-            and isinstance(new_field, ForeignKey)
+            and isinstance(new_field, ForeignKeyField)
             and new_field.db_index
         ) or (not old_field.primary_key and new_field.primary_key):
             like_index_statement = self._create_like_index_sql(model, new_field)
@@ -294,7 +294,7 @@ def _alter_field(
 
         # Removed an index? Drop any PostgreSQL-specific indexes.
         if old_field.primary_key and not (
-            (isinstance(new_field, ForeignKey) and new_field.db_index)
+            (isinstance(new_field, ForeignKeyField) and new_field.db_index)
             or new_field.primary_key
         ):
             index_to_remove = self._create_index_name(

plain-models/plain/models/backends/sqlite3/schema.py

@@ -10,7 +10,7 @@
 from plain.models.backends.utils import strip_quotes
 from plain.models.constraints import UniqueConstraint
 from plain.models.db import NotSupportedError
-from plain.models.fields.related import ForeignKey, RelatedField
+from plain.models.fields.related import ForeignKeyField, RelatedField
 from plain.models.registry import ModelsRegistry
 from plain.models.transaction import atomic
 
@@ -410,8 +410,8 @@ def remove_field(self, model: type[Model], field: Field) -> None:
             # Primary keys, unique fields, indexed fields, and foreign keys are
             # not supported in ALTER TABLE DROP COLUMN.
             and not field.primary_key
-            and not (isinstance(field, ForeignKey) and field.db_index)
-            and not (isinstance(field, ForeignKey) and field.db_constraint)
+            and not (isinstance(field, ForeignKeyField) and field.db_index)
+            and not (isinstance(field, ForeignKeyField) and field.db_constraint)
         ):
             super().remove_field(model, field)
         # For everything else, remake.
@@ -440,9 +440,9 @@ def _alter_field(
             and old_field.column != new_field.column
             and self.column_sql(model, old_field) == self.column_sql(model, new_field)
             and not (
-                isinstance(old_field, ForeignKey)
+                isinstance(old_field, ForeignKeyField)
                 and old_field.db_constraint
-                or isinstance(new_field, ForeignKey)
+                or isinstance(new_field, ForeignKeyField)
                 and new_field.db_constraint
             )
         ):