Switch from elasticsearch-dsl-py to elasticsearch-py

sximba · sximba · commit e5441e936095 · 2025-06-22T14:59:14.000+02:00
This commit switches the dependency of this library from elasticsearch-dsl-py
to elasticsearch-py since the former was merged into the latter.

This commit also updates the tox matrix to only run tests for supported
dependencies only
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,14 +13,24 @@ jobs:
       fail-fast: false
 
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
-        django-version: ["3.2", "4.1", "4.2"]
-        es-dsl-version: ["6.4", "7.4"]
-        es-version: ["8.10.2"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        django-version: ["4.2", "5.1", "5.2"]
+        es-version: ["7", "8", "9"]
+        version: ["7.4", "8.0", "master"]
 
         exclude:
-          - python-version: "3.11"
-            django-version: "3.2"
+          - python-version: "3.13"
+            django-version: "4.2"
+          - python-version: "3.9"
+            django-version: "5.1"
+          - python-version: "3.9"
+            django-version: "5.2"
+          - version: "8.0"
+            es-version: "7"
+          - version: "master"
+            es-version: "7"
+          - version: "master"
+            es-version: "8"
 
     steps:
       - name: Install and Run Elasticsearch
@@ -29,6 +39,8 @@ jobs:
           stack-version: ${{ matrix.es-version }}
 
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ matrix.version }}
 
       - name: Install Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
@@ -47,12 +59,11 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install "Django==${{ matrix.django-version }}"
-          python -m pip install "elasticsearch-dsl==${{ matrix.es-dsl-version }}"
           python -m pip install -r requirements_test.txt
 
-      - name: Run tests with Python ${{ matrix.python-version }} and Django ${{ matrix.django-version }} and elasticsearch-dsl-py ${{ matrix.es-dsl-version }}
+      - name: Run tests with Python ${{ matrix.python-version }} and Django ${{ matrix.django-version }}
         run: |
-          TOX_ENV=$(echo "py${{ matrix.python-version }}-django-${{ matrix.django-version }}-es${{ matrix.es-dsl-version }}" | tr -d .)
+          TOX_ENV=$(echo "py${{ matrix.python-version }}-django-${{ matrix.django-version }}" | tr -d .)
           python -m tox -e $TOX_ENV -- --elasticsearch
           python -m tox -e $TOX_ENV -- --elasticsearch --signal-processor celery
 
diff --git a/README.rst b/README.rst
@@ -12,17 +12,17 @@ Django Elasticsearch DSL
     :target: https://django-elasticsearch-dsl.readthedocs.io/en/latest/
 
 Django Elasticsearch DSL is a package that allows indexing of django models in elasticsearch.
-It is built as a thin wrapper around elasticsearch-dsl-py_
-so you can use all the features developed by the elasticsearch-dsl-py team.
+It is built as a thin wrapper around elasticsearch-py_
+so you can use all the features developed by the elasticsearch-py team.
 
 You can view the full documentation at https://django-elasticsearch-dsl.readthedocs.io
 
-.. _elasticsearch-dsl-py: https://github.com/elastic/elasticsearch-dsl-py
+.. _elasticsearch-py: https://github.com/elastic/elasticsearch-py
 
 Features
 --------
 
-- Based on elasticsearch-dsl-py_ so you can make queries with the Search_ class.
+- Based on elasticsearch-py_ so you can make queries with the Search_ class.
 - Django signal receivers on save and delete for keeping Elasticsearch in sync.
 - Management commands for creating, deleting, rebuilding and populating indices.
 - Elasticsearch auto mapping from django models fields.
@@ -31,11 +31,12 @@ Features
 - Requirements
 
    - Django >= 3.2
-   - Python 3.8, 3.9, 3.10, 3.11
+   - Python 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
 
 **Elasticsearch Compatibility:**
 The library is compatible with all Elasticsearch versions since 5.x
 **but you have to use a matching major version:**
+- For Elasticsearch 9.0 and later, use the major version 9 (9.x.y) of the library.
 
 - For Elasticsearch 8.0 and later, use the major version 8 (8.x.y) of the library.
 
@@ -45,6 +46,9 @@ The library is compatible with all Elasticsearch versions since 5.x
 
 .. code-block:: python
 
+    # Elasticsearch 9.x
+    elasticsearch>=9.0.0,<10.0.0
+
     # Elasticsearch 8.x
     elasticsearch-dsl>=8.0.0,<9.0.0
 
diff --git a/django_elasticsearch_dsl/__init__.py b/django_elasticsearch_dsl/__init__.py
@@ -1,15 +1,9 @@
-import django
-
 from django.utils.module_loading import autodiscover_modules
 
 from .documents import Document  # noqa
