omnipy.components.json.typedefs

Type aliases describing JSON-compatible Omnipy data structures.

ATTRIBUTE	DESCRIPTION
Json	TYPE: TypeAlias
JsonDict	TYPE: TypeAlias
JsonDictOfDicts	TYPE: TypeAlias
JsonDictOfDictsOfScalars	TYPE: TypeAlias
JsonDictOfLists	TYPE: TypeAlias
JsonDictOfListsOfDicts	TYPE: TypeAlias
JsonDictOfListsOfScalars	TYPE: TypeAlias
JsonDictOfNestedLists	TYPE: TypeAlias
JsonDictOfScalars	TYPE: TypeAlias
JsonList	TYPE: TypeAlias
JsonListOfDicts	TYPE: TypeAlias
JsonListOfDictsOfScalars	TYPE: TypeAlias
JsonListOfLists	TYPE: TypeAlias
JsonListOfListsOfScalars	TYPE: TypeAlias
JsonListOfNestedDicts	TYPE: TypeAlias
JsonListOfScalars	TYPE: TypeAlias
JsonNestedDicts	TYPE: TypeAlias
JsonNestedLists	TYPE: TypeAlias
JsonOnlyDicts	TYPE: TypeAlias
JsonOnlyLists	TYPE: TypeAlias
JsonScalar	TYPE: TypeAlias

Json module-attribute

Json: TypeAlias = JsonList | JsonDict | JsonScalar

Returned by:

• Reference Code reference omnipy components json  helpers  parse_str_as_json

Used by:

• Reference Code reference omnipy components json  helpers
  •  is_json_dict
  •  is_json_list
  •  is_json_scalar

JsonDict module-attribute

JsonDict: TypeAlias = dict[str, 'Json']

Returned by:

• Reference Code reference omnipy components json  helpers
  •  is_json_dict
  •  parse_line_as_elements_of_dict

Used by:

• Reference Code reference omnipy components json  typedefs
  •  Json
  •  JsonDictOfDicts
  •  JsonListOfDicts

JsonDictOfDicts module-attribute

JsonDictOfDicts: TypeAlias = dict[str, JsonDict]

JsonDictOfDictsOfScalars module-attribute

JsonDictOfDictsOfScalars: TypeAlias = dict[str, JsonDictOfScalars]

JsonDictOfLists module-attribute

JsonDictOfLists: TypeAlias = dict[str, JsonList]

JsonDictOfListsOfDicts module-attribute

JsonDictOfListsOfDicts: TypeAlias = dict[str, JsonListOfDicts]

JsonDictOfListsOfScalars module-attribute

JsonDictOfListsOfScalars: TypeAlias = dict[str, JsonListOfScalars]

JsonDictOfNestedLists module-attribute

JsonDictOfNestedLists: TypeAlias = dict[str, JsonNestedLists]

JsonDictOfScalars module-attribute

JsonDictOfScalars: TypeAlias = dict[str, JsonScalar]

Used by:

• Reference Code reference omnipy components
  • json  typedefs  JsonDictOfDictsOfScalars
  • tables  models
    •  JsonMaxLevel1Types
    •  JsonMaxLevel2Types

JsonList module-attribute

JsonList: TypeAlias = list['Json']

Returned by:

• Reference Code reference omnipy components json  helpers
  •  is_json_list
  •  parse_line_as_elements_of_list

Used by:

• Reference Code reference omnipy components json  typedefs
  •  Json
  •  JsonDictOfLists
  •  JsonListOfLists

JsonListOfDicts module-attribute

JsonListOfDicts: TypeAlias = list[JsonDict]

Used by:

• Reference Code reference omnipy components json  typedefs  JsonDictOfListsOfDicts

JsonListOfDictsOfScalars module-attribute

JsonListOfDictsOfScalars: TypeAlias = list['JsonDictOfScalars']

JsonListOfLists module-attribute

JsonListOfLists: TypeAlias = list[JsonList]

JsonListOfListsOfScalars module-attribute

JsonListOfListsOfScalars: TypeAlias = list[JsonListOfScalars]

JsonListOfNestedDicts module-attribute

JsonListOfNestedDicts: TypeAlias = list[JsonNestedDicts]

JsonListOfScalars module-attribute

JsonListOfScalars: TypeAlias = list[JsonScalar]

Used by:

• Reference Code reference omnipy components
  • json  typedefs
    •  JsonDictOfListsOfScalars
    •  JsonListOfListsOfScalars
  • tables  models
    •  JsonMaxLevel1Types
    •  JsonMaxLevel2Types

JsonNestedDicts module-attribute

JsonNestedDicts: TypeAlias = dict[str, JsonOnlyDicts]

Used by:

• Reference Code reference omnipy components json  typedefs  JsonListOfNestedDicts

JsonNestedLists module-attribute

JsonNestedLists: TypeAlias = list[JsonOnlyLists]

Used by:

• Reference Code reference omnipy components json  typedefs  JsonDictOfNestedLists

JsonOnlyDicts module-attribute

JsonOnlyDicts: TypeAlias = 'JsonScalar | JsonNestedDicts'

Used by:

• Reference Code reference omnipy components json  typedefs  JsonNestedDicts

JsonOnlyLists module-attribute

JsonOnlyLists: TypeAlias = 'JsonScalar | JsonNestedLists'

Used by:

• Reference Code reference omnipy components json  typedefs  JsonNestedLists

JsonScalar module-attribute

JsonScalar: TypeAlias = None | int | float | str | bool

Returned by:

• Reference Code reference omnipy components json  helpers  is_json_scalar

Subclassed by:

• Reference Code reference
  •  omnipy
    •  ColumnWiseTableWithColNamesAndIndexModel
    •  JsonScalarModel
    •  PydanticRecordModel
    •  RowWiseTableModel
  • omnipy components
    • json  models  JsonScalarModel
    • tables  models
      •  ColumnWiseTableWithColNamesAndIndexModel
      •  JsonScalarColumnModel
      •  JsonScalarColumnWiseTableWithColNamesModel
      •  PydanticRecordModel
      •  RowWiseTableModel
      •  RowWiseTableWithColNamesNoConvertModel

Used by:

• Reference Code reference omnipy components
  • json  typedefs
    •  Json
    •  JsonDictOfScalars
    •  JsonListOfScalars
  • tables  models
    •  ColWiseAddOtherType
    •  JsonMaxLevel1Types
    •  JsonMaxLevel2Types