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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.1.7
+Version: 8.2.0
 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>
@@ -133,7 +133,7 @@ cursor = db.aql.execute("FOR doc IN students RETURN doc")
 student_names = [document["name"] for document in cursor]
 ```
 
-Another example with [graphs](https://www.arangodb.com/docs/stable/graphs.html):
+Another example with [graphs](https://docs.arangodb.com/stable/graphs/):
 
 ```python
 from arango import ArangoClient

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

@@ -67,7 +67,7 @@ cursor = db.aql.execute("FOR doc IN students RETURN doc")
 student_names = [document["name"] for document in cursor]
 ```
 
-Another example with [graphs](https://www.arangodb.com/docs/stable/graphs.html):
+Another example with [graphs](https://docs.arangodb.com/stable/graphs/):
 
 ```python
 from arango import ArangoClient

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

@@ -3008,9 +3008,8 @@ class VertexCollection(Collection):
         self,
         vertex: Json,
         sync: Optional[bool] = None,
-        silent: bool = False,
         return_new: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Insert a new vertex document.
 
         :param vertex: New vertex document to insert. If it has "_key" or "_id"
@@ -3019,20 +3018,16 @@ class VertexCollection(Collection):
         :type vertex: dict
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
         :param return_new: Include body of the new document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_new: bool
-        :return: Document metadata (e.g. document key, revision), or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentInsertError: If insert fails.
         """
         vertex = self._ensure_key_from_id(vertex)
 
-        params: Params = {"silent": silent, "returnNew": return_new}
+        params: Params = {"returnNew": return_new}
         if sync is not None:
             params["waitForSync"] = sync
 
@@ -3044,11 +3039,9 @@ class VertexCollection(Collection):
             write=self.name,
         )
 
-        def response_handler(resp: Response) -> Union[bool, Json]:
+        def response_handler(resp: Response) -> Json:
             if not resp.is_success:
                 raise DocumentInsertError(resp, request)
-            if silent:
-                return True
             return format_vertex(resp.body)
 
         return self._execute(request, response_handler)
@@ -3059,10 +3052,9 @@ class VertexCollection(Collection):
         check_rev: bool = True,
         keep_none: bool = True,
         sync: Optional[bool] = None,
-        silent: bool = False,
         return_old: bool = False,
         return_new: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Update a vertex document.
 
         :param vertex: Partial or full vertex document with updated values. It
@@ -3076,18 +3068,14 @@ class VertexCollection(Collection):
         :type keep_none: bool | None
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
         :param return_old: Include body of the old document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_old: bool
         :param return_new: Include body of the new document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_new: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentUpdateError: If update fails.
         :raise arango.exceptions.DocumentRevisionError: If revisions mismatch.
         """
@@ -3096,7 +3084,6 @@ class VertexCollection(Collection):
         params: Params = {
             "keepNull": keep_none,
             "overwrite": not check_rev,
-            "silent": silent,
             "returnNew": return_new,
             "returnOld": return_old,
         }
@@ -3112,13 +3099,11 @@ class VertexCollection(Collection):
             write=self.name,
         )
 
-        def response_handler(resp: Response) -> Union[bool, Json]:
+        def response_handler(resp: Response) -> Json:
             if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             elif not resp.is_success:
                 raise DocumentUpdateError(resp, request)
-            if silent is True:
-                return True
             return format_vertex(resp.body)
 
         return self._execute(request, response_handler)
@@ -3128,10 +3113,9 @@ class VertexCollection(Collection):
         vertex: Json,
         check_rev: bool = True,
         sync: Optional[bool] = None,
-        silent: bool = False,
         return_old: bool = False,
         return_new: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Replace a vertex document.
 
         :param vertex: New vertex document to replace the old one with. It must
@@ -3142,25 +3126,20 @@ class VertexCollection(Collection):
         :type check_rev: bool
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
         :param return_old: Include body of the old document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_old: bool
         :param return_new: Include body of the new document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_new: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentReplaceError: If replace fails.
         :raise arango.exceptions.DocumentRevisionError: If revisions mismatch.
         """
         vertex_id, headers = self._prep_from_body(vertex, check_rev)
 
         params: Params = {
-            "silent": silent,
             "returnNew": return_new,
             "returnOld": return_old,
         }
@@ -3176,13 +3155,11 @@ class VertexCollection(Collection):
             write=self.name,
         )
 
-        def response_handler(resp: Response) -> Union[bool, Json]:
+        def response_handler(resp: Response) -> Json:
             if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             elif not resp.is_success:
                 raise DocumentReplaceError(resp, request)
-            if silent is True:
-                return True
             return format_vertex(resp.body)
 
         return self._execute(request, response_handler)
@@ -3326,9 +3303,8 @@ class EdgeCollection(Collection):
         self,
         edge: Json,
         sync: Optional[bool] = None,
-        silent: bool = False,
         return_new: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Insert a new edge document.
 
         :param edge: New edge document to insert. It must contain "_from" and
@@ -3338,20 +3314,16 @@ class EdgeCollection(Collection):
         :type edge: dict
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
         :param return_new: Include body of the new document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_new: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentInsertError: If insert fails.
         """
         edge = self._ensure_key_from_id(edge)
 
-        params: Params = {"silent": silent, "returnNew": return_new}
+        params: Params = {"returnNew": return_new}
         if sync is not None:
             params["waitForSync"] = sync
 
@@ -3363,11 +3335,9 @@ class EdgeCollection(Collection):
             write=self.name,
         )
 
-        def response_handler(resp: Response) -> Union[bool, Json]:
+        def response_handler(resp: Response) -> Json:
             if not resp.is_success:
                 raise DocumentInsertError(resp, request)
-            if silent:
-                return True
             return format_edge(resp.body)
 
         return self._execute(request, response_handler)
@@ -3378,10 +3348,9 @@ class EdgeCollection(Collection):
         check_rev: bool = True,
         keep_none: bool = True,
         sync: Optional[bool] = None,
-        silent: bool = False,
         return_old: bool = False,
         return_new: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Update an edge document.
 
         :param edge: Partial or full edge document with updated values. It must
@@ -3395,18 +3364,14 @@ class EdgeCollection(Collection):
         :type keep_none: bool | None
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
         :param return_old: Include body of the old document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_old: bool
         :param return_new: Include body of the new document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_new: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentUpdateError: If update fails.
         :raise arango.exceptions.DocumentRevisionError: If revisions mismatch.
         """
@@ -3415,7 +3380,6 @@ class EdgeCollection(Collection):
         params: Params = {
             "keepNull": keep_none,
             "overwrite": not check_rev,
-            "silent": silent,
             "returnNew": return_new,
             "returnOld": return_old,
         }
@@ -3431,13 +3395,11 @@ class EdgeCollection(Collection):
             write=self.name,
         )
 
-        def response_handler(resp: Response) -> Union[bool, Json]:
+        def response_handler(resp: Response) -> Json:
             if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             if not resp.is_success:
                 raise DocumentUpdateError(resp, request)
-            if silent is True:
-                return True
             return format_edge(resp.body)
 
         return self._execute(request, response_handler)
@@ -3447,10 +3409,9 @@ class EdgeCollection(Collection):
         edge: Json,
         check_rev: bool = True,
         sync: Optional[bool] = None,
-        silent: bool = False,
         return_old: bool = False,
         return_new: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Replace an edge document.
 
         :param edge: New edge document to replace the old one with. It must
@@ -3462,25 +3423,20 @@ class EdgeCollection(Collection):
         :type check_rev: bool
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
         :param return_old: Include body of the old document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_old: bool
         :param return_new: Include body of the new document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_new: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentReplaceError: If replace fails.
         :raise arango.exceptions.DocumentRevisionError: If revisions mismatch.
         """
         edge_id, headers = self._prep_from_body(edge, check_rev)
 
         params: Params = {
-            "silent": silent,
             "returnNew": return_new,
             "returnOld": return_old,
         }
@@ -3496,13 +3452,11 @@ class EdgeCollection(Collection):
             write=self.name,
         )
 
-        def response_handler(resp: Response) -> Union[bool, Json]:
+        def response_handler(resp: Response) -> Json:
             if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             if not resp.is_success:
                 raise DocumentReplaceError(resp, request)
-            if silent is True:
-                return True
             return format_edge(resp.body)
 
         return self._execute(request, response_handler)
@@ -3575,9 +3529,8 @@ class EdgeCollection(Collection):
         to_vertex: Union[str, Json],
         data: Optional[Json] = None,
         sync: Optional[bool] = None,
-        silent: bool = False,
         return_new: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Insert a new edge document linking the given vertices.
 
         :param from_vertex: "From" vertex document ID or body with "_id" field.
@@ -3590,21 +3543,17 @@ class EdgeCollection(Collection):
         :type data: dict | None
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
         :param return_new: Include body of the new document in the returned
             metadata. Ignored if parameter **silent** is set to True.
         :type return_new: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentInsertError: If insert fails.
         """
         edge = {"_from": get_doc_id(from_vertex), "_to": get_doc_id(to_vertex)}
         if data is not None:
             edge.update(self._ensure_key_from_id(data))
-        return self.insert(edge, sync=sync, silent=silent, return_new=return_new)
+        return self.insert(edge, sync=sync, return_new=return_new)
 
     def edges(
         self,

{python_arango-8.1.7 → python_arango-8.2.0}/arango/exceptions.py

@@ -543,6 +543,10 @@ class VertexCollectionDeleteError(ArangoServerError):
     """Failed to delete vertex collection."""
 
 
+class EdgeCollectionListError(ArangoServerError):
+    """Failed to retrieve edge collections."""
+
+
 class EdgeDefinitionListError(ArangoServerError):
     """Failed to retrieve edge definitions."""
 

{python_arango-8.1.7 → python_arango-8.2.0}/arango/graph.py

@@ -7,6 +7,7 @@ from arango.api import ApiGroup
 from arango.collection import EdgeCollection, VertexCollection
 from arango.connection import Connection
 from arango.exceptions import (
+    EdgeCollectionListError,
     EdgeDefinitionCreateError,
     EdgeDefinitionDeleteError,
     EdgeDefinitionListError,
@@ -136,19 +137,28 @@ class Graph(ApiGroup):
         """
         return VertexCollection(self._conn, self._executor, self._name, name)
 
-    def create_vertex_collection(self, name: str) -> Result[VertexCollection]:
+    def create_vertex_collection(
+        self,
+        name: str,
+        options: Optional[Json] = None,
+    ) -> Result[VertexCollection]:
         """Create a vertex collection in the graph.
 
         :param name: Vertex collection name.
         :type name: str
+        :param options: Additional options for creating vertex collections.
+        :type options: dict | None
         :return: Vertex collection API wrapper.
         :rtype: arango.collection.VertexCollection
         :raise arango.exceptions.VertexCollectionCreateError: If create fails.
         """
+        data: Json = {"collection": name}
+        if options is not None:
+            data["options"] = options
         request = Request(
             method="post",
             endpoint=f"/_api/gharial/{self._name}/vertex",
-            data={"collection": name},
+            data=data,
         )
 
         def response_handler(resp: Response) -> VertexCollection:
@@ -259,6 +269,7 @@ class Graph(ApiGroup):
         edge_collection: str,
         from_vertex_collections: Sequence[str],
         to_vertex_collections: Sequence[str],
+        options: Optional[Json] = None,
     ) -> Result[EdgeCollection]:
         """Create a new edge definition.
 
@@ -279,18 +290,24 @@ class Graph(ApiGroup):
         :type from_vertex_collections: [str]
         :param to_vertex_collections: Names of "to" vertex collections.
         :type to_vertex_collections: [str]
+        :param options: Additional options for creating edge definitions.
+        :type options: dict | None
         :return: Edge collection API wrapper.
         :rtype: arango.collection.EdgeCollection
         :raise arango.exceptions.EdgeDefinitionCreateError: If create fails.
         """
+        data: Json = {
+            "collection": edge_collection,
+            "from": from_vertex_collections,
+            "to": to_vertex_collections,
+        }
+        if options is not None:
+            data["options"] = options
+
         request = Request(
             method="post",
             endpoint=f"/_api/gharial/{self._name}/edge",
-            data={
-                "collection": edge_collection,
-                "from": from_vertex_collections,
-                "to": to_vertex_collections,
-            },
+            data=data,
         )
 
         def response_handler(resp: Response) -> EdgeCollection:
@@ -300,11 +317,32 @@ class Graph(ApiGroup):
 
         return self._execute(request, response_handler)
 
+    def edge_collections(self) -> Result[List[str]]:
+        """Get the names of all edge collections in the graph.
+
+        :return: Edge collections in the graph.
+        :rtype: list
+        :raise: arango.exceptions.EdgeCollectionListError: If retrieval fails.
+        """
+        request = Request(
+            method="get",
+            endpoint=f"/_api/gharial/{self._name}/edge",
+        )
+
+        def response_handler(resp: Response) -> List[str]:
+            if not resp.is_success:
+                raise EdgeCollectionListError(resp, request)
+            return list(sorted(resp.body["collections"]))
+
+        return self._execute(request, response_handler)
+
     def replace_edge_definition(
         self,
         edge_collection: str,
         from_vertex_collections: Sequence[str],
         to_vertex_collections: Sequence[str],
+        sync: Optional[bool] = None,
+        purge: bool = False,
     ) -> Result[EdgeCollection]:
         """Replace an edge definition.
 
@@ -314,18 +352,28 @@ class Graph(ApiGroup):
         :type from_vertex_collections: [str]
         :param to_vertex_collections: Names of "to" vertex collections.
         :type to_vertex_collections: [str]
+        :param sync: Block until operation is synchronized to disk.
+        :type sync: bool | None
+        :param purge: Drop the edge collection in addition to removing it from
+            the graph. The collection is only dropped if it is not used in other graphs.
+        :type purge: bool
         :return: Edge collection API wrapper.
         :rtype: arango.collection.EdgeCollection
         :raise arango.exceptions.EdgeDefinitionReplaceError: If replace fails.
         """
+        data: Json = {
+            "collection": edge_collection,
+            "from": from_vertex_collections,
+            "to": to_vertex_collections,
+            "purge": purge,
+        }
+        if sync is not None:
+            data["waitForSync"] = sync
+
         request = Request(
             method="put",
             endpoint=f"/_api/gharial/{self._name}/edge/{edge_collection}",
-            data={
-                "collection": edge_collection,
-                "from": from_vertex_collections,
-                "to": to_vertex_collections,
-            },
+            data=data,
         )
 
         def response_handler(resp: Response) -> EdgeCollection:
@@ -335,7 +383,12 @@ class Graph(ApiGroup):
 
         return self._execute(request, response_handler)
 
-    def delete_edge_definition(self, name: str, purge: bool = False) -> Result[bool]:
+    def delete_edge_definition(
+        self,
+        name: str,
+        purge: bool = False,
+        sync: Optional[bool] = None,
+    ) -> Result[bool]:
         """Delete an edge definition from the graph.
 
         :param name: Edge collection name.
@@ -344,14 +397,20 @@ class Graph(ApiGroup):
             from the graph but the edge collection is also deleted completely
             from the database.
         :type purge: bool
+        :sync: Block until operation is synchronized to disk.
+        :type sync: bool | None
         :return: True if edge definition was deleted successfully.
         :rtype: bool
         :raise arango.exceptions.EdgeDefinitionDeleteError: If delete fails.
         """
+        params: Json = {"dropCollections": purge}
+        if sync is not None:
+            params["waitForSync"] = sync
+
         request = Request(
             method="delete",
             endpoint=f"/_api/gharial/{self._name}/edge/{name}",
-            params={"dropCollections": purge},
+            params=params,
         )
 
         def response_handler(resp: Response) -> bool:
@@ -549,8 +608,7 @@ class Graph(ApiGroup):
         collection: str,
         vertex: Json,
         sync: Optional[bool] = None,
-        silent: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Insert a new vertex document.
 
         :param collection: Vertex collection name.
@@ -561,15 +619,11 @@ class Graph(ApiGroup):
         :type vertex: dict
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentInsertError: If insert fails.
         """
-        return self.vertex_collection(collection).insert(vertex, sync, silent)
+        return self.vertex_collection(collection).insert(vertex, sync)
 
     def update_vertex(
         self,
@@ -577,8 +631,7 @@ class Graph(ApiGroup):
         check_rev: bool = True,
         keep_none: bool = True,
         sync: Optional[bool] = None,
-        silent: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Update a vertex document.
 
         :param vertex: Partial or full vertex document with updated values. It
@@ -592,12 +645,8 @@ class Graph(ApiGroup):
         :type keep_none: bool
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentUpdateError: If update fails.
         :raise arango.exceptions.DocumentRevisionError: If revisions mismatch.
         """
@@ -606,7 +655,6 @@ class Graph(ApiGroup):
             check_rev=check_rev,
             keep_none=keep_none,
             sync=sync,
-            silent=silent,
         )
 
     def replace_vertex(
@@ -614,8 +662,7 @@ class Graph(ApiGroup):
         vertex: Json,
         check_rev: bool = True,
         sync: Optional[bool] = None,
-        silent: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Replace a vertex document.
 
         :param vertex: New vertex document to replace the old one with. It must
@@ -626,17 +673,15 @@ class Graph(ApiGroup):
         :type check_rev: bool
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentReplaceError: If replace fails.
         :raise arango.exceptions.DocumentRevisionError: If revisions mismatch.
         """
         return self._get_col_by_vertex(vertex).replace(
-            vertex=vertex, check_rev=check_rev, sync=sync, silent=silent
+            vertex=vertex,
+            check_rev=check_rev,
+            sync=sync,
         )
 
     def delete_vertex(
@@ -727,8 +772,7 @@ class Graph(ApiGroup):
         collection: str,
         edge: Json,
         sync: Optional[bool] = None,
-        silent: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Insert a new edge document.
 
         :param collection: Edge collection name.
@@ -740,15 +784,11 @@ class Graph(ApiGroup):
         :type edge: dict
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentInsertError: If insert fails.
         """
-        return self.edge_collection(collection).insert(edge, sync, silent)
+        return self.edge_collection(collection).insert(edge, sync)
 
     def update_edge(
         self,
@@ -756,8 +796,7 @@ class Graph(ApiGroup):
         check_rev: bool = True,
         keep_none: bool = True,
         sync: Optional[bool] = None,
-        silent: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Update an edge document.
 
         :param edge: Partial or full edge document with updated values. It must
@@ -771,12 +810,8 @@ class Graph(ApiGroup):
         :type keep_none: bool | None
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentUpdateError: If update fails.
         :raise arango.exceptions.DocumentRevisionError: If revisions mismatch.
         """
@@ -785,7 +820,6 @@ class Graph(ApiGroup):
             check_rev=check_rev,
             keep_none=keep_none,
             sync=sync,
-            silent=silent,
         )
 
     def replace_edge(
@@ -793,8 +827,7 @@ class Graph(ApiGroup):
         edge: Json,
         check_rev: bool = True,
         sync: Optional[bool] = None,
-        silent: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Replace an edge document.
 
         :param edge: New edge document to replace the old one with. It must
@@ -806,17 +839,15 @@ class Graph(ApiGroup):
         :type check_rev: bool
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentReplaceError: If replace fails.
         :raise arango.exceptions.DocumentRevisionError: If revisions mismatch.
         """
         return self._get_col_by_edge(edge).replace(
-            edge=edge, check_rev=check_rev, sync=sync, silent=silent
+            edge=edge,
+            check_rev=check_rev,
+            sync=sync,
         )
 
     def delete_edge(
@@ -865,8 +896,7 @@ class Graph(ApiGroup):
         to_vertex: Union[str, Json],
         data: Optional[Json] = None,
         sync: Optional[bool] = None,
-        silent: bool = False,
-    ) -> Result[Union[bool, Json]]:
+    ) -> Result[Json]:
         """Insert a new edge document linking the given vertices.
 
         :param collection: Edge collection name.
@@ -881,12 +911,8 @@ class Graph(ApiGroup):
         :type data: dict
         :param sync: Block until operation is synchronized to disk.
         :type sync: bool | None
-        :param silent: If set to True, no document metadata is returned. This
-            can be used to save resources.
-        :type silent: bool
-        :return: Document metadata (e.g. document key, revision) or True if
-            parameter **silent** was set to True.
-        :rtype: bool | dict
+        :return: Document metadata (e.g. document key, revision).
+        :rtype: dict
         :raise arango.exceptions.DocumentInsertError: If insert fails.
         """
         return self.edge_collection(collection).link(
@@ -894,7 +920,6 @@ class Graph(ApiGroup):
             to_vertex=to_vertex,
             data=data,
             sync=sync,
-            silent=silent,
         )
 
     def edges(

{python_arango-8.1.7 → python_arango-8.2.0}/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.7"
+    driver_version = "8.2.0"
     driver_header = "python-arango/" + driver_version + " (" + flags + ")"
     normalized_headers: Headers = {
         "charset": "utf-8",

{python_arango-8.1.7 → python_arango-8.2.0}/docs/graph.rst

@@ -83,6 +83,7 @@ Here is an example showing how edge definitions are managed:
 
     # Create an edge definition named "teach". This creates any missing
     # collections and returns an API wrapper for "teach" edge collection.
+    # At first, create a wrong teachers->teachers mapping intentionally.
     if not school.has_edge_definition('teach'):
         teach = school.create_edge_definition(
             edge_collection='teach',
@@ -93,7 +94,7 @@ Here is an example showing how edge definitions are managed:
     # List edge definitions.
     school.edge_definitions()
 
-    # Replace the edge definition.
+    # Replace with the correct edge definition.
     school.replace_edge_definition(
         edge_collection='teach',
         from_vertex_collections=['teachers'],

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.1.7
+Version: 8.2.0
 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>
@@ -133,7 +133,7 @@ cursor = db.aql.execute("FOR doc IN students RETURN doc")
 student_names = [document["name"] for document in cursor]
 ```
 
-Another example with [graphs](https://www.arangodb.com/docs/stable/graphs.html):
+Another example with [graphs](https://docs.arangodb.com/stable/graphs/):
 
 ```python
 from arango import ArangoClient