docutils.core.Publisher

class documentation

class Publisher(object): (source)

Constructor: Publisher(reader, parser, writer, source, ...)

A facade encapsulating the high-level logic of a Docutils system.

Method	`__init__`	Initial setup. If any of `reader`, `parser`, or `writer` are not specified, the corresponding `set_...` method should be called with a component name (`set_reader` sets the parser as well).
Method	`apply_transforms`	Undocumented
Method	`debugging_dumps`	Undocumented
Method	`get_settings`	Set and return default settings (overrides in `defaults` dict).
Method	`process_command_line`	Pass an empty list to `argv` to avoid reading `sys.argv` (the default).
Method	`process_programmatic_settings`	Undocumented
Method	`publish`	Process command line options and arguments (if `self.settings` not already set), run `self.reader` and then `self.writer`. Return `self.writer`'s output.
Method	`report_Exception`	Undocumented
Method	`report_SystemMessage`	Undocumented
Method	`report_UnicodeError`	Undocumented
Method	`set_components`	Undocumented
Method	`set_destination`	Undocumented
Method	`set_io`	Undocumented
Method	`set_reader`	Set `self.reader` by name.
Method	`set_source`	Undocumented
Method	`set_writer`	Set `self.writer` by name.
Method	`setup_option_parser`	Undocumented
Instance Variable	`destination`	The destination for docutils output, a `docutils.io.Output` instance.
Instance Variable	`destination_class`	The class for dynamically created destination objects.
Instance Variable	`document`	The document tree (`docutils.nodes` objects).
Instance Variable	`parser`	A `docutils.parsers.Parser` instance.
Instance Variable	`reader`	A `docutils.readers.Reader` instance.
Instance Variable	`settings`	An object containing Docutils settings as instance attributes. Set by `self.process_command_line()` or `self.get_settings()`.
Instance Variable	`source`	The source of input data, a `docutils.io.Input` instance.
Instance Variable	`source_class`	The class for dynamically created source objects.
Instance Variable	`writer`	A `docutils.writers.Writer` instance.
Instance Variable	`_stderr`	Undocumented

def __init__(self, reader=None, parser=None, writer=None, source=None, source_class=io.FileInput, destination=None, destination_class=io.FileOutput, settings=None): (source) ¶

Initial setup. If any of reader, parser, or writer are not specified, the corresponding set_... method should be called with a component name (set_reader sets the parser as well).

def apply_transforms(self): (source) ¶

Undocumented

def debugging_dumps(self): (source) ¶

Undocumented

def get_settings(self, usage=None, description=None, settings_spec=None, config_section=None, **defaults): (source) ¶

Set and return default settings (overrides in defaults dict).

Set components first (self.set_reader & self.set_writer). Explicitly setting self.settings disables command line option processing from self.publish().

def process_command_line(self, argv=None, usage=None, description=None, settings_spec=None, config_section=None, **defaults): (source) ¶

Pass an empty list to argv to avoid reading sys.argv (the default).

Set components first (self.set_reader & self.set_writer).

def process_programmatic_settings(self, settings_spec, settings_overrides, config_section): (source) ¶

Undocumented

def publish(self, argv=None, usage=None, description=None, settings_spec=None, settings_overrides=None, config_section=None, enable_exit_status=False): (source) ¶

Process command line options and arguments (if self.settings not already set), run self.reader and then self.writer. Return self.writer's output.