elasticsearch 8.12.1__tar.gz → 8.13.1__tar.gz

{elasticsearch-8.12.1 → elasticsearch-8.13.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: elasticsearch
-Version: 8.12.1
+Version: 8.13.1
 Summary: Python client for Elasticsearch
 Home-page: https://github.com/elastic/elasticsearch-py
 Author: Elastic Client Library Maintainers
@@ -27,11 +27,16 @@ Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: elastic-transport<9,>=8
+Requires-Dist: elastic-transport<9,>=8.13
 Provides-Extra: requests
 Requires-Dist: requests<3.0.0,>=2.4.0; extra == "requests"
 Provides-Extra: async
 Requires-Dist: aiohttp<4,>=3; extra == "async"
+Provides-Extra: orjson
+Requires-Dist: orjson>=3; extra == "orjson"
+Provides-Extra: vectorstore-mmr
+Requires-Dist: numpy>=1; extra == "vectorstore-mmr"
+Requires-Dist: simsimd>=3; extra == "vectorstore-mmr"
 
 
 Elasticsearch Python Client
@@ -46,8 +51,8 @@ Elasticsearch Python Client
 .. image:: https://static.pepy.tech/badge/elasticsearch
    :target: https://pepy.tech/project/elasticsearch?versions=*
 
-.. image:: https://clients-ci.elastic.co/job/elastic+elasticsearch-py+main/badge/icon
-   :target: https://clients-ci.elastic.co/job/elastic+elasticsearch-py+main
+.. image:: https://badge.buildkite.com/68e22afcb2ea8f6dcc20834e3a5b5ab4431beee33d3bd751f3.svg
+   :target: https://buildkite.com/elastic/elasticsearch-py-integration-tests
 
 .. image:: https://readthedocs.org/projects/elasticsearch-py/badge/?version=latest&style=flat
    :target: https://elasticsearch-py.readthedocs.io
@@ -104,12 +109,27 @@ Usage
 Compatibility
 -------------
 
-Language clients are forward compatible; meaning that clients support communicating
-with greater or equal minor versions of Elasticsearch. Elasticsearch language clients
-are only backwards compatible with default distributions and without guarantees made.
+Language clients are forward compatible; meaning that the clients support
+communicating with greater or equal minor versions of Elasticsearch without
+breaking. It does not mean that the clients automatically support new features
+of newer Elasticsearch versions; it is only possible after a release of a new
+client version. For example, a 8.12 client version won't automatically support
+the new features of the 8.13 version of Elasticsearch, the 8.13 client version
+is required for that. Elasticsearch language clients are only backwards
+compatible with default distributions and without guarantees made.
+
++-----------------------+-------------------------+-----------+
+| Elasticsearch version | elasticsearch-py branch | Supported |
++=======================+=========================+===========+
+| main                  | main                    |           |
++-----------------------+-------------------------+-----------+
+| 8.x                   | 8.x                     | 8.x       |
++-----------------------+-------------------------+-----------+
+| 7.x                   | 7.x                     | 7.17      |
++-----------------------+-------------------------+-----------+
 
 If you have a need to have multiple versions installed at the same time older
-versions are also released as ``elasticsearch2`` and ``elasticsearch5``.
+versions are also released as ``elasticsearch7`` and ``elasticsearch8``.
 
 
 Documentation

{elasticsearch-8.12.1 → elasticsearch-8.13.1}/README.rst

@@ -14,8 +14,8 @@ Elasticsearch Python Client
 .. image:: https://static.pepy.tech/badge/elasticsearch
    :target: https://pepy.tech/project/elasticsearch?versions=*
 
-.. image:: https://clients-ci.elastic.co/job/elastic+elasticsearch-py+main/badge/icon
-   :target: https://clients-ci.elastic.co/job/elastic+elasticsearch-py+main
+.. image:: https://badge.buildkite.com/68e22afcb2ea8f6dcc20834e3a5b5ab4431beee33d3bd751f3.svg
+   :target: https://buildkite.com/elastic/elasticsearch-py-integration-tests
 
 .. image:: https://readthedocs.org/projects/elasticsearch-py/badge/?version=latest&style=flat
    :target: https://elasticsearch-py.readthedocs.io
@@ -72,12 +72,27 @@ Usage
 Compatibility
 -------------
 
-Language clients are forward compatible; meaning that clients support communicating
-with greater or equal minor versions of Elasticsearch. Elasticsearch language clients
-are only backwards compatible with default distributions and without guarantees made.
+Language clients are forward compatible; meaning that the clients support
+communicating with greater or equal minor versions of Elasticsearch without
+breaking. It does not mean that the clients automatically support new features
+of newer Elasticsearch versions; it is only possible after a release of a new
+client version. For example, a 8.12 client version won't automatically support
+the new features of the 8.13 version of Elasticsearch, the 8.13 client version
+is required for that. Elasticsearch language clients are only backwards
+compatible with default distributions and without guarantees made.
+
++-----------------------+-------------------------+-----------+
+| Elasticsearch version | elasticsearch-py branch | Supported |
++=======================+=========================+===========+
+| main                  | main                    |           |
++-----------------------+-------------------------+-----------+
+| 8.x                   | 8.x                     | 8.x       |
++-----------------------+-------------------------+-----------+
+| 7.x                   | 7.x                     | 7.17      |
++-----------------------+-------------------------+-----------+
 
 If you have a need to have multiple versions installed at the same time older
-versions are also released as ``elasticsearch2`` and ``elasticsearch5``.
+versions are also released as ``elasticsearch7`` and ``elasticsearch8``.
 
 
 Documentation

{elasticsearch-8.12.1 → elasticsearch-8.13.1}/docs/sphinx/async.rst

@@ -1,11 +1,11 @@
-Using Asyncio with Elasticsearch
+Using asyncio with Elasticsearch
 ================================
 
  .. py:module:: elasticsearch
     :no-index:
 
 The ``elasticsearch`` package supports async/await with
-`Asyncio <https://docs.python.org/3/library/asyncio.html>`_ and `Aiohttp <https://docs.aiohttp.org>`_.
+`asyncio <https://docs.python.org/3/library/asyncio.html>`_ and `aiohttp <https://docs.aiohttp.org>`_.
 You can either install ``aiohttp`` directly or use the ``[async]`` extra:
 
  .. code-block:: bash
@@ -27,10 +27,10 @@ and are used in the same way as other APIs, just with an extra ``await``:
     import asyncio
     from elasticsearch import AsyncElasticsearch
 
-    es = AsyncElasticsearch()
+    client = AsyncElasticsearch()
 
     async def main():
-        resp = await es.search(
+        resp = await client.search(
             index="documents",
             body={"query": {"match_all": {}}},
             size=20,
@@ -97,20 +97,20 @@ For example if using FastAPI that might look like this:
     from elasticsearch import AsyncElasticsearch
 
     ELASTICSEARCH_URL = os.environ["ELASTICSEARCH_URL"]
-    es = None
+    client = None
 
     @asynccontextmanager
     async def lifespan(app: FastAPI):
-        global es
-        es = AsyncElasticsearch(ELASTICSEARCH_URL)
+        global client
+        client = AsyncElasticsearch(ELASTICSEARCH_URL)
         yield
-        await es.close()
+        await client.close()
 
     app = FastAPI(lifespan=lifespan)
 
     @app.get("/")
     async def main():
-        return await es.info()
+        return await client.info()
 
 You can run this example by saving it to ``main.py`` and executing
 ``ELASTICSEARCH_URL=http://localhost:9200 uvicorn main:app``.
@@ -140,7 +140,7 @@ Bulk and Streaming Bulk
     from elasticsearch import AsyncElasticsearch
     from elasticsearch.helpers import async_bulk
 
-    es = AsyncElasticsearch()
+    client = AsyncElasticsearch()
 
     async def gendata():
         mywords = ['foo', 'bar', 'baz']
@@ -151,7 +151,7 @@ Bulk and Streaming Bulk
             }
 
     async def main():
-        await async_bulk(es, gendata())
+        await async_bulk(client, gendata())
 
     loop = asyncio.get_event_loop()
     loop.run_until_complete(main())
@@ -164,7 +164,7 @@ Bulk and Streaming Bulk
     from elasticsearch import AsyncElasticsearch
     from elasticsearch.helpers import async_streaming_bulk
 
-    es = AsyncElasticsearch()
+    client = AsyncElasticsearch()
 
     async def gendata():
         mywords = ['foo', 'bar', 'baz']
@@ -175,7 +175,7 @@ Bulk and Streaming Bulk
             }
 
     async def main():
-        async for ok, result in async_streaming_bulk(es, gendata()):
+        async for ok, result in async_streaming_bulk(client, gendata()):
             action, result = result.popitem()
             if not ok:
                 print("failed to %s document %s" % ())
@@ -194,11 +194,11 @@ Scan
     from elasticsearch import AsyncElasticsearch
     from elasticsearch.helpers import async_scan
 
-    es = AsyncElasticsearch()
+    client = AsyncElasticsearch()
 
     async def main():
         async for doc in async_scan(
-            client=es,
+            client=client,
             query={"query": {"match": {"title": "python"}}},
             index="orders-*"
         ):

{elasticsearch-8.12.1 → elasticsearch-8.13.1}/docs/sphinx/helpers.rst

@@ -5,6 +5,15 @@ Helpers
 
 Collection of simple helper functions that abstract some specifics of the raw API.
 
+Connecting
+----------
+
+.. code-block:: python
+
+    from elasticsearch import Elasticsearch
+    
+    client = Elasticsearch("https://.../", api_key="YOUR_API_KEY")
+
 
 Bulk helpers
 ------------
@@ -74,6 +83,8 @@ document is like ``{"word": "<myword>"}``.
 
 .. code:: python
 
+    from elasticsearch.helpers import bulk
+
     def gendata():
         mywords = ['foo', 'bar', 'baz']
         for word in mywords:
@@ -82,7 +93,7 @@ document is like ``{"word": "<myword>"}``.
                 "word": word,
             }
 
