pyopensky 2.16__tar.gz → 2.17__tar.gz

pyopensky-2.17/.gitattributes

@@ -0,0 +1,4 @@
+# Ensure consistent line endings across platforms
+# uv.lock must hash identically on Linux, macOS and Windows so that
+# the GitHub Actions cache key is the same on all runners.
+uv.lock text eol=lf

{pyopensky-2.16 → pyopensky-2.17}/.github/workflows/build-docs.yml

@@ -15,7 +15,7 @@ jobs:
       UV_CACHE_DIR: /tmp/.uv-cache
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
 
@@ -23,13 +23,13 @@ jobs:
         run: curl -LsSf https://astral.sh/uv/install.sh | sh
 
       - name: Set up Python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7.0.0
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
 
       - name: Cache folder for uv
-        uses: actions/cache@v5
+        uses: actions/cache@v6
         with:
           path: /tmp/.uv-cache
           key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}

{pyopensky-2.16 → pyopensky-2.17}/.github/workflows/pypi_publish.yml

@@ -9,16 +9,16 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
 
       - name: Set up uv
         run: curl -LsSf https://astral.sh/uv/install.sh | sh
 
       - name: Set up Python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7.0.0
 
       - name: Cache folder for uv
-        uses: actions/cache@v5
+        uses: actions/cache@v6
         with:
           path: /tmp/.uv-cache
           key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}

pyopensky-2.17/.github/workflows/run_tests.yml

@@ -0,0 +1,123 @@
+name: tests
+
+on:
+  push:
+  pull_request_target:
+  schedule: # keep the cache warm
+    - cron: "42 3 * * 0" # every Sunday morning
+  workflow_dispatch:
+
+jobs:
+  lint:
+    name: lint and format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: astral-sh/setup-uv@v10.1.0
+        with:
+          enable-cache: true
+
+      - run: uv sync --dev --extra rs1090 --extra cartes
+      - run: uv run ruff check
+      - run: uv run ruff format --check
+      - run: uv cache prune --ci
+
+  typing:
+    name: type checking
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: astral-sh/setup-uv@v10.1.0
+        with:
+          enable-cache: true
+
+      - run: uv sync --dev --extra rs1090 --extra cartes
+      - run: uv run ty check src tests
+      - run: uv cache prune --ci
+
+  fill_cache:
+    name: fill trino cache
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v10.1.0
+        with:
+          enable-cache: true
+
+      - uses: actions/cache@v6
+        id: cache
+        with:
+          path: cache_opensky
+          enableCrossOsArchive: true
+          key: opensky-${{ hashFiles('uv.lock') }}
+
+      - run: uv sync --dev --extra rs1090 --extra cartes
+
+      - name: Fill cache with Trino queries
+        if: steps.cache.outputs.cache-hit != 'true'
+        env:
+          OPENSKY_USERNAME: ${{ secrets.OPENSKY_USERNAME }}
+          OPENSKY_PASSWORD: ${{ secrets.OPENSKY_PASSWORD }}
+          OPENSKY_CACHE: ${{ github.workspace }}/cache_opensky
+        run: uv run pytest tests/test_trino.py tests/test_rebuild.py
+
+      - run: uv cache prune --ci
+
+  tests:
+    name: python-${{ matrix.python-version }} on ${{ matrix.os }}
+    needs: fill_cache
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+          # `trino` (v0.336.0) depends on `orjson` (v3.11.5)
+          # which does not support Python 3.14t
+          # https://github.com/ijl/orjson/issues/591#issuecomment-3160351169
+          # - "3.14t"
+        exclude:
+          # greenlet v3.2.4 is not available for Python 3.14t on Windows
+          # and fails to compile there. Not much we can do about that right now.
+          - os: windows-latest
+            python-version: "3.14t"
+        include:
+          - os: ubuntu-latest
+            python-version: "3.13"
+            rest: true
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v10.1.0
+        with:
+          enable-cache: true
+
+      - uses: actions/cache@v6
+        with:
+          path: cache_opensky
+          enableCrossOsArchive: true
+          key: opensky-${{ hashFiles('uv.lock') }}
+
+      - run: uv sync --dev --python ${{ matrix.python-version }} --extra rs1090 --extra cartes
+
+      - name: Run tests
+        env:
+          OPENSKY_CACHE: ${{ github.workspace }}/cache_opensky
+        run: uv run pytest ${{ ! matrix.rest && '--ignore=tests/test_rest.py' || '' }}
+
+      - run: uv cache prune --ci

