create_config_schema#

create_config_schema(output_folder: Path | str | None = None, file_name: Path | str = 'pygta_config.schema.json') → Path[source]#

Create json schema file to be used for autocompletion and linting of the config.

Parameters:

  • output_folder (Path | str | None) –

    Folder to write schema file to. Defaults to None, which means that the script

    folder is used

  • file_name (Path | str) – Name of the scheme file. Defaults to “pygta_config.schema.json”

Returns:

Path to the file the schema got saved to.

Return type:

Path

Raises:

UsePlotConfigError – If any function decorated with use_plot_config has a keyword argument with a default value and a type annotation that can not be serialized into a json schema.