python-arango-async 0.0.2__py3-none-any.whl → 0.0.3__py3-none-any.whl

arangoasync/aql.py

@@ -238,6 +238,11 @@ class AQL:
         """Return the name of the current database."""
         return self._executor.db_name
 
+    @property
+    def context(self) -> str:
+        """Return the current API execution context."""
+        return self._executor.context
+
     @property
     def serializer(self) -> Serializer[Json]:
         """Return the serializer."""

arangoasync/client.py

@@ -139,7 +139,9 @@ class ArangoClient:
 
     async def close(self) -> None:
         """Close HTTP sessions."""
-        await asyncio.gather(*(session.close() for session in self._sessions))
+        await asyncio.gather(
+            *(self._http_client.close_session(session) for session in self._sessions)
+        )
 
     async def db(
         self,

arangoasync/collection.py

@@ -251,6 +251,15 @@ class Collection(Generic[T, U, V]):
         """
         return self._name
 
+    @property
+    def context(self) -> str:
+        """Return the context of the collection.
+
+        Returns:
+            str: Context.
+        """
+        return self._executor.context
+
     @property
     def db_name(self) -> str:
         """Return the name of the current database.
@@ -270,9 +279,17 @@ class Collection(Generic[T, U, V]):
         """Return the deserializer."""
         return self._executor.deserializer
 
-    async def indexes(self) -> Result[List[IndexProperties]]:
+    async def indexes(
+        self,
+        with_stats: Optional[bool] = None,
+        with_hidden: Optional[bool] = None,
+    ) -> Result[List[IndexProperties]]:
         """Fetch all index descriptions for the given collection.
 
+        Args:
+            with_stats (bool | None): Whether to include figures and estimates in the result.
+            with_hidden (bool | None): Whether to include hidden indexes in the result.
+
         Returns:
             list: List of index properties.
 
@@ -282,10 +299,16 @@ class Collection(Generic[T, U, V]):
         References:
             - `list-all-indexes-of-a-collection <https://docs.arangodb.com/stable/develop/http-api/indexes/#list-all-indexes-of-a-collection>`__
         """  # noqa: E501
+        params: Params = dict(collection=self._name)
+        if with_stats is not None:
+            params["withStats"] = with_stats
+        if with_hidden is not None:
+            params["withHidden"] = with_hidden
+
         request = Request(
             method=Method.GET,
             endpoint="/_api/index",
-            params=dict(collection=self._name),
+            params=params,
         )
 
         def response_handler(resp: Response) -> List[IndexProperties]:
@@ -564,6 +587,7 @@ class StandardCollection(Collection[T, U, V]):
         Raises:
             DocumentRevisionError: If the revision is incorrect.
             DocumentGetError: If retrieval fails.
+            DocumentParseError: If the document is malformed.
 
         References:
             - `get-a-document <https://docs.arangodb.com/stable/develop/http-api/documents/#get-a-document>`__
@@ -707,6 +731,7 @@ class StandardCollection(Collection[T, U, V]):
 
         Raises:
             DocumentInsertError: If insertion fails.
+            DocumentParseError: If the document is malformed.
 
         References:
             - `create-a-document <https://docs.arangodb.com/stable/develop/http-api/documents/#create-a-document>`__

arangoasync/connection.py

@@ -177,6 +177,9 @@ class BaseConnection(ABC):
         host_index = self._host_resolver.get_host_index()
         for tries in range(self._host_resolver.max_tries):
             try:
+                logger.debug(
+                    f"Sending request to host {host_index} ({tries}): {request}"
+                )
                 resp = await self._http_client.send_request(
                     self._sessions[host_index], request
                 )

arangoasync/database.py

@@ -596,7 +596,6 @@ class Database:
         )
 
         def response_handler(resp: Response) -> StandardCollection[T, U, V]:
-            nonlocal doc_serializer, doc_deserializer
             if not resp.is_success:
                 raise CollectionCreateError(resp, request)
             if doc_serializer is None:
@@ -648,7 +647,6 @@ class Database:
         )
 
         def response_handler(resp: Response) -> bool:
-            nonlocal ignore_missing
             if resp.is_success:
                 return True
             if resp.status_code == HTTP_NOT_FOUND and ignore_missing:
@@ -1001,7 +999,6 @@ class Database:
         )
 
         def response_handler(resp: Response) -> bool:
-            nonlocal ignore_failure
             if resp.is_success:
                 return True
             if ignore_failure:
@@ -1046,7 +1043,6 @@ class Database:
         )
 
         def response_handler(resp: Response) -> bool:
-            nonlocal ignore_failure
             if resp.is_success:
                 return True
             if ignore_failure:

arangoasync/http.py

@@ -33,6 +33,8 @@ class HTTPClient(ABC):  # pragma: no cover
             class MyCustomHTTPClient(HTTPClient):
                 def create_session(self, host):
                     pass
