pyopensky 2.3__tar.gz → 2.5__tar.gz

{pyopensky-2.3 → pyopensky-2.5}/PKG-INFO

@@ -1,14 +1,13 @@
 Metadata-Version: 2.1
 Name: pyopensky
-Version: 2.3
+Version: 2.5
 Summary: A Python interface for OpenSky database
 License: MIT
 Author: Xavier Olive
 Author-email: git@xoolive.org
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -52,29 +51,13 @@ poetry install
 
 ## Credentials
 
-|        | Apply for access                                               |
-| ------ | -------------------------------------------------------------- |
-| Impala | https://opensky-network.org/data/impala                        |
-| Trino  | contact@opensky-network.org (or specify it in the Impala form) |
-
-The first time you use the library, a configuration file named `settings.conf` is created, including the following content:
-
-```text
-[default]
-username =
-password =
-```
-
-You will identify the folder where the `settings.conf` is located:
-
-```python
-from pyopensky.config import opensky_config_dir
-
-print(opensky_config_dir)
-```
+See details in the [documentation](https://open-aviation.github.io/pyopensky/credentials.html)
 
 ## Usage
 
+> [!IMPORTANT]
+> The Impala shell is now deprecated. Please upgrade to Trino.
+
 - from the [REST API](https://open-aviation.github.io/pyopensky/rest.html):
 
   ```python
@@ -90,18 +73,6 @@ print(opensky_config_dir)
   rest.departure(airport, begin, end)
   ```
 
-- from the [Impala](https://open-aviation.github.io/pyopensky/impala.html) shell (requires authentication):
-
-  ```python
-  from pyopensky.impala import Impala
-
-  impala = Impala()
-  # full description of the whole set of parameters in the documentation
-  impala.flightlist(start, stop, *, airport, callsign, icao24)
-  impala.history(start, stop, *, callsign, icao24, bounds)
-  impala.rawdata(start, stop, *, callsign, icao24, bounds)
-  ```
-
 - from the [Trino](https://open-aviation.github.io/pyopensky/trino.html) database (requires authentication):
 
   ```python

{pyopensky-2.3 → pyopensky-2.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyopensky"
-version = "2.3"
+version = "2.5"
 description = "A Python interface for OpenSky database"
 authors = ["Xavier Olive <git@xoolive.org>", "Junzi Sun <j.sun-1@tudelft.nl>"]
 license = "MIT"
@@ -11,7 +11,7 @@ include = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.9"
 pandas = ">=1.5"
 trino = { version = ">=0.322", extras = ['sqlalchemy'] }
 minio = ">=7.1"
@@ -45,7 +45,7 @@ target_version = ['py38', 'py39', 'py310', 'py311']
 include = '\.pyi?$'
 
 [tool.ruff]
-select = [
+lint.select = [
   "E", "W",  # pycodestyle
   "F",  # pyflakes
   "I",  # isort
@@ -57,7 +57,7 @@ select = [
 line-length = 80
 target-version = "py38"
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 known-first-party = ["numpy", "pandas"]
 
 [tool.mypy]

{pyopensky-2.3 → pyopensky-2.5}/readme.md

@@ -26,29 +26,13 @@ poetry install
 
 ## Credentials
 
-|        | Apply for access                                               |
-| ------ | -------------------------------------------------------------- |
-| Impala | https://opensky-network.org/data/impala                        |
-| Trino  | contact@opensky-network.org (or specify it in the Impala form) |
-
-The first time you use the library, a configuration file named `settings.conf` is created, including the following content:
-
-```text
-[default]
-username =
-password =
-```
-
-You will identify the folder where the `settings.conf` is located:
-
-```python
-from pyopensky.config import opensky_config_dir
-
-print(opensky_config_dir)
-```
+See details in the [documentation](https://open-aviation.github.io/pyopensky/credentials.html)
 
 ## Usage
 
+> [!IMPORTANT]
+> The Impala shell is now deprecated. Please upgrade to Trino.
+
 - from the [REST API](https://open-aviation.github.io/pyopensky/rest.html):
 
   ```python
@@ -64,18 +48,6 @@ print(opensky_config_dir)
   rest.departure(airport, begin, end)
   ```
 
-- from the [Impala](https://open-aviation.github.io/pyopensky/impala.html) shell (requires authentication):
-
-  ```python
-  from pyopensky.impala import Impala
-
-  impala = Impala()
-  # full description of the whole set of parameters in the documentation
-  impala.flightlist(start, stop, *, airport, callsign, icao24)
-  impala.history(start, stop, *, callsign, icao24, bounds)
-  impala.rawdata(start, stop, *, callsign, icao24, bounds)
-  ```
-
 - from the [Trino](https://open-aviation.github.io/pyopensky/trino.html) database (requires authentication):
 
   ```python

{pyopensky-2.3 → pyopensky-2.5}/src/pyopensky/api.py

@@ -14,8 +14,7 @@ ProgressbarType = Callable[[Iterable[T]], Iterable[T]]
 
 class HasBounds(Protocol):
     @property
-    def bounds(self) -> tuple[float, float, float, float]:
-        ...
+    def bounds(self) -> tuple[float, float, float, float]: ...
 
 
 class OpenSkyDBAPI(Protocol):
@@ -33,8 +32,7 @@ class OpenSkyDBAPI(Protocol):
         compress: bool = False,
         limit: None | int = None,
         **kwargs: Any,
-    ) -> None | pd.DataFrame:
-        ...
+    ) -> None | pd.DataFrame: ...
 
     def history(
         self,
@@ -57,8 +55,7 @@ class OpenSkyDBAPI(Protocol):
         compress: bool = False,
         limit: None | int = None,
         **kwargs: Any,
-    ) -> None | pd.DataFrame:
-        ...
+    ) -> None | pd.DataFrame: ...
 
     def rawdata(
         self,
@@ -76,5 +73,4 @@ class OpenSkyDBAPI(Protocol):
         compress: bool = False,
         limit: None | int = None,
         **kwargs: Any,
-    ) -> None | pd.DataFrame:
-        ...
+    ) -> None | pd.DataFrame: ...

