elasticsearch 8.17.1__tar.gz → 9.0.0__tar.gz

{elasticsearch-8.17.1 → elasticsearch-9.0.0}/CHANGELOG.md

@@ -1 +1 @@
-See: https://www.elastic.co/guide/en/elasticsearch/client/python-api/master/release-notes.html
+See: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/release-notes.html

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: elasticsearch
-Version: 8.17.1
+Version: 9.0.0
 Summary: Python client for Elasticsearch
 Project-URL: Documentation, https://elasticsearch-py.readthedocs.io/
 Project-URL: Homepage, https://github.com/elastic/elasticsearch-py
@@ -28,6 +28,8 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.8
 Requires-Dist: elastic-transport<9,>=8.15.1
+Requires-Dist: python-dateutil
+Requires-Dist: typing-extensions
 Provides-Extra: async
 Requires-Dist: aiohttp<4,>=3; extra == 'async'
 Provides-Extra: dev
@@ -38,19 +40,27 @@ Requires-Dist: coverage; extra == 'dev'
 Requires-Dist: isort; extra == 'dev'
 Requires-Dist: jinja2; extra == 'dev'
 Requires-Dist: mapbox-vector-tile; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: nltk; extra == 'dev'
 Requires-Dist: nox; extra == 'dev'
 Requires-Dist: numpy; extra == 'dev'
 Requires-Dist: orjson; extra == 'dev'
 Requires-Dist: pandas; extra == 'dev'
 Requires-Dist: pyarrow; extra == 'dev'
+Requires-Dist: pyright; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-asyncio; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-mock; extra == 'dev'
 Requires-Dist: python-dateutil; extra == 'dev'
 Requires-Dist: pyyaml>=5.4; extra == 'dev'
 Requires-Dist: requests<3,>=2; extra == 'dev'
+Requires-Dist: sentence-transformers; extra == 'dev'
 Requires-Dist: simsimd; extra == 'dev'
+Requires-Dist: tqdm; extra == 'dev'
 Requires-Dist: twine; extra == 'dev'
+Requires-Dist: types-python-dateutil; extra == 'dev'
+Requires-Dist: types-tqdm; extra == 'dev'
 Requires-Dist: unasync; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == 'docs'
@@ -68,7 +78,7 @@ Requires-Dist: simsimd>=3; extra == 'vectorstore-mmr'
 Description-Content-Type: text/markdown
 
 <p align="center">
-    <img src="https://github.com/elastic/elasticsearch-py/raw/main/docs/logo-elastic-glyph-color.svg" width="20%" alt="Elastic logo" />
+    <img src="https://github.com/elastic/elasticsearch-py/raw/main/docs/images/logo-elastic-glyph-color.svg" width="20%" alt="Elastic logo" />
 </p>
 
 # Elasticsearch Python Client
@@ -160,19 +170,6 @@ Documentation for the client is [available on elastic.co] and [Read the Docs].
 [Read the Docs]: https://elasticsearch-py.readthedocs.io
 
 
-## Feedback 🗣️
-
-The engineering team here at Elastic is looking for developers to participate in
-research and feedback sessions to learn more about how you use our Python client and
-what improvements we can make to their design and your workflow. If you're interested in
-sharing your insights into developer experience and language client design, please fill
-out this [short form]. Depending on the number of responses we get, we may either
-contact you for a 1:1 conversation or a focus group with other developers who use the
-same client. Thank you in advance - your feedback is crucial to improving the user
-experience for all Elasticsearch developers!
-
-[short form]: https://forms.gle/bYZwDQXijfhfwshn9
-
 ## License
 
 This software is licensed under the [Apache License 2.0](./LICENSE). See [NOTICE](./NOTICE).

{elasticsearch-8.17.1 → elasticsearch-9.0.0}/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <img src="https://github.com/elastic/elasticsearch-py/raw/main/docs/logo-elastic-glyph-color.svg" width="20%" alt="Elastic logo" />
+    <img src="https://github.com/elastic/elasticsearch-py/raw/main/docs/images/logo-elastic-glyph-color.svg" width="20%" alt="Elastic logo" />
 </p>
 
 # Elasticsearch Python Client
@@ -91,19 +91,6 @@ Documentation for the client is [available on elastic.co] and [Read the Docs].
 [Read the Docs]: https://elasticsearch-py.readthedocs.io
 
 
-## Feedback 🗣️
-
-The engineering team here at Elastic is looking for developers to participate in
-research and feedback sessions to learn more about how you use our Python client and
-what improvements we can make to their design and your workflow. If you're interested in
-sharing your insights into developer experience and language client design, please fill
-out this [short form]. Depending on the number of responses we get, we may either
-contact you for a 1:1 conversation or a focus group with other developers who use the
-same client. Thank you in advance - your feedback is crucial to improving the user
-experience for all Elasticsearch developers!
-
-[short form]: https://forms.gle/bYZwDQXijfhfwshn9
-
 ## License
 
 This software is licensed under the [Apache License 2.0](./LICENSE). See [NOTICE](./NOTICE).

{elasticsearch-8.17.1 → elasticsearch-9.0.0}/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-9.0.0}/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-9.0.0}/docs/sphinx/quickstart.rst

@@ -39,7 +39,7 @@ under **Cloud ID**.
 
 You can generate an API key on the **Management** page under Security.
 
-.. image:: ../guide/images/create-api-key.png
+.. image:: _static/images/create-api-key.png
 
 Confirm that the connection was successful.
 

{elasticsearch-8.17.1 → elasticsearch-9.0.0}/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)