{pyopensky-2.16 → pyopensky-2.17}/PKG-INFO

@@ -1,11 +1,11 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: pyopensky
-Version: 2.16
+Version: 2.17
 Summary: A Python interface for OpenSky database
 Project-URL: Repository, https://github.com/open-aviation/pyopensky/
 Author-email: Xavier Olive <git@xoolive.org>, Junzi Sun <j.sun-1@tudelft.nl>
 License-Expression: MIT
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Requires-Dist: appdirs>=1.4.4
 Requires-Dist: httpx>=0.27.2
 Requires-Dist: minio>=7.2.8
@@ -14,6 +14,7 @@ Requires-Dist: pandas>=2.2.2
 Requires-Dist: pyarrow>=17.0.0
 Requires-Dist: pyjwt>=2.9.0
 Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: stamina>=25.1.0
 Requires-Dist: tqdm>=4.66.5
 Requires-Dist: trino[sqlalchemy]>=0.329.0
 Requires-Dist: typing-extensions>=4.12.2

{pyopensky-2.16 → pyopensky-2.17}/agents.md

@@ -7,7 +7,7 @@
 ## Coding style
 
 - Run `uv run ruff check` and `uv run ruff format` to check and format code
-- Run `uvx ty check src/ tests/` to check types
+- Run `uv run ty check src/ tests/` to check types
 
 ## Documentation commands
 

{pyopensky-2.16 → pyopensky-2.17}/docs/source/credentials.rst

@@ -5,9 +5,9 @@ Apply for access
 ----------------
 
 Access to the Trino database will be granted provided you meet the `conditions
-defined by The OpenSky Network <https://opensky-network.org/about/faq#q5>`_. Please create an account on
-https://trino.opensky-network.org, and then apply at https://opensky-network.org/data/apply
-with your Trino username to request for activation.
+defined by The OpenSky Network <https://opensky-network.org/about/faq>`_. Please create an account on
+https://trino.opensky-network.org, and then apply at https://opensky-network.org/my-opensky/request-data
+to request activation.
 
 Configuration
 -------------

{pyopensky-2.16 → pyopensky-2.17}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "pyopensky"
-version = "2.16"
+version = "2.17"
 description = "A Python interface for OpenSky database"
 authors = [{ name = "Xavier Olive", email = "git@xoolive.org" }, { name = "Junzi Sun", email = "j.sun-1@tudelft.nl" }]
 license = "MIT"
 readme = "readme.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 dependencies = [
   "appdirs >= 1.4.4",
   "httpx >= 0.27.2",