+                async def close_session(self, session):
+                    pass
                 async def send_request(self, session, request):
                     pass
     """
@@ -52,6 +54,18 @@ class HTTPClient(ABC):  # pragma: no cover
         """
         raise NotImplementedError
 
+    @abstractmethod
+    async def close_session(self, session: Any) -> None:
+        """Close the session.
+
+        Note:
+            This method must be overridden by the user.
+
+        Args:
+            session (Any): Client session object.
+        """
+        raise NotImplementedError
+
     @abstractmethod
     async def send_request(
         self,
@@ -129,6 +143,14 @@ class AioHTTPClient(HTTPClient):
             read_bufsize=self._read_bufsize,
         )
 
+    async def close_session(self, session: ClientSession) -> None:
+        """Close the session.
+
+        Args:
+            session (Any): Client session object.
+        """
+        await session.close()
+
     async def send_request(
         self,
         session: ClientSession,

arangoasync/version.py

@@ -1 +1 @@
-__version__ = "0.0.2"
+__version__ = "0.0.3"

{python_arango_async-0.0.2.dist-info → python_arango_async-0.0.3.dist-info}/METADATA

@@ -1,45 +1,23 @@
 Metadata-Version: 2.4
 Name: python-arango-async
-Version: 0.0.2
+Version: 0.0.3
 Summary: Async Python Driver for ArangoDB
 Author-email: Alexandru Petenchea <alexandru.petenchea@arangodb.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
 Maintainer-email: Alexandru Petenchea <alexandru.petenchea@arangodb.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
-License: MIT License
-        
-        Copyright (c) 2024 ArangoDB
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
+License-Expression: MIT
 Project-URL: homepage, https://github.com/arangodb/python-arango-async
 Keywords: arangodb,python,driver,async
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Documentation :: Sphinx
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: packaging>=23.1
@@ -68,7 +46,7 @@ Dynamic: license-file
 [![Last commit](https://img.shields.io/github/last-commit/arangodb/python-arango-async)](https://github.com/arangodb/python-arango-async/commits/main)
 
 [![PyPI version badge](https://img.shields.io/pypi/v/python-arango-async?color=3775A9&style=for-the-badge&logo=pypi&logoColor=FFD43B)](https://pypi.org/project/python-arango-async/)
-[![Python versions badge](https://img.shields.io/badge/3.9%2B-3776AB?style=for-the-badge&logo=python&logoColor=FFD43B&label=Python)](https://pypi.org/project/python-arango-async/)
+[![Python versions badge](https://img.shields.io/badge/3.10%2B-3776AB?style=for-the-badge&logo=python&logoColor=FFD43B&label=Python)](https://pypi.org/project/python-arango-async/)
 
 [![License](https://img.shields.io/github/license/arangodb/python-arango?color=9E2165&style=for-the-badge)](https://github.com/arangodb/python-arango/blob/main/LICENSE)
 [![Code style: black](https://img.shields.io/static/v1?style=for-the-badge&label=code%20style&message=black&color=black)](https://github.com/psf/black)
@@ -80,7 +58,7 @@ Dynamic: license-file
 Python driver for [ArangoDB](https://www.arangodb.com), a scalable multi-model
 database natively supporting documents, graphs and search.
 
-This is the _asyncio_ alternative of the officially supported [python-arango](https://github.com/arangodb/python-arango)
+This is the _asyncio_ alternative of the [python-arango](https://github.com/arangodb/python-arango)
 driver.
 
 **Note: This project is still in active development, features might be added or removed.**
@@ -88,7 +66,7 @@ driver.
 ## Requirements
 
 - ArangoDB version 3.11+
-- Python version 3.9+
+- Python version 3.10+
 
 ## Installation
 

{python_arango_async-0.0.2.dist-info → python_arango_async-0.0.3.dist-info}/RECORD

@@ -1,16 +1,16 @@
 arangoasync/__init__.py,sha256=HEJ7_q_pRcS9Gco3poa89jLQr_zDrDrHAXCEJMgjUFI,196
-arangoasync/aql.py,sha256=LetOQO5rzoER_dyTJhbEqPScifZRtgLA4y09K5RgQIY,28897
+arangoasync/aql.py,sha256=wof_53c0qvjjo470Q7o8mJzh3mZ7b79BF3LROd5PXf0,29036
 arangoasync/auth.py,sha256=MM13-S06zBU22v1Y978URMBOBgb1O1HLIANL7HKv9cA,2989
-arangoasync/client.py,sha256=WoYcQJrppzNGf73a6OuCyfnSdMZ-hywCPUyqa2MAbOc,9871
-arangoasync/collection.py,sha256=AB7GwN2BzkhfYCPnNZOA6TqjybvEdn-zNn4WCD2reVc,67915
+arangoasync/client.py,sha256=0h98YyZCuRPtWz3S7nVOXrRJaPRsFEjoQr9px-z7S9Y,9918
+arangoasync/collection.py,sha256=zL2UqBIx5xFMyR_ySNACcfBZpoJZsrXuaJXJVtv9zSY,68722
 arangoasync/compression.py,sha256=vMhcg5nQPkbgplk48vxARUnJ6YeIwrCLC6pDCVJSwo0,3804
-arangoasync/connection.py,sha256=4JEbbeBPhlSSbhvNfwSKD9jKDrhvbLqM29UhPr5eszY,17236
+arangoasync/connection.py,sha256=Md7vOVDEJRG0kYOSsYJtJxW54sqdTfAyfZkbM-KzeBc,17365
 arangoasync/cursor.py,sha256=GUnfjIuA4nmfk5GMi3WR5MXCaqHr_eyRmGWBG6ZuqLM,8446
-arangoasync/database.py,sha256=iHIAZO4gp5TEALmuqGEk-bWQkrgaab_hAlFjzjOlpAg,58927
+arangoasync/database.py,sha256=wYfthDHzpieelm_l359mzANnSbM21W4RnPo3y7gd7P0,58765
 arangoasync/errno.py,sha256=4oKY9IyyzjOitbywhjH8S214qeNtpDlQg7JsHENJNoU,25245
 arangoasync/exceptions.py,sha256=7YFm9pqTsnLyp_AcOT-nn0tV7YesgYek9ll-Ydn2PIM,9320
 arangoasync/executor.py,sha256=eRUfWQc4eHgJr15nPnDju8oSK0408x6yB8XEGk7YhPY,4740
-arangoasync/http.py,sha256=Ang6gAwmrkbfZm32OtXylyoFvEb4o-w8aLP098jNE5I,5578
+arangoasync/http.py,sha256=xkxnLMbqFBEngmqGCuBOgRuXgQSBUk9-dzYXB1yrL98,6154
 arangoasync/job.py,sha256=Lr6BiMywq_iIJYtU8SQ3unhlAa0j1sfNngTm4LFF9ek,7441
 arangoasync/logger.py,sha256=Ui4n-ELcYM4fujpZV6myU4by82L_70S1cfG0bhEhf-Q,58
 arangoasync/request.py,sha256=3-C5bFJiihrAEo7pIQX-CSX6nF-x783G_TVLiepz13s,2845
@@ -19,9 +19,9 @@ arangoasync/response.py,sha256=xw8fHODyd8dYc2Cvvk8xhOQ4AynufRE7-qSTHunfBIw,1764
 arangoasync/result.py,sha256=NVwFxpYUDujHNRCqCZIBOlGLzB7XsiSmjWPFhUgRS6k,233
 arangoasync/serialization.py,sha256=ExRqrEpbk11Hb3AfFUJGqPlGBD3dbvwQg_xsZUsrm6I,2910
 arangoasync/typings.py,sha256=JRiHUeZg7GBendgrnw3cedFbMIOXNxx5EM-bgfSJTuU,54801
-arangoasync/version.py,sha256=QvlVh4JTl3JL7jQAja76yKtT-IvF4631ASjWY1wS6AQ,22
-python_arango_async-0.0.2.dist-info/licenses/LICENSE,sha256=6zoGhJon2tcnvzmycirNjLNBZ6rlLJtYDdVGO76RXVM,1065
-python_arango_async-0.0.2.dist-info/METADATA,sha256=cklad_innyaCHLPensB2ouevOCLoCTKIEe6aB9-mIcc,6413
-python_arango_async-0.0.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-python_arango_async-0.0.2.dist-info/top_level.txt,sha256=uabwJ6t-MiIaZQXGUvYikeSbZDcF0RK37GzikBnDz5k,12
-python_arango_async-0.0.2.dist-info/RECORD,,
+arangoasync/version.py,sha256=4GZKi13lDTD25YBkGakhZyEQZWTER_OWQMNPoH_UM2c,22
+python_arango_async-0.0.3.dist-info/licenses/LICENSE,sha256=6zoGhJon2tcnvzmycirNjLNBZ6rlLJtYDdVGO76RXVM,1065
+python_arango_async-0.0.3.dist-info/METADATA,sha256=CerksE9Dkn97BmP7T1QjqXDsxtwl7SzrbkXBCvISzEY,5126
+python_arango_async-0.0.3.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+python_arango_async-0.0.3.dist-info/top_level.txt,sha256=uabwJ6t-MiIaZQXGUvYikeSbZDcF0RK37GzikBnDz5k,12
+python_arango_async-0.0.3.dist-info/RECORD,,

{python_arango_async-0.0.2.dist-info → python_arango_async-0.0.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.4.0)
 Root-Is-Purelib: true
 Tag: py3-none-any