DOC: Update python function styling in docs

Author: robertmaierle

databento/common/dbnstore.py

@@ -328,6 +328,8 @@ class DBNStore:
         Write the data to a file in JSON format.
     to_ndarray : np.ndarray
         The data as a numpy `ndarray`.
+    to_parquet
+        Write the data to a parquet file.
 
     Raises
     ------
@@ -662,7 +664,7 @@ def from_bytes(cls, data: BytesIO | bytes | IO[bytes]) -> DBNStore:
 
         Parameters
         ----------
-        data : BytesIO or bytes
+        data : BytesIO or bytes or IO[bytes]
             The bytes to read from.
 
         Returns
@@ -698,7 +700,7 @@ def insert_symbology_json(
             self._instrument_map.clear()
         self._instrument_map.insert_json(json_data)
 
-    def replay(self, callback: Callable[[Any], None]) -> None:
+    def replay(self, callback: Callable[[DBNRecord], None]) -> None:
         """
         Replay data by passing records sequentially to the given callback.
 
@@ -983,6 +985,8 @@ def to_parquet(
 
         Parameters
         ----------
+        path: PathLike[str] or str
+            The file path to write the data to.
         price_type : str, default "float"
             The price type to use for price fields.
             If "fixed", prices will have a type of `int` in fixed decimal format; each unit representing 1e-9 or 0.000000001.

databento/common/parsing.py

@@ -351,7 +351,7 @@ def datetime_to_unix_nanoseconds(
 
 
 def optional_datetime_to_unix_nanoseconds(
-    value: pd.Timestamp | str | int | None,
+    value: pd.Timestamp | date | str | int | None,
 ) -> int | None:
     """
     Return a valid UNIX nanosecond timestamp from the given value (if not

databento/historical/api/batch.py

@@ -184,7 +184,7 @@ def submit_job(
 
     def list_jobs(
         self,
-        states: list[str] | str = "received,queued,processing,done",
+        states: Iterable[str] | str = "received,queued,processing,done",
         since: pd.Timestamp | datetime | date | str | int | None = None,
     ) -> list[dict[str, Any]]:
         """
@@ -196,8 +196,8 @@ def list_jobs(
 
         Parameters
         ----------
-        states : list[str] or str, optional {'received', 'queued', 'processing', 'done', 'expired'}  # noqa
-            The filter for jobs states as a list of comma separated values.
+        states : Iterable[str] or str, optional {'received', 'queued', 'processing', 'done', 'expired'}  # noqa
+            The filter for jobs states as an iterable of comma separated values.
         since : pd.Timestamp, datetime, date, str, or int, optional
             The filter for timestamp submitted (will not include jobs prior to this).
 

databento/historical/api/metadata.py

@@ -32,7 +32,7 @@ def __init__(self, key: str, gateway: str) -> None:
         super().__init__(key=key, gateway=gateway)
         self._base_url = gateway + f"/v{API_VERSION}/metadata"
 
-    def list_publishers(self) -> list[dict[str, Any]]:
+    def list_publishers(self) -> list[dict[str, int | str]]:
         """
         Request all publishers from Databento.
 
@@ -42,7 +42,7 @@ def list_publishers(self) -> list[dict[str, Any]]:
 
         Returns
         -------
-        list[dict[str, Any]]
+        list[dict[str, int | str]]
 
         """
         response: Response = self._get(
@@ -121,7 +121,7 @@ def list_fields(
         self,
         schema: Schema | str,
         encoding: Encoding | str,
-    ) -> list[dict[str, Any]]:
+    ) -> list[dict[str, str]]:
         """
         List all fields for a particular schema and encoding from Databento.
 
@@ -136,7 +136,7 @@ def list_fields(
 
         Returns
         -------
-        list[dict[str, Any]]
+        list[dict[str, str]]
             A list of field details.
 
         """
@@ -189,7 +189,7 @@ def get_dataset_condition(
         dataset: Dataset | str,
         start_date: date | str | None = None,
         end_date: date | str | None = None,
-    ) -> list[dict[str, str]]:
+    ) -> list[dict[str, str | None]]:
         """
         Get the per date dataset conditions from Databento.
 
@@ -210,7 +210,7 @@ def get_dataset_condition(
 
         Returns
         -------
-        list[dict[str, str]]
+        list[dict[str, str | None]]
 
         """
         params: list[tuple[str, str | None]] = [

databento/historical/api/symbology.py

@@ -44,7 +44,7 @@ def resolve(
         ----------
         dataset : Dataset or str
             The dataset code (string identifier) for the request.
-        symbols : Iterable[str | int] or str or int, optional
+        symbols : Iterable[str | int] or str or int
             The symbols to resolve. Takes up to 2,000 symbols per request.
         stype_in : SType or str, default 'raw_symbol'
             The input symbology type to resolve from.

tests/test_historical_bento.py

@@ -435,13 +435,14 @@ def test_replay_with_stub_data_record_passes_to_callback(
     stub_data = test_data(Dataset.GLBX_MDP3, Schema.MBO)
     data = DBNStore.from_bytes(data=stub_data)
 
-    handler: list[MBOMsg] = []
+    handler: list[DBNRecord] = []
 
     # Act
     data.replay(callback=handler.append)
-    record: MBOMsg = handler[0]
+    record: DBNRecord = handler[0]
 
     # Assert
+    assert isinstance(record, MBOMsg)
     assert record.hd.length == 14
     assert record.hd.rtype == 160
     assert record.hd.rtype == 160