speechmarkdown.formatters.factory

Classes

FormatterFactory

Factory for producing specific formatters given the SpeechOptions definition.

Module Contents

class speechmarkdown.formatters.factory.FormatterFactory

Factory for producing specific formatters given the SpeechOptions definition.

static create_formatter(options: speechmarkdown.options.SpeechOptions) → speechmarkdown.formatters.base.FormatterBase

Construct a format engine relying upon the defined target platform.

Parameters:

options (SpeechOptions) – Formatter configuration parameters.

Returns:

Appropriate concrete formatter instantiation.

Return type:

FormatterBase

static create_text_formatter(options: speechmarkdown.options.SpeechOptions) → speechmarkdown.formatters.text.TextFormatter

Specifically return the base text parsing formatter engine.

Parameters:

options (SpeechOptions) – Formatting controls.

Returns:

Configured instance generating just text chunks.

Return type:

TextFormatter