@@ -15,6 +15,7 @@ dependencies = [
   "pyarrow >= 17.0.0",
   "pyjwt >= 2.9.0",
   "python-dotenv>=1.0.1",
+  "stamina>=25.1.0",
   "tqdm >= 4.66.5",
   "trino[sqlalchemy] >= 0.329.0",
   "typing-extensions >= 4.12.2",
@@ -35,8 +36,6 @@ build-backend = "hatchling.build"
 
 [dependency-groups]
 dev = [
-  "pre-commit >= 3.8.0",
-  "mypy >= 1.11.2",
   "ruff >= 0.6.3",
   "pytest >= 8.3.2",
   "ipykernel >= 7.1.0; python_version>='3.10'",
@@ -44,6 +43,7 @@ dev = [
   "sphinx-design >= 0.6.1; python_version>'3.11'",
   "sphinx-rtd-theme >= 2.0.0; python_version>'3.11'",
   "sphinx-autodoc-typehints >= 2.3.0; python_version>'3.11'",
+  "ty>=0.0.17",
 ]
 
 [tool.ruff]
@@ -58,21 +58,21 @@ lint.select = [
   "RUF",
 ]
 line-length = 80
-target-version = "py39"
+target-version = "py310"
 
 [tool.ruff.lint.isort]
 known-first-party = ["numpy", "pandas"]
 
-[tool.mypy]
-python_version = "3.9"
-platform = "posix"
-color_output = true
-pretty = true
-show_column_numbers = true
-strict = true
-check_untyped_defs = true
-ignore_missing_imports = true
-warn_no_return = true
-warn_redundant_casts = true
-warn_unused_configs = true
-warn_unused_ignores = true
+[tool.ty.src]
+exclude = ["src/pyopensky/decoders/pymodes.py"]
+
+[[tool.ty.overrides]]
+# SQLAlchemy models expose their columns dynamically. Ty cannot verify these
+# attributes for the heterogeneous raw-message table union.
+include = ["src/pyopensky/rest.py", "src/pyopensky/trino.py"]
+rules = { "unresolved-attribute" = "ignore" }
+
+[tool.pytest.ini_options]
+log_cli = true
+log_cli_level = "DEBUG"
+log_cli_format = "%(levelname)s %(name)s:%(filename)s:%(lineno)d %(message)s"

pyopensky-2.17/src/pyopensky/api.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from typing import Any, Callable, Iterable, TypeVar
+
+from typing_extensions import Protocol
+
+import pandas as pd
+
+from .time import timelike
+
+T = TypeVar("T")
+ProgressbarType = Callable[[Iterable[T]], Iterable[T]]
+
+
+class HasBounds(Protocol):
+    @property
+    def bounds(self) -> tuple[float, float, float, float]: ...
+
+
+class OpenSkyDBAPI(Protocol):
+    def flightlist(
+        self,
+        start: timelike,
+        stop: timelike | None = None,
+        *args: Any,  # more reasonable to be explicit about arguments
+        departure_airport: str | list[str] | None = None,
+        arrival_airport: str | list[str] | None = None,
+        airport: str | list[str] | None = None,
+        callsign: str | list[str] | None = None,
+        icao24: str | list[str] | None = None,
+        cached: bool = True,
+        compress: bool = False,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> pd.DataFrame | None: ...
+
+    def history(
+        self,
+        start: timelike,
+        stop: timelike | None = None,
+        *args: Any,
+        # date_delta: timedelta = timedelta(hours=1),
+        callsign: str | list[str] | None = None,
+        icao24: str | list[str] | None = None,
+        serials: int | Iterable[int] | None = None,
+        bounds: (
+            str | HasBounds | tuple[float, float, float, float] | None
+        ) = None,
+        departure_airport: str | None = None,
+        arrival_airport: str | None = None,
+        airport: str | None = None,
+        time_buffer: str | pd.Timedelta | None = None,
+        cached: bool = True,
+        compress: bool = False,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> pd.DataFrame | None: ...
+
+    def rawdata(
+        self,
+        start: timelike,
+        stop: timelike | None = None,
+        *args: Any,  # more reasonable to be explicit about arguments
+        icao24: str | list[str] | None = None,
+        serials: int | Iterable[int] | None = None,
+        bounds: HasBounds | tuple[float, float, float, float] | None = None,
+        callsign: str | list[str] | None = None,
+        departure_airport: str | None = None,
+        arrival_airport: str | None = None,
+        airport: str | None = None,
+        cached: bool = True,
+        compress: bool = False,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> pd.DataFrame | None: ...

{pyopensky-2.16 → pyopensky-2.17}/src/pyopensky/config.py

@@ -173,10 +173,10 @@ __all__ = list(NAME_RESOLUTION.keys())
 def get_config(
     opensky_category: str,
     opensky_name: str,
-    traffic_category: None | str = None,
-    traffic_name: None | str = None,
-    environment_variable: None | str = None,
-) -> None | str:
+    traffic_category: str | None = None,
+    traffic_name: str | None = None,
+    environment_variable: str | None = None,
+) -> str | None:
     if opensky_value := opensky_config.get(
         opensky_category, opensky_name, fallback=None
     ):
@@ -204,7 +204,7 @@ if not cache_path.exists():
 purge_cache(cache_path)
 
 
-def __getattr__(name: str) -> None | str:
+def __getattr__(name: str) -> str | None:
     # Pick in order:
     # 1. pyopensky -> settings.conf
     # 2. traffic -> traffic.conf

{pyopensky-2.16 → pyopensky-2.17}/src/pyopensky/decoders/pymodes.py

@@ -49,7 +49,7 @@ class PyModesDecoder(Decoder):
     def __init__(self) -> None:
         """Initialize PyModesDecoder and import pyModeS library."""
         try:
-            import pyModeS as pms  # ty: ignore[unresolved-import]
+            import pyModeS as pms
 
             self.pms = pms
         except ImportError as e:

{pyopensky-2.16 → pyopensky-2.17}/src/pyopensky/rebuild.py

@@ -6,7 +6,7 @@ multiple tables and reconstructing complete state vectors.
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Literal
+from typing import TYPE_CHECKING, Any, Literal, cast
 
 if TYPE_CHECKING:
     import pandas as pd
@@ -83,13 +83,13 @@ class Rebuild:
         start: timelike,
         stop: timelike,
         *,
-        icao24: None | str | list[str] = None,
-        bounds: None | HasBounds | tuple[float, float, float, float] = None,
+        icao24: str | list[str] | None = None,
+        bounds: HasBounds | tuple[float, float, float, float] | None = None,
         cached: bool = True,
         compress: bool = False,
-        decoder: None | Decoder = None,
+        decoder: Decoder | None = None,
         **kwargs: Any,
-    ) -> None | pd.DataFrame:
+    ) -> pd.DataFrame | None:
         """Download and optionally redecode position data from raw messages.
 
         Downloads position data with raw ADS-B messages, pairs odd/even CPR
@@ -198,12 +198,12 @@ class Rebuild:
         start: timelike,
         stop: timelike,
         *,
-        icao24: None | str | list[str] = None,
+        icao24: str | list[str] | None = None,
         cached: bool = True,
         compress: bool = False,
-        decoder: None | Decoder = None,
+        decoder: Decoder | None = None,
         **kwargs: Any,
-    ) -> None | pd.DataFrame:
+    ) -> pd.DataFrame | None:
         """Download and optionally redecode velocity data from raw messages.
 
         :param decoder: decoder implementing decode_velocity(df) method
@@ -257,12 +257,12 @@ class Rebuild:
         start: timelike,
         stop: timelike,
         *,
-        icao24: None | str | list[str] = None,
+        icao24: str | list[str] | None = None,
         cached: bool = True,
         compress: bool = False,
-        decoder: None | Decoder = None,
+        decoder: Decoder | None = None,
         **kwargs: Any,
-    ) -> None | pd.DataFrame:
+    ) -> pd.DataFrame | None:
         """Download and optionally redecode identification (callsign) data.
 
         :param decoder: decoder implementing decode_identification(df) method
@@ -311,12 +311,12 @@ class Rebuild:
         start: timelike,
         stop: timelike,
         *,
-        icao24: None | str | list[str] = None,
+        icao24: str | list[str] | None = None,
         cached: bool = True,
         compress: bool = False,
-        decoder: None | Decoder = None,
+        decoder: Decoder | None = None,
         **kwargs: Any,
-    ) -> None | pd.DataFrame:
+    ) -> pd.DataFrame | None:
         """Download and optionally redecode rollcall (squawk) data.
 
         :param decoder: decoder implementing decode_rollcall(df) method
