python-arango 8.1.5__tar.gz → 8.1.7__tar.gz

{python_arango-8.1.5 → python_arango-8.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: python-arango
-Version: 8.1.5
+Version: 8.1.7
 Summary: Python Driver for ArangoDB
 Author-email: Joohwan Oh <joohwan.oh@outlook.com>
 Maintainer-email: Joohwan Oh <joohwan.oh@outlook.com>, Alexandru Petenchea <alex.petenchea@gmail.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
@@ -62,6 +62,7 @@ Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: sphinx_rtd_theme; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
 Requires-Dist: types-setuptools; extra == "dev"
+Dynamic: license-file
 
 ![Logo](https://user-images.githubusercontent.com/2701938/108583516-c3576680-72ee-11eb-883f-2d9b52e74e45.png)
 
@@ -72,7 +73,7 @@ Requires-Dist: types-setuptools; extra == "dev"
 [![Last commit](https://img.shields.io/github/last-commit/arangodb/python-arango)](https://github.com/arangodb/python-arango/commits/main)
 
 [![PyPI version badge](https://img.shields.io/pypi/v/python-arango?color=3775A9&style=for-the-badge&logo=pypi&logoColor=FFD43B)](https://pypi.org/project/python-arango/)
-[![Python versions badge](https://img.shields.io/badge/3.8%2B-3776AB?style=for-the-badge&logo=python&logoColor=FFD43B&label=Python)](https://pypi.org/project/python-arango/)
+[![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/)
 
 [![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)
@@ -84,6 +85,8 @@ Requires-Dist: types-setuptools; extra == "dev"
 Python driver for [ArangoDB](https://www.arangodb.com), a scalable multi-model
 database natively supporting documents, graphs and search.
 
+If you're interested in using asyncio, please check [python-arango-async](https://github.com/arangodb/python-arango-async).
+
 ## Requirements
 
 - ArangoDB version 3.11+

{python_arango-8.1.5 → python_arango-8.1.7}/README.md

@@ -7,7 +7,7 @@
 [![Last commit](https://img.shields.io/github/last-commit/arangodb/python-arango)](https://github.com/arangodb/python-arango/commits/main)
 
 [![PyPI version badge](https://img.shields.io/pypi/v/python-arango?color=3775A9&style=for-the-badge&logo=pypi&logoColor=FFD43B)](https://pypi.org/project/python-arango/)
-[![Python versions badge](https://img.shields.io/badge/3.8%2B-3776AB?style=for-the-badge&logo=python&logoColor=FFD43B&label=Python)](https://pypi.org/project/python-arango/)
+[![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/)
 
 [![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)
@@ -19,6 +19,8 @@
 Python driver for [ArangoDB](https://www.arangodb.com), a scalable multi-model
 database natively supporting documents, graphs and search.
 
+If you're interested in using asyncio, please check [python-arango-async](https://github.com/arangodb/python-arango-async).
+
 ## Requirements
 
 - ArangoDB version 3.11+

{python_arango-8.1.5 → python_arango-8.1.7}/arango/client.py

@@ -79,10 +79,12 @@ class ArangoClient:
     :type deserializer: callable
     :param verify_override: Override TLS certificate verification. This will
        override the verify method of the underlying HTTP client.
-       None: Do not change the verification behavior of the underlying HTTP client.
-       True: Verify TLS certificate using the system CA certificates.
-       False: Do not verify TLS certificate.
-       str: Path to a custom CA bundle file or directory.
+
+           - `None`: Do not change the verification behavior of the
+             underlying HTTP client.
+           - `True`: Verify TLS certificate using the system CA certificates.
+           - `False`: Do not verify TLS certificate.
+           - `str`: Path to a custom CA bundle file or directory.
     :type verify_override: Union[bool, str, None]
     :param request_timeout: This is the default request timeout (in seconds)
        for http requests issued by the client if the parameter http_client is

{python_arango-8.1.5 → python_arango-8.1.7}/arango/collection.py

@@ -566,15 +566,31 @@ class Collection(ApiGroup):
 
         return self._execute(request, response_handler)
 
-    def truncate(self) -> Result[bool]:
+    def truncate(
+        self,
+        sync: Optional[bool] = None,
+        compact: Optional[bool] = None,
+    ) -> Result[bool]:
         """Delete all documents in the collection.
 
+        :param sync: Block until deletion operation is synchronized to disk.
+        :type sync: bool | None
+        :param compact: Whether to compact the collection after truncation.
+        :type compact: bool | None
         :return: True if collection was truncated successfully.
         :rtype: bool
         :raise arango.exceptions.CollectionTruncateError: If operation fails.
         """
+        params: Json = {}
+        if sync is not None:
+            params["waitForSync"] = sync
+        if compact is not None:
+            params["compact"] = compact
+
         request = Request(
-            method="put", endpoint=f"/_api/collection/{self.name}/truncate"
+            method="put",
+            endpoint=f"/_api/collection/{self.name}/truncate",
+            params=params,
         )
 
         def response_handler(resp: Response) -> bool:
@@ -1736,6 +1752,7 @@ class Collection(ApiGroup):
         merge: Optional[bool] = None,
         refill_index_caches: Optional[bool] = None,
         version_attribute: Optional[str] = None,
+        raise_on_document_error: bool = False,
     ) -> Result[Union[bool, List[Union[Json, ArangoServerError]]]]:
         """Insert multiple documents.
 
@@ -1745,15 +1762,8 @@ class Collection(ApiGroup):
             returned as an object in the result list. It is up to you to
             inspect the list to determine which documents were inserted
             successfully (returns document metadata) and which were not
-            (returns exception object).
-
-        .. note::
-
-            In edge/vertex collections, this method does NOT provide the
-            transactional guarantees and validations that single insert
-            operation does for graphs. If these properties are required, see
-            :func:`arango.database.StandardDatabase.begin_batch_execution`
-            for an alternative approach.
+            (returns exception object). Alternatively, you can rely on
+            setting **raise_on_document_error** to True (defaults to False).
 
         :param documents: List of new documents to insert. If they contain the
             "_key" or "_id" fields, the values are used as the keys of the new
@@ -1793,6 +1803,11 @@ class Collection(ApiGroup):
         :param version_attribute: support for simple external versioning to
             document operations.
         :type version_attribute: str
+        :param raise_on_document_error: Whether to raise if a DocumentRevisionError
+            or a DocumentInsertError is encountered on an individual document,
+            as opposed to returning the error as an object in the result list.
+            Defaults to False.
+        :type raise_on_document_error: bool
         :return: List of document metadata (e.g. document keys, revisions) and
             any exception, or True if parameter **silent** was set to True.
         :rtype: [dict | ArangoServerError] | bool
@@ -1845,7 +1860,12 @@ class Collection(ApiGroup):
                     results.append(body)
                 else:
                     sub_resp = self._conn.prep_bulk_err_response(resp, body)
-                    results.append(DocumentInsertError(sub_resp, request))
+                    error = DocumentInsertError(sub_resp, request)
+
+                    if raise_on_document_error:
+                        raise error
+
+                    results.append(error)
 
             return results
 
@@ -1876,14 +1896,6 @@ class Collection(ApiGroup):
             (returns exception object). Alternatively, you can rely on
             setting **raise_on_document_error** to True (defaults to False).
 
-        .. note::
-
-            In edge/vertex collections, this method does NOT provide the
-            transactional guarantees and validations that single update
-            operation does for graphs. If these properties are required, see
-            :func:`arango.database.StandardDatabase.begin_batch_execution`
-            for an alternative approach.
-
         :param documents: Partial or full documents with the updated values.
             They must contain the "_id" or "_key" fields.
         :type documents: [dict]
@@ -1995,14 +2007,6 @@ class Collection(ApiGroup):
     ) -> Result[int]:
         """Update matching documents.
 
-        .. note::
-
-            In edge/vertex collections, this method does NOT provide the
-            transactional guarantees and validations that single update
-            operation does for graphs. If these properties are required, see
-            :func:`arango.database.StandardDatabase.begin_batch_execution`
-            for an alternative approach.
-
         :param filters: Document filters.
         :type filters: dict
         :param body: Full or partial document body with the updates.
@@ -2085,14 +2089,6 @@ class Collection(ApiGroup):
             successfully (returns document metadata) and which were not
             (returns exception object).
 
-        .. note::
-
-            In edge/vertex collections, this method does NOT provide the
-            transactional guarantees and validations that single replace
-            operation does for graphs. If these properties are required, see
-            :func:`arango.database.StandardDatabase.begin_batch_execution`
-            for an alternative approach.
-
         :param documents: New documents to replace the old ones with. They must
             contain the "_id" or "_key" fields. Edge documents must also have
             "_from" and "_to" fields.
@@ -2187,14 +2183,6 @@ class Collection(ApiGroup):
     ) -> Result[int]:
         """Replace matching documents.
 
-        .. note::
-
-            In edge/vertex collections, this method does NOT provide the
-            transactional guarantees and validations that single replace
-            operation does for graphs. If these properties are required, see
-            :func:`arango.database.StandardDatabase.begin_batch_execution`
-            for an alternative approach.
-
         :param filters: Document filters.
         :type filters: dict
         :param body: New document body.
@@ -2252,6 +2240,7 @@ class Collection(ApiGroup):
         sync: Optional[bool] = None,
         silent: bool = False,
         refill_index_caches: Optional[bool] = None,
+        raise_on_document_error: bool = False,
     ) -> Result[Union[bool, List[Union[Json, ArangoServerError]]]]:
         """Delete multiple documents.
 
@@ -2263,14 +2252,6 @@ class Collection(ApiGroup):
             successfully (returns document metadata) and which were not
             (returns exception object).
 
-        .. note::
-
-            In edge/vertex collections, this method does NOT provide the
-            transactional guarantees and validations that single delete
-            operation does for graphs. If these properties are required, see
-            :func:`arango.database.StandardDatabase.begin_batch_execution`
-            for an alternative approach.
-
         :param documents: Document IDs, keys or bodies. Document bodies must
             contain the "_id" or "_key" fields.
         :type documents: [str | dict]
@@ -2288,6 +2269,11 @@ class Collection(ApiGroup):
             index caches if document operations affect the edge index or
             cache-enabled persistent indexes.
         :type refill_index_caches: bool | None
+        :param raise_on_document_error: Whether to raise if a DocumentRevisionError
+            or a DocumentDeleteError is encountered on an individual document,
+            as opposed to returning the error as an object in the result list.
+            Defaults to False.
+        :type raise_on_document_error: bool
         :return: List of document metadata (e.g. document keys, revisions) and
             any exceptions, or True if parameter **silent** was set to True.
         :rtype: [dict | ArangoServerError] | bool
@@ -2339,6 +2325,10 @@ class Collection(ApiGroup):
                         error = DocumentRevisionError(sub_resp, request)
                     else:
                         error = DocumentDeleteError(sub_resp, request)
+
+                    if raise_on_document_error:
+                        raise error
+
                     results.append(error)
 
             return results
@@ -2354,14 +2344,6 @@ class Collection(ApiGroup):
     ) -> Result[int]:
         """Delete matching documents.
 
-        .. note::
-
-            In edge/vertex collections, this method does NOT provide the
-            transactional guarantees and validations that single delete
-            operation does for graphs. If these properties are required, see
-            :func:`arango.database.StandardDatabase.begin_batch_execution`
-            for an alternative approach.
-
         :param filters: Document filters.
         :type filters: dict
         :param limit: Max number of documents to delete. If the limit is lower
@@ -2428,14 +2410,6 @@ class Collection(ApiGroup):
             This method is faster than :func:`arango.collection.Collection.insert_many`
             but does not return as many details.
 
-        .. note::
-
-            In edge/vertex collections, this method does NOT provide the
-            transactional guarantees and validations that single insert
-            operation does for graphs. If these properties are required, see
-            :func:`arango.database.StandardDatabase.begin_batch_execution`
-            for an alternative approach.
-
         :param documents: List of new documents to insert. If they contain the
             "_key" or "_id" fields, the values are used as the keys of the new
             documents (auto-generated otherwise). Any "_rev" field is ignored.
@@ -2757,7 +2731,6 @@ class StandardCollection(Collection):
             "returnNew": return_new,
             "returnOld": return_old,
             "ignoreRevs": not check_rev,
-            "overwrite": not check_rev,
             "silent": silent,
         }
         if sync is not None:

{python_arango-8.1.5 → python_arango-8.1.7}/arango/database.py

@@ -17,6 +17,7 @@ from arango.backup import Backup
 from arango.cluster import Cluster
 from arango.collection import StandardCollection
 from arango.connection import Connection
+from arango.errno import HTTP_NOT_FOUND
 from arango.exceptions import (
     AnalyzerCreateError,
     AnalyzerDeleteError,
@@ -1644,12 +1645,14 @@ class Database(ApiGroup):
         :return: True if graph exists, False otherwise.
         :rtype: bool
         """
-        request = Request(method="get", endpoint="/_api/gharial")
+        request = Request(method="get", endpoint=f"/_api/gharial/{name}")
 
         def response_handler(resp: Response) -> bool:
-            if not resp.is_success:
-                raise GraphListError(resp, request)
-            return any(name == graph["_key"] for graph in resp.body["graphs"])
+            if resp.is_success:
+                return True
+            if resp.status_code == HTTP_NOT_FOUND:
+                return False
+            raise GraphListError(resp, request)
 
         return self._execute(request, response_handler)
 
@@ -1699,6 +1702,7 @@ class Database(ApiGroup):
         replication_factor: Optional[int] = None,
         write_concern: Optional[int] = None,
         satellite_collections: Optional[Sequence[str]] = None,
+        sync: Optional[bool] = None,
     ) -> Result[Graph]:
         """Create a new graph.
 
@@ -1753,6 +1757,8 @@ class Database(ApiGroup):
             element must be a string and a valid collection name. The
             collection type cannot be modified later.
         :type satellite_collections: [str] | None
+        :param sync: Wait until everything is synced to disk.
+        :type sync: bool | None
         :return: Graph API wrapper.
         :rtype: arango.graph.Graph
         :raise arango.exceptions.GraphCreateError: If create fails.
@@ -1796,7 +1802,16 @@ class Database(ApiGroup):
         if satellite_collections is not None:  # pragma: no cover
             data["options"]["satellites"] = satellite_collections
 
-        request = Request(method="post", endpoint="/_api/gharial", data=data)
+        params: Params = {}
+        if sync is not None:
+            params["waitForSync"] = sync
+
+        request = Request(
+            method="post",
+            endpoint="/_api/gharial",
+            data=data,
+            params=params,
+        )
 
         def response_handler(resp: Response) -> Graph:
             if resp.is_success:

{python_arango-8.1.5 → python_arango-8.1.7}/arango/job.py

@@ -60,10 +60,10 @@ class AsyncJob(Generic[T]):
         fail.
 
         :return: Async job status. Possible values are "pending" (job is still
-            in queue), "done" (job finished or raised an error), or "cancelled"
-            (job was cancelled before completion).
+            in queue), "done" (job finished or raised an error).
         :rtype: str
-        :raise arango.exceptions.AsyncJobStatusError: If retrieval fails.
+        :raise arango.exceptions.AsyncJobStatusError: If retrieval fails or
+            job is not found.
         """
         request = Request(method="get", endpoint=f"/_api/job/{self._id}")
         resp = self._conn.send_request(request)

{python_arango-8.1.5 → python_arango-8.1.7}/arango/request.py

@@ -12,7 +12,7 @@ def normalize_headers(
     if driver_flags is not None:
         for flag in driver_flags:
             flags = flags + flag + ";"
-    driver_version = "8.1.5"
+    driver_version = "8.1.7"
     driver_header = "python-arango/" + driver_version + " (" + flags + ")"
     normalized_headers: Headers = {
         "charset": "utf-8",

{python_arango-8.1.5 → python_arango-8.1.7}/arango/utils.py

@@ -64,11 +64,11 @@ def get_doc_id(doc: Union[str, Json]) -> str:
 
 
 def is_none_or_int(obj: Any) -> bool:
-    """Check if obj is None or an integer.
+    """Check if obj is None or a positive integer.
 
     :param obj: Object to check.
     :type obj: Any
-    :return: True if object is None or an integer.
+    :return: True if object is None or a positive integer.
     :rtype: bool
     """
     return obj is None or (isinstance(obj, int) and obj >= 0)
@@ -128,11 +128,11 @@ def build_filter_conditions(filters: Json) -> str:
     return "FILTER " + " AND ".join(conditions)
 
 
-def validate_sort_parameters(sort: Sequence[Json]) -> bool:
+def validate_sort_parameters(sort: Jsons) -> bool:
     """Validate sort parameters for an AQL query.
 
     :param sort: Document sort parameters.
-    :type sort: Sequence[Json]
+    :type sort: Jsons
     :return: Validation success.
     :rtype: bool
     :raise arango.exceptions.SortValidationError: If sort parameters are invalid.

{python_arango-8.1.5 → python_arango-8.1.7}/docs/async.rst

@@ -45,8 +45,8 @@ the results can be retrieved once available via :ref:`AsyncJob` objects.
 
     # Retrieve the status of each async job.
     for job in [job1, job2, job3, job4]:
-        # Job status can be "pending", "done" or "cancelled".
-        assert job.status() in {'pending', 'done', 'cancelled'}
+        # Job status can be "pending" or "done".
+        assert job.status() in {'pending', 'done'}
 
         # Let's wait until the jobs are finished.
         while job.status() != 'done':

{python_arango-8.1.5 → python_arango-8.1.7}/docs/certificates.rst

@@ -17,8 +17,7 @@ your HTTP client as described in the :ref:`HTTPClients` section.
 
 The ``ArangoClient`` class provides an option to override the verification behavior,
 no matter what has been defined in the underlying HTTP session.
-You can use this option to disable verification or provide a custom CA bundle without
-defining a custom HTTP Client.
+You can use this option to disable verification.
 
 .. code-block:: python
 
@@ -34,3 +33,18 @@ application:
 
     import requests
     requests.packages.urllib3.disable_warnings()
+
+You can also provide a custom CA bundle without defining a custom HTTP Client:
+
+.. code-block:: python
+
+    client = ArangoClient(hosts="https://localhost:8529", verify_override="path/to/certfile")
+
+If `verify_override` is set to a path to a directory, the directory must have been processed using the `c_rehash` utility
+supplied with OpenSSL. For more information, see the `requests documentation <https://requests.readthedocs.io/en/master/user/advanced/#ssl-cert-verification>`_.
+
+Setting `verify_override` to `True` will use the system's default CA bundle.
+
+.. code-block:: python
+
+    client = ArangoClient(hosts="https://localhost:8529", verify_override=True)

{python_arango-8.1.5 → python_arango-8.1.7}/docs/index.rst

@@ -7,6 +7,8 @@ Python-Arango
 
 Welcome to the documentation for **python-arango**, a Python driver for ArangoDB_.
 
+If you're interested in using asyncio, please check python-arango-async_ driver.
+
 Requirements
 =============
 
@@ -96,3 +98,4 @@ Development
     specs
 
 .. _ArangoDB: https://www.arangodb.com
+.. _python-arango-async: https://python-arango-async.readthedocs.io

{python_arango-8.1.5 → python_arango-8.1.7}/python_arango.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: python-arango
-Version: 8.1.5
+Version: 8.1.7
 Summary: Python Driver for ArangoDB
 Author-email: Joohwan Oh <joohwan.oh@outlook.com>
 Maintainer-email: Joohwan Oh <joohwan.oh@outlook.com>, Alexandru Petenchea <alex.petenchea@gmail.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
@@ -62,6 +62,7 @@ Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: sphinx_rtd_theme; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
 Requires-Dist: types-setuptools; extra == "dev"
+Dynamic: license-file
 
 ![Logo](https://user-images.githubusercontent.com/2701938/108583516-c3576680-72ee-11eb-883f-2d9b52e74e45.png)
 
@@ -72,7 +73,7 @@ Requires-Dist: types-setuptools; extra == "dev"
 [![Last commit](https://img.shields.io/github/last-commit/arangodb/python-arango)](https://github.com/arangodb/python-arango/commits/main)
 
 [![PyPI version badge](https://img.shields.io/pypi/v/python-arango?color=3775A9&style=for-the-badge&logo=pypi&logoColor=FFD43B)](https://pypi.org/project/python-arango/)
-[![Python versions badge](https://img.shields.io/badge/3.8%2B-3776AB?style=for-the-badge&logo=python&logoColor=FFD43B&label=Python)](https://pypi.org/project/python-arango/)
+[![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/)
 
 [![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)
@@ -84,6 +85,8 @@ Requires-Dist: types-setuptools; extra == "dev"
 Python driver for [ArangoDB](https://www.arangodb.com), a scalable multi-model
 database natively supporting documents, graphs and search.
 
+If you're interested in using asyncio, please check [python-arango-async](https://github.com/arangodb/python-arango-async).
+
 ## Requirements
 
 - ArangoDB version 3.11+