-from .indices import Index  # noqa
 from .fields import *  # noqa
-
-__version__ = '7.1.1'
+from .indices import Index  # noqa
 
 
 def autodiscover():
     autodiscover_modules('documents')
-
-
diff --git a/django_elasticsearch_dsl/apps.py b/django_elasticsearch_dsl/apps.py
@@ -1,8 +1,7 @@
 from django.apps import AppConfig
 from django.conf import settings
 from django.utils.module_loading import import_string
-
-from elasticsearch_dsl.connections import connections
+from elasticsearch.dsl.connections import connections
 
 
 class DEDConfig(AppConfig):
diff --git a/django_elasticsearch_dsl/documents.py b/django_elasticsearch_dsl/documents.py
@@ -6,8 +6,8 @@
 
 from django import VERSION as DJANGO_VERSION
 from django.db import models
+from elasticsearch.dsl import Document as DSLDocument
 from elasticsearch.helpers import bulk, parallel_bulk
-from elasticsearch_dsl import Document as DSLDocument
 from six import iteritems
 
 from .exceptions import ModelFieldNotMappedError
@@ -21,7 +21,8 @@
     KeywordField,
     LongField,
     ShortField,
-    TextField, TimeField,
+    TextField,
+    TimeField,
 )
 from .search import Search
 from .signals import post_index
@@ -219,14 +220,13 @@ def _get_actions(self, object_list, action):
         for object_instance in object_list:
             if action == 'delete' or self.should_index_object(object_instance):
                 yield self._prepare_action(object_instance, action)
-    
+
     def get_actions(self, object_list, action):
         """
         Generate the elasticsearch payload.
         """
         return self._get_actions(object_list, action)
 
-
     def _bulk(self, *args, **kwargs):
         """Helper for switching between normal and parallel bulk operation"""
         parallel = kwargs.pop('parallel', False)
diff --git a/django_elasticsearch_dsl/fields.py b/django_elasticsearch_dsl/fields.py
@@ -9,8 +9,9 @@
     from django.utils.encoding import force_text as force_str
 else:
     from django.utils.encoding import force_str
+
 from django.utils.functional import Promise