@@ -354,14 +354,14 @@ class Rebuild:
         start: timelike,
         stop: timelike,
         *,
-        icao24: None | str | list[str] = None,
-        bounds: None | HasBounds | tuple[float, float, float, float] = None,
+        icao24: str | list[str] | None = None,
+        bounds: HasBounds | tuple[float, float, float, float] | None = None,
         cached: bool = True,
         compress: bool = False,
-        decoder: None | Decoder | Literal["pymodes", "rs1090"] = None,
+        decoder: Decoder | Literal["pymodes", "rs1090"] | None = None,
         include_rollcall: bool = False,
         **kwargs: Any,
-    ) -> None | pd.DataFrame:
+    ) -> pd.DataFrame | None:
         """Rebuild state vectors by downloading and merging all data tables.
 
         This method downloads data from position, velocity, identification,
@@ -459,7 +459,7 @@ class Rebuild:
                 on="timestamp",
                 by="icao24",
                 direction="nearest",
-                tolerance=pd.Timedelta(seconds=5),
+                tolerance=cast(pd.Timedelta, pd.Timedelta(seconds=5)),
                 suffixes=("_pos", "_vel"),
             )
 
@@ -508,7 +508,7 @@ class Rebuild:
                 on="timestamp",
                 by="icao24",
                 direction="nearest",
-                tolerance=pd.Timedelta(seconds=5),
+                tolerance=cast(pd.Timedelta, pd.Timedelta(seconds=5)),
             )
 
         # Optionally get and merge rollcall data
@@ -530,7 +530,7 @@ class Rebuild:
                     on="timestamp",
                     by="icao24",
                     direction="nearest",
-                    tolerance=pd.Timedelta(seconds=5),
+                    tolerance=cast(pd.Timedelta, pd.Timedelta(seconds=5)),
                 )
             else:
                 pos_data = pd.concat([pos_data, rollcall_data], axis=0)