richie 3.0.1.dev4__tar.gz → 3.0.1.dev8__tar.gz

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/.gitlint

@@ -1,8 +1,8 @@
 # All these sections are optional, edit this file as you like.
 [general]
+regex-style-search=true
 # Ignore certain rules, you can reference them by their id or by their full name
 # ignore=title-trailing-punctuation, T3
-
 # verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this
 # verbosity = 2
 

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/CHANGELOG.md

@@ -8,10 +8,15 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unrealeased]
 
+### Added
+
+- Refactor Elasticsearch client initialization and add client custom settings
+
 ### Fixed
 
 - Fix building site from cookicutter
 - Fix lazy load video player mode for programs
+- Fix gitlint warning
 
 ## [3.0.0] - 2025-04-03
 

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: richie
-Version: 3.0.1.dev4
+Version: 3.0.1.dev8
 Summary: A CMS to build learning portals for open education
 Author-email: "Open FUN (France Université Numérique)" <fun.dev@fun-mooc.fr>
 License: MIT License

richie-3.0.1.dev8/src/richie/apps/search/apps.py

@@ -0,0 +1,52 @@
+"""Signals to update the Elasticsearch indices when page modifications are published."""
+
+# Define the global ES_CLIENT and ES_INDICES_CLIENT variables
+
+from django.apps import AppConfig
+from django.conf import settings
+
+from .elasticsearch import (
+    ElasticsearchClientCompat7to6,
+    ElasticsearchIndicesClientCompat7to6,
+)
+
+ES_CLIENT = None
+ES_INDICES_CLIENT = None
+
+
+def init_es():
+    """
+    Initialize the Elasticsearch client and indices client.
+    """
+    global ES_CLIENT  # pylint: disable=global-statement
+    ES_CLIENT = ElasticsearchClientCompat7to6(
+        getattr(settings, "RICHIE_ES_HOST", ["elasticsearch"]),
+        **getattr(settings, "RICHIE_ES_CLIENT_KWARGS", {}),
+    )
+    global ES_INDICES_CLIENT  # pylint: disable=global-statement
+    ES_INDICES_CLIENT = ElasticsearchIndicesClientCompat7to6(ES_CLIENT)
+
+
+# pylint: disable=import-outside-toplevel,cyclic-import
+def init_signals():
+    """Register signals to update the Elasticsearch indices."""
+    from cms.signals import post_publish, post_unpublish
+
+    from .signals import on_page_published, on_page_unpublished
+
+    post_publish.connect(on_page_published, dispatch_uid="search_post_publish")
+    post_unpublish.connect(on_page_unpublished, dispatch_uid="search_post_unpublish")
+
+
+class SearchConfig(AppConfig):
+    """Configuration class for the search app."""
+
+    name = "richie.apps.search"
+    verbose_name = "Richie search app"
+
+    def ready(self):
+        """
+        Initialize the Elasticsearch client and register signals.
+        """
+        init_es()
+        init_signals()

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/src/richie/apps/search/filter_definitions/courses.py

@@ -15,7 +15,7 @@ from cms.api import Page
 
 from richie.apps.core.defaults import ALL_LANGUAGES_DICT
 
-from .. import ES_CLIENT
+from ..apps import ES_CLIENT
 from ..fields.array import ArrayField
 from ..indexers import ES_INDICES
 from ..utils.i18n import get_best_field_language

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/src/richie/apps/search/index_manager.py

@@ -10,7 +10,7 @@ from django.utils import timezone
 
 from elasticsearch.exceptions import NotFoundError, RequestError
 
-from . import ES_CLIENT, ES_INDICES_CLIENT
+from .apps import ES_CLIENT, ES_INDICES_CLIENT
 from .defaults import ES_CHUNK_SIZE, ES_INDICES_PREFIX
 from .elasticsearch import bulk_compat
 from .indexers import ES_INDICES

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/src/richie/apps/search/utils/viewsets.py

@@ -7,7 +7,7 @@ from django.utils.translation import get_language_from_request
 from rest_framework.decorators import action
 from rest_framework.response import Response
 