-from elasticsearch_dsl.field import (
+from elasticsearch.dsl.field import (
     Boolean,
     Byte,
     Completion,
@@ -22,14 +23,14 @@
     GeoShape,
     Integer,
     Ip,
+    Keyword,
     Long,
     Nested,
     Object,
     ScaledFloat,
+    SearchAsYouType,
     Short,
-    Keyword,
     Text,
-    SearchAsYouType,
 )
 
 from .exceptions import VariableLookupError
diff --git a/django_elasticsearch_dsl/indices.py b/django_elasticsearch_dsl/indices.py
@@ -1,6 +1,6 @@
 from copy import deepcopy
 
-from elasticsearch_dsl import Index as DSLIndex
+from elasticsearch.dsl import Index as DSLIndex
 from six import python_2_unicode_compatible
 
 from .apps import DEDConfig
diff --git a/django_elasticsearch_dsl/management/commands/search_index.py b/django_elasticsearch_dsl/management/commands/search_index.py
@@ -1,10 +1,12 @@
-from __future__ import unicode_literals, absolute_import
+from __future__ import absolute_import, unicode_literals
+
 from datetime import datetime
 
-from elasticsearch_dsl import connections
 from django.conf import settings
 from django.core.management.base import BaseCommand, CommandError
+from elasticsearch.dsl import connections
 from six.moves import input
+
 from ...registries import registry
 
 
diff --git a/django_elasticsearch_dsl/registries.py b/django_elasticsearch_dsl/registries.py
@@ -1,14 +1,13 @@
 from collections import defaultdict
 from copy import deepcopy
-
 from itertools import chain
 
-from django.core.exceptions import ObjectDoesNotExist
-from django.core.exceptions import ImproperlyConfigured
-from elasticsearch_dsl import AttrDict
-from six import itervalues, iterkeys, iteritems
+from django.core.exceptions import ImproperlyConfigured, ObjectDoesNotExist
+from elasticsearch.dsl import AttrDict
+from six import iteritems, iterkeys, itervalues
 
 from django_elasticsearch_dsl.exceptions import RedeclaredFieldError
+
 from .apps import DEDConfig
 
 
diff --git a/django_elasticsearch_dsl/search.py b/django_elasticsearch_dsl/search.py
@@ -1,7 +1,6 @@
 from django.db.models import Case, When
 from django.db.models.fields import IntegerField
-
-from elasticsearch_dsl import Search as DSLSearch
+from elasticsearch.dsl import Search as DSLSearch
 
 
 class Search(DSLSearch):
diff --git a/django_elasticsearch_dsl/signals.py b/django_elasticsearch_dsl/signals.py
@@ -6,15 +6,19 @@
 
 from __future__ import absolute_import
 
-from django.db import models
+from importlib import import_module
+
 from django.apps import apps
+from django.core.exceptions import ObjectDoesNotExist
+from django.db import models
 from django.dispatch import Signal
+
 from .registries import registry
-from django.core.exceptions import ObjectDoesNotExist
-from importlib import import_module
+
 # Sent after document indexing is completed
 post_index = Signal()
 
+
 class BaseSignalProcessor(object):
     """Base signal processor.
 
@@ -99,6 +103,7 @@ def teardown(self):
         models.signals.m2m_changed.disconnect(self.handle_m2m_changed)
         models.signals.pre_delete.disconnect(self.handle_pre_delete)
 
+
 try:
     from celery import shared_task
 except ImportError:
@@ -166,7 +171,7 @@ def prepare_registry_delete_related_task(self, instance):
                     self.registry_delete_task.delay(doc_instance.__class__.__name__, bulk_data)
 
         @shared_task()
-        def registry_delete_task(doc_label, data):
+        def registry_delete_task(doc_label, bulk_data):
             """
             Handle the bulk delete data on the registry as a Celery task.
             The different implementations used are due to the difference between delete and update operations. 
diff --git a/django_elasticsearch_dsl/test/testcases.py b/django_elasticsearch_dsl/test/testcases.py
@@ -1,7 +1,7 @@
 import re
 
 from django.test.utils import captured_stderr
-from elasticsearch_dsl.connections import connections
+from elasticsearch.dsl.connections import connections
 
 from ..registries import registry
 
diff --git a/docs/source/es_index.rst b/docs/source/es_index.rst
@@ -4,7 +4,7 @@ Index
 In typical scenario using `class Index` on a `Document` class is sufficient to perform any action.
 In a few cases though it can be useful to manipulate an Index object directly.
 
-To define an Elasticsearch index you must instantiate a ``elasticsearch_dsl.Index`` class
+To define an Elasticsearch index you must instantiate a ``elasticsearch.dsl.Index`` class
 and set the name and settings of the index.
 After you instantiate your class,
 you need to associate it with the Document you want to put in this Elasticsearch index
@@ -14,7 +14,7 @@ and also add the `registry.register_document` decorator.
 .. code-block:: python
 
     # documents.py
-    from elasticsearch_dsl import Index
+    from elasticsearch.dsl import Index
     from django_elasticsearch_dsl import Document
     from .models import Car, Manufacturer
 
diff --git a/example/test_app/documents.py b/example/test_app/documents.py
@@ -1,10 +1,10 @@
-from elasticsearch_dsl import analyzer
+from elasticsearch.dsl import analyzer
+
 from django_elasticsearch_dsl import Document, Index, fields
 from django_elasticsearch_dsl.registries import registry
 
 from .models import Ad, Car, Manufacturer
 
-
 car = Index('test_cars')
 car.settings(
     number_of_shards=1,
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,2 @@
 django>=3.2
-elasticsearch-dsl>=8.0.0,<9.0.0
+elasticsearch>=9.0.0,<10.0.0
diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -1,7 +1,7 @@
 bumpversion==0.6.0
 wheel==0.41.2
 django>=3.2
-elasticsearch-dsl>=7.0.0,<8.0.0
+elasticsearch>=9.0.0,<10.0.0
 twine
 sphinx
 -e .
diff --git a/requirements_test.txt b/requirements_test.txt
@@ -1,8 +1,8 @@
-coverage==7.3.1
-mock>=1.0.1
-flake8>=2.1.0
-tox>=1.7.0
-Pillow==10.0.0
-celery>=4.1.0
+coverage==7.9.1
+mock>=5.2.0
+flake8>=7.3.0
+tox>=4.27.0
+Pillow==11.0.0
+celery>=5.5.3
 
 # Additional test requirements go here
diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 7.1.1
+current_version = 9.0.0
 commit = True
 tag = True
 
diff --git a/setup.py b/setup.py
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/documents.py b/tests/documents.py
diff --git a/tests/test_documents.py b/tests/test_documents.py
diff --git a/tests/test_integration.py b/tests/test_integration.py
diff --git a/tox.ini b/tox.ini