-    bulk(es, gendata())
+    bulk(client, gendata())
 
 
 For a more complete and complex example please take a look at

{elasticsearch-8.12.1 → elasticsearch-8.13.1}/docs/sphinx/index.rst

@@ -34,9 +34,24 @@ Read more about `how to use asyncio with this project <async.html>`_.
 Compatibility
 -------------
 
-Language clients are forward compatible; meaning that clients support communicating
-with greater or equal minor versions of Elasticsearch. Elasticsearch language clients
-are only backwards compatible with default distributions and without guarantees made.
+Language clients are forward compatible; meaning that the clients support
+communicating with greater or equal minor versions of Elasticsearch without
+breaking. It does not mean that the clients automatically support new features
+of newer Elasticsearch versions; it is only possible after a release of a new
+client version. For example, a 8.12 client version won't automatically support
+the new features of the 8.13 version of Elasticsearch, the 8.13 client version
+is required for that. Elasticsearch language clients are only backwards
+compatible with default distributions and without guarantees made.
+
++-----------------------+-------------------------+-----------+
+| Elasticsearch version | elasticsearch-py branch | Supported |
++=======================+=========================+===========+
+| main                  | main                    |           |
++-----------------------+-------------------------+-----------+
+| 8.x                   | 8.x                     | 8.x       |
++-----------------------+-------------------------+-----------+
+| 7.x                   | 7.x                     | 7.17      |
++-----------------------+-------------------------+-----------+
 
 If you need multiple versions installed at the same time, versions are
 also released, such as ``elasticsearch7`` and ``elasticsearch8``.