-from .. import ES_CLIENT
+from ..apps import ES_CLIENT
 
 
 class ViewSetMetadata:

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/src/richie/apps/search/viewsets/categories.py

@@ -11,7 +11,7 @@ from rest_framework.exceptions import NotFound
 from rest_framework.response import Response
 from rest_framework.viewsets import ViewSet
 
-from .. import ES_CLIENT
+from ..apps import ES_CLIENT
 from ..defaults import ES_PAGE_SIZE
 from ..indexers import ES_INDICES
 from ..utils.viewsets import ViewSetMetadata

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/src/richie/apps/search/viewsets/courses.py

@@ -8,7 +8,7 @@ from elasticsearch.exceptions import NotFoundError
 from rest_framework.response import Response
 from rest_framework.viewsets import ViewSet
 
-from .. import ES_CLIENT
+from ..apps import ES_CLIENT
 from ..defaults import ES_PAGE_SIZE, FILTERS_PRESENTATION
 from ..filter_definitions import FILTERS
 from ..indexers import ES_INDICES

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/src/richie/apps/search/viewsets/licences.py

@@ -9,7 +9,7 @@ from elasticsearch.exceptions import NotFoundError
 from rest_framework.response import Response
 from rest_framework.viewsets import ViewSet
 
-from .. import ES_CLIENT
+from ..apps import ES_CLIENT
 from ..defaults import ES_PAGE_SIZE
 from ..indexers import ES_INDICES
 from ..utils.viewsets import AutocompleteMixin, ViewSetMetadata

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/src/richie/apps/search/viewsets/organizations.py

@@ -9,7 +9,7 @@ from elasticsearch.exceptions import NotFoundError
 from rest_framework.response import Response
 from rest_framework.viewsets import ViewSet
 
-from .. import ES_CLIENT
+from ..apps import ES_CLIENT
 from ..defaults import ES_PAGE_SIZE
 from ..indexers import ES_INDICES
 from ..utils.viewsets import AutocompleteMixin, ViewSetMetadata

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/src/richie/apps/search/viewsets/persons.py

@@ -9,7 +9,7 @@ from elasticsearch.exceptions import NotFoundError
 from rest_framework.response import Response
 from rest_framework.viewsets import ViewSet
 
-from .. import ES_CLIENT
+from ..apps import ES_CLIENT
 from ..defaults import ES_PAGE_SIZE
 from ..indexers import ES_INDICES
 from ..utils.viewsets import AutocompleteMixin, ViewSetMetadata

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/src/richie.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: richie
-Version: 3.0.1.dev4
+Version: 3.0.1.dev8
 Summary: A CMS to build learning portals for open education
 Author-email: "Open FUN (France Université Numérique)" <fun.dev@fun-mooc.fr>
 License: MIT License

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/src/richie.egg-info/SOURCES.txt

@@ -2756,6 +2756,7 @@ tests/apps/search/test_fields_datetimerange.py
 tests/apps/search/test_filter_definitions.py
 tests/apps/search/test_forms_search_courses.py
 tests/apps/search/test_forms_search_items.py
+tests/apps/search/test_index_client.py
 tests/apps/search/test_index_manager.py
 tests/apps/search/test_indexers_categories.py
 tests/apps/search/test_indexers_courses.py

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_autocomplete_categories.py

@@ -7,7 +7,7 @@ from unittest import mock
 
 from django.test import TestCase
 
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.indexers.categories import CategoriesIndexer
 from richie.apps.search.text_indexing import ANALYSIS_SETTINGS

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_autocomplete_courses.py

@@ -7,7 +7,7 @@ from unittest import mock
 
 from django.test import TestCase
 
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.indexers.courses import CoursesIndexer
 from richie.apps.search.text_indexing import ANALYSIS_SETTINGS

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_autocomplete_licences.py

@@ -7,7 +7,7 @@ from unittest import mock
 
 from django.test import TestCase
 
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.indexers.licences import LicencesIndexer
 from richie.apps.search.text_indexing import ANALYSIS_SETTINGS

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_autocomplete_organizations.py

