elasticsearch 8.17.1__tar.gz → 8.17.2__tar.gz

{elasticsearch-8.17.1 → elasticsearch-8.17.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: elasticsearch
-Version: 8.17.1
+Version: 8.17.2
 Summary: Python client for Elasticsearch
 Project-URL: Documentation, https://elasticsearch-py.readthedocs.io/
 Project-URL: Homepage, https://github.com/elastic/elasticsearch-py

{elasticsearch-8.17.1 → elasticsearch-8.17.2}/docs/sphinx/api/elasticsearch.rst

@@ -3,7 +3,7 @@
 Elasticsearch
 -------------
 
-.. py:module:: elasticsearch.client
+.. py:module:: elasticsearch
 
 .. autoclass:: Elasticsearch
    :members:

{elasticsearch-8.17.1 → elasticsearch-8.17.2}/docs/sphinx/conf.py

@@ -21,10 +21,42 @@ import elasticsearch
 
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.intersphinx"]
 
-autoclass_content = "both"
+autoclass_content = "class"
+autodoc_class_signature = "separated"
 
 autodoc_typehints = "description"
 
+
+def client_name(full_name):
+    # Get the class name, e.g. ['elasticsearch', 'client', 'TextStructureClient'] -> 'TextStructure'
+    class_name = full_name.split(".")[-1].removesuffix("Client")
+    # Convert to snake case, e.g. 'TextStructure' -> '_text_structure'
+    snake_case = "".join(["_" + c.lower() if c.isupper() else c for c in class_name])
+    # Remove the leading underscore
+    return snake_case.lstrip("_")
+
+
+def add_client_usage_example(app, what, name, obj, options, lines):
+    if what == "class" and "Client" in name:
+        sub_client_name = client_name(name)
+        lines.append(
+            f"To use this client, access ``client.{sub_client_name}`` from an "
+            " :class:`~elasticsearch.Elasticsearch` client. For example::"
+        )
+        lines.append("")
+        lines.append("    from elasticsearch import Elasticsearch")
+        lines.append("")
+        lines.append("    # Create the client instance")
+        lines.append("    client = Elasticsearch(...)")
+        lines.append(f"    # Use the {sub_client_name} client")
+        lines.append(f"    client.{sub_client_name}.<method>(...)")
+        lines.append("")
+
+
+def setup(app):
+    app.connect("autodoc-process-docstring", add_client_usage_example)
+
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

{elasticsearch-8.17.1 → elasticsearch-8.17.2}/elasticsearch/__init__.py

@@ -27,7 +27,7 @@ from ._utils import fixup_module_metadata
 from ._version import __versionstr__
 
 # Ensure that a compatible version of elastic-transport is installed.
-_version_groups = tuple(int(x) for x in re.search(r"^(\d+)\.(\d+)\.(\d+)", _elastic_transport_version).groups())  # type: ignore
+_version_groups = tuple(int(x) for x in re.search(r"^(\d+)\.(\d+)\.(\d+)", _elastic_transport_version).groups())  # type: ignore[union-attr]
 if _version_groups < (8, 0, 0) or _version_groups > (9, 0, 0):
     raise ImportError(
         "An incompatible version of elastic-transport is installed. Must be between "
@@ -35,7 +35,7 @@ if _version_groups < (8, 0, 0) or _version_groups > (9, 0, 0):
         "$ python -m pip install 'elastic-transport>=8, <9'"
     )
 
-_version_groups = re.search(r"^(\d+)\.(\d+)\.(\d+)", __versionstr__).groups()  # type: ignore
+_version_groups = re.search(r"^(\d+)\.(\d+)\.(\d+)", __versionstr__).groups()  # type: ignore[assignment, union-attr]
 _major, _minor, _patch = (int(x) for x in _version_groups)
 VERSION = __version__ = (_major, _minor, _patch)