Skip to content

Switch from elasticsearch-dsl-py dependency to elasticsearch-py #492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
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-py-version: ["9.0"]
es-version: ["8.10.2"]

exclude:
Expand Down Expand Up @@ -47,12 +47,12 @@ 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 "elasticsearch==${{ matrix.es-py-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 }} and elasticsearch-py ${{ matrix.es-py-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 }}-es${{ matrix.es-py-version }}" | tr -d .)
python -m tox -e $TOX_ENV -- --elasticsearch
python -m tox -e $TOX_ENV -- --elasticsearch --signal-processor celery

Expand Down
9 changes: 7 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ 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

Expand All @@ -37,6 +37,8 @@ Features
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.

- For Elasticsearch 7.0 and later, use the major version 7 (7.x.y) of the library.
Expand All @@ -45,6 +47,9 @@ The library is compatible with all Elasticsearch versions since 5.x

.. code-block:: python

# Elasticsearch 9.x
elasticsearch-dsl>=9.0.0,<10.0.0

# Elasticsearch 8.x
elasticsearch-dsl>=8.0.0,<9.0.0

Expand Down
2 changes: 1 addition & 1 deletion django_elasticsearch_dsl/apps.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
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):
Expand Down
4 changes: 2 additions & 2 deletions django_elasticsearch_dsl/documents.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from django import VERSION as DJANGO_VERSION
from django.db import models
from elasticsearch.helpers import bulk, parallel_bulk
from elasticsearch_dsl import Document as DSLDocument
from elasticsearch.dsl import Document as DSLDocument
from six import iteritems

from .exceptions import ModelFieldNotMappedError
Expand Down Expand Up @@ -219,7 +219,7 @@ 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.
Expand Down
2 changes: 1 addition & 1 deletion django_elasticsearch_dsl/fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
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,
Expand Down
2 changes: 1 addition & 1 deletion django_elasticsearch_dsl/indices.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from __future__ import unicode_literals, absolute_import
from datetime import datetime

from elasticsearch_dsl import connections
from elasticsearch.dsl import connections
from django.conf import settings
from django.core.management.base import BaseCommand, CommandError
from six.moves import input
Expand Down
2 changes: 1 addition & 1 deletion django_elasticsearch_dsl/registries.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

from django.core.exceptions import ObjectDoesNotExist
from django.core.exceptions import ImproperlyConfigured
from elasticsearch_dsl import AttrDict
from elasticsearch.dsl import AttrDict
from six import itervalues, iterkeys, iteritems

from django_elasticsearch_dsl.exceptions import RedeclaredFieldError
Expand Down
2 changes: 1 addition & 1 deletion django_elasticsearch_dsl/search.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
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):
Expand Down
2 changes: 1 addition & 1 deletion django_elasticsearch_dsl/test/testcases.py
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/source/es_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion example/test_app/documents.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
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

Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
django>=3.2
elasticsearch-dsl>=8.0.0,<9.0.0
elasticsearch>=9.0.0,<10.0.0
2 changes: 1 addition & 1 deletion requirements_dev.txt
Original file line number Diff line number Diff line change
@@ -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 .
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 7.1.1
current_version = 9.0
commit = True
tag = True

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
except ImportError:
from distutils.core import setup

version = '8.0'
version = '9.0'

if sys.argv[-1] == 'publish':
try:
Expand Down Expand Up @@ -43,7 +43,7 @@
],
include_package_data=True,
install_requires=[
'elasticsearch-dsl>=8.9.0,<9.0.0',
'elasticsearch>=9.0.0,<10.0.0',
'six',
],
license="Apache Software License 2.0",
Expand Down
2 changes: 1 addition & 1 deletion tests/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
from elasticsearch_dsl import VERSION
from elasticsearch.dsl import VERSION

ES_MAJOR_VERSION = VERSION[0]
2 changes: 1 addition & 1 deletion tests/documents.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from elasticsearch_dsl import analyzer
from elasticsearch.dsl import analyzer
from django_elasticsearch_dsl import Document, fields
from django_elasticsearch_dsl.registries import registry

Expand Down
10 changes: 5 additions & 5 deletions tests/test_documents.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
from django.utils.translation import ugettext_lazy as _
else:
from django.utils.translation import gettext_lazy as _
from elasticsearch_dsl import GeoPoint, InnerDoc
from elasticsearch.dsl import GeoPoint, InnerDoc
from mock import patch, Mock

from django_elasticsearch_dsl import fields
Expand Down Expand Up @@ -453,7 +453,7 @@ def test_init_prepare_results(self):
# got iterated and generate_id called.
# If we mock the bulk in django_elasticsearch_dsl.document
# the actual bulk will be never called and the test will fail
@patch('elasticsearch_dsl.connections.Elasticsearch.bulk')
@patch('elasticsearch.dsl.connections.Elasticsearch.bulk')
def test_default_generate_id_is_called(self, _):
article = Article(
id=124594,
Expand Down Expand Up @@ -481,7 +481,7 @@ class Index:
d.update(article)
patched_method.assert_called()

@patch('elasticsearch_dsl.connections.Elasticsearch.bulk')
@patch('elasticsearch.dsl.connections.Elasticsearch.bulk')
def test_custom_generate_id_is_called(self, mock_bulk):
article = Article(
id=54218,
Expand Down Expand Up @@ -511,7 +511,7 @@ def generate_id(cls, article):
data = json.loads(mock_bulk.call_args[1]['operations'][1])
assert data['slug'] == article.slug

@patch('elasticsearch_dsl.connections.Elasticsearch.bulk')
@patch('elasticsearch.dsl.connections.Elasticsearch.bulk')
def test_should_index_object_is_called(self, mock_bulk):
doc = CarDocument()
car1 = Car()
Expand All @@ -525,7 +525,7 @@ def test_should_index_object_is_called(self, mock_bulk):
self.assertEqual(mock_should_index_object.call_count, 3,
"should_index_object is called")

@patch('elasticsearch_dsl.connections.Elasticsearch.bulk')
@patch('elasticsearch.dsl.connections.Elasticsearch.bulk')
def test_should_index_object_working_perfectly(self, mock_bulk):
article1 = Article(slug='article1')
article2 = Article(slug='article2')
Expand Down
2 changes: 1 addition & 1 deletion tests/test_integration.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from six import StringIO

from elasticsearch.exceptions import NotFoundError
from elasticsearch_dsl import Index as DSLIndex
from elasticsearch.dsl import Index as DSLIndex
from django_elasticsearch_dsl.test import ESTestCase, is_es_online
from tests import ES_MAJOR_VERSION

Expand Down
3 changes: 1 addition & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ deps =
django-32: Django>=3.2,<3.3
django-41: Django>=4.1,<4.2
django-42: Django>=4.2,<4.3
es64: elasticsearch-dsl>=6.4.0,<7.0.0
es74: elasticsearch-dsl>=7.4.0,<8
es9: elasticsearch>=9.0.0,<10
-r{toxinidir}/requirements_test.txt

basepython =
Expand Down