@@ -50,22 +65,22 @@ Example Usage
     from datetime import datetime
     from elasticsearch import Elasticsearch
 
-    es = Elasticsearch("http://localhost:9200")
+    client = Elasticsearch("http://localhost:9200/", api_key="YOUR_API_KEY")
 
     doc = {
         "author": "kimchy",
         "text": "Elasticsearch: cool. bonsai cool.",
         "timestamp": datetime.now(),
     }
-    resp = es.index(index="test-index", id=1, document=doc)
+    resp = client.index(index="test-index", id=1, document=doc)
     print(resp["result"])
 
-    resp = es.get(index="test-index", id=1)
+    resp = client.get(index="test-index", id=1)
     print(resp["_source"])
 
-    es.indices.refresh(index="test-index")
+    client.indices.refresh(index="test-index")
 
-    resp = es.search(index="test-index", query={"match_all": {}})
+    resp = client.search(index="test-index", query={"match_all": {}})
     print("Got {} hits:".format(resp["hits"]["total"]["value"]))
     for hit in resp["hits"]["hits"]:
         print("{timestamp} {author} {text}".format(**hit["_source"]))

{elasticsearch-8.12.1 → elasticsearch-8.13.1}/elasticsearch/__init__.py

@@ -63,6 +63,11 @@ from .exceptions import (
 )
 from .serializer import JSONSerializer, JsonSerializer
 
+try:
+    from .serializer import OrjsonSerializer
+except ImportError:
+    OrjsonSerializer = None  # type: ignore[assignment,misc]
+
 # Only raise one warning per deprecation message so as not
 # to spam up the user if the same action is done multiple times.
 warnings.simplefilter("default", category=ElasticsearchWarning, append=True)
@@ -86,6 +91,8 @@ __all__ = [
     "UnsupportedProductError",
     "ElasticsearchWarning",
 ]
+if OrjsonSerializer is not None:
+    __all__.append("OrjsonSerializer")
 
 fixup_module_metadata(__name__, globals())
 del fixup_module_metadata