pyopensky 2.1__tar.gz → 2.2__tar.gz

{pyopensky-2.1 → pyopensky-2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyopensky
-Version: 2.1
+Version: 2.2
 Summary: A Python interface for OpenSky database
 License: MIT
 Author: Xavier Olive
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: appdirs (>=1.4.4)
 Requires-Dist: minio (>=7.1)
 Requires-Dist: pandas (>=1.5)
@@ -27,6 +28,8 @@ Description-Content-Type: text/markdown
 
 The `pyopensky` Python library provides functions to download data from the OpenSky Network live API and historical databases. It aims at making ADS-B and Mode S data from OpenSky easily accessible in the Python programming environment.
 
+Full documentation on https://open-aviation.github.io/pyopensky
+
 ## Installation
 
 ```sh
@@ -72,7 +75,7 @@ print(opensky_config_dir)
 
 ## Usage
 
-- from the REST API:
+- from the [REST API](https://open-aviation.github.io/pyopensky/rest.html):
 
   ```python
   from pyopensky.rest import REST
@@ -87,7 +90,7 @@ print(opensky_config_dir)
   rest.departure(airport, begin, end)
   ```
 
-- from the Impala shell (requires authentication):
+- from the [Impala](https://open-aviation.github.io/pyopensky/impala.html) shell (requires authentication):
 
   ```python
   from pyopensky.impala import Impala
@@ -99,7 +102,7 @@ print(opensky_config_dir)
   impala.rawdata(start, stop, *, callsign, icao24, bounds)
   ```
 
-- from the Trino shell (requires authentication):
+- from the [Trino](https://open-aviation.github.io/pyopensky/trino.html) database (requires authentication):
 
   ```python
   from pyopensky.trino import Trino

{pyopensky-2.1 → pyopensky-2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyopensky"
-version = "2.1"
+version = "2.2"
 description = "A Python interface for OpenSky database"
 authors = ["Xavier Olive <git@xoolive.org>", "Junzi Sun <j.sun-1@tudelft.nl>"]
 license = "MIT"
@@ -24,13 +24,16 @@ paramiko = ">=2.7"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = ">=3.1.1"
-black = ">=23.1.0"
 mypy = ">=1.0.1"
 ruff = ">=0.0.253"
 pytest = ">=7.2.1"
 ipykernel = ">=6.21.2"
 types-requests = ">=2.28.11.15"
 types-paramiko = ">=3.3.0.0"
+Sphinx = ">=5.1"
+sphinx-design = ">=0.4.1"
+sphinx-rtd-theme = ">=0.5.2"
+sphinx-autodoc-typehints = ">=1.17,!=1.21.4"
 
 [build-system]
 requires = ["poetry-core"]

{pyopensky-2.1 → pyopensky-2.2}/readme.md

@@ -2,6 +2,8 @@
 
 The `pyopensky` Python library provides functions to download data from the OpenSky Network live API and historical databases. It aims at making ADS-B and Mode S data from OpenSky easily accessible in the Python programming environment.
 
+Full documentation on https://open-aviation.github.io/pyopensky
+
 ## Installation
 
 ```sh
@@ -47,7 +49,7 @@ print(opensky_config_dir)
 
 ## Usage
 
-- from the REST API:
+- from the [REST API](https://open-aviation.github.io/pyopensky/rest.html):
 
   ```python
   from pyopensky.rest import REST
@@ -62,7 +64,7 @@ print(opensky_config_dir)
   rest.departure(airport, begin, end)
   ```
 
-- from the Impala shell (requires authentication):
+- from the [Impala](https://open-aviation.github.io/pyopensky/impala.html) shell (requires authentication):
 
   ```python
   from pyopensky.impala import Impala
@@ -74,7 +76,7 @@ print(opensky_config_dir)
   impala.rawdata(start, stop, *, callsign, icao24, bounds)
   ```
 
-- from the Trino shell (requires authentication):
+- from the [Trino](https://open-aviation.github.io/pyopensky/trino.html) database (requires authentication):
 
   ```python
   from pyopensky.trino import Trino

pyopensky-2.2/src/pyopensky/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("pyopensky")

{pyopensky-2.1 → pyopensky-2.2}/src/pyopensky/api.py

@@ -50,6 +50,7 @@ class OpenSkyDBAPI(Protocol):
         departure_airport: None | str = None,
         arrival_airport: None | str = None,
         airport: None | str = None,
+        time_buffer: None | str | pd.Timedelta = None,
         cached: bool = True,
         compress: bool = False,
         limit: None | int = None,

{pyopensky-2.1 → pyopensky-2.2}/src/pyopensky/impala.py

@@ -656,12 +656,12 @@ class Impala(OpenSkyDBAPI):
         departure_airport: None | str = None,
         arrival_airport: None | str = None,
         airport: None | str = None,
+        time_buffer: None | str | pd.Timedelta = None,
         cached: bool = True,
         compress: bool = False,
         limit: None | int = None,
         other_tables: str = "",
         other_params: str = "",
-        time_buffer: None | str | pd.Timedelta = None,
         progressbar: bool | ProgressbarType[Any] = True,
         date_delta: timedelta = timedelta(hours=1),
         count: bool = False,
@@ -711,6 +711,10 @@ class Impala(OpenSkyDBAPI):
         :param airport: a string for the ICAO identifier of the airport. Selects
             flights departing from or arriving at the airport between the two
             timestamps;
+        :param time_buffer: (default: None) time buffer used to extend time
+            bounds for flights in the OpenSky flight tables: requests will get
+            flights between ``start - time_buffer`` and ``stop + time_buffer``.
+            If no airport is specified, the parameter is ignored.
 
         .. warning::
 
@@ -728,10 +732,6 @@ class Impala(OpenSkyDBAPI):
             received each record;
         :param nautical_units: (default: True) convert data stored in Impala to
             standard nautical units (ft, ft/min, knots).
-        :param time_buffer: (default: None) time buffer used to extend time
-            bounds for flights in the OpenSky flight tables: requests will get
-            flights between ``start - time_buffer`` and ``stop + time_buffer``.
-            If no airport is specified, the parameter is ignored.
         :param cached: (default: True) switch to False to force a new request to
             the database regardless of the cached files. This option also
             deletes previous cache files;
@@ -804,7 +804,7 @@ class Impala(OpenSkyDBAPI):
                 else:
                     other_params += f"and RTRIM(callsign) REGEXP('{callsign}') "
 
-            elif callsign.find("%") > 0 or callsign.find("_") > 0:
+            elif callsign.find("%") >= 0 or callsign.find("_") >= 0:
                 other_params += "and callsign ilike '{}' ".format(callsign)
             else:
                 other_params += "and callsign='{:<8s}' ".format(callsign)
@@ -1010,7 +1010,7 @@ class Impala(OpenSkyDBAPI):
         other_params += "and not typeogn "
 
         if isinstance(sensor_name, str):
-            if sensor_name.find("%") > 0 or sensor_name.find("_") > 0:
+            if sensor_name.find("%") > -1 or sensor_name.find("_") > -1:
                 other_params += "and sensorname ilike '{}' ".format(sensor_name)
             else:
                 other_params += "and sensorname='{:<8s}' ".format(sensor_name)
@@ -1241,7 +1241,7 @@ class Impala(OpenSkyDBAPI):
                     "supported at the moment."
                 )
             if isinstance(callsign, str):
-                if callsign.find("%") > 0 or callsign.find("_") > 0:
+                if callsign.find("%") > -1 or callsign.find("_") > -1:
                     callsigns = "and callsign ilike '{}' ".format(callsign)
                 else:
                     callsigns = "and callsign='{:<8s}' ".format(callsign)

{pyopensky-2.1 → pyopensky-2.2}/src/pyopensky/rest.py

@@ -64,6 +64,7 @@ class REST:
         | str
         | HasBounds
         | tuple[float, float, float, float] = None,
+        retry: int = 5,
     ) -> pd.DataFrame:
         """Returns the current state vectors from OpenSky REST API.
 
@@ -132,9 +133,12 @@ class REST:
                     columns.append("_")
             r = pd.DataFrame.from_records(json["states"], columns=columns)
         except Exception:
-            _log.warning("Error in received data, retrying in 10 seconds")
-            time.sleep(10)
-            return self.states(own, bounds)
+            if retry > 0:
+                retry = retry - 1
+                _log.warning("Retrying in 10 seconds... {retry} more time")
+                time.sleep(10)
+                return self.states(own, bounds, retry=retry)
+            raise
 
         return r.assign(
             timestamp=lambda df: pd.to_datetime(
@@ -210,7 +214,7 @@ class REST:
         c.raise_for_status()
         json = c.json()
 
-        return tuple(json["route"])  # type: ignore
+        return tuple(json["route"])
 
     def aircraft(
         self,

{pyopensky-2.1 → pyopensky-2.2}/src/pyopensky/schema.py

@@ -31,6 +31,8 @@ class UTCTimestampInteger(TypeDecorator[pd.Timestamp]):
             value = pd.to_datetime(value, utc=True)
         if isinstance(value, pd.Timestamp):
             return int(value.timestamp())
+        if isinstance(value, pd.Timedelta):
+            return int(value.total_seconds())
         return super().process_bind_param(value, dialect)
 
     def process_result_value(
@@ -83,6 +85,7 @@ class CallsignString(TypeDecorator[str]):
             operator.ne,  # !=
             sql_operators.eq,
             sql_operators.ne,
+            sql_operators.in_op,
             sql_operators.contains,  # .in()
         ):
             return self
@@ -408,16 +411,22 @@ class PositionData4(Base):
     maxtime: Mapped[pd.Timestamp] = mapped_column(UTCTimestampFloat)
     msgcount: Mapped[int]
     icao24: Mapped[str]
-    message: Mapped[str]
-    isid: Mapped[bool]
-    flightstatus: Mapped[int]
-    downlinkrequest: Mapped[int]
-    utilitymsg: Mapped[int]
-    interrogatorid: Mapped[int]
-    identifierdesignator: Mapped[int]
-    valuecode: Mapped[int]
-    altitude: Mapped[float]
-    identity: Mapped[str]
+    nicsuppla: Mapped[bool]
+    hcr: Mapped[float]
+    nic: Mapped[int]
+    survstatus: Mapped[int]
+    nicsupplb: Mapped[bool]
+    odd: Mapped[bool]
+    baroalt: Mapped[bool]
+    lat: Mapped[float]
+    lon: Mapped[float]
+    alt: Mapped[float]
+    nicsupplc: Mapped[bool]
+    groundspeed: Mapped[float]
+    gsresolution: Mapped[float]
+    heading: Mapped[float]
+    timeflag: Mapped[bool]
+    surface: Mapped[bool]
 
     # Whatever, we pick this one as primary key BUT
     #   - this is not true

{pyopensky-2.1 → pyopensky-2.2}/src/pyopensky/trino.py

@@ -22,6 +22,7 @@ from sqlalchemy import (
 )
 from sqlalchemy.orm import aliased
 from sqlalchemy.orm.attributes import InstrumentedAttribute
+from sqlalchemy.sql import ColumnExpressionArgument
 from sqlalchemy.sql.expression import text
 from tqdm import tqdm
 from trino.auth import JWTAuthentication, OAuth2Authentication
@@ -224,7 +225,7 @@ class Trino(OpenSkyDBAPI):
         self,
         start: timelike,
         stop: None | timelike = None,
-        *args: Any,  # more reasonable to be explicit about arguments
+        *args: ColumnExpressionArgument[bool],
         departure_airport: None | str | list[str] = None,
         arrival_airport: None | str | list[str] = None,
         airport: None | str | list[str] = None,
@@ -345,6 +346,9 @@ class Trino(OpenSkyDBAPI):
                 Table.day < stop_ts.ceil("1d"),
             )
 
+        for condition in args:
+            stmt = stmt.where(condition)
+
         if limit is not None:
             stmt = stmt.limit(limit)
 
@@ -364,7 +368,7 @@ class Trino(OpenSkyDBAPI):
         self,
         start: timelike,
         stop: None | timelike = None,
-        *args: Any,
+        *args: ColumnExpressionArgument[bool],
         # date_delta: timedelta = timedelta(hours=1),
         callsign: None | str | list[str] = None,
         icao24: None | str | list[str] = None,
@@ -581,7 +585,7 @@ class Trino(OpenSkyDBAPI):
         self,
         start: timelike,
         stop: None | timelike = None,
-        *args: Any,  # more reasonable to be explicit about arguments
+        *args: ColumnExpressionArgument[bool],
         icao24: None | str | list[str] = None,
         serials: None | int | Iterable[int] = None,
         bounds: None | HasBounds | tuple[float, float, float, float] = None,
@@ -593,6 +597,7 @@ class Trino(OpenSkyDBAPI):
         compress: bool = False,
         limit: None | int = None,
         Table: Type[RawTable] = RollcallRepliesData4,
+        extra_columns: tuple[InstrumentedAttribute[Any], ...] = (),
         **kwargs: Any,
     ) -> None | pd.DataFrame:
         """Get raw message from the OpenSky Trino database.
@@ -687,11 +692,9 @@ class Trino(OpenSkyDBAPI):
                 select(Table)
                 .with_only_columns(
                     Table.mintime,
-                    Table.maxtime,
                     Table.rawmsg,
-                    Table.msgcount,
                     Table.icao24,
-                    Table.sensors,
+                    *extra_columns,
                 )
                 .where(Table.rawmsg.is_not(None))
             )
@@ -807,6 +810,9 @@ class Trino(OpenSkyDBAPI):
                 )
             )
 
+        for condition in args:
+            stmt = stmt.where(condition)
+
         stmt = self.stmt_where_str(stmt, icao24, Table.icao24)
 
         stmt = stmt.where(