elasticsearch9 9.0.0__py3-none-any.whl

elasticsearch9/_sync/client/xpack.py

@@ -0,0 +1,134 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+import typing as t
+
+from elastic_transport import ObjectApiResponse
+
+from ._base import NamespacedClient
+from .utils import _rewrite_parameters
+
+
+class XPackClient(NamespacedClient):
+    def __getattr__(self, attr_name: str) -> t.Any:
+        return getattr(self.client, attr_name)
+
+    # AUTO-GENERATED-API-DEFINITIONS #
+
+    @_rewrite_parameters()
+    def info(
+        self,
+        *,
+        accept_enterprise: t.Optional[bool] = None,
+        categories: t.Optional[
+            t.Sequence[t.Union[str, t.Literal["build", "features", "license"]]]
+        ] = None,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        pretty: t.Optional[bool] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        .. raw:: html
+
+          <p>Get information.
+          The information provided by the API includes:</p>
+          <ul>
+          <li>Build information including the build number and timestamp.</li>
+          <li>License information about the currently installed license.</li>
+          <li>Feature information for the features that are currently enabled and available under the current license.</li>
+          </ul>
+
+
+        `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-info>`_
+
+        :param accept_enterprise: If this param is used it must be set to true
+        :param categories: A comma-separated list of the information categories to include
+            in the response. For example, `build,license,features`.
+        """
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_xpack"
+        __query: t.Dict[str, t.Any] = {}
+        if accept_enterprise is not None:
+            __query["accept_enterprise"] = accept_enterprise
+        if categories is not None:
+            __query["categories"] = categories
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if pretty is not None:
+            __query["pretty"] = pretty
+        __headers = {"accept": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="xpack.info",
+            path_parts=__path_parts,
+        )
+
+    @_rewrite_parameters()
+    def usage(
+        self,
+        *,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+        pretty: t.Optional[bool] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        .. raw:: html
+
+          <p>Get usage information.
+          Get information about the features that are currently enabled and available under the current license.
+          The API also provides some usage statistics.</p>
+
+
+        `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-xpack>`_
+
+        :param master_timeout: The period to wait for a connection to the master node.
+            If no response is received before the timeout expires, the request fails
+            and returns an error. To indicate that the request should never timeout,
+            set it to `-1`.
+        """
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_xpack/usage"
+        __query: t.Dict[str, t.Any] = {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if master_timeout is not None:
+            __query["master_timeout"] = master_timeout
+        if pretty is not None:
+            __query["pretty"] = pretty
+        __headers = {"accept": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="xpack.usage",
+            path_parts=__path_parts,
+        )

elasticsearch9/_utils.py

@@ -0,0 +1,34 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+import re
+from typing import Any, Dict
+
+
+def fixup_module_metadata(module_name: str, namespace: Dict[str, Any]) -> None:
+    # Yoinked from python-trio/outcome, thanks Nathaniel! License: MIT
+    def fix_one(obj: Any) -> None:
+        mod = getattr(obj, "__module__", None)
+        if mod is not None and re.match(r"^elasticsearch[0-9]*\.", mod) is not None:
+            obj.__module__ = module_name
+            if isinstance(obj, type):
+                for attr_value in obj.__dict__.values():
+                    fix_one(attr_value)
+
+    for objname in namespace["__all__"]:
+        obj = namespace[objname]
+        fix_one(obj)

elasticsearch9/_version.py

@@ -0,0 +1,18 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+__versionstr__ = "9.0.0"

elasticsearch9/client.py

@@ -0,0 +1,126 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+import warnings
+
+from ._sync.client import Elasticsearch as Elasticsearch  # noqa: F401
+from ._sync.client.async_search import (  # noqa: F401
+    AsyncSearchClient as AsyncSearchClient,
+)
+from ._sync.client.autoscaling import (  # noqa: F401
+    AutoscalingClient as AutoscalingClient,
+)
+from ._sync.client.cat import CatClient as CatClient  # noqa: F401
+from ._sync.client.ccr import CcrClient as CcrClient  # noqa: F401
+from ._sync.client.cluster import ClusterClient as ClusterClient  # noqa: F401
+from ._sync.client.connector import ConnectorClient as ConnectorClient  # noqa: F401
+from ._sync.client.dangling_indices import (  # noqa: F401
+    DanglingIndicesClient as DanglingIndicesClient,
+)
+from ._sync.client.enrich import EnrichClient as EnrichClient  # noqa: F401
+from ._sync.client.eql import EqlClient as EqlClient  # noqa: F401
+from ._sync.client.esql import EsqlClient as EsqlClient  # noqa: F401
+from ._sync.client.features import FeaturesClient as FeaturesClient  # noqa: F401
+from ._sync.client.fleet import FleetClient as FleetClient  # noqa: F401
+from ._sync.client.graph import GraphClient as GraphClient  # noqa: F401
+from ._sync.client.ilm import IlmClient as IlmClient  # noqa: F401
+from ._sync.client.indices import IndicesClient as IndicesClient  # noqa: F401
+from ._sync.client.inference import InferenceClient as InferenceClient  # noqa: F401
+from ._sync.client.ingest import IngestClient as IngestClient  # noqa: F401
+from ._sync.client.license import LicenseClient as LicenseClient  # noqa: F401
+from ._sync.client.logstash import LogstashClient as LogstashClient  # noqa: F401
+from ._sync.client.migration import MigrationClient as MigrationClient  # noqa: F401
+from ._sync.client.ml import MlClient as MlClient  # noqa: F401
+from ._sync.client.monitoring import MonitoringClient as MonitoringClient  # noqa: F401
+from ._sync.client.nodes import NodesClient as NodesClient  # noqa: F401
+from ._sync.client.query_rules import QueryRulesClient as QueryRulesClient  # noqa: F401
+from ._sync.client.rollup import RollupClient as RollupClient  # noqa: F401
+from ._sync.client.search_application import (  # noqa: F401
+    SearchApplicationClient as SearchApplicationClient,
+)
+from ._sync.client.searchable_snapshots import (  # noqa: F401
+    SearchableSnapshotsClient as SearchableSnapshotsClient,
+)
+from ._sync.client.security import SecurityClient as SecurityClient  # noqa: F401
+from ._sync.client.shutdown import ShutdownClient as ShutdownClient  # noqa: F401
+from ._sync.client.simulate import SimulateClient as SimulateClient  # noqa: F401
+from ._sync.client.slm import SlmClient as SlmClient  # noqa: F401
+from ._sync.client.snapshot import SnapshotClient as SnapshotClient  # noqa: F401
+from ._sync.client.sql import SqlClient as SqlClient  # noqa: F401
+from ._sync.client.ssl import SslClient as SslClient  # noqa: F401
+from ._sync.client.synonyms import SynonymsClient as SynonymsClient  # noqa: F401
+from ._sync.client.tasks import TasksClient as TasksClient  # noqa: F401
+from ._sync.client.text_structure import (  # noqa: F401
+    TextStructureClient as TextStructureClient,
+)
+from ._sync.client.transform import TransformClient as TransformClient  # noqa: F401
+from ._sync.client.watcher import WatcherClient as WatcherClient  # noqa: F401
+from ._sync.client.xpack import XPackClient as XPackClient  # noqa: F401
+from ._utils import fixup_module_metadata
+
+# This file exists for backwards compatibility.
+# We can't remove it as we use it for the Sphinx docs which show the full page, and we'd
+# rather show `elasticsearch.client.FooClient` than `elasticsearch._sync.client.FooClient`.
+warnings.warn(
+    "Importing from the 'elasticsearch.client' module is deprecated. "
+    "Instead use 'elasticsearch' module for importing the client.",
+    category=DeprecationWarning,
+    stacklevel=2,
+)
+
+__all__ = [
+    "AsyncSearchClient",
+    "AutoscalingClient",
+    "CatClient",
+    "CcrClient",
+    "ClusterClient",
+    "ConnectorClient",
+    "DanglingIndicesClient",
+    "Elasticsearch",
+    "EnrichClient",
+    "EqlClient",
+    "FeaturesClient",
+    "FleetClient",
+    "GraphClient",
+    "IlmClient",
+    "IndicesClient",
+    "IngestClient",
+    "LicenseClient",
+    "LogstashClient",
+    "MigrationClient",
+    "MlClient",
+    "MonitoringClient",
+    "NodesClient",
+    "RollupClient",
+    "SearchApplicationClient",
+    "SearchableSnapshotsClient",
+    "SecurityClient",
+    "ShutdownClient",
+    "SimulateClient",
+    "SlmClient",
+    "SnapshotClient",
+    "SqlClient",
+    "SslClient",
+    "TasksClient",
+    "TextStructureClient",
+    "TransformClient",
+    "WatcherClient",
+    "XPackClient",
+]
+
+fixup_module_metadata(__name__, globals())
+del fixup_module_metadata

elasticsearch9/compat.py

@@ -0,0 +1,79 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+import inspect
+import sys
+from pathlib import Path
+from typing import Tuple, Type, Union
+
+string_types: Tuple[Type[str], Type[bytes]] = (str, bytes)
+
+
+def to_str(x: Union[str, bytes], encoding: str = "ascii") -> str:
+    if not isinstance(x, str):
+        return x.decode(encoding)
+    return x
+
+
+def to_bytes(x: Union[str, bytes], encoding: str = "ascii") -> bytes:
+    if not isinstance(x, bytes):
+        return x.encode(encoding)
+    return x
+
+
+def warn_stacklevel() -> int:
+    """Dynamically determine warning stacklevel for warnings based on the call stack"""
+    try:
+        # Grab the root module from the current module '__name__'
+        module_name = __name__.partition(".")[0]
+        module_path = Path(sys.modules[module_name].__file__)  # type: ignore[arg-type]
+
+        # If the module is a folder we're looking at
+        # subdirectories, otherwise we're looking for
+        # an exact match.
+        module_is_folder = module_path.name == "__init__.py"
+        if module_is_folder:
+            module_path = module_path.parent
+
+        # Look through frames until we find a file that
+        # isn't a part of our module, then return that stacklevel.
+        for level, frame in enumerate(inspect.stack()):
+            # Garbage collecting frames
+            frame_filename = Path(frame.filename)
+            del frame
+
+            if (
+                # If the module is a folder we look at subdirectory
+                module_is_folder
+                and module_path not in frame_filename.parents
+            ) or (
+                # Otherwise we're looking for an exact match.
+                not module_is_folder
+                and module_path != frame_filename
+            ):
+                return level
+    except KeyError:
+        pass
+    return 0
+
+
+__all__ = [
+    "string_types",
+    "to_str",
+    "to_bytes",
+    "warn_stacklevel",
+]

elasticsearch9/dsl/__init__.py

@@ -0,0 +1,203 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+from . import async_connections, connections
+from .aggs import A, Agg
+from .analysis import analyzer, char_filter, normalizer, token_filter, tokenizer
+from .document import AsyncDocument, Document
+from .document_base import InnerDoc, M, MetaField, mapped_field
+from .exceptions import (
+    ElasticsearchDslException,
+    IllegalOperation,
+    UnknownDslObject,
+    ValidationException,
+)
+from .faceted_search import (
+    AsyncFacetedSearch,
+    DateHistogramFacet,
+    Facet,
+    FacetedResponse,
+    FacetedSearch,
+    HistogramFacet,
+    NestedFacet,
+    RangeFacet,
+    TermsFacet,
+)
+from .field import (
+    Binary,
+    Boolean,
+    Byte,
+    Completion,
+    ConstantKeyword,
+    CustomField,
+    Date,
+    DateRange,
+    DenseVector,
+    Double,
+    DoubleRange,
+    Field,
+    Float,
+    FloatRange,
+    GeoPoint,
+    GeoShape,
+    HalfFloat,
+    Integer,
+    IntegerRange,
+    Ip,
+    IpRange,
+    Join,
+    Keyword,
+    Long,
+    LongRange,
+    Murmur3,
+    Nested,
+    Object,
+    Percolator,
+    Point,
+    RangeField,
+    RankFeature,
+    RankFeatures,
+    ScaledFloat,
+    SearchAsYouType,
+    Shape,
+    Short,
+    SparseVector,
+    Text,
+    TokenCount,
+    construct_field,
+)
+from .function import SF
+from .index import (
+    AsyncComposableIndexTemplate,
+    AsyncIndex,
+    AsyncIndexTemplate,
+    ComposableIndexTemplate,
+    Index,
+    IndexTemplate,
+)
+from .mapping import AsyncMapping, Mapping
+from .query import Q, Query
+from .response import AggResponse, Response, UpdateByQueryResponse
+from .search import (
+    AsyncEmptySearch,
+    AsyncMultiSearch,
+    AsyncSearch,
+    EmptySearch,
+    MultiSearch,
+    Search,
+)
+from .update_by_query import AsyncUpdateByQuery, UpdateByQuery
+from .utils import AttrDict, AttrList, DslBase
+from .wrappers import Range
+
+__all__ = [
+    "A",
+    "Agg",
+    "AggResponse",
+    "AsyncComposableIndexTemplate",
+    "AsyncDocument",
+    "AsyncEmptySearch",
+    "AsyncFacetedSearch",
+    "AsyncIndex",
+    "AsyncIndexTemplate",
+    "AsyncMapping",
+    "AsyncMultiSearch",
+    "AsyncSearch",
+    "AsyncUpdateByQuery",
+    "AttrDict",
+    "AttrList",
+    "Binary",
+    "Boolean",
+    "Byte",
+    "Completion",
+    "ComposableIndexTemplate",
+    "ConstantKeyword",
+    "CustomField",
+    "Date",
+    "DateHistogramFacet",
+    "DateRange",
+    "DenseVector",
+    "Document",
+    "Double",
+    "DoubleRange",
+    "DslBase",
+    "ElasticsearchDslException",
+    "EmptySearch",
+    "Facet",
+    "FacetedResponse",
+    "FacetedSearch",
+    "Field",
+    "Float",
+    "FloatRange",
+    "GeoPoint",
+    "GeoShape",
+    "HalfFloat",
+    "HistogramFacet",
+    "IllegalOperation",
+    "Index",
+    "IndexTemplate",
+    "InnerDoc",
+    "Integer",
+    "IntegerRange",
+    "Ip",
+    "IpRange",
+    "Join",
+    "Keyword",
+    "Long",
+    "LongRange",
+    "M",
+    "Mapping",
+    "MetaField",
+    "MultiSearch",
+    "Murmur3",
+    "Nested",
+    "NestedFacet",
+    "Object",
+    "Percolator",
+    "Point",
+    "Q",
+    "Query",
+    "Range",
+    "RangeFacet",
+    "RangeField",
+    "RankFeature",
+    "RankFeatures",
+    "Response",
+    "SF",
+    "ScaledFloat",
+    "Search",
+    "SearchAsYouType",
+    "Shape",
+    "Short",
+    "SparseVector",
+    "TermsFacet",
+    "Text",
+    "TokenCount",
+    "UnknownDslObject",
+    "UpdateByQuery",
+    "UpdateByQueryResponse",
+    "ValidationException",
+    "analyzer",
+    "async_connections",
+    "char_filter",
+    "connections",
+    "construct_field",
+    "mapped_field",
+    "normalizer",
+    "token_filter",
+    "tokenizer",
+]

elasticsearch9/dsl/_async/__init__.py

@@ -0,0 +1,16 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.