orangeqs.juice._sphinx._parsing#

Module Contents#

Functions#

walk_schema

Walk the JSON schema of a Configurable class.

API#

orangeqs.juice._sphinx._parsing.walk_schema(config_class: type[orangeqs.juice.settings.Configurable]) → collections.abc.Generator[tuple[str, str | None, dict[str, Any]], None, None]#

Walk the JSON schema of a Configurable class.

Parameters#

  • config_class (type[Configurable]): The Configurable class to walk the schema of.

Yields#

  • (str): The full path of the field.

  • (str | None): The model name if the field is a model, else None.

  • (dict[str, Any]): The schema of the field.