Module omnipy.modules.json.functions

Overview

View Source

from copy import copy

from typing import cast

from .typedefs import (JsonDict,

                       JsonDictOfListsOfDicts,

                       JsonDictOfScalars,

                       JsonList,

                       JsonListOfDicts,

                       JsonScalar)

def flatten_outer_level_of_nested_record(

    nested_record: JsonDict,

    record_id: str,

    data_file_title: str,

    id_key: str,

    ref_key: str,

    default_key: str,

) -> tuple[JsonDictOfScalars, JsonDictOfListsOfDicts]:

    record_id = ensure_item_first_in_nested_record(nested_record, key=id_key, value=record_id)

    new_data_files: JsonDictOfListsOfDicts = JsonDictOfListsOfDicts()

    records_of_scalars: JsonDictOfScalars = JsonDictOfScalars()

    for key, value in nested_record.items():

        if any(isinstance(value, typ) for typ in (dict, list)):

            new_data_file_title: str = f'{data_file_title}.{key}'

            new_data_file: JsonListOfDicts = transform_into_list_of_dicts(

                cast(JsonList | JsonDict, value), default_key=default_key)

            add_references_to_parent_in_child_records(

                child=new_data_file, parent_title=data_file_title, ident=record_id, ref_key=ref_key)

            new_data_files[new_data_file_title] = new_data_file

        else:

            records_of_scalars[key] = cast(JsonScalar, value)

    return records_of_scalars, new_data_files

def ensure_item_first_in_nested_record(

    nested_record: JsonDict,

    key: str,

    value: str,

    fail_if_present: bool = False,

) -> str:

    if key in nested_record:

        assert not fail_if_present, f'Key "{key}" already present in dict'

        del nested_record[key]

    update_dict_from_front(nested_record, {key: value})

    return value

def update_dict_from_front(dict_a: dict, dict_b: dict) -> None:

    dict_a_copy = copy(dict_a)

    dict_a.clear()

    dict_a.update(dict_b)

    dict_a.update(dict_a_copy)

def transform_into_list_of_dicts(value: JsonList | JsonDict, default_key: str) -> JsonListOfDicts:

    if isinstance(value, dict):

        return JsonListOfDicts([value])

    else:

        ret_value = JsonListOfDicts()

        for list_val in value:

            if isinstance(list_val, dict):

                ret_value.append(list_val)

            else:

                new_nested_record = JsonDict({default_key: list_val})

                ret_value.append(new_nested_record)

        return ret_value

def add_references_to_parent_in_child_records(

    child: JsonListOfDicts,

    parent_title: str,

    ident: str,

    ref_key: str,

):

    ref_value = get_ref_value(parent_title, ident)

    for new_nested_record in child:

        ensure_item_first_in_nested_record(

            new_nested_record, key=ref_key, value=ref_value, fail_if_present=True)

def get_ref_value(data_file_title: str, ident: str) -> str:

    return f'{data_file_title}.{ident}'

Functions

add_references_to_parent_in_child_records

def add_references_to_parent_in_child_records(
    child: list[dict[str, 'Json']],
    parent_title: str,
    ident: str,
    ref_key: str
)

Parameters:

Name	Type	Description	Default
child	list[dict[str, 'Json']]
parent_title	str
ident	str
ref_key	str

View Source

def add_references_to_parent_in_child_records(

    child: JsonListOfDicts,

    parent_title: str,

    ident: str,

    ref_key: str,

):

    ref_value = get_ref_value(parent_title, ident)

    for new_nested_record in child:

        ensure_item_first_in_nested_record(

            new_nested_record, key=ref_key, value=ref_value, fail_if_present=True)

ensure_item_first_in_nested_record

def ensure_item_first_in_nested_record(
    nested_record: dict[str, 'Json'],
    key: str,
    value: str,
    fail_if_present: bool = False
) -> str

Parameters:

Name	Type	Description	Default
nested_record	dict[str, 'Json']
key	str
value	str
fail_if_present	bool

Returns:

Type	Description
str

View Source

def ensure_item_first_in_nested_record(

    nested_record: JsonDict,

    key: str,

    value: str,

    fail_if_present: bool = False,

) -> str:

    if key in nested_record:

        assert not fail_if_present, f'Key "{key}" already present in dict'

        del nested_record[key]

    update_dict_from_front(nested_record, {key: value})

    return value

flatten_outer_level_of_nested_record

def flatten_outer_level_of_nested_record(
    nested_record: dict[str, 'Json'],
    record_id: str,
    data_file_title: str,
    id_key: str,
    ref_key: str,
    default_key: str
) -> tuple[dict[str, None | int | float | str | bool], dict[str, list[dict[str, 'Json']]]]

Parameters:

Name	Type	Description	Default
nested_record	dict[str, 'Json']
record_id	str
data_file_title	str
id_key	str
ref_key	str
default_key	str

Returns:

Type	Description
tuple[dict[str, None	int

View Source

def flatten_outer_level_of_nested_record(

    nested_record: JsonDict,

    record_id: str,

    data_file_title: str,

    id_key: str,

    ref_key: str,

    default_key: str,

) -> tuple[JsonDictOfScalars, JsonDictOfListsOfDicts]:

    record_id = ensure_item_first_in_nested_record(nested_record, key=id_key, value=record_id)

    new_data_files: JsonDictOfListsOfDicts = JsonDictOfListsOfDicts()

    records_of_scalars: JsonDictOfScalars = JsonDictOfScalars()

    for key, value in nested_record.items():

        if any(isinstance(value, typ) for typ in (dict, list)):

            new_data_file_title: str = f'{data_file_title}.{key}'

            new_data_file: JsonListOfDicts = transform_into_list_of_dicts(

                cast(JsonList | JsonDict, value), default_key=default_key)

            add_references_to_parent_in_child_records(

                child=new_data_file, parent_title=data_file_title, ident=record_id, ref_key=ref_key)

            new_data_files[new_data_file_title] = new_data_file

        else:

            records_of_scalars[key] = cast(JsonScalar, value)

    return records_of_scalars, new_data_files

get_ref_value

def get_ref_value(
    data_file_title: str,
    ident: str
) -> str

Parameters:

Name	Type	Description	Default
data_file_title	str
ident	str

Returns:

Type	Description
str

View Source

def get_ref_value(data_file_title: str, ident: str) -> str:

    return f'{data_file_title}.{ident}'

transform_into_list_of_dicts

def transform_into_list_of_dicts(
    value: list['Json'] | dict[str, 'Json'],
    default_key: str
) -> list[dict[str, 'Json']]

Parameters:

Name	Type	Description	Default
value	list['Json']	dict[str, 'Json']
default_key	str

Returns:

Type	Description
list[dict[str, 'Json']]

View Source

def transform_into_list_of_dicts(value: JsonList | JsonDict, default_key: str) -> JsonListOfDicts:

    if isinstance(value, dict):

        return JsonListOfDicts([value])

    else:

        ret_value = JsonListOfDicts()

        for list_val in value:

            if isinstance(list_val, dict):

                ret_value.append(list_val)

            else:

                new_nested_record = JsonDict({default_key: list_val})

                ret_value.append(new_nested_record)

        return ret_value

update_dict_from_front

def update_dict_from_front(
    dict_a: dict,
    dict_b: dict
) -> None

Parameters:

Name	Type	Description	Default
dict_a	dict
dict_b	dict

Returns:

Type	Description
NoneType

View Source

def update_dict_from_front(dict_a: dict, dict_b: dict) -> None:

    dict_a_copy = copy(dict_a)

    dict_a.clear()

    dict_a.update(dict_b)

    dict_a.update(dict_a_copy)