MOD: Standardize optional default arguments

Author: cjdsellers

databento/common/bento.py

@@ -592,44 +592,76 @@ def to_file(self, path: Union[Path, str]) -> "FileBento":
 
         return bento
 
-    def to_csv(self, path: Union[Path, str]) -> None:
+    def to_csv(
+        self,
+        path: Union[Path, str],
+        pretty_ts: bool = True,
+        pretty_px: bool = True,
+        map_symbols: bool = True,
+    ) -> None:
         """
         Write the data to a file in CSV format.
 
         Parameters
         ----------
         path : Path or str
             The file path to write to.
+        pretty_ts : bool, default True
+            If all timestamp columns should be converted from UNIX nanosecond
+            `int` to `pd.Timestamp` tz-aware (UTC).
+        pretty_px : bool, default True
+            If all price columns should be converted from `int` to `float` at
+            the correct scale (using the fixed precision scalar 1e-9).
+        map_symbols : bool, default True
+            If symbology mappings from the metadata should be used to create
+            a 'symbol' column, mapping the product ID to its native symbol for
+            every record.
 
         Notes
         -----
         Requires all the data to be brought up into memory to then be written.
 
         """
         self.to_df(
-            pretty_ts=False,
-            pretty_px=False,
-            map_symbols=False,
+            pretty_ts=pretty_ts,
+            pretty_px=pretty_px,
+            map_symbols=map_symbols,
         ).to_csv(path)
 
-    def to_json(self, path: Union[Path, str]) -> None:
+    def to_json(
+        self,
+        path: Union[Path, str],
+        pretty_ts: bool = True,
+        pretty_px: bool = True,
+        map_symbols: bool = True,
+    ) -> None:
         """
         Write the data to a file in JSON format.
 
         Parameters
         ----------
         path : Path or str
             The file path to write to.
+        pretty_ts : bool, default True
+            If all timestamp columns should be converted from UNIX nanosecond
+            `int` to `pd.Timestamp` tz-aware (UTC).
+        pretty_px : bool, default True
+            If all price columns should be converted from `int` to `float` at
+            the correct scale (using the fixed precision scalar 1e-9).
+        map_symbols : bool, default True
+            If symbology mappings from the metadata should be used to create
+            a 'symbol' column, mapping the product ID to its native symbol for
+            every record.
 
         Notes
         -----
         Requires all the data to be brought up into memory to then be written.
 
         """
         self.to_df(
-            pretty_ts=False,
-            pretty_px=False,
-            map_symbols=False,
+            pretty_ts=pretty_ts,
+            pretty_px=pretty_px,
+            map_symbols=map_symbols,
         ).to_json(path, orient="records", lines=True)
 
     def request_symbology(self, client: "Historical") -> Dict[str, Any]:

examples/historical_batch_download.py

@@ -2,7 +2,7 @@
 
 
 if __name__ == "__main__":
-    db.log = "debug"  # optional debug logging
+    db.log = "debug"  # Optional debug logging
 
     key = "YOUR_API_KEY"
     client = db.Historical(key=key)

examples/historical_batch_list_jobs.py

@@ -4,14 +4,14 @@
 
 
 if __name__ == "__main__":
-    db.log = "debug"  # optional debug logging
+    db.log = "debug"  # Optional debug logging
 
     key = "YOUR_API_KEY"
     client = db.Historical(key=key)
 
     response = client.batch.list_jobs(
-        states="received,queued,processing,done",
-        since=None,
+        states="received,queued,processing,done",  # Included states
+        since=None,  # <-- Filter for jobs 'since' the given time
     )
 
     pprint(response)

examples/historical_batch_submit_job.py

@@ -4,7 +4,7 @@
 
 
 if __name__ == "__main__":
-    db.log = "debug"  # optional debug logging
+    db.log = "debug"  # Optional debug logging
 
     key = "YOUR_API_KEY"
     client = db.Historical(key=key)
@@ -15,7 +15,7 @@
         schema="mbo",
         start="2022-06-10T12:00",
         end="2022-06-10T14:00",
-        limit=1000,  # <-- limiting batch request to 1000 records only
+        limit=1000,  # <-- Limiting batch request to 1000 records only
         encoding="csv",
         compression="zstd",
         delivery="download",

examples/historical_metadata.py

@@ -2,7 +2,7 @@
 
 
 if __name__ == "__main__":
-    db.log = "debug"  # optional debug logging
+    db.log = "debug"  # Optional debug logging
 
     key = "YOUR_API_KEY"
     client = db.Historical(key=key)

examples/historical_metadata_get_billable_size.py

@@ -2,7 +2,7 @@
 
 
 if __name__ == "__main__":
-    db.log = "debug"  # optional debug logging
+    db.log = "debug"  # Optional debug logging
 
     key = "YOUR_API_KEY"
     client = db.Historical(key=key)

examples/historical_metadata_get_cost.py

@@ -2,7 +2,7 @@
 
 
 if __name__ == "__main__":
-    db.log = "debug"  # optional debug logging
+    db.log = "debug"  # Optional debug logging
 
     key = "YOUR_API_KEY"
     client = db.Historical(key=key)

examples/historical_metadata_get_record_count.py

@@ -2,7 +2,7 @@
 
 
 if __name__ == "__main__":
-    db.log = "debug"  # optional debug logging
+    db.log = "debug"  # Optional debug logging
 
     key = "YOUR_API_KEY"
     client = db.Historical(key=key)

examples/historical_metadata_list_unit_price.py

@@ -4,7 +4,7 @@
 
 
 if __name__ == "__main__":
-    db.log = "debug"  # optional debug logging
+    db.log = "debug"  # Optional debug logging
 
     key = "YOUR_API_KEY"
     client = db.Historical(key=key)

examples/historical_symbology_resolve.py

@@ -5,7 +5,7 @@
 
 
 if __name__ == "__main__":
-    db.log = "debug"  # optional debug logging
+    db.log = "debug"  # Optional debug logging
 
     key = "YOUR_API_KEY"
     client = db.Historical(key=key)