{pyopensky-2.3 → pyopensky-2.5}/src/pyopensky/config.py

@@ -18,7 +18,7 @@ DEFAULT_CONFIG = """
 username =
 password =
 
-# If you use different credentials for Impala and Trino, uncomment the following
+# If you use both Impala and Trino, uncomment the following
 # [impala]
 # username =
 # password =

{pyopensky-2.3 → pyopensky-2.5}/src/pyopensky/impala.py

@@ -136,9 +136,9 @@ class Impala(OpenSkyDBAPI):
     For more information, find below the error and the buggy line:
     """
 
-    stdin: paramiko.ChannelFile  # type: ignore
-    stdout: paramiko.ChannelFile  # type: ignore
-    stderr: paramiko.ChannelFile  # type: ignore
+    stdin: paramiko.ChannelFile
+    stdout: paramiko.ChannelFile
+    stderr: paramiko.ChannelFile
     # actually ChannelStderrFile
 
     def __init__(self, **kwargs: Any) -> None:
@@ -338,7 +338,7 @@ class Impala(OpenSkyDBAPI):
             request = request.replace("\n", " ")
             _log.info(request)
 
-            self.stdin.channel.send(request + ";\n")
+            self.stdin.channel.send((request + ";\n").encode())
             # avoid messing lines in the cache file
             time.sleep(0.1)
             total = ""

{pyopensky-2.3 → pyopensky-2.5}/src/pyopensky/s3.py

@@ -90,8 +90,7 @@ class S3Client:
         self,
         obj: datatypes.Object,
         filename: None | Path,
-    ) -> Path:
-        ...
+    ) -> Path: ...
 
     @overload
     def download_object(
@@ -99,8 +98,7 @@ class S3Client:
         obj: datatypes.Object,
         filename: None | Path,
         return_buffer: Literal[False],
-    ) -> Path:
-        ...
+    ) -> Path: ...
 
     @overload
     def download_object(
@@ -108,8 +106,7 @@ class S3Client:
         obj: datatypes.Object,
         filename: None | Path,
         return_buffer: Literal[True],
-    ) -> BytesIO:
-        ...
+    ) -> BytesIO: ...
 
     def download_object(
         self,

{pyopensky-2.3 → pyopensky-2.5}/src/pyopensky/trino.py

@@ -119,6 +119,8 @@ class Trino(OpenSkyDBAPI):
                 if token is not None
                 else OAuth2Authentication(),
                 http_scheme="https",
+                # https://github.com/trinodb/trino-python-client/discussions/456
+                legacy_prepared_statements=True,
             ),
         )
         return engine