@@ -7,7 +7,7 @@ from unittest import mock
 
 from django.test import TestCase
 
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.indexers.organizations import OrganizationsIndexer
 from richie.apps.search.text_indexing import ANALYSIS_SETTINGS

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_autocomplete_persons.py

@@ -7,7 +7,7 @@ from unittest import mock
 
 from django.test import TestCase
 
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.indexers.persons import PersonsIndexer
 from richie.apps.search.text_indexing import ANALYSIS_SETTINGS

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_elasticsearch_compat_layer.py

@@ -70,9 +70,9 @@ class ElasticSearchCompatLayerTestCase(TestCase):
         with mock.patch(
             "elasticsearch.Elasticsearch.info", wraps=es_client.info
         ) as mock_es_info:
-            with mock.patch("richie.apps.search.ES_CLIENT", es_client):
+            with mock.patch("richie.apps.search.apps.ES_CLIENT", es_client):
                 with mock.patch(
-                    "richie.apps.search.ES_INDICES_CLIENT", es_indices_client
+                    "richie.apps.search.apps.ES_INDICES_CLIENT", es_indices_client
                 ):
                     # Perform a bunch of ES actions, from index management all the way to searches
 

richie-3.0.1.dev8/tests/apps/search/test_index_client.py

@@ -0,0 +1,26 @@
+"""
+Test the index client initialization.
+"""
+
+from django.test import TestCase
+from django.test.utils import override_settings
+
+
+class IndexClientTestCase(TestCase):
+    """
+    Test the index client.
+    """
+
+    # pylint: disable=import-outside-toplevel
+    @override_settings(RICHIE_ES_CLIENT_KWARGS={"timeout": 99})
+    def test_index_client_kwargs(self):
+        """
+        Test `RICHIE_ES_CLIENT_KWARGS` setting, that allows to pass extra configurations to the
+        elastic search index client.
+        """
+        from richie.apps.search.apps import init_es
+
+        init_es()
+        from richie.apps.search.apps import ES_CLIENT
+
+        self.assertEqual(ES_CLIENT.transport.kwargs, {"timeout": 99})

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_index_manager.py

