test_autodoc module

class test_autodoc.MyModule(*args, **kwargs)[source]

Bases: argschema.argschema_parser.ArgSchemaParser

Note

This class takes a ArgSchema as an input to parse inputs , with a default schema of type SchemaWithQuotedDescriptions

default_schema

alias of SchemaWithQuotedDescriptions

class test_autodoc.SchemaWithQuotedDescriptions(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]

Bases: argschema.schemas.ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object
SchemaWithQuotedDescriptions
key description default field_type json_type
input_json file path of input json file NA InputFile str
output_json file path to output json file NA OutputFile str
log_level set the logging level of the module ERROR LogLevel str
a something that is ‘quoted’ is problematic (REQUIRED) Integer int
opts = <marshmallow.schema.SchemaOpts object>
test_autodoc.test_autodoc()[source]
test_autodoc.test_autodoc_argschemaparser()[source]
test_autodoc.test_autodoc_list()[source]
test_autodoc.test_autodoc_myparser()[source]
test_autodoc.test_autodoc_nested()[source]
test_autodoc.test_autodoc_quotes()[source]
test_autodoc.test_autodoc_recursive_nested()[source]
test_autodoc.test_autodoc_slice()[source]
test_autodoc.test_new_default_schema()[source]
test_autodoc.validate_rst_lines(lines, level=2)[source]

validates a set of lines that would make up an rst file using rstcheck

Parameters:
  • lines (list[str]) – a list of lines that would compose some restructuredText
  • level (docutils.utils.Reporter.WARNING_LEVEL) – the reporting level to hold this to
Returns:

Return type:

None

Raises:

AssertionError – If the lines contain any errors above the level