jsonschema_diff.config_maker

Factory for a ready-to-use jsonschema_diff.core.Config instance.

All optional switches are enabled by default; pass False to disable.

Classes

ConfigMaker

Helper that builds a fully populated Config.

Module Contents

class ConfigMaker[source]

Helper that builds a fully populated Config.

static make(
*,
tab_size: int = 2,
path_render_with_properies: bool = False,
path_render_with_items: bool = False,
list_comparator: bool = True,
range_digit_comparator: bool = True,
range_length_comparator: bool = True,
range_items_comparator: bool = True,
range_properties_comparator: bool = True,
additional_compare_rules: jsonschema_diff.core.tools.compare.COMPARE_RULES_TYPE = {},
additional_combine_rules: jsonschema_diff.core.tools.combine.COMBINE_RULES_TYPE = [],
additional_pair_context_rules: jsonschema_diff.core.tools.context.PAIR_CONTEXT_RULES_TYPE = [],
additional_context_rules: jsonschema_diff.core.tools.context.CONTEXT_RULES_TYPE = {},
additional_path_maker_ignore: jsonschema_diff.core.tools.render.PATH_MAKER_IGNORE_RULES_TYPE = [],
) → Config[source]

Assemble and return a Config.

Parameters:

  • tab_size (int) – Number of spaces per indentation level.

  • path_render_with_properies (bool) – Include these schema service tokens in rendered paths.

  • path_render_with_items (bool) – Include these schema service tokens in rendered paths.

  • list_comparator (bool) – Enable CompareList.

  • range_*_comparator (bool) – Enable CompareRange for numeric/length/items/properties limits.

  • additional_* (collections) – User-supplied rules that override the built-ins.