bo4e.utils package

Module contents

utils necessary for reflection/inspection and documentation runs

bo4e.utils.add_comments_to_description(cls: type[T]) → type[T]

Add comments of fields to the description of the fields. This enables the generation of JSON-Schemas with proper descriptions.

bo4e.utils.postprocess_docstring(cls: type[T]) → type[T]

Postprocess the docstring to inject the __gh_version__ for proper linking of the JSON-schemas. Note that doc-strings in Python have to be string literals, so we cannot use f-strings. Additionally, we add the comments to the description of the fields to enable the generation of JSON-Schemas with proper descriptions.