@@ -12,7 +12,7 @@ from django.utils import timezone as django_timezone
 from elasticsearch.exceptions import NotFoundError
 
 from richie.apps.courses.factories import CourseFactory
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.index_manager import (
     ES_INDICES,
     get_indices_by_alias,

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_partial_mappings.py

@@ -4,7 +4,7 @@ Test for our partial mappings
 
 from django.test import TestCase
 
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.text_indexing import ANALYSIS_SETTINGS, MULTILINGUAL_TEXT
 
 

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_query_categories.py

@@ -5,7 +5,7 @@ from unittest import mock
 
 from django.test import TestCase
 
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.indexers.categories import CategoriesIndexer
 from richie.apps.search.text_indexing import ANALYSIS_SETTINGS

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_query_courses.py

@@ -16,7 +16,7 @@ from richie.apps.courses.factories import (
     OrganizationFactory,
     PersonFactory,
 )
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.filter_definitions import FILTERS
 from richie.apps.search.filter_definitions.courses import ALL_LANGUAGES_DICT

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_query_courses_edge_cases.py

@@ -11,7 +11,7 @@ from django.test import TestCase
 import arrow
 
 from richie.apps.courses.factories import CategoryFactory, OrganizationFactory
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.filter_definitions import FILTERS
 from richie.apps.search.indexers.courses import CoursesIndexer

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_query_courses_facets.py

@@ -9,7 +9,7 @@ from django.test import TestCase
 import arrow
 
 from richie.apps.courses.factories import CategoryFactory
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.filter_definitions import (
     FILTERS,

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_query_courses_i18n.py

@@ -9,7 +9,7 @@ from richie.apps.courses.factories import (
     CourseFactory,
     OrganizationFactory,
 )
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.filter_definitions import FILTERS
 from richie.apps.search.indexers import ES_INDICES

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_query_licences.py

@@ -5,7 +5,7 @@ from unittest import mock
 
 from django.test import TestCase
 
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.indexers.licences import LicencesIndexer
 from richie.apps.search.text_indexing import ANALYSIS_SETTINGS

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_query_organizations.py

@@ -5,7 +5,7 @@ from unittest import mock
 
 from django.test import TestCase
 
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.indexers.organizations import OrganizationsIndexer
 from richie.apps.search.text_indexing import ANALYSIS_SETTINGS

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_query_persons.py

@@ -5,7 +5,7 @@ from unittest import mock
 
 from django.test import TestCase
 
-from richie.apps.search import ES_CLIENT, ES_INDICES_CLIENT
+from richie.apps.search.apps import ES_CLIENT, ES_INDICES_CLIENT
 from richie.apps.search.elasticsearch import bulk_compat
 from richie.apps.search.indexers.persons import PersonsIndexer
 from richie.apps.search.text_indexing import ANALYSIS_SETTINGS

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_viewsets_categories.py

@@ -9,7 +9,7 @@ from django.test.utils import override_settings
 
 from elasticsearch.exceptions import NotFoundError
 
-from richie.apps.search import ES_CLIENT
+from richie.apps.search.apps import ES_CLIENT
 
 
 class CategoriesViewsetsTestCase(TestCase):

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_viewsets_courses.py

@@ -11,7 +11,7 @@ from django.utils import timezone as django_timezone
 from cms.test_utils.testcases import CMSTestCase
 from elasticsearch.exceptions import NotFoundError
 
-from richie.apps.search import ES_CLIENT
+from richie.apps.search.apps import ES_CLIENT
 from richie.apps.search.indexers.courses import CoursesIndexer
 
 

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_viewsets_licences.py

@@ -9,7 +9,7 @@ from django.test.utils import override_settings
 
 from elasticsearch.exceptions import NotFoundError
 
-from richie.apps.search import ES_CLIENT
+from richie.apps.search.apps import ES_CLIENT
 
 
 class LicencesViewsetsTestCase(TestCase):

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_viewsets_organizations.py

@@ -9,7 +9,7 @@ from django.test.utils import override_settings
 
 from elasticsearch.exceptions import NotFoundError
 
-from richie.apps.search import ES_CLIENT
+from richie.apps.search.apps import ES_CLIENT
 
 
 class OrganizationsViewsetsTestCase(TestCase):

{richie-3.0.1.dev4 → richie-3.0.1.dev8}/tests/apps/search/test_viewsets_persons.py

@@ -9,7 +9,7 @@ from django.test.utils import override_settings
 
 from elasticsearch.exceptions import NotFoundError
 
-from richie.apps.search import ES_CLIENT
+from richie.apps.search.apps import ES_CLIENT
 
 
 class PersonsViewSetTestCase(TestCase):

richie-3.0.1.dev4/src/richie/apps/search/__init__.py

@@ -1,17 +0,0 @@
-"""Define SearchConfig as the default app configuration."""
-
-from django.conf import settings
-
-from .elasticsearch import (
-    ElasticsearchClientCompat7to6,
-    ElasticsearchIndicesClientCompat7to6,
-)
-
-# pylint: disable=invalid-name
-default_app_config = "richie.apps.search.apps.SearchConfig"
-
-ES_CLIENT = ElasticsearchClientCompat7to6(
-    getattr(settings, "RICHIE_ES_HOST", ["elasticsearch"])
-)
-
-ES_INDICES_CLIENT = ElasticsearchIndicesClientCompat7to6(ES_CLIENT)

richie-3.0.1.dev4/src/richie/apps/search/apps.py

@@ -1,22 +0,0 @@
-"""Signals to update the Elasticsearch indices when page modifications are published."""
-
-from django.apps import AppConfig
-
-
-class SearchConfig(AppConfig):
-    """Configuration class for the search app."""
-
-    name = "richie.apps.search"
-    verbose_name = "Richie search app"
-
-    # pylint: disable=import-outside-toplevel
-    def ready(self):
-        """Register signals to update the Elasticsearch indices."""
-        from cms.signals import post_publish, post_unpublish
-
-        from .signals import on_page_published, on_page_unpublished
-
-        post_publish.connect(on_page_published, dispatch_uid="search_post_publish")
-        post_unpublish.connect(
-            on_page_unpublished, dispatch_uid="search_post_unpublish"
-        )