@@ -384,6 +386,7 @@ class Trino(OpenSkyDBAPI):
         cached: bool = True,
         compress: bool = False,
         limit: None | int = None,
+        selected_columns: tuple[InstrumentedAttribute[Any] | str, ...] = (),
         **kwargs: Any,
     ) -> None | pd.DataFrame:
         """Get Traffic from the OpenSky Trino database.
@@ -413,6 +416,10 @@ class Trino(OpenSkyDBAPI):
         :param bounds: sets a geographical footprint. Either an **airspace or
             shapely shape** (requires the bounds attribute); or a **tuple of
             float** (west, south, east, north);
+        :param selected_columns: specify the columns you want to retrieve. When
+            empty, use all columns of the StateVectorsData4 table. You may
+            escape column names as str. **Always** escape names from the
+            FlightsData4 table.
 
         **Airports**
 
@@ -475,7 +482,7 @@ class Trino(OpenSkyDBAPI):
                 )
                 .where(
                     FlightsData4.day >= start_ts.floor("1d"),
-                    FlightsData4.day <= start_ts.ceil("1d"),
+                    FlightsData4.day <= stop_ts.ceil("1d"),
                 )
             )
 
@@ -568,10 +575,31 @@ class Trino(OpenSkyDBAPI):
         stmt = stmt.where(
             StateVectorsData4.time >= start_ts,
             StateVectorsData4.time <= stop_ts,
-            StateVectorsData4.hour >= start_ts.floor("1H"),
-            StateVectorsData4.hour < stop_ts.ceil("1H"),
+            StateVectorsData4.hour >= start_ts.floor("1h"),
+            StateVectorsData4.hour < stop_ts.ceil("1h"),
         )
 
+        def transform_column(col: str) -> InstrumentedAttribute[Any]:
+            if "." in col:
+                table, column = col.split(".")
+                MATCH = {
+                    "StateVectorsData4": StateVectorsData4,
+                    "FlightsData4": fd4,
+                }
+                return getattr(MATCH[table], column)  # type: ignore
+            if candidate := getattr(StateVectorsData4, col, None):
+                return candidate  # type: ignore
+            if candidate := getattr(fd4, col, None):
+                return candidate  # type: ignore
+            raise ValueError(f"Unknown column: {col}")
+
+        if len(selected_columns) > 0:
+            columns = (
+                transform_column(col) if isinstance(col, str) else col
+                for col in selected_columns
+            )
+            stmt = stmt.with_only_columns(*columns)
+
         if limit is not None:
             stmt = stmt.limit(limit)
 
@@ -712,7 +740,7 @@ class Trino(OpenSkyDBAPI):
                 )
                 .where(
                     FlightsData4.day >= start_ts.floor("1d"),
-                    FlightsData4.day <= start_ts.ceil("1d"),
+                    FlightsData4.day <= stop_ts.ceil("1d"),
                 )
             )
 
@@ -766,8 +794,8 @@ class Trino(OpenSkyDBAPI):
                 )
                 .group_by(StateVectorsData4.icao24)
                 .where(
-                    StateVectorsData4.hour >= start_ts.floor("1H"),
-                    StateVectorsData4.hour <= stop_ts.ceil("1H"),
+                    StateVectorsData4.hour >= start_ts.floor("1h"),
+                    StateVectorsData4.hour <= stop_ts.ceil("1h"),
                     StateVectorsData4.time >= start_ts,
                     StateVectorsData4.time <= stop_ts,
                 )
@@ -819,8 +847,8 @@ class Trino(OpenSkyDBAPI):
         stmt = stmt.where(
             Table.mintime >= start_ts,
             Table.mintime <= stop_ts,
-            Table.hour >= start_ts.floor("1H"),
-            Table.hour < stop_ts.ceil("1H"),
+            Table.hour >= start_ts.floor("1h"),
+            Table.hour < stop_ts.ceil("1h"),
         )
 
         if limit is not None: