mario package¶

Subpackages¶

mario.plugins package

Submodules¶

mario.app module¶

Command line pipes in python.

async mario.app.async_main(basic_traversals, **kwargs)[source]¶

async mario.app.call_traversal(context, traversal, items, exit_stack)[source]¶

mario.app.main(pairs, **kwargs)[source]¶

async mario.app.program_runner(traversals, items, context)[source]¶

mario.asynch module¶

Command line pipes in python.

class mario.asynch.TerminatedFrameReceiver(stream, terminator, max_frame_length=16384)[source]¶

Bases: object

Parse frames out of a Trio stream, where each frame is terminated by a

fixed byte sequence.

For example, you can parse newline-terminated lines by setting the terminator to b”

“.

This uses some tricks to protect against denial of service attacks:

It puts a limit on the maximum frame size, to avoid memory overflow; you

might want to adjust the limit for your situation.

It uses some algorithmic trickiness to avoid “slow loris” attacks. All algorithms are amortized O(n) in the length of the input.

async receive()[source]¶

Return type: bytearray

mario.cli module¶

class mario.cli.SectionedContext(*args, sections, **kwargs)[source]¶

Bases: click.core.Context

make_formatter()[source]¶: Creates the formatter for the help and usage output.

class mario.cli.SectionedFormatter(*args, sections, **kwargs)[source]¶

Bases: click.formatting.HelpFormatter

write_dl(rows, *args, **kwargs)[source]¶

Writes a definition list into the buffer. This is how options and commands are usually formatted.

Parameters

rows – a list of two item tuples for the terms and values.
col_max – the maximum width of the first column.
col_spacing – the number of spaces between the first and second column.

class mario.cli.SectionedGroup(*args, sections, **kwargs)[source]¶

Bases: click.core.Group

format_commands(ctx, formatter)[source]¶: Extra format methods for multi methods that adds all the commands after the options.

make_context(info_name, args, parent=None, **extra)[source]¶

This function when given an info name and arguments will kick off the parsing and create a new Context. It does not invoke the actual command callback though.

Parameters

info_name – the info name for this invokation. Generally this is the most descriptive name for the script or command. For the toplevel script it’s usually the name of the script, for commands below it it’s the name of the script.
args – the arguments to parse as list of strings.
parent – the parent context if available.
extra – extra keyword arguments forwarded to the context constructor.

mario.cli.build_stages(command)[source]¶

mario.cli.cli_main(pairs, **kwargs)[source]¶

mario.cli.version_option(ctx, param, value)[source]¶

mario.cli_tools module¶

class mario.cli_tools.CommandInSection(*args, section=None, **kwargs)[source]¶: Bases: click.core.Command

class mario.cli_tools.DocumentedCommand(*args, section=None, **kwargs)[source]¶: Bases: mario.cli_tools.ReSTCommand, mario.cli_tools.CommandInSection

class mario.cli_tools.ReSTCommand(name, context_settings=None, callback=None, params=None, help=None, epilog=None, short_help=None, options_metavar='[OPTIONS]', add_help_option=True, no_args_is_help=False, hidden=False, deprecated=False)[source]¶

Bases: click.core.Command

Parse help as rst.

format_help_text(ctx, formatter)[source]¶: Writes the help text to the formatter if it exists.

mario.config module¶

mario.config.get_config_dir()[source]¶

mario.config.load_config(dir_path=None)[source]¶

mario.declarative module¶

class mario.declarative.AnyField(*, default=<marshmallow.missing>, missing=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, **metadata)[source]¶: Bases: marshmallow.fields.Field

class mario.declarative.ArgumentNameField(*, default=<marshmallow.missing>, missing=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, **metadata)[source]¶: Bases: marshmallow.fields.Field

class mario.declarative.ArgumentSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]¶