ADD: Add Py client batch.submit_job map_symbols

Author: cjdsellers

databento/common/dbnstore.py

@@ -847,7 +847,7 @@ def to_csv(
             prices are replaced with an empty string.
         map_symbols : bool, default True
             If symbology mappings from the metadata should be used to create
-            a 'symbol' column, mapping the instrument ID to its native symbol for
+            a 'symbol' column, mapping the instrument ID to its requested symbol for
             every record.
         schema : Schema or str, optional
             The schema for the csv.
@@ -922,7 +922,7 @@ def to_df(
             prices are replaced with NaN.
         map_symbols : bool, default True
             If symbology mappings from the metadata should be used to create
-            a 'symbol' column, mapping the instrument ID to its native symbol for
+            a 'symbol' column, mapping the instrument ID to its requested symbol for
             every record.
         schema : Schema or str, optional
             The schema for the dataframe.
@@ -1020,7 +1020,7 @@ def to_json(
             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 instrument ID to its native symbol for
+            a 'symbol' column, mapping the instrument ID to its requested symbol for
             every record.
         schema : Schema or str, optional
             The schema for the json.

databento/historical/api/batch.py

@@ -54,6 +54,7 @@ def submit_job(
         end: pd.Timestamp | date | str | int | None = None,
         encoding: Encoding | str = "dbn",
         compression: Compression | str = "zstd",
+        map_symbols: bool = False,
         split_duration: SplitDuration | str = "day",
         split_size: int | None = None,
         packaging: Packaging | str | None = None,
@@ -91,6 +92,9 @@ def submit_job(
             The data encoding.
         compression : Compression or str {'none', 'zstd'}, default 'zstd'
             The data compression format (if any).
+        map_symbols : bool, default False
+            If the raw symbol should be appended to every text encoded record.
+            Must be requested with either 'csv' or 'json' encoding.
         split_duration : SplitDuration or str {'day', 'week', 'month', 'none'}, default 'day'
             The maximum time duration before batched data is split into multiple files.
             A week starts on Sunday UTC.
@@ -131,7 +135,10 @@ def submit_job(
             "compression": str(validate_enum(compression, Compression, "compression"))
             if compression
             else None,
-            "split_duration": str(validate_enum(split_duration, SplitDuration, "split_duration")),
+            "map_symbols": map_symbols,
+            "split_duration": str(
+                validate_enum(split_duration, SplitDuration, "split_duration"),
+            ),
             "packaging": str(validate_enum(packaging, Packaging, "packaging"))
             if packaging
             else None,

tests/test_historical_batch.py

@@ -77,7 +77,9 @@ def test_batch_submit_job_sends_expected_request(
 
     # Assert
     call = mocked_post.call_args.kwargs
-    assert call["url"] == f"{historical_client.gateway}/v{db.API_VERSION}/batch.submit_job"
+    assert (
+        call["url"] == f"{historical_client.gateway}/v{db.API_VERSION}/batch.submit_job"
+    )
     assert sorted(call["headers"].keys()) == ["accept", "user-agent"]
     assert call["headers"]["accept"] == "application/json"
     assert all(v in call["headers"]["user-agent"] for v in ("Databento/", "Python/"))
@@ -91,6 +93,7 @@ def test_batch_submit_job_sends_expected_request(
         "stype_out": "instrument_id",
         "encoding": "csv",
         "compression": "zstd",
+        "map_symbols": False,
         "split_duration": "day",
         "packaging": "none",
         "delivery": "download",
@@ -112,7 +115,9 @@ def test_batch_list_jobs_sends_expected_request(
 
     # Assert
     call = mocked_get.call_args.kwargs
-    assert call["url"] == f"{historical_client.gateway}/v{db.API_VERSION}/batch.list_jobs"
+    assert (
+        call["url"] == f"{historical_client.gateway}/v{db.API_VERSION}/batch.list_jobs"
+    )
     assert sorted(call["headers"].keys()) == ["accept", "user-agent"]
     assert call["headers"]["accept"] == "application/json"
     assert all(v in call["headers"]["user-agent"] for v in ("Databento/", "Python/"))
@@ -137,7 +142,9 @@ def test_batch_list_files_sends_expected_request(
 
     # Assert
     call = mocked_get.call_args.kwargs
-    assert call["url"] == f"{historical_client.gateway}/v{db.API_VERSION}/batch.list_files"
+    assert (
+        call["url"] == f"{historical_client.gateway}/v{db.API_VERSION}/batch.list_files"
+    )
     assert sorted(call["headers"].keys()) == ["accept", "user-agent"]
     assert call["headers"]["accept"] == "application/json"
     assert all(v in call["headers"]["user-agent"] for v in ("Databento/", "Python/"))
@@ -168,7 +175,9 @@ def test_batch_download_single_file_sends_expected_request(
 
     # Assert
     call = mocked_get.call_args.kwargs
-    assert call["url"] == f"{historical_client.gateway}/v{db.API_VERSION}/batch.list_files"
+    assert (
+        call["url"] == f"{historical_client.gateway}/v{db.API_VERSION}/batch.list_files"
+    )
     assert sorted(call["headers"].keys()) == ["accept", "user-agent"]
     assert call["headers"]["accept"] == "application/json"
     assert all(v in call["headers"]["user-agent"] for v in ("Databento/", "Python/"))