cookiecutter_autodocs.schemas.description.CookieCutterDescription#

class cookiecutter_autodocs.schemas.description.CookieCutterDescription(*, variables: Dict[str, VariableDescription])#

Bases: SchemaBase

Schema for the cookiecutter.desc file

__init__(**data: Any) → None#

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Methods

`__init__`(**data)	Create a new model by parsing and validating input data from keyword arguments.
`construct`([_fields_set])	Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
`copy`(*[, include, exclude, update, deep])	Duplicate a model, optionally choose which fields to include, exclude and change.
`dict`(**kwargs)	Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
`from_cookiecutter_desc`(cookiecutter_desc_path)	Create a CookieCutterDescription from a cookiecutter.desc file
`from_cookiecutter_json`(cookiecutter_json_path)	Create a CookieCutterDescription from a cookiecutter.json file
`from_orm`(obj)
`json`(*[, include, exclude, by_alias, ...])	Generate a JSON representation of the model, include and exclude arguments as per dict().
`parse_file`(path, *[, content_type, ...])
`parse_obj`(obj)
`parse_raw`(b, *[, content_type, encoding, ...])
`schema`([by_alias, ref_template])
`schema_json`(*[, by_alias, ref_template])
`to_cookiecutter_desc`(cookiecutter_desc_path)	Write a cookiecutter.desc file from the CookieCutterDescription
`to_cookiecutter_json`(cookiecutter_json_path)	Write a cookiecutter.json file from the CookieCutterDescription
`update`(other)	Update the CookieCutterDescription with another CookieCutterDescription
`update_forward_refs`(**localns)	Try to update ForwardRefs on fields based on this Model, globalns and localns.
`validate`(value)
`validate_cookiecutter_json`(cookiecutter_json)	Validate the cookiecutter.json against the CookieCutterDescription

Attributes

`cookiecutter_desc_dict`	The cookiecutter.desc for this CookieCutterDescription as a dictionary
`cookiecutter_json`	The cookiecutter.json for this CookieCutterDescription as a dictionary
`variables`

classmethod construct(_fields_set: SetStr | None = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

property cookiecutter_desc_dict#: The cookiecutter.desc for this CookieCutterDescription as a dictionary

property cookiecutter_json#: The cookiecutter.json for this CookieCutterDescription as a dictionary

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns:

new model instance

dict(**kwargs) → Dict[str, Any]#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

async classmethod from_cookiecutter_desc(cookiecutter_desc_path: StrOrPath) → CookieCutterDescription#: Create a CookieCutterDescription from a cookiecutter.desc file

async classmethod from_cookiecutter_json(cookiecutter_json_path: StrOrPath) → CookieCutterDescription#: Create a CookieCutterDescription from a cookiecutter.json file

json(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, by_alias: bool = False, skip_defaults: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Callable[[Any], Any] | None = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode#

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

async to_cookiecutter_desc(cookiecutter_desc_path: StrOrPath) → None#: Write a cookiecutter.desc file from the CookieCutterDescription

async to_cookiecutter_json(cookiecutter_json_path: StrOrPath) → None#: Write a cookiecutter.json file from the CookieCutterDescription

update(other: CookieCutterDescription) → None#: Update the CookieCutterDescription with another CookieCutterDescription

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

validate_cookiecutter_json(cookiecutter_json: Dict[str, Any], allow_empty_desc=False)#: Validate the cookiecutter.json against the CookieCutterDescription