MOD: Standardize Python client on os.PathLike

Author: nmacholl

databento/common/dbnstore.py

@@ -132,7 +132,7 @@ class FileDataSource(DataSource):
         The name of the file.
     nbytes : int
         The size of the data in bytes; equal to the file size.
-    path : PathLike or str
+    path : PathLike[str] or str
         The path of the file.
     reader : IO[bytes]
         A `BufferedReader` for this file-backed data.
@@ -634,7 +634,7 @@ def from_file(cls, path: PathLike[str] | str) -> DBNStore:
 
         Parameters
         ----------
-        path : Path or str
+        path : PathLike[str] or str
             The path to read from.
 
         Returns
@@ -695,7 +695,7 @@ def replay(self, callback: Callable[[Any], None]) -> None:
     def request_full_definitions(
         self,
         client: Historical,
-        path: Path | str | None = None,
+        path: PathLike[str] | str | None = None,
     ) -> DBNStore:
         """
         Request full instrument definitions based on the metadata properties.
@@ -706,7 +706,7 @@ def request_full_definitions(
         ----------
         client : Historical
             The historical client to use for the request (contains the API key).
-        path : Path or str, optional
+        path : PathLike[str] or str, optional
             The path to stream the data to on disk (will then return a `DBNStore`).
 
         Returns
@@ -768,7 +768,7 @@ def request_symbology(self, client: Historical) -> dict[str, Any]:
 
     def to_csv(
         self,
-        path: Path | str,
+        path: PathLike[str] | str,
         pretty_px: bool = True,
         pretty_ts: bool = True,
         map_symbols: bool = True,
@@ -780,7 +780,7 @@ def to_csv(
 
         Parameters
         ----------
-        path : Path or str
+        path : PathLike[str] or str
             The file path to write to.
         pretty_px : bool, default True
             If all price columns should be converted from `int` to `float` at
@@ -922,7 +922,7 @@ def to_df(
 
     def to_parquet(
         self,
-        path: Path | str,
+        path: PathLike[str] | str,
         price_type: Literal["fixed", "float"] = "float",
         pretty_ts: bool = True,
         map_symbols: bool = True,
@@ -995,13 +995,13 @@ def to_parquet(
             if writer is not None:
                 writer.close()
 
-    def to_file(self, path: Path | str) -> None:
+    def to_file(self, path: PathLike[str] | str) -> None:
         """
         Write the data to a DBN file at the given path.
 
         Parameters
         ----------
-        path : str
+        path : PathLike[str] or str
             The file path to write to.
 
         Raises
@@ -1021,7 +1021,7 @@ def to_file(self, path: Path | str) -> None:
 
     def to_json(
         self,
-        path: Path | str,
+        path: PathLike[str] | str,
         pretty_px: bool = True,
         pretty_ts: bool = True,
         map_symbols: bool = True,
@@ -1033,7 +1033,7 @@ def to_json(
 
         Parameters
         ----------
-        path : Path or str
+        path : PathLike[str] or str
             The file path to write to.
         pretty_px : bool, default True
             If all price columns should be converted from `int` to `float` at

databento/common/symbology.py

@@ -43,8 +43,8 @@ class MappingInterval(NamedTuple):
 
 
 def _validate_path_pair(
-    in_file: Path | PathLike[str] | str,
-    out_file: Path | PathLike[str] | str | None,
+    in_file: PathLike[str] | str,
+    out_file: PathLike[str] | str | None,
 ) -> tuple[Path, Path]:
     in_file_valid = Path(in_file)
 
@@ -74,22 +74,22 @@ def _validate_path_pair(
 
 
 def map_symbols_csv(
-    symbology_file: Path | PathLike[str] | str,
-    csv_file: Path | PathLike[str] | str,
-    out_file: Path | PathLike[str] | str | None = None,
+    symbology_file: PathLike[str] | str,
+    csv_file: PathLike[str] | str,
+    out_file: PathLike[str] | str | None = None,
 ) -> Path:
     """
     Use a `symbology.json` file to map a symbols column onto an existing CSV
     file. The result is written to `out_file`.
 
     Parameters
     ----------
-    symbology_file: Path | PathLike[str] | str
+    symbology_file: PathLike[str] | str
         Path to a `symbology.json` file to use as a symbology source.
-    csv_file: Path | PathLike[str] | str
+    csv_file: PathLike[str] | str
         Path to a CSV file that contains encoded DBN data; must contain
         a `ts_recv` or `ts_event` and `instrument_id` column.
-    out_file: Path | PathLike[str] | str (optional)
+    out_file: PathLike[str] | str (optional)
         Path to a file to write results to. If unspecified, `_mapped` will be
         appended to the `csv_file` name.
 
@@ -119,21 +119,21 @@ def map_symbols_csv(
 
 
 def map_symbols_json(
-    symbology_file: Path | PathLike[str] | str,
-    json_file: Path | PathLike[str] | str,
-    out_file: Path | PathLike[str] | str | None = None,
+    symbology_file: PathLike[str] | str,
+    json_file: PathLike[str] | str,
+    out_file: PathLike[str] | str | None = None,
 ) -> Path:
     """
     Use a `symbology.json` file to insert a symbols key into records of an
     existing JSON file. The result is written to `out_file`.
 
     Parameters
     ----------
-    symbology_file: Path | PathLike[str] | str
+    symbology_file: PathLike[str] | str
         Path to a `symbology.json` file to use as a symbology source.
-    json_file: Path | PathLike[str] | str
+    json_file: PathLike[str] | str
         Path to a JSON file that contains encoded DBN data.
-    out_file: Path | PathLike[str] | str (optional)
+    out_file: PathLike[str] | str (optional)
         Path to a file to write results to. If unspecified, `_mapped` will be
         appended to the `json_file` name.
 
@@ -243,7 +243,9 @@ def insert_metadata(self, metadata: Metadata) -> None:
             return
 
         stype_in = SType(metadata.stype_in) if metadata.stype_in is not None else None
-        stype_out = SType(metadata.stype_out) if metadata.stype_out is not None else None
+        stype_out = (
+            SType(metadata.stype_out) if metadata.stype_out is not None else None
+        )
 
         for symbol_in, entries in metadata.mappings.items():
             for entry in entries:
@@ -395,19 +397,19 @@ def insert_json(
 
     def map_symbols_csv(
         self,
-        csv_file: Path | PathLike[str] | str,
-        out_file: Path | PathLike[str] | str | None = None,
+        csv_file: PathLike[str] | str,
+        out_file: PathLike[str] | str | None = None,
     ) -> Path:
         """
         Use the loaded symbology data to map a symbols column onto an existing
         CSV file. The result is written to `out_file`.
 
         Parameters
         ----------
-        csv_file: Path | PathLike[str] | str
+        csv_file: PathLike[str] | str
             Path to a CSV file that contains encoded DBN data; must contain
             a `ts_recv` or `ts_event` and `instrument_id` column.
-        out_file: Path | PathLike[str] | str (optional)
+        out_file: PathLike[str] | str (optional)
             Path to a file to write results to. If unspecified, `_mapped` will be
             appended to the `csv_file` name.
 
@@ -474,18 +476,18 @@ def map_symbols_csv(
 
     def map_symbols_json(
         self,
-        json_file: Path | PathLike[str] | str,
-        out_file: Path | PathLike[str] | str | None = None,
+        json_file: PathLike[str] | str,
+        out_file: PathLike[str] | str | None = None,
     ) -> Path:
         """
         Use the loaded symbology data to insert a symbols key into records of
         an existing JSON file. The result is written to `out_file`.
 
         Parameters
         ----------
-        json_file: Path | PathLike[str] | str
+        json_file: PathLike[str] | str
             Path to a JSON file that contains encoded DBN data.
-        out_file: Path | PathLike[str] | str (optional)
+        out_file: PathLike[str] | str (optional)
             Path to a file to write results to. If unspecified, `_mapped` will be
             appended to the `json_file` name.
 

databento/common/validation.py

@@ -18,7 +18,7 @@ def validate_path(value: PathLike[str] | str, param: str) -> Path:
 
     Parameters
     ----------
-    value: PathLike or str
+    value: PathLike[str] or str
         The value to validate.
     param : str
         The name of the parameter being validated (for any error message).
@@ -49,7 +49,7 @@ def validate_file_write_path(value: PathLike[str] | str, param: str) -> Path:
 
     Parameters
     ----------
-    value: PathLike or str
+    value: PathLike[str] or str
         The value to validate.
     param : str
         The name of the parameter being validated (for any error message).

databento/historical/api/batch.py

@@ -253,7 +253,7 @@ def download(
 
         Parameters
         ----------
-        output_dir: PathLike or str
+        output_dir: PathLike[str] or str
             The directory to download the file(s) to.
         job_id : str
             The batch job identifier.
@@ -397,7 +397,7 @@ async def download_async(
 
         Parameters
         ----------
-        output_dir: PathLike or str
+        output_dir: PathLike[str] or str
             The directory to download the file(s) to.
         job_id : str
             The batch job identifier.

databento/historical/api/timeseries.py

@@ -80,7 +80,7 @@ def get_range(
             The output symbology type to resolve to.
         limit : int, optional
             The maximum number of records to return. If `None` then no limit.
-        path : PathLike or str, optional
+        path : PathLike[str] or str, optional
             The file path to stream the data to on disk (will then return a `DBNStore`).
 
         Returns
@@ -177,7 +177,7 @@ async def get_range_async(
             The output symbology type to resolve to.
         limit : int, optional
             The maximum number of records to return. If `None` then no limit.
-        path : PathLike or str, optional
+        path : PathLike[str] or str, optional
             The file path to stream the data to on disk (will then return a `DBNStore`).
 
         Returns

tests/mock_live_server.py

@@ -15,6 +15,7 @@
 from concurrent import futures
 from functools import singledispatchmethod
 from io import BytesIO
+from os import PathLike
 from typing import Callable, NewType, TypeVar
 
 import zstandard
@@ -80,7 +81,7 @@ def __init__(
         version: str,
         user_api_keys: dict[str, str],
         message_queue: MessageQueue,
-        dbn_path: pathlib.Path,
+        dbn_path: PathLike[str],
         mode: MockLiveMode = MockLiveMode.REPLAY,
     ) -> None:
         self.__transport: asyncio.Transport
@@ -99,7 +100,7 @@ def __init__(
         self._is_streaming: bool = False
         self._repeater_tasks: set[asyncio.Task[None]] = set()
 
-        self._dbn_path = dbn_path
+        self._dbn_path = pathlib.Path(dbn_path)
         self._user_api_keys = user_api_keys
 
     @property
@@ -392,7 +393,6 @@ def _(self, message: AuthenticationRequest) -> None:
             )
             self.__transport.write(bytes(auth_success))
 
-
     @handle_client_message.register(SubscriptionRequest)
     def _(self, message: SubscriptionRequest) -> None:
         logger.info("received subscription request: %s", str(message).strip())
@@ -548,7 +548,7 @@ def _protocol_factory(
         user_api_keys: dict[str, str],
         message_queue: MessageQueue,
         version: str,
-        dbn_path: pathlib.Path,
+        dbn_path: PathLike[str],
         mode: MockLiveMode,
     ) -> Callable[[], MockLiveServerProtocol]:
         def factory() -> MockLiveServerProtocol:
@@ -567,7 +567,7 @@ async def create(
         cls,
         host: str = "localhost",
         port: int = 0,
-        dbn_path: pathlib.Path = pathlib.Path.cwd(),
+        dbn_path: PathLike[str] = pathlib.Path.cwd(),
         mode: MockLiveMode = MockLiveMode.REPLAY,
     ) -> MockLiveServer:
         """
@@ -582,7 +582,7 @@ async def create(
         port : int
             The port to bind for the mock server.
             Defaults to 0 which will bind to an open port.
-        dbn_path : pathlib.Path (default: cwd)
+        dbn_path : PathLike[str] (default: cwd)
             A path to DBN files for streaming.
             The files must contain the schema name and end with
             `.dbn.zst`.