Skip to content

Add read method for yielding transformed records to TIMDEXDataset #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonavellecuerdo merged 1 commit into from
Jan 7, 2025
Merged

Add read method for yielding transformed records to TIMDEXDataset #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions tests/test_dataset_read.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,10 @@ def test_read_dicts_filter_to_none_stopiteration_immediately(fixed_local_dataset
batches = fixed_local_dataset.read_dicts_iter(source="not-gonna-find-me")
with pytest.raises(StopIteration):
next(batches)


def test_read_transformed_records_yields_parsed_dictionary(fixed_local_dataset):
batches = fixed_local_dataset.read_transformed_records_iter()
transformed_record = next(batches)
assert isinstance(transformed_record, dict)
assert transformed_record == {"title": ["Hello World."]}
17 changes: 17 additions & 0 deletions timdex_dataset_api/dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""timdex_dataset_api/dataset.py"""

import itertools
import json
import operator
import time
import uuid
Expand Down Expand Up @@ -468,3 +469,19 @@ def read_dicts_iter(
columns=columns, batch_size=batch_size, **filters
):
yield from record_batch.to_pylist()

def read_transformed_records_iter(
self,
batch_size: int = DEFAULT_BATCH_SIZE,
**filters: Unpack[DatasetFilters],
) -> Iterator[dict]:
"""Yield individual transformed records as dictionaries from the dataset.

If 'transformed_record' is None (i.e., action="skip"|"error"), the yield
statement will not be executed for the row.
"""
for record_dict in self.read_dicts_iter(
columns=["transformed_record"], batch_size=batch_size, **filters
):
if transformed_record := record_dict["transformed_record"]:
yield json.loads(transformed_record)
Loading