Skip to content

Commit 36b8b5a

Browse files
threecgreenthreecgreen
committed
DOC: Update references to NDJSON to JSON lines
1 parent d7c1200 commit 36b8b5a

11 files changed

+17
-17
lines changed

‎databento/common/parsing.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -424,14 +424,14 @@ def convert_datetime_columns(df: pd.DataFrame, columns: list[str]) -> None:
424424
df[column] = df[column].apply(convert_to_datetime)
425425

426426

427-
def convert_ndjson_to_df(data: bytes, compressed: bool) -> pd.DataFrame:
427+
def convert_jsonl_to_df(data: bytes, compressed: bool) -> pd.DataFrame:
428428
"""
429-
Convert the given NDJSON bytes `data` to a pandas DataFrame.
429+
Convert the given JSON lines bytes `data` to a pandas DataFrame.
430430
431431
Parameters
432432
----------
433433
data : bytes
434-
The NDJSON data as bytes to be converted.
434+
The JSON lines data as bytes to be converted.
435435
compressed : bool
436436
If the content is zstd compressed.
437437

‎databento/reference/api/adjustment.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from databento.common.http import BentoHttpAPI
1414
from databento.common.parsing import convert_date_columns
1515
from databento.common.parsing import convert_datetime_columns
16-
from databento.common.parsing import convert_ndjson_to_df
16+
from databento.common.parsing import convert_jsonl_to_df
1717
from databento.common.parsing import datetime_to_string
1818
from databento.common.parsing import optional_datetime_to_string
1919
from databento.common.parsing import optional_string_to_list
@@ -100,7 +100,7 @@ def get_range(
100100
basic_auth=True,
101101
)
102102

103-
df = convert_ndjson_to_df(response.content, compressed=True)
103+
df = convert_jsonl_to_df(response.content, compressed=True)
104104
if df.empty:
105105
return df
106106

‎databento/reference/api/corporate.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from databento.common.http import BentoHttpAPI
1414
from databento.common.parsing import convert_date_columns
1515
from databento.common.parsing import convert_datetime_columns
16-
from databento.common.parsing import convert_ndjson_to_df
16+
from databento.common.parsing import convert_jsonl_to_df
1717
from databento.common.parsing import datetime_to_string
1818
from databento.common.parsing import optional_datetime_to_string
1919
from databento.common.parsing import optional_string_to_list
@@ -126,7 +126,7 @@ def get_range(
126126
basic_auth=True,
127127
)
128128

129-
df = convert_ndjson_to_df(response.content, compressed=True)
129+
df = convert_jsonl_to_df(response.content, compressed=True)
130130
if df.empty:
131131
return df
132132

‎databento/reference/api/security.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from databento.common.http import BentoHttpAPI
1414
from databento.common.parsing import convert_date_columns
1515
from databento.common.parsing import convert_datetime_columns
16-
from databento.common.parsing import convert_ndjson_to_df
16+
from databento.common.parsing import convert_jsonl_to_df
1717
from databento.common.parsing import datetime_to_string
1818
from databento.common.parsing import optional_datetime_to_string
1919
from databento.common.parsing import optional_string_to_list
@@ -107,7 +107,7 @@ def get_range(
107107
basic_auth=True,
108108
)
109109

110-
df = convert_ndjson_to_df(response.content, compressed=True)
110+
df = convert_jsonl_to_df(response.content, compressed=True)
111111
if df.empty:
112112
return df
113113

@@ -178,7 +178,7 @@ def get_last(
178178
basic_auth=True,
179179
)
180180

181-
df = convert_ndjson_to_df(response.content, compressed=True)
181+
df = convert_jsonl_to_df(response.content, compressed=True)
182182
if df.empty:
183183
return df
184184

tests/data/REFERENCE/test_data.adjustment-factors.ndjson renamed to tests/data/REFERENCE/test_data.adjustment-factors.jsonl

File renamed without changes.

tests/data/REFERENCE/test_data.corporate-actions-pit.ndjson renamed to tests/data/REFERENCE/test_data.corporate-actions-pit.jsonl

File renamed without changes.

tests/data/REFERENCE/test_data.corporate-actions.ndjson renamed to tests/data/REFERENCE/test_data.corporate-actions.jsonl

File renamed without changes.

tests/data/REFERENCE/test_data.security-master.ndjson renamed to tests/data/REFERENCE/test_data.security-master.jsonl

File renamed without changes.

‎tests/test_reference_adjustment.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ def test_adjustment_factors_get_range_response(
128128
) -> None:
129129
# Arrange
130130
mock_response = MagicMock()
131-
data_path = Path(TESTS_ROOT) / "data" / "REFERENCE" / "test_data.adjustment-factors.ndjson"
131+
data_path = Path(TESTS_ROOT) / "data" / "REFERENCE" / "test_data.adjustment-factors.jsonl"
132132
mock_response.content = zstandard.compress(data_path.read_bytes())
133133
mock_response.__enter__.return_value = mock_response
134134
mock_response.__exit__ = MagicMock()

‎tests/test_reference_corporate.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ def test_corporate_actions_get_range_response_parsing_as_pit(
145145
reference_client: Reference,
146146
) -> None:
147147
# Arrange
148-
data_path = Path(TESTS_ROOT) / "data" / "REFERENCE" / "test_data.corporate-actions.ndjson"
148+
data_path = Path(TESTS_ROOT) / "data" / "REFERENCE" / "test_data.corporate-actions.jsonl"
149149
mock_response = MagicMock()
150150
mock_response.content = zstandard.compress(data_path.read_bytes())
151151
mock_response.__enter__.return_value = mock_response
@@ -176,7 +176,7 @@ def test_corporate_actions_get_range_response(
176176
reference_client: Reference,
177177
) -> None:
178178
# Arrange
179-
data_path = Path(TESTS_ROOT) / "data" / "REFERENCE" / "test_data.corporate-actions-pit.ndjson"
179+
data_path = Path(TESTS_ROOT) / "data" / "REFERENCE" / "test_data.corporate-actions-pit.jsonl"
180180
mock_response = MagicMock()
181181
mock_response.content = zstandard.compress(data_path.read_bytes())
182182
mock_response.__enter__.return_value = mock_response
@@ -202,7 +202,7 @@ def test_corporate_actions_get_range_with_ts_record_index(
202202
reference_client: Reference,
203203
) -> None:
204204
# Arrange
205-
data_path = Path(TESTS_ROOT) / "data" / "REFERENCE" / "test_data.corporate-actions.ndjson"
205+
data_path = Path(TESTS_ROOT) / "data" / "REFERENCE" / "test_data.corporate-actions.jsonl"
206206
mock_response = MagicMock()
207207
mock_response.content = zstandard.compress(data_path.read_bytes())
208208
mock_response.__enter__.return_value = mock_response
@@ -236,7 +236,7 @@ def test_corporate_actions_get_range_without_flattening(
236236
reference_client: Reference,
237237
) -> None:
238238
# Arrange
239-
data_path = Path(TESTS_ROOT) / "data" / "REFERENCE" / "test_data.corporate-actions.ndjson"
239+
data_path = Path(TESTS_ROOT) / "data" / "REFERENCE" / "test_data.corporate-actions.jsonl"
240240
mock_response = MagicMock()
241241
mock_response.content = zstandard.compress(data_path.read_bytes())
242242
mock_response.__enter__.return_value = mock_response

0 commit comments

Comments
 (0)