Update fork to v0.5.0

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - run: pip install poetry==${{ env.POETRY_VERSION }}
@@ -53,7 +53,7 @@ jobs:
             org_id: TESTING_STAGING_ORG_ID
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
       - run: pip install poetry==${{ env.POETRY_VERSION }}
@@ -72,7 +72,7 @@ jobs:
       - test-integration
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - run: pip install poetry==${{ env.POETRY_VERSION }}

README.md

@@ -1,14 +1,19 @@
-![axiom-py: The official Python bindings for the Axiom API](.github/images/banner-dark.svg#gh-dark-mode-only)
-![axiom-py: The official Python bindings for the Axiom API](.github/images/banner-light.svg#gh-light-mode-only)
-
-<div align="center">
+# axiom-py
+
+<a href="https://axiom.co">
+<picture>
+  <source media="(prefers-color-scheme: dark) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-vertical.svg">
+  <source media="(prefers-color-scheme: light) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-dark-vertical.svg">
+  <source media="(prefers-color-scheme: dark) and (max-width: 599px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-horizontal.svg">
+  <img alt="Axiom.co banner" src="https://axiom.co/assets/github/axiom-github-banner-dark-horizontal.svg" align="right">
+</picture>
+</a>
+&nbsp;
 
 [![CI][ci_badge]][ci]
 [![PyPI version][pypi_badge]][pypi]
 [![Python version][version_badge]][pypi]
 
-</div>
-
 [Axiom](https://axiom.co) unlocks observability at any scale.
 
 - **Ingest with ease, store without limits:** Axiom’s next-generation datastore enables ingesting petabytes of data with ultimate efficiency. Ship logs from Kubernetes, AWS, Azure, Google Cloud, DigitalOcean, Nomad, and others.

axiom/client.py

@@ -8,7 +8,7 @@
 from .util import Util
 from enum import Enum
 from humps import decamelize
-from typing import Optional, List, Dict, Any
+from typing import Optional, List, Dict
 from logging import getLogger
 from dataclasses import dataclass, field, asdict
 from datetime import datetime
@@ -98,11 +98,18 @@ class WrongQueryKindException(Exception):
 class AplOptions:
     """AplOptions specifies the optional parameters for the apl query method."""
 
+    # Start time for the interval to query.
     start_time: Optional[datetime] = field(default=None)
+    # End time for the interval to query.
     end_time: Optional[datetime] = field(default=None)
-    no_cache: bool = field(default=False)
-    save: bool = field(default=False)
+    # The result format.
     format: AplResultFormat = field(default=AplResultFormat.Legacy)
+    # Cursor is the query cursor. It should be set to the Cursor returned with
+    # a previous query result if it was partial.
+    cursor: Optional[str] = field(default=None)
+    # IncludeCursor will return the Cursor as part of the query result, if set
+    # to true.
+    includeCursor: bool = field(default=False)
 
 
 def raise_response_error(r):
@@ -267,7 +274,7 @@ def query(self, apl: str, opts: Optional[AplOptions] = None) -> QueryResult:
         result.savedQueryID = query_id
         return result
 
-    def _prepare_query_options(self, opts: QueryOptions) -> Dict[str, Any]:
+    def _prepare_query_options(self, opts: QueryOptions) -> Dict[str, object]:
         """returns the query options as a Dict, handles any renaming for key fields."""
         if opts is None:
             return {}
@@ -283,7 +290,9 @@ def _prepare_query_options(self, opts: QueryOptions) -> Dict[str, Any]:
 
         return params
 
-    def _prepare_ingest_options(self, opts: Optional[IngestOptions]) -> Dict[str, Any]:
+    def _prepare_ingest_options(
+        self, opts: Optional[IngestOptions]
+    ) -> Dict[str, object]:
         """the query params for ingest api are expected in a format
         that couldn't be defined as a variable name because it has a dash.
         As a work around, we create the params dict manually."""
@@ -301,34 +310,31 @@ def _prepare_ingest_options(self, opts: Optional[IngestOptions]) -> Dict[str, An
 
         return params
 
-    def _prepare_apl_options(self, opts: Optional[AplOptions]) -> Dict[str, Any]:
+    def _prepare_apl_options(self, opts: Optional[AplOptions]) -> Dict[str, object]:
         """Prepare the apl query options for the request."""
-        params = {}
-
-        if opts is None:
-            params["format"] = AplResultFormat.Legacy.value
-            return params
+        params = {"format": AplResultFormat.Legacy.value}
 
-        if opts.no_cache:
-            params["nocache"] = opts.no_cache.__str__()
-        if opts.save:
-            params["save"] = opts.save
-        if opts.format:
-            params["format"] = opts.format.value
+        if opts is not None:
+            if opts.format:
+                params["format"] = opts.format.value
 
         return params
 
     def _prepare_apl_payload(
         self, apl: str, opts: Optional[AplOptions]
-    ) -> Dict[str, Any]:
+    ) -> Dict[str, object]:
         """Prepare the apl query options for the request."""
         params = {}
         params["apl"] = apl
 
         if opts is not None:
-            if opts.start_time:
+            if opts.start_time is not None:
                 params["startTime"] = opts.start_time
-            if opts.end_time:
+            if opts.end_time is not None:
                 params["endTime"] = opts.end_time
+            if opts.cursor is not None:
+                params["cursor"] = opts.cursor
+            if opts.includeCursor:
+                params["includeCursor"] = opts.includeCursor
 
         return params

axiom/query/result.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 from datetime import datetime, timedelta
-from typing import List, Dict, Any, Optional
+from typing import List, Dict, Optional
 from enum import Enum
 
 from .query import QueryLegacy
@@ -87,7 +87,7 @@ class Entry:
     _rowId: str
     # contains the raw data of the event (with filters and aggregations
     # applied).
-    data: Dict[str, Any]
+    data: Dict[str, object]
 
 
 @dataclass
@@ -96,7 +96,7 @@ class EntryGroupAgg:
 
     # alias is the aggregations alias. If it wasn't specified at query time, it
     # is the uppercased string representation of the aggregation operation.
-    value: Any
+    value: object
     op: str = field(default="")
     # value is the result value of the aggregation.
 
@@ -108,7 +108,7 @@ class EntryGroup:
     # the unique id of the group.
     id: int
     # group maps the fieldnames to the unique values for the entry.
-    group: Dict[str, Any]
+    group: Dict[str, object]
     # aggregations of the group.
     aggregations: List[EntryGroupAgg]
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "axiom-py"
-version = "0.4.0"
+version = "0.5.0"
 description = "Axiom API Python bindings."
 authors = ["Axiom, Inc."]
 license = "MIT"
@@ -22,10 +22,10 @@ rfc3339 = "^6.2"
 iso8601 = ">=1.0.2,<3.0.0"
 
 [tool.poetry.dev-dependencies]
-black = "^23.3.0"
-pytest = "^7.3.2"
-pylint = "^2.7.2"
-responses = "^0.23.1"
+black = "^24.4.2"
+pytest = "^8.2.1"
+pylint = "^3.2.1"
+responses = "^0.25.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

tests/test_annotations.py

@@ -3,7 +3,7 @@
 import os
 
 import unittest
-from typing import List, Dict, Any, Optional
+from typing import List, Dict, Optional
 from logging import getLogger
 from requests.exceptions import HTTPError
 from datetime import timedelta

tests/test_client.py

@@ -166,8 +166,6 @@ def test_step005_apl_query(self):
         opts = AplOptions(
             start_time=startTime,
             end_time=endTime,
-            no_cache=True,
-            save=False,
             format=AplResultFormat.Legacy,
         )
         qr = self.client.query(apl, opts)

tests/test_datasets.py

@@ -3,7 +3,7 @@
 import os
 
 import unittest
-from typing import List, Dict, Any
+from typing import List, Dict
 from logging import getLogger
 from requests.exceptions import HTTPError
 from datetime import timedelta
@@ -17,7 +17,7 @@
 
 class TestDatasets(unittest.TestCase):
     dataset_name: str
-    events: List[Dict[str, Any]]
+    events: List[Dict[str, object]]
     client: Client
     events_time_format = "%d/%b/%Y:%H:%M:%S +0000"