Skip to content

omnipy.components.json.flows

JSON flows for flattening and transposing structured JSON datasets.

FUNCTION DESCRIPTION
flatten_nested_json

Flatten nested JSON records into scalar-only records.
transpose_dict_of_dicts_2_list_of_dicts

Transpose a dataset of dictionaries of dictionaries into lists of dictionaries.
transpose_dicts_of_lists_of_dicts_2_lists_of_dicts

Transpose a dataset of dictionaries of lists of dictionaries into lists of dictionaries.

flatten_nested_json 

flatten_nested_json(
    dataset: JsonListOfDictsDataset, id_key: str, ref_key: str, default_key: str
) -> JsonListOfDictsOfScalarsDataset

Flatten nested JSON records into scalar-only records.

Repeatedly flattens one nesting level at a time until only dictionaries of scalars remain.

Source code in src/omnipy/components/json/flows.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@FuncFlowTemplate(fixed_params=dict(id_key=ID_KEY, ref_key=REF_KEY, default_key=DEFAULT_KEY))
def flatten_nested_json(
    dataset: JsonListOfDictsDataset,
    id_key: str,
    ref_key: str,
    default_key: str,
) -> JsonListOfDictsOfScalarsDataset:
    """Flatten nested JSON records into scalar-only records.

    Repeatedly flattens one nesting level at a time until only dictionaries of scalars remain.
    """
    all_data_files_of_scalar_records_ds = JsonListOfDictsOfScalarsDataset()
    data_files_of_any_ds = dataset

    while len(data_files_of_any_ds) > 0:
        data_files_of_scalar_records_ds, data_files_of_any_ds = \
            _flatten_outer_level_of_all_data_files(
                data_files_of_any_ds, id_key, ref_key, default_key)

        all_data_files_of_scalar_records_ds |= data_files_of_scalar_records_ds

    return all_data_files_of_scalar_records_ds

transpose_dict_of_dicts_2_list_of_dicts 

transpose_dict_of_dicts_2_list_of_dicts(
    dataset: JsonDictOfDictsDataset, id_key: str = ID_KEY
) -> JsonListOfDictsDataset

Transpose a dataset of dictionaries of dictionaries into lists of dictionaries.

Adds the original outer key to each emitted record under id_key.

Source code in src/omnipy/components/json/flows.py 
37
38
39
40
41
42
43
44
45
46
47
48
@FuncFlowTemplate()
def transpose_dict_of_dicts_2_list_of_dicts(
    dataset: JsonDictOfDictsDataset,
    id_key: str = ID_KEY,
) -> JsonListOfDictsDataset:
    """Transpose a dataset of dictionaries of dictionaries into lists of dictionaries.

    Adds the original outer key to each emitted record under ``id_key``.
    """
    output_dataset = JsonListOfDictsDataset()
    output_dataset |= transpose_dicts_2_lists(dataset, id_key=id_key)
    return output_dataset

transpose_dicts_of_lists_of_dicts_2_lists_of_dicts 

transpose_dicts_of_lists_of_dicts_2_lists_of_dicts(
    dataset: JsonDictOfListsOfDictsDataset, id_key: str = ID_KEY
) -> JsonListOfDictsDataset

Transpose a dataset of dictionaries of lists of dictionaries into lists of dictionaries.

Adds the original outer key to each emitted record under id_key.

Source code in src/omnipy/components/json/flows.py 
51
52
53
54
55
56
57
58
59
60
61
62
@FuncFlowTemplate()
def transpose_dicts_of_lists_of_dicts_2_lists_of_dicts(
    dataset: JsonDictOfListsOfDictsDataset,
    id_key: str = ID_KEY,
) -> JsonListOfDictsDataset:
    """Transpose a dataset of dictionaries of lists of dictionaries into lists of dictionaries.

    Adds the original outer key to each emitted record under ``id_key``.
    """
    output_dataset = JsonListOfDictsDataset()
    output_dataset |= transpose_dicts_2_lists(dataset, id_key=id_key)
    return output_dataset