python-arango 8.3.3__tar.gz → 8.3.4__tar.gz

python_arango-8.3.4/.circleci/config.yml

@@ -0,0 +1,200 @@
+version: 2.1
+
+executors:
+  python-container:
+    parameters:
+      python_version:
+        type: string
+        default: "3.14"
+    docker:
+      - image: cimg/python:<< parameters.python_version >>
+    resource_class: arangodb/small-amd64
+  arangodb-container:
+    parameters:
+      arangodb_image:
+        type: string
+    docker:
+      - image: << parameters.arangodb_image >>
+        entrypoint: /bin/sh
+        command: -c "while true; do sleep 10; done"
+        user: root
+    resource_class: arangodb/medium-amd64
+
+workflows:
+  ci:
+    jobs:
+      - lint
+      - import-test:
+          name: Imports (Python << matrix.python_version >>)
+          matrix:
+            parameters:
+              python_version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+      - integration-test:
+          name: ArangoDB (enterprise, 3.12 << matrix.arangodb_config >>)
+          matrix:
+            parameters:
+              arangodb_config: ["single", "cluster"]
+              arangodb_image: ["arangodb/enterprise:3.12"]
+              arangodb_conf_version: ["3.12"]
+      - integration-test:
+          name: ArangoDB (enterprise-preview, 4.0-nightly << matrix.arangodb_config >>)
+          matrix:
+            parameters:
+              arangodb_config: ["single", "cluster"]
+              arangodb_image: ["arangodb/enterprise-preview:4.0-nightly"]
+              arangodb_conf_version: ["4.0"]
+
+jobs:
+  lint:
+    executor: python-container
+    steps:
+      - checkout
+      - run:
+          name: Install Dependencies
+          command: python -m pip install .[dev]
+      - run:
+          name: Run black
+          command: black --check --verbose --diff --color --config=pyproject.toml ./arango ./tests/
+      - run:
+          name: Run flake8
+          command: flake8 ./arango ./tests
+      - run:
+          name: Run isort
+          command: isort --check ./arango ./tests
+      - run:
+          name: Run mypy
+          command: mypy ./arango
+  import-test:
+    parameters:
+      python_version:
+        type: string
+    executor:
+      name: python-container
+      python_version: << parameters.python_version >>
+    steps:
+      - checkout
+      - run:
+          name: Install Dependencies
+          command: |
+            python --version
+            python -m pip install .[dev]
+      - run:
+          name: Run Import Tests
+          command: python -m pytest tests/test_imports.py --skip-arango-setup --color=yes --code-highlight=yes
+  integration-test:
+    parameters:
+      arangodb_config:
+        type: string
+      arangodb_image:
+        type: string
+      arangodb_conf_version:
+        type: string
+    executor:
+      name: arangodb-container
+      arangodb_image: << parameters.arangodb_image >>
+    steps:
+      - run:
+          name: Bootstrap CI Tools
+          command: |
+            apk add --no-cache \
+              bash \
+              build-base \
+              ca-certificates \
+              curl \
+              git \
+              jq \
+              openssh-client \
+              openssl-dev \
+              py3-pip \
+              py3-virtualenv \
+              python3 \
+              python3-dev
+      - checkout
+      - run:
+          name: Setup ArangoDB
+          command: |
+            mkdir -p /tests
+            if [ ! -e /tests/static ]; then
+              ln -s "$PWD/tests/static" /tests/static
+            fi
+
+            conf_file="/tests/static/<< parameters.arangodb_config >>-<< parameters.arangodb_conf_version >>.conf"
+            if [ ! -f "$conf_file" ]; then
+              echo "Missing configuration file: $conf_file"
+              exit 1
+            fi
+
+            arangodb --configuration="$conf_file" > arangodb.log 2>&1 &
+            echo "$!" > arangodb.pid
+
+            ports="8529"
+            if [ << parameters.arangodb_config >> = "cluster" ]; then
+              ports="$ports 8539 8549"
+            fi
+
+            for port in $ports; do
+              echo "Waiting for ArangoDB at http://localhost:$port/_api/version"
+              for attempt in $(seq 1 120); do
+                if curl --fail --silent --show-error \
+                    --user root:passwd \
+                    "http://localhost:$port/_api/version" | jq; then
+                  break
+                fi
+
+                if ! kill -0 "$(cat arangodb.pid)" 2>/dev/null; then
+                  echo "ArangoDB process exited before port $port became ready"
+                  exit 1
+                fi
+
+                if [ "$attempt" -eq 120 ]; then
+                  echo "Timed out waiting for ArangoDB on port $port"
+                  exit 1
+                fi
+
+                sleep 1
+              done
+            done
+      - run:
+          name: Show ArangoDB Logs
+          command: tail -n 1000 arangodb.log
+          when: always
+      - run:
+          name: Setup Python
+          shell: /bin/bash -eo pipefail
+          command: |
+            python3 --version
+            python3 -m virtualenv .venv
+            source .venv/bin/activate
+            python --version
+            python -m pip --version
+      - run:
+          name: Install Dependencies
+          shell: /bin/bash -eo pipefail
+          command: |
+            source .venv/bin/activate
+            python -m pip install -e .[dev]
+      - run:
+          name: Run pytest
+          shell: /bin/bash -eo pipefail
+          command: |
+            mkdir test-results
+            mkdir htmlcov
+
+            source .venv/bin/activate
+
+            args=("--junitxml=test-results/junit.xml" "--log-cli-level=DEBUG" "--host" "localhost" "--port=8529")
+            if [ << parameters.arangodb_config >> = "cluster" ]; then
+              args+=("--cluster" "--port=8539" "--port=8549")
+            fi
+
+            echo "Running pytest with args: ${args[@]}"
+            pytest tests --cov=arango --cov-report=html:htmlcov --color=yes --code-highlight=yes "${args[@]}"
+      - store_artifacts:
+          path: htmlcov
+          destination: coverage-report
+      - store_artifacts:
+          path: test-results
+      - store_artifacts:
+          path: arangodb.log
+      - store_test_results:
+          path: test-results

{python_arango-8.3.3 → python_arango-8.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.3.3
+Version: 8.3.4
 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>

{python_arango-8.3.3 → python_arango-8.3.4}/arango/collection.py

@@ -816,14 +816,20 @@ class Collection(ApiGroup):
 
         skip_val = skip if skip is not None else 0
         limit_val = limit if limit is not None else "null"
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
+        sort_expression, sort_bind_vars = build_sort_expression(sort)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 LIMIT {skip_val}, {limit_val}
-                {build_sort_expression(sort)}
+                {sort_expression}
                 RETURN doc
         """
-        bind_vars = {"@collection": self.name}
+        bind_vars = {
+            "@collection": self.name,
+            **filter_bind_vars,
+            **sort_bind_vars,
+        }
 
         request = Request(
             method="post",
@@ -1920,9 +1926,10 @@ class Collection(ApiGroup):
         # then the collection’s default waitForSync behavior is applied.
         sync_val = f", waitForSync: {sync}" if sync is not None else ""
 
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 {f"LIMIT {limit}" if limit is not None else ""}
                 UPDATE doc WITH @body IN @@collection
                 OPTIONS {{ keepNull: @keep_none, mergeObjects: @merge {sync_val} }}
@@ -1933,6 +1940,7 @@ class Collection(ApiGroup):
             "body": body,
             "keep_none": keep_none,
             "merge": merge,
+            **filter_bind_vars,
         }
 
         request = Request(
@@ -2089,15 +2097,20 @@ class Collection(ApiGroup):
         # then the collection’s default waitForSync behavior is applied.
         sync_val = f"waitForSync: {sync}" if sync is not None else ""
 
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 {f"LIMIT {limit}" if limit is not None else ""}
                 REPLACE doc WITH @body IN @@collection
                 {f"OPTIONS {{ {sync_val} }}" if sync_val else ""}
         """  # noqa: E201 E202
 
-        bind_vars = {"@collection": self.name, "body": body}
+        bind_vars = {
+            "@collection": self.name,
+            "body": body,
+            **filter_bind_vars,
+        }
 
         request = Request(
             method="post",
@@ -2248,15 +2261,16 @@ class Collection(ApiGroup):
         # then the collection’s default waitForSync behavior is applied.
         sync_val = f"waitForSync: {sync}" if sync is not None else ""
 
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 {f"LIMIT {limit}" if limit is not None else ""}
                 REMOVE doc IN @@collection
                 {f"OPTIONS {{ {sync_val} }}" if sync_val else ""}
         """  # noqa: E201 E202
 
-        bind_vars = {"@collection": self.name}
+        bind_vars = {"@collection": self.name, **filter_bind_vars}
 
         request = Request(
             method="post",

{python_arango-8.3.3 → python_arango-8.3.4}/arango/database.py

@@ -1128,6 +1128,20 @@ class Database(ApiGroup):
 
         return self._execute(request, response_handler)
 
+    def request(self, request: Request) -> Result[Response]:
+        """Execute a custom request.
+
+        :param request: Request object to be executed.
+        :type request: Request
+        :return: Response object containing the result of the request.
+        :rtype: Response
+        """
+
+        def response_handler(resp: Response) -> Response:
+            return resp
+
+        return self._executor.execute(request, response_handler)
+
     def metrics(self) -> Result[str]:
         """Return server metrics in Prometheus format.
 

{python_arango-8.3.3 → python_arango-8.3.4}/arango/replication.py

@@ -18,7 +18,6 @@ from arango.exceptions import (
     ReplicationInventoryError,
     ReplicationLoggerFirstTickError,
     ReplicationLoggerStateError,
-    ReplicationMakeSlaveError,
     ReplicationServerIDError,
     ReplicationSyncError,
 )
@@ -209,7 +208,9 @@ class Replication(ApiGroup):
         restrict_collections: Optional[Sequence[str]] = None,
         initial_sync_wait_time: Optional[int] = None,
     ) -> Result[Json]:  # pragma: no cover
-        """Synchronize data from a remote endpoint.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Synchronize data from a remote endpoint.
 
         :param endpoint: Master endpoint (e.g. "tcp://192.168.173.13:8529").
         :type endpoint: str
@@ -247,6 +248,9 @@ class Replication(ApiGroup):
         :rtype: dict
         :raise arango.exceptions.ReplicationSyncError: If sync fails.
         """
+        m = "/_api/replication/sync was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         data: Json = {"endpoint": endpoint}
 
         if database is not None:
@@ -320,13 +324,18 @@ class Replication(ApiGroup):
         return self._execute(request, response_handler)
 
     def logger_first_tick(self) -> Result[str]:
-        """Return the first available tick value from the server.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Return the first available tick value from the server.
 
         :return: First tick value.
         :rtype: str
         :raise arango.exceptions.ReplicationLoggerFirstTickError: If retrieval fails.
         """
-        m = "/_api/replication/logger-first-tick endpoint is removed in ArangoDB v4.0"
+        m = (
+            "/_api/replication/logger-first-tick endpoint is removed in "
+            "ArangoDB v3.12.10."
+        )
         warn(m, DeprecationWarning, stacklevel=2)
 
         request = Request(
@@ -342,12 +351,17 @@ class Replication(ApiGroup):
         return self._execute(request, response_handler)
 
     def applier_config(self) -> Result[Json]:
-        """Return the configuration of the replication applier.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Return the configuration of the replication applier.
 
         :return: Configuration of the replication applier.
         :rtype: dict
         :raise arango.exceptions.ReplicationApplierConfigError: If retrieval fails.
         """
+        m = "/_api/replication/applier-config was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="get",
             endpoint="/_api/replication/applier-config",
@@ -384,7 +398,9 @@ class Replication(ApiGroup):
         restrict_type: Optional[str] = None,
         restrict_collections: Optional[Sequence[str]] = None,
     ) -> Result[Json]:
-        """Set configuration values of the replication applier.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Set configuration values of the replication applier.
 
         :param endpoint: Server endpoint (e.g. "tcp://192.168.173.13:8529").
         :type endpoint: str
@@ -477,6 +493,9 @@ class Replication(ApiGroup):
         :rtype: dict
         :raise arango.exceptions.ReplicationApplierConfigSetError: If update fails.
         """
+        m = "/_api/replication/applier-config was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         data: Json = {"endpoint": endpoint}
 
         if database is not None:
@@ -532,12 +551,17 @@ class Replication(ApiGroup):
         return self._execute(request, response_handler)
 
     def applier_state(self) -> Result[Json]:
-        """Return the state of the replication applier
+        """**Removed** in ArangoDB v3.12.10.
+
+        Return the state of the replication applier
 
         :return: Applier state and details.
         :rtype: dict
         :raise arango.exceptions.ReplicationApplierStateError: If retrieval fails.
         """
+        m = "/_api/replication/applier-state was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="get",
             endpoint="/_api/replication/applier-state",
@@ -551,7 +575,9 @@ class Replication(ApiGroup):
         return self._execute(request, response_handler)
 
     def start_applier(self, last_tick: Optional[str] = None) -> Result[Json]:
-        """Start the replication applier.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Start the replication applier.
 
         :param last_tick: The remote last log tick value from which to start
             applying replication. If not specified, the last saved tick from
@@ -563,6 +589,9 @@ class Replication(ApiGroup):
         :rtype: dict
         :raise arango.exceptions.ReplicationApplierStartError: If operation fails.
         """
+        m = "/_api/replication/applier-start was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="put",
             endpoint="/_api/replication/applier-start",
@@ -577,12 +606,15 @@ class Replication(ApiGroup):
         return self._execute(request, response_handler)
 
     def stop_applier(self) -> Result[Json]:
-        """Stop the replication applier.
+        """**Removed** in ArangoDB v3.12.10.
 
         :return: Applier state and details.
         :rtype: dict
         :raise arango.exceptions.ReplicationApplierStopError: If operation fails.
         """
+        m = "/_api/replication/applier-stop was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="put",
             endpoint="/_api/replication/applier-stop",
@@ -595,178 +627,18 @@ class Replication(ApiGroup):
 
         return self._execute(request, response_handler)
 
-    def make_slave(
-        self,
-        endpoint: str,
-        database: Optional[str] = None,
-        username: Optional[str] = None,
-        password: Optional[str] = None,
-        restrict_type: Optional[str] = None,
-        restrict_collections: Optional[Sequence[str]] = None,
-        include_system: Optional[bool] = None,
-        max_connect_retries: Optional[int] = None,
-        connect_timeout: Optional[int] = None,
-        request_timeout: Optional[int] = None,
-        chunk_size: Optional[int] = None,
-        adaptive_polling: Optional[bool] = None,
-        auto_resync: Optional[bool] = None,
-        auto_resync_retries: Optional[int] = None,
-        initial_sync_max_wait_time: Optional[int] = None,
-        connection_retry_wait_time: Optional[int] = None,
-        idle_min_wait_time: Optional[int] = None,
-        idle_max_wait_time: Optional[int] = None,
-        require_from_present: Optional[bool] = None,
-        verbose: Optional[bool] = None,
-    ) -> Result[Json]:  # pragma: no cover
-        """Change the server role to slave.
-
-        :param endpoint: Master endpoint (e.g. "tcp://192.168.173.13:8529").
-        :type endpoint: str
-        :param database: Database name.
-        :type database: str | None
-        :param username: Username.
-        :type username: str | None
-        :param password: Password.
-        :type password: str | None
-        :param restrict_type: Optional string value for collection filtering.
-            Allowed values are "include" or "exclude".
-        :type restrict_type: str | None
-        :param restrict_collections: Optional list of collections for use with
-            argument **restrict_type**. If **restrict_type** set to "include",
-            only the specified collections are included. Otherwise, only the
-            specified collections are excluded.
-        :type restrict_collections: [str] | None
-        :param include_system: Whether system collection operations are
-            applied.
-        :type include_system: bool | None
-        :param max_connect_retries: Maximum number of connection attempts the
-            applier makes in a row before stopping itself.
-        :type max_connect_retries: int | None
-        :param connect_timeout: Timeout in seconds when attempting to connect
-            to the endpoint. This value is used for each connection attempt.
-        :type connect_timeout: int | None
-        :param request_timeout: Timeout in seconds for individual requests to
-            the endpoint.
-        :type request_timeout: int | None
-        :param chunk_size: Requested maximum size in bytes for log transfer
-            packets when the endpoint is contacted.
-        :type chunk_size: int | None
-        :param adaptive_polling: If set to True, replication applier sleeps
-            for an increasingly long period in case the logger server at the
-            endpoint has no replication events to apply. Using adaptive polling
-            reduces the amount of work done by both the applier and the logger
-            server when there are infrequent changes. The downside is that it
-            might take longer for the replication applier to detect new events.
-        :type adaptive_polling: bool | None
-        :param auto_resync: Whether the slave should perform a full automatic
-            resynchronization with the master in case the master cannot serve
-            log data requested by the slave, or when the replication is started
-            and no tick value can be found.
-        :type auto_resync: bool | None
-        :param auto_resync_retries: Max number of resynchronization retries.
-            Setting this to 0 disables it.
-        :type auto_resync_retries: int | None
-        :param initial_sync_max_wait_time: Max wait time in seconds the initial
-            synchronization waits for master on collection data. This value
-            is relevant even for continuous replication when **auto_resync** is
-            set to True because this may restart the initial synchronization
-            when master cannot provide log data slave requires. This value is
-            ignored if set to 0.
-        :type initial_sync_max_wait_time: int | None
-        :param connection_retry_wait_time: Time in seconds the applier idles
-            before trying to connect to master in case of connection problems.
-            This value is ignored if set to 0.
-        :type connection_retry_wait_time: int | None
-        :param idle_min_wait_time: Minimum wait time in seconds the applier
-            idles before fetching more log data from the master in case the
-            master has already sent all its log data. This wait time can be
-            used to control the frequency with which the replication applier
-            sends HTTP log fetch requests to the master in case there is no
-            write activity on the master. This value is ignored if set to 0.
-        :type idle_min_wait_time: int | None
-        :param idle_max_wait_time: Maximum wait time in seconds the applier
-            idles before fetching more log data from the master in case the
-            master has already sent all its log data. This wait time can be
-            used to control the maximum frequency with which the replication
-            applier sends HTTP log fetch requests to the master in case there
-            is no write activity on the master. Applies only when argument
-            **adaptive_polling** is set to True. This value is ignored if set
-            to 0.
-        :type idle_max_wait_time: int | None
-        :param require_from_present: If set to True, replication applier checks
-            at start whether the start tick from which it starts or resumes
-            replication is still present on the master. If not, then there
-            would be data loss. If set to True, the replication applier aborts
-            with an appropriate error message. If set to False, the applier
-            still starts and ignores the data loss.
-        :type require_from_present: bool | None
-        :param verbose: If set to True, a log line is emitted for all
-            operations performed by the replication applier. This should be
-            used for debugging replication problems only.
-        :type verbose: bool | None
-        :return: Replication details.
-        :rtype: dict
-        :raise arango.exceptions.ReplicationApplierStopError: If operation fails.
-        """
-        data: Json = {"endpoint": endpoint}
-
-        if database is not None:
-            data["database"] = database
-        if username is not None:
-            data["username"] = username
-        if password is not None:
-            data["password"] = password
-        if restrict_type is not None:
-            data["restrictType"] = restrict_type
-        if restrict_collections is not None:
-            data["restrictCollections"] = restrict_collections
-        if include_system is not None:
-            data["includeSystem"] = include_system
-        if max_connect_retries is not None:
-            data["maxConnectRetries"] = max_connect_retries
-        if connect_timeout is not None:
-            data["connectTimeout"] = connect_timeout
-        if request_timeout is not None:
-            data["requestTimeout"] = request_timeout
-        if chunk_size is not None:
-            data["chunkSize"] = chunk_size
-        if adaptive_polling is not None:
-            data["adaptivePolling"] = adaptive_polling
-        if auto_resync is not None:
-            data["autoResync"] = auto_resync
-        if auto_resync_retries is not None:
-            data["autoResyncRetries"] = auto_resync_retries
-        if initial_sync_max_wait_time is not None:
-            data["initialSyncMaxWaitTime"] = initial_sync_max_wait_time
-        if connection_retry_wait_time is not None:
-            data["connectionRetryWaitTime"] = connection_retry_wait_time
-        if idle_min_wait_time is not None:
-            data["idleMinWaitTime"] = idle_min_wait_time
-        if idle_max_wait_time is not None:
-            data["idleMaxWaitTime"] = idle_max_wait_time
-        if require_from_present is not None:
-            data["requireFromPresent"] = require_from_present
-        if verbose is not None:
-            data["verbose"] = verbose
-
-        request = Request(
-            method="put", endpoint="/_api/replication/make-slave", data=data
-        )
-
-        def response_handler(resp: Response) -> Json:
-            if resp.is_success:
-                return format_replication_applier_state(resp.body)
-            raise ReplicationMakeSlaveError(resp, request)
-
-        return self._execute(request, response_handler)
-
     def server_id(self) -> Result[str]:
-        """Return this server's ID.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Return this server's ID.
 
         :return: Server ID.
         :rtype: str
         :raise arango.exceptions.ReplicationServerIDError: If retrieval fails.
         """
+        m = "/_api/replication/server-id was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="get",
             endpoint="/_api/replication/server-id",