bootstraparse API Documentation Modules Classes Names
Clear Help

Search bar offers the following options:

  • Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
  • Wildcards. The below example searches for documents with words beginning with “foo”: foo*
  • Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search

    Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

  • Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Class Hierarchy

  • bootstraparse.modules.config.ConfigLoader - Reads all config files in a folder Behaves like a dictionary of all config files
  • bootstraparse.modules.context_mngr.BaseContainer - Creates container holding all the elements from the start of a parsed element to its end.
    • bootstraparse.modules.context_mngr.DisplayContainer - Undocumented
    • bootstraparse.modules.context_mngr.EtCustomSpanContainer - Undocumented
    • bootstraparse.modules.context_mngr.EtEmContainer - Undocumented
    • bootstraparse.modules.context_mngr.EtStrikethroughContainer - Undocumented
    • bootstraparse.modules.context_mngr.EtStrongContainer - Undocumented
    • bootstraparse.modules.context_mngr.EtUnderlineContainer - Undocumented
    • bootstraparse.modules.context_mngr.HeaderContainer - Undocumented
    • bootstraparse.modules.context_mngr.HyperLinkContainer - Undocumented
    • bootstraparse.modules.context_mngr.LinebreakContainer - Undocumented
    • bootstraparse.modules.context_mngr.ReContextContainer - Undocumented
      • bootstraparse.modules.context_mngr.EtOlistContainer - Undocumented
      • bootstraparse.modules.context_mngr.EtUlistContainer - Undocumented
    • bootstraparse.modules.context_mngr.SeContainer - Undocumented
    • bootstraparse.modules.context_mngr.TableCellContainer - Undocumented
    • bootstraparse.modules.context_mngr.TableRowContainer - Undocumented
    • bootstraparse.modules.context_mngr.TableSeparatorContainer - Undocumented
    • bootstraparse.modules.context_mngr.TextContainer - Undocumented
  • bootstraparse.modules.context_mngr.ContextManager - Class in charge of piling all the parsed elements and then encapsulating them inside one another.
  • bootstraparse.modules.environment.Environment - Object containing all the important variables, with appropriate getters and setters. Also contains self integrity checks.
  • bootstraparse.modules.export.ContextConverter - Transforms output form context manager into final, printable versions of the containers.
  • bootstraparse.modules.export.ExportManager - Transforms ExportRequest tuples to ExportResponse tuples with the config-provided appropriate markup.
  • bootstraparse.modules.pathresolver.PathResolver - Initialised with a relative path and returns the translated absolute path
    • bootstraparse.modules.pathresolver.BoostraPath - Initialises PathResolver with the path of the bootstraparse installation folder
  • bootstraparse.modules.preparser.PreParser - Takes a path and environment, executes all pre-parsing methods on the specified file.
  • bootstraparse.modules.sitecrawler.SiteCrawler - A sitecrawler is a generator that yields a tuple of the form (PreParser, file) Its goal is to create a list of preparsers and files to be parsed based on the files and directories in the initial path. ...
  • bootstraparse.modules.syntax.SemanticType - Allows us to access basic operations and identify each token parsed.
    • bootstraparse.modules.syntax.AddFirstElementToLabel - Class used for verification in the context manager. Adds the first element of the content to the label (for matching purposes).
      • bootstraparse.modules.syntax.EtCustomSpanToken - (#int)
      • bootstraparse.modules.syntax.StructuralElementEndToken - div|article|section|aside|header|body|nav>>
      • bootstraparse.modules.syntax.StructuralElementStartToken - <<div|article|section|aside|header|body|nav
    • bootstraparse.modules.syntax.AliasToken - Undocumented
    • bootstraparse.modules.syntax.BeAssignToken - Undocumented
    • bootstraparse.modules.syntax.BeValueToken - Undocumented
    • bootstraparse.modules.syntax.BlockQuoteAuthorToken - Undocumented
    • bootstraparse.modules.syntax.BlockQuoteToken - Undocumented
    • bootstraparse.modules.syntax.ClosedSemanticType - Semantic type used to signify it has a matching start component and needs to be matched.
      • bootstraparse.modules.syntax.StructuralElementEndToken - div|article|section|aside|header|body|nav>>
    • bootstraparse.modules.syntax.ExplicitSemanticType - Explicit semantic type, the label is the only information we need.
      • bootstraparse.modules.syntax.CodeToken - Undocumented
      • bootstraparse.modules.syntax.EtCustomSpanToken - (#int)
      • bootstraparse.modules.syntax.EtEmToken - *
      • bootstraparse.modules.syntax.EtStrikethroughToken - ~~
      • bootstraparse.modules.syntax.EtStrongToken - **
      • bootstraparse.modules.syntax.EtUnderlineToken - __
      • bootstraparse.modules.syntax.Linebreak - Undocumented
    • bootstraparse.modules.syntax.FinalSemanticType - Semantic type used by the context manager to ascertain token is possible to encapsulate.
      • bootstraparse.modules.syntax.DisplayToken - ! string ! number of ! indicates level
      • bootstraparse.modules.syntax.EmptySemanticType - Empty semantic type, the content is the only information we need.
        • bootstraparse.modules.syntax.TextToken - Undocumented
      • bootstraparse.modules.syntax.EtOlistToken - #.
      • bootstraparse.modules.syntax.EtUlistToken - No summary
      • bootstraparse.modules.syntax.HeaderToken - # string # number of # indicates level
      • bootstraparse.modules.syntax.HyperlinkToken - Undocumented
    • bootstraparse.modules.syntax.ImageToken - Undocumented
    • bootstraparse.modules.syntax.OpenedSemanticType - Semantic type used to signify it has a matching end component and needs to be matched.
      • bootstraparse.modules.syntax.StructuralElementStartToken - <<div|article|section|aside|header|body|nav
    • bootstraparse.modules.syntax.OptionalClassToken - Undocumented
    • bootstraparse.modules.syntax.OptionalInsertToken - Undocumented
    • bootstraparse.modules.syntax.OptionalToken - Undocumented
    • bootstraparse.modules.syntax.OptionalVarToken - Undocumented
    • bootstraparse.modules.syntax.TableCellToken - Undocumented
    • bootstraparse.modules.syntax.TableRowToken - Undocumented
    • bootstraparse.modules.syntax.TableSeparatorToken - Undocumented
    • bootstraparse.modules.syntax.TableToken - Undocumented
    • bootstraparse.modules.syntax.TokensToMatch - Class used for verification in the context manager. Classes inheriting this should be added to matched_elements.
      • bootstraparse.modules.syntax.CodeToken - Undocumented
      • bootstraparse.modules.syntax.EtCustomSpanToken - (#int)
      • bootstraparse.modules.syntax.EtEmToken - *
      • bootstraparse.modules.syntax.EtStrikethroughToken - ~~
      • bootstraparse.modules.syntax.EtStrongToken - **
      • bootstraparse.modules.syntax.EtUnderlineToken - __
      • bootstraparse.modules.syntax.StructuralElementStartToken - <<div|article|section|aside|header|body|nav
    • bootstraparse.modules.syntax.UnimplementedToken - Undocumented
  • Exception
    • bootstraparse.modules.error_mngr.BootstraparseError - Base class for all Bootstraparse errors
      • bootstraparse.modules.error_mngr.LonelyOptionalError - Optional token could not be matched with last element in pile (not a container).
      • bootstraparse.modules.error_mngr.MismatchedContainerError - The token is not final and cannot be contained. Indicative of a mismatched token.
    • bootstraparse.modules.error_mngr.ParsingError - Exception class for parsing errors
API Documentation for bootstraparse, generated by pydoctor 22.5.1 at 2022-06-15 20:05:50.