pyndoc.readers package

This package contains classes and functions related to the Pyndoc general reader and parser, as well as Subpackages containing definitions of language-specific AST block handling for custom readers (see Subpackages below)

Subpackages

• pyndoc.readers.gfm package
  • Submodules
  • pyndoc.readers.gfm.blocks module
    • Space
      • Space.match_pattern()
    • SoftBreak
      • SoftBreak.match_pattern()
    • Header
      • Header.process_read()
    • Emph
      • Emph.start()
      • Emph.end()
      • Emph.handle_premature_closure()
    • BulletList
      • BulletList.process_read()
    • OrderedList
      • OrderedList.separator_dict
      • OrderedList.numbering_type
      • OrderedList.process_read()
    • Table
      • Table.add_table_head()
      • Table.add_table_body()
      • Table.add_row()
      • Table.add_cell()
      • Table.handle_table_end()
      • Table.handle_table_head_end()
      • Table.process_read()
      • Table.handle_premature_closure()
      • Table.start()
      • Table.end()
    • TableHead
      • TableHead.format_table_head()
      • TableHead.end()
    • TableBody
      • TableBody.format_table_body()
      • TableBody.end()
    • Row
      • Row.format_row()
      • Row.is_delimiter_row()
      • Row.end()
    • Cell
      • Cell.delimiter_regex
      • Cell.is_delimiter_cell()
      • Cell.get_delimiter_cell_alignment()
      • Cell.start()
      • Cell.end()
    • CodeBlockHelper
      • CodeBlockHelper.process_read()
      • CodeBlockHelper.end()
    • CodeHelper
      • CodeHelper.process_read()
      • CodeHelper.start()
      • CodeHelper.end()
  • pyndoc.readers.gfm.tokens module
    • assign_patterns()
  • Module contents

Submodules

pyndoc.readers.parser module

class pyndoc.readers.parser.Parser(lang: str)

Bases: object

Class representing a general reader for all input languages

Parameters:

lang (str) – The reader’s language

context

The context stack

token

Token currently matched

check_atom_block() → None

Check if an atom block has ended. That is, if matching it with a next character results in None (but previously matched)

check_end() → None

check if the current context block has ended

check_start() → None

Check if a new block has just started. If so, set the current context as the block

close_context() → None

If the file has ended - go through each block in the context and end it

process_trailing_atom() → None

Immediately process an atom block without checking for the usual condition

pyndoc.readers.reader module

class pyndoc.readers.reader.Reader(lang: str)

Bases: object

process(char: str) → None

Process a current token taking into consideration the current context tree, check if a new block has started or ended, process atom blocks

Parameters:

char (str) – The currently processed character

read(filename: str) → None

Open and read a file one character at a time, then pass the character to tokenizer

Module contents