xdjango-postgres-extra 2.1.1__tar.gz → 2.2.0__tar.gz

xdjango_postgres_extra-2.2.0/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: xdjango-postgres-extra
+Version: 2.2.0
+Summary: Bringing all of PostgreSQL's awesomeness to Django.
+Home-page: https://github.com/SectorLabs/django-postgres-extra
+Author: Sector Labs
+Author-email: open-source@sectorlabs.ro
+License: MIT License
+Keywords: django,postgres,extra,hstore,upsert,partioning,materialized,view
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 6.0
+Classifier: Framework :: Django :: 6.1
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django<7.0,>=2.0
+Requires-Dist: python-dateutil<=3.0.0,>=2.8.0
+Requires-Dist: dataclasses; python_version <= "3.6"
+Provides-Extra: dev
+Requires-Dist: poethepoet==0.34.0; python_version >= "3.9" and extra == "dev"
+Requires-Dist: poethepoet==0.30.0; (python_version >= "3.8" and python_version < "3.9") and extra == "dev"
+Requires-Dist: poethepoet==0.19.0; (python_version >= "3.7" and python_version < "3.8") and extra == "dev"
+Requires-Dist: poethepoet==0.13.1; (python_version >= "3.6" and python_version < "3.7") and extra == "dev"
+Provides-Extra: test
+Requires-Dist: psycopg2==2.9.10; python_version >= "3.8" and extra == "test"
+Requires-Dist: psycopg2==2.9.9; (python_version >= "3.7" and python_version < "3.8") and extra == "test"
+Requires-Dist: psycopg2==2.9.8; (python_version >= "3.6" and python_version < "3.7") and extra == "test"
+Requires-Dist: types-psycopg2==2.9.21.20250516; python_version >= "3.9" and extra == "test"
+Requires-Dist: types-psycopg2==2.9.8; (python_version >= "3.6" and python_version < "3.9") and extra == "test"
+Requires-Dist: pytest==8.4.0; python_version > "3.8" and extra == "test"
+Requires-Dist: pytest==7.0.1; python_version <= "3.8" and extra == "test"
+Requires-Dist: pytest-benchmark==5.1.0; python_version > "3.8" and extra == "test"
+Requires-Dist: pytest-benchmark==3.4.1; python_version <= "3.8" and extra == "test"
+Requires-Dist: pytest-django==4.11.1; python_version > "3.7" and extra == "test"
+Requires-Dist: pytest-django==4.5.2; python_version <= "3.7" and extra == "test"
+Requires-Dist: pytest-cov==6.1.1; python_version > "3.8" and extra == "test"
+Requires-Dist: pytest-cov==4.0.0; python_version <= "3.8" and extra == "test"
+Requires-Dist: coverage==7.8.2; python_version > "3.8" and extra == "test"
+Requires-Dist: coverage==7.6.1; (python_version >= "3.8" and python_version <= "3.8") and extra == "test"
+Requires-Dist: coverage==6.2; python_version <= "3.7" and extra == "test"
+Requires-Dist: tox==4.26.0; python_version > "3.8" and extra == "test"
+Requires-Dist: tox==3.28.0; python_version <= "3.8" and extra == "test"
+Requires-Dist: freezegun==1.5.2; python_version > "3.7" and extra == "test"
+Requires-Dist: freezegun==1.2.2; python_version <= "3.7" and extra == "test"
+Requires-Dist: syrupy==4.9.1; python_version >= "3.9" and extra == "test"
+Requires-Dist: syrupy==2.3.1; python_version <= "3.8" and extra == "test"
+Provides-Extra: test-report
+Requires-Dist: coveralls==4.0.1; extra == "test-report"
+Provides-Extra: analysis
+Requires-Dist: black==22.3.0; extra == "analysis"
+Requires-Dist: flake8==7.2.0; extra == "analysis"
+Requires-Dist: autoflake==2.3.1; extra == "analysis"
+Requires-Dist: autopep8==2.3.2; extra == "analysis"
+Requires-Dist: isort==6.0.1; extra == "analysis"
+Requires-Dist: docformatter==1.7.7; extra == "analysis"
+Requires-Dist: mypy==1.16.0; extra == "analysis"
+Requires-Dist: django-stubs==4.2.7; extra == "analysis"
+Requires-Dist: typing-extensions==4.14.0; extra == "analysis"
+Requires-Dist: types-dj-database-url==1.3.0.4; extra == "analysis"
+Requires-Dist: types-python-dateutil==2.9.0.20250516; extra == "analysis"
+Provides-Extra: docs
+Requires-Dist: Sphinx==8.2.3; extra == "docs"
+Requires-Dist: sphinx-rtd-theme==3.0.2; extra == "docs"
+Requires-Dist: docutils==0.21.2; extra == "docs"
+Requires-Dist: Jinja2==3.1.6; extra == "docs"
+Provides-Extra: publish
+Requires-Dist: build<2.0.0,>=1.2.0; extra == "publish"
+Requires-Dist: twine<7.0.0,>=6.0.0; extra == "publish"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# xdjango-postgres-extra
+
+[![PyPI version](https://img.shields.io/pypi/v/xdjango-postgres-extra.svg)](https://pypi.org/project/xdjango-postgres-extra/)
+[![Python versions](https://img.shields.io/pypi/pyversions/xdjango-postgres-extra.svg)](https://pypi.org/project/xdjango-postgres-extra/)
+[![Django 6](https://img.shields.io/badge/Django-6.0-0C4B33.svg)](https://docs.djangoproject.com/en/6.0/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+`xdjango-postgres-extra` is a maintained fork of
+[`django-postgres-extra`](https://github.com/SectorLabs/django-postgres-extra).
+It extends Django's PostgreSQL backend with features such as atomic upserts,
+table partitioning, views, materialized views, schema management, and explicit
+table locking.
+
+The PyPI distribution is named `xdjango-postgres-extra`. The Python package
+and existing imports remain named `psqlextra`.
+
+## Compatibility
+
+- Django: 2.0 through 6.x (`Django>=2.0,<7.0`)
+- Python: 3.6 through 3.14
+- PostgreSQL: 11 or newer
+- Psycopg: 2 and 3
+
+Django 6 requires Python 3.12 or newer. The 2.1.x release line was verified with
+Django 6.0.6 and Python 3.14.
+
+## Installation
+
+```bash
+python -m pip install xdjango-postgres-extra
+```
+
+Use the `psqlextra` database backend in your Django settings:
+
+```python
+DATABASES = {
+    "default": {
+        "ENGINE": "psqlextra.backend",
+        "NAME": "my_database",
+        "USER": "my_user",
+        "PASSWORD": "my_password",
+        "HOST": "localhost",
+        "PORT": "5432",
+    }
+}
+```
+
+Add the application when using features that require app registration:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "django.contrib.postgres",
+    "psqlextra",
+]
+```
+
+Existing application code continues to use `psqlextra` imports:
+
+```python
+from psqlextra.models import PostgresModel
+```
+
+## Features
+
+- Atomic `INSERT ... ON CONFLICT` handling with `DO UPDATE` and `DO NOTHING`
+- Bulk inserts and upserts
+- PostgreSQL range, list, hash, and default table partitions
+- Time-based partition management
+- Database views and materialized views integrated with migrations
+- PostgreSQL schema creation, deletion, and temporary schemas
+- Explicit model and table locks
+- `TRUNCATE TABLE`, including cascading truncation
+- HStore constraints and expressions
+- PostgreSQL-specific indexes and introspection
+
+The upstream documentation remains the primary API reference:
+
+- [Documentation](https://django-postgres-extra.readthedocs.io/en/master/)
+- [Installation guide](https://django-postgres-extra.readthedocs.io/en/master/installation.html)
+- [Feature reference](https://django-postgres-extra.readthedocs.io/en/master/index.html#features)
+
+When following upstream installation instructions, install
+`xdjango-postgres-extra` instead of `django-postgres-extra`.
+
+## Development
+
+Create a virtual environment and install the development extras:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e ".[dev,test]"
+```
+
+Set a PostgreSQL test database URL:
+
+```bash
+export DATABASE_URL="postgres://psqlextra:password@localhost/psqlextra"
+```
+
+Run the available Poe tasks:
+
+```bash
+poe test
+poe verify
+```
+
+## License
+
+MIT. See [LICENSE](LICENSE).

xdjango_postgres_extra-2.2.0/README.md

@@ -0,0 +1,111 @@
+# xdjango-postgres-extra
+
+[![PyPI version](https://img.shields.io/pypi/v/xdjango-postgres-extra.svg)](https://pypi.org/project/xdjango-postgres-extra/)
+[![Python versions](https://img.shields.io/pypi/pyversions/xdjango-postgres-extra.svg)](https://pypi.org/project/xdjango-postgres-extra/)
+[![Django 6](https://img.shields.io/badge/Django-6.0-0C4B33.svg)](https://docs.djangoproject.com/en/6.0/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+`xdjango-postgres-extra` is a maintained fork of
+[`django-postgres-extra`](https://github.com/SectorLabs/django-postgres-extra).
+It extends Django's PostgreSQL backend with features such as atomic upserts,
+table partitioning, views, materialized views, schema management, and explicit
+table locking.
+
+The PyPI distribution is named `xdjango-postgres-extra`. The Python package
+and existing imports remain named `psqlextra`.
+
+## Compatibility
+
+- Django: 2.0 through 6.x (`Django>=2.0,<7.0`)
+- Python: 3.6 through 3.14
+- PostgreSQL: 11 or newer
+- Psycopg: 2 and 3
+
+Django 6 requires Python 3.12 or newer. The 2.1.x release line was verified with
+Django 6.0.6 and Python 3.14.
+
+## Installation
+
+```bash
+python -m pip install xdjango-postgres-extra
+```
+
+Use the `psqlextra` database backend in your Django settings:
+
+```python
+DATABASES = {
+    "default": {
+        "ENGINE": "psqlextra.backend",
+        "NAME": "my_database",
+        "USER": "my_user",
+        "PASSWORD": "my_password",
+        "HOST": "localhost",
+        "PORT": "5432",
+    }
+}
+```
+
+Add the application when using features that require app registration:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "django.contrib.postgres",
+    "psqlextra",
+]
+```
+
+Existing application code continues to use `psqlextra` imports:
+
+```python
+from psqlextra.models import PostgresModel
+```
+
+## Features
+
+- Atomic `INSERT ... ON CONFLICT` handling with `DO UPDATE` and `DO NOTHING`
+- Bulk inserts and upserts
+- PostgreSQL range, list, hash, and default table partitions
+- Time-based partition management
+- Database views and materialized views integrated with migrations
+- PostgreSQL schema creation, deletion, and temporary schemas
+- Explicit model and table locks
+- `TRUNCATE TABLE`, including cascading truncation
+- HStore constraints and expressions
+- PostgreSQL-specific indexes and introspection
+
+The upstream documentation remains the primary API reference:
+
+- [Documentation](https://django-postgres-extra.readthedocs.io/en/master/)
+- [Installation guide](https://django-postgres-extra.readthedocs.io/en/master/installation.html)
+- [Feature reference](https://django-postgres-extra.readthedocs.io/en/master/index.html#features)
+
+When following upstream installation instructions, install
+`xdjango-postgres-extra` instead of `django-postgres-extra`.
+
+## Development
+
+Create a virtual environment and install the development extras:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e ".[dev,test]"
+```
+
+Set a PostgreSQL test database URL:
+
+```bash
+export DATABASE_URL="postgres://psqlextra:password@localhost/psqlextra"
+```
+
+Run the available Poe tasks:
+
+```bash
+poe test
+poe verify
+```
+
+## License
+
+MIT. See [LICENSE](LICENSE).

xdjango_postgres_extra-2.2.0/psqlextra/_version.py

@@ -0,0 +1 @@
+__version__ = "2.2.0"

{xdjango_postgres_extra-2.1.1 → xdjango_postgres_extra-2.2.0}/psqlextra/backend/introspection.py

@@ -1,6 +1,8 @@
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Dict, List, Optional, Tuple
 
+import django
+
 from django.db.backends.postgresql.introspection import (  # type: ignore[import]
     DatabaseIntrospection,
 )
@@ -305,13 +307,16 @@ class PostgresIntrospection(Introspection):
         """Gets a dictionary {field_name: (field_name_other_table,
         other_table)} representing all relations in the specified table.
 
+        Django 6.1 and newer expect a third element in the value tuple
+        that describes the database-level ON DELETE behaviour.
+
         This is overriden because the query in Django does not handle
         relations between tables in different schemas properly.
         """
 
         cursor.execute(
             """
-            SELECT a1.attname, c2.relname, a2.attname
+            SELECT a1.attname, c2.relname, a2.attname, con.confdeltype
             FROM pg_constraint con
             LEFT JOIN pg_class c1 ON con.conrelid = c1.oid
             LEFT JOIN pg_class c2 ON con.confrelid = c2.oid
@@ -324,4 +329,13 @@ class PostgresIntrospection(Introspection):
         """,
             [table_name],
         )
-        return {row[0]: (row[2], row[1]) for row in cursor.fetchall()}
+
+        rows = cursor.fetchall()
+
+        if django.VERSION >= (6, 1):
+            return {
+                row[0]: (row[2], row[1], self.on_delete_types.get(row[3]))
+                for row in rows
+            }
+
+        return {row[0]: (row[2], row[1]) for row in rows}

{xdjango_postgres_extra-2.1.1 → xdjango_postgres_extra-2.2.0}/psqlextra/backend/migrations/operations/create_partitioned_model.py

@@ -74,13 +74,19 @@ class PostgresCreatePartitionedModel(CreateModel):
         result = super().reduce(*args, **kwargs)
 
         # replace CreateModel operation with PostgresCreatePartitionedModel
+        #
+        # Django >= 6.0 reduces through `copy.replace()`, which rebuilds the
+        # operation as its own class, partitioning options included. Only a
+        # plain CreateModel still has to be converted.
         if isinstance(result, list) and result:
             for i, op in enumerate(result):
-                if isinstance(op, CreateModel):
-                    _, args, kwargs = op.deconstruct()
+                if isinstance(op, CreateModel) and not isinstance(
+                    op, PostgresCreatePartitionedModel
+                ):
+                    _, op_args, op_kwargs = op.deconstruct()
                     result[i] = PostgresCreatePartitionedModel(
-                        *args,
-                        **kwargs,
+                        *op_args,
+                        **op_kwargs,
                         partitioning_options=self.partitioning_options
                     )
 

{xdjango_postgres_extra-2.1.1 → xdjango_postgres_extra-2.2.0}/psqlextra/backend/schema.py

@@ -295,8 +295,7 @@ class PostgresSchemaEditor(SchemaEditor):
                             model, [field.column], foreign_key=True
                         )
 
-                    sql = Statement(
-                        self.sql_create_fk_not_valid,
+                    fk_parts = dict(
                         table=self.quote_name(model._meta.db_table),
                         name=self.quote_name(fk_name),
                         column=self.quote_name(field.column),
@@ -307,6 +306,15 @@ class PostgresSchemaEditor(SchemaEditor):
                         deferrable=self.connection.ops.deferrable_sql(),
                     )
 
+                    # Django 6.1 added a database-level ON DELETE clause to
+                    # the foreign key statement we borrow the template from.
+                    if django.VERSION >= (6, 1):
+                        fk_parts["on_delete_db"] = self._create_on_delete_sql(  # type: ignore[attr-defined]
+                            model, field
+                        )
+
+                    sql = Statement(self.sql_create_fk_not_valid, **fk_parts)
+
                     self.execute(sql)
 
                 # It's hard to alter a field's check because it is defined

{xdjango_postgres_extra-2.1.1 → xdjango_postgres_extra-2.2.0}/setup.py

@@ -7,7 +7,7 @@ exec(open("psqlextra/_version.py").read())
 with open(
     os.path.join(os.path.dirname(__file__), "README.md"), encoding="utf-8"
 ) as readme:
-    README = readme.read().split("h1>\n", 2)[1]
+    README = readme.read()
 
 
 setup(
@@ -37,6 +37,7 @@ setup(
         "Environment :: Web Environment",
         "Framework :: Django",
         "Framework :: Django :: 6.0",
+        "Framework :: Django :: 6.1",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",

xdjango_postgres_extra-2.2.0/tests/test_django_61_compatibility.py

@@ -0,0 +1,79 @@
+import io
+
+import django
+import pytest
+
+from django.core.management import call_command
+from django.db import models
+
+from . import db_introspection
+from .fake_model import delete_fake_model, get_fake_model
+
+pytestmark = pytest.mark.skipif(
+    django.VERSION < (6, 1),
+    reason="Django < 6.1 does not report database level ON DELETE behaviour",
+)
+
+
+@pytest.fixture
+def fk_target():
+    model = get_fake_model({"name": models.TextField()})
+
+    yield model
+
+    delete_fake_model(model)
+
+
+@pytest.fixture
+def fk_source(fk_target):
+    model = get_fake_model(
+        {
+            "python_cascade": models.ForeignKey(
+                fk_target, on_delete=models.CASCADE, related_name="+"
+            ),
+            "db_cascade": models.ForeignKey(
+                fk_target, on_delete=models.DB_CASCADE, related_name="+"
+            ),
+        }
+    )
+
+    yield model
+
+    delete_fake_model(model)
+
+
+def test_get_relations_reports_db_on_delete(fk_target, fk_source):
+    """Django 6.1 and newer expect the values of the dict returned by
+    `get_relations` to carry the database level ON DELETE behaviour as a third
+    element."""
+
+    relations = db_introspection.get_relations(fk_source._meta.db_table)
+
+    assert relations == {
+        # a Python level on_delete leaves no ON DELETE clause behind
+        "python_cascade_id": (
+            "id",
+            fk_target._meta.db_table,
+            models.DO_NOTHING,
+        ),
+        "db_cascade_id": (
+            "id",
+            fk_target._meta.db_table,
+            models.DB_CASCADE,
+        ),
+    }
+
+
+def test_inspectdb_unpacks_relations(fk_target, fk_source):
+    """`inspectdb` is the one command that unpacks the value tuples returned by
+    `get_relations`, so it breaks loudly when their shape is wrong."""
+
+    stdout = io.StringIO()
+    call_command(
+        "inspectdb",
+        fk_target._meta.db_table,
+        fk_source._meta.db_table,
+        stdout=stdout,
+    )
+
+    assert "ForeignKey" in stdout.getvalue()

{xdjango_postgres_extra-2.1.1 → xdjango_postgres_extra-2.2.0}/tests/test_make_migrations.py

@@ -174,7 +174,12 @@ def test_make_migration_field_operations_view_models(
     last_name_field = models.TextField(null=True)
     last_name_field.contribute_to_class(model, "last_name")
 
-    migration = make_migration(model._meta.app_label, from_state=state_1)
+    # a clone, because Django >= 6.0 strips `indexes`/`constraints` out of
+    # the options of the state it detects changes against, and `state_1` is
+    # re-used as the target state further down
+    migration = make_migration(
+        model._meta.app_label, from_state=state_1.clone()
+    )
     assert len(migration.operations) == 1
     assert isinstance(migration.operations[0], operations.ApplyState)
     assert isinstance(migration.operations[0].state_operation, AddField)

{xdjango_postgres_extra-2.1.1 → xdjango_postgres_extra-2.2.0}/tests/test_schema_editor_clone_model_to_schema.py

@@ -156,6 +156,16 @@ def fake_model_fk_target_2():
 
 @pytest.fixture
 def fake_model(fake_model_fk_target_1, fake_model_fk_target_2):
+    # `check` was renamed to `condition` in Django 5.1 and dropped in 6.0
+    if django.VERSION >= (5, 1):
+        age_height_check = models.CheckConstraint(
+            condition=Q(age__gt=0, height__gt=0), name="age_height_check"
+        )
+    else:
+        age_height_check = models.CheckConstraint(
+            check=Q(age__gt=0, height__gt=0), name="age_height_check"
+        )
+
     meta_options = {
         "indexes": [
             models.Index(fields=["age", "height"]),
@@ -167,9 +177,7 @@ def fake_model(fake_model_fk_target_1, fake_model_fk_target_2):
                 fields=["first_name", "last_name"],
                 name="first_last_name_uniq",
             ),
-            models.CheckConstraint(
-                check=Q(age__gt=0, height__gt=0), name="age_height_check"
-            ),
+            age_height_check,
         ],
         "unique_together": (
             "first_name",