-
bootstraparse
index.html
Package
Package
PUBLIC
Bootstraparse is a tool to parse a folder and create a website from it. After installing it with pip, you can use it by running the following command:
-
bootstraparse.__main__
bootstraparse.__main__.html
ZopeInterfaceModule
Module
PRIVATE
Main program, use this to start parsing
-
bootstraparse.modules
bootstraparse.modules.html
Package
Package
PUBLIC
The modules in this folder are used to parse the website.
-
bootstraparse.modules.config
bootstraparse.modules.config.html
ZopeInterfaceModule
Module
PUBLIC
Interprets config files The Config will be loaded by the environment at runtime and should be accessed that way Usage:
-
bootstraparse.modules.context_mngr
bootstraparse.modules.context_mngr.html
ZopeInterfaceModule
Module
PUBLIC
Interprets where the parser is located and resolves errors You're probably here for the ContextManager class. Containers have class_name, debug_map and validate methods for debug,
-
bootstraparse.modules.environment
bootstraparse.modules.environment.html
ZopeInterfaceModule
Module
PUBLIC
Module for containing super important variables Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and
-
bootstraparse.modules.error_mngr
bootstraparse.modules.error_mngr.html
ZopeInterfaceModule
Module
PUBLIC
Dedicated module for defining and interpreting errors as well as generating error messages You're probably here for log_message or log_exception.
-
bootstraparse.modules.export
bootstraparse.modules.export.html
ZopeInterfaceModule
Module
PUBLIC
Module for final generation of the translated website Usage:
-
bootstraparse.modules.parser
bootstraparse.modules.parser.html
ZopeInterfaceModule
Module
PUBLIC
Main parser, gets config files and parses them for the context manager. parse_line takes a io and outputs it all as a list of parsed elements Usage:
-
bootstraparse.modules.pathresolver
bootstraparse.modules.pathresolver.html
ZopeInterfaceModule
Module
PUBLIC
Module for resolving relative path problems PathResolver takes a relative path in the module and outputs the absolute path, BoostraPath can deal with relative paths in the installation folder. Usage:
-
bootstraparse.modules.preparser
bootstraparse.modules.preparser.html
ZopeInterfaceModule
Module
PUBLIC
Module for pre-parsing user files in preparation for the parser Usage:
-
bootstraparse.modules.sitecrawler
bootstraparse.modules.sitecrawler.html
ZopeInterfaceModule
Module
PUBLIC
Module for file and directories repartition Usage:
-
bootstraparse.modules.sitecreator
bootstraparse.modules.sitecreator.html
ZopeInterfaceModule
Module
PUBLIC
Module sequencing the successive actions necessary for website building Usage:
-
bootstraparse.modules.syntax
bootstraparse.modules.syntax.html
ZopeInterfaceModule
Module
PUBLIC
# Dedicated module for the syntax of all the parsing # All tokens inherit a SemanticType among SemanticType, ExplicitSemanticType and EmptySemanticType # All tokens have a label, and __eq__ and __ne__ methods...
-
bootstraparse.modules.template_mngr
bootstraparse.modules.template_mngr.html
ZopeInterfaceModule
Module
PUBLIC
Module for interpreting default or custom templates.
-
bootstraparse.modules.tools
bootstraparse.modules.tools.html
ZopeInterfaceModule
Module
PUBLIC
Usage:
-
bootstraparse.modules.pathresolver.PathResolver
bootstraparse.modules.pathresolver.PathResolver.html
ZopeInterfaceClass
Class
PUBLIC
Initialised with a relative path and returns the translated absolute path
-
bootstraparse.modules.pathresolver.PathResolver.__init__
bootstraparse.modules.pathresolver.PathResolver.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initialises the PathResolver with the base path :param base_path: Base path :type base_path: str
-
bootstraparse.modules.pathresolver.PathResolver.base_path
bootstraparse.modules.pathresolver.PathResolver.html#base_path
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.pathresolver.PathResolver.__call__
bootstraparse.modules.pathresolver.PathResolver.html#__call__
ZopeInterfaceFunction
Method
PUBLIC
Returns the absolute path of the relative path :param relative_path: Relative path to be resolved :type relative_path: str :return: Absolute path
-
bootstraparse.modules.pathresolver.PathResolver.give_absolute
bootstraparse.modules.pathresolver.PathResolver.html#give_absolute
ZopeInterfaceFunction
Method
PUBLIC
Returns the absolute path of the relative path :param relative_path: Relative path to be resolved :type relative_path: str :return: Absolute path
-
bootstraparse.modules.pathresolver.BoostraPath
bootstraparse.modules.pathresolver.BoostraPath.html
ZopeInterfaceClass
Class
PUBLIC
Initialises PathResolver with the path of the bootstraparse installation folder
-
bootstraparse.modules.pathresolver.BoostraPath.__init__
bootstraparse.modules.pathresolver.BoostraPath.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initialises the PathResolver with the base path :param base_path: Base path :type base_path: str
-
bootstraparse.modules.pathresolver.b_path
bootstraparse.modules.pathresolver.html#b_path
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.tools.dict_check
bootstraparse.modules.tools.html#dict_check
ZopeInterfaceFunction
Function
PUBLIC
Helper function to test existence of a list of succesive keys within a nested dictionary. :param dic: The dictionary of dictionaries to check :param args: Any number of keys to check the dictionaries for :type dic: dict | config...
-
bootstraparse.modules.tools.str_dict_check
bootstraparse.modules.tools.html#str_dict_check
ZopeInterfaceFunction
Function
PUBLIC
Helper function to test existence within a dictionary and return a string of the values of the keys checked and wether they exist. 'arg[0]' : True or False :param dic: The nested dictionary to check :param args: Any number of keys to check successively :type dic: dict :type args: str :return: A string of the values of the keys checked and wether they exist...
-
bootstraparse.modules.tools.__base
bootstraparse.modules.tools.html#__base
ZopeInterfaceFunction
Function
PRIVATE
Return the path of the main module (relative to the tests) :return: Path of the main module :rtype: str
-
bootstraparse.modules.tools.__module_path
bootstraparse.modules.tools.html#__module_path
ZopeInterfaceFunction
Function
PRIVATE
Return the path of the module module_name :param module_name: Name of the module :type module_name: str :return: Path of the module :rtype: str
-
bootstraparse.modules.tools.__prev_stack
bootstraparse.modules.tools.html#__prev_stack
ZopeInterfaceFunction
Function
PRIVATE
Return the nth previous stack :return: Previous stack :rtype: inspect.Traceback
-
bootstraparse.modules.tools.__GL
bootstraparse.modules.tools.html#__GL
ZopeInterfaceFunction
Function
PRIVATE
Undocumented
-
bootstraparse.modules.tools.__GFu
bootstraparse.modules.tools.html#__GFu
ZopeInterfaceFunction
Function
PRIVATE
Undocumented
-
bootstraparse.modules.tools.__GFi
bootstraparse.modules.tools.html#__GFi
ZopeInterfaceFunction
Function
PRIVATE
Undocumented
-
bootstraparse.modules.tools.__GLk
bootstraparse.modules.tools.html#__GLk
ZopeInterfaceFunction
Function
PRIVATE
Undocumented
-
bootstraparse.modules.tools.find_string_in_file
bootstraparse.modules.tools.html#find_string_in_file
ZopeInterfaceFunction
Function
PUBLIC
Find the string in the file stream :param file_path: Path of the file :type file_path: str :param list_regex_to_find: List of string to find :type list_regex_to_find: list :return: Dict of string found and line number :rtype: dict...
-
bootstraparse.modules.tools.find_functions_in_file
bootstraparse.modules.tools.html#find_functions_in_file
ZopeInterfaceFunction
Function
PUBLIC
Find the function in the file stream :param file_path: Path of the file :type file_path: str :param list_function_name: List of function name to find :type list_function_name: iterable :return: Dict of function found and line number :rtype: dict...
-
bootstraparse.modules.tools.find_classes_in_file
bootstraparse.modules.tools.html#find_classes_in_file
ZopeInterfaceFunction
Function
PUBLIC
Find the class in the file stream :param file_path: Path of the file :type file_path: str :param list_class_name: List of class name to find :type list_class_name: iterable :return: Dict of class found and line number :rtype: dict...
-
bootstraparse.modules.tools.find_variables_in_file
bootstraparse.modules.tools.html#find_variables_in_file
ZopeInterfaceFunction
Function
PUBLIC
Find the variable in the file stream :param file_path: Path of the file :type file_path: str :param list_variable_name: List of variable name to find :type list_variable_name: iterable :return: Dict of variable found and line number :rtype: dict...
-
bootstraparse.modules.error_mngr._ERRORS
bootstraparse.modules.error_mngr.html#_ERRORS
ZopeInterfaceAttribute
Constant
PRIVATE
Undocumented
-
bootstraparse.modules.error_mngr.init_logging
bootstraparse.modules.error_mngr.html#init_logging
ZopeInterfaceFunction
Function
PUBLIC
Initializes logging :param filename: The path for the log file :param loglevel: The level of logging: "ERROR", "INFO", "WARNING", "DEBUG", "CRITICAL" :param filemode: The mode of the log file: "w", "a" :param handler: The handler to use :type filename: str :type loglevel: str :type filemode: str :type handler: logging...
-
bootstraparse.modules.error_mngr.log_message
bootstraparse.modules.error_mngr.html#log_message
ZopeInterfaceFunction
Function
PUBLIC
Logs a message :param message: The message to log :param level: The level of the message :type level: str :type message: str :return: None
-
bootstraparse.modules.error_mngr.log_exception
bootstraparse.modules.error_mngr.html#log_exception
ZopeInterfaceFunction
Function
PUBLIC
Logs an exception :param exception: The exception to log :param level: The level of the exception :type level: str :return: None
-
bootstraparse.modules.error_mngr.BootstraparseError
bootstraparse.modules.error_mngr.BootstraparseError.html
ZopeInterfaceClass
Class
PUBLIC
Base class for all Bootstraparse errors
-
bootstraparse.modules.error_mngr.BootstraparseTokenError
bootstraparse.modules.error_mngr.BootstraparseTokenError.html
ZopeInterfaceClass
Class
PUBLIC
Error on a token, provides if possible the line and column number of the error, the file name and the message of the error and if possible a context for the error
-
bootstraparse.modules.error_mngr.BootstraparseTokenError.__init__
bootstraparse.modules.error_mngr.BootstraparseTokenError.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.BootstraparseTokenError.token
bootstraparse.modules.error_mngr.BootstraparseTokenError.html#token
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.BootstraparseTokenError.pile
bootstraparse.modules.error_mngr.BootstraparseTokenError.html#pile
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.BootstraparseTokenError.line
bootstraparse.modules.error_mngr.BootstraparseTokenError.html#line
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.BootstraparseTokenError.index
bootstraparse.modules.error_mngr.BootstraparseTokenError.html#index
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.BootstraparseTokenError.label
bootstraparse.modules.error_mngr.BootstraparseTokenError.html#label
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.BootstraparseTokenError.name
bootstraparse.modules.error_mngr.BootstraparseTokenError.html#name
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.BootstraparseTokenError.context
bootstraparse.modules.error_mngr.BootstraparseTokenError.html#context
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.BootstraparseTokenError.get_context
bootstraparse.modules.error_mngr.BootstraparseTokenError.html#get_context
ZopeInterfaceFunction
Method
PUBLIC
Returns the context of the error :return: The context of the error :rtype: str
-
bootstraparse.modules.error_mngr.BootstraparseTokenError.context_multiline
bootstraparse.modules.error_mngr.BootstraparseTokenError.html#context_multiline
ZopeInterfaceFunction
Method
PUBLIC
Returns the context of the error as a multiline string :return: The context of the error :rtype: str
-
bootstraparse.modules.error_mngr.ParsingError
bootstraparse.modules.error_mngr.ParsingError.html
ZopeInterfaceClass
Class
PUBLIC
Exception class for parsing errors
-
bootstraparse.modules.error_mngr.ParsingError.__init__
bootstraparse.modules.error_mngr.ParsingError.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initializes the ParsingError class with the filename and a line and column number based on the current position in the file (if available) :param message: The message to display :type message: str :param line: The line number of the error :type line: int :param column: The column number of the error :type column: int :param file: The name of the file :type file: str :return: None...
-
bootstraparse.modules.error_mngr.ParsingError.line
bootstraparse.modules.error_mngr.ParsingError.html#line
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.ParsingError.column
bootstraparse.modules.error_mngr.ParsingError.html#column
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.ParsingError.file
bootstraparse.modules.error_mngr.ParsingError.html#file
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.ParsingError.message
bootstraparse.modules.error_mngr.ParsingError.html#message
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.ParsingError.__str__
bootstraparse.modules.error_mngr.ParsingError.html#__str__
ZopeInterfaceFunction
Method
PUBLIC
Returns a string representation of the ParsingError :return: The string representation of the ParsingError
-
bootstraparse.modules.error_mngr.MismatchedContainerError
bootstraparse.modules.error_mngr.MismatchedContainerError.html
ZopeInterfaceClass
Class
PUBLIC
The token is not final and cannot be contained. Indicative of a mismatched token.
-
bootstraparse.modules.error_mngr.MismatchedContainerError.__init__
bootstraparse.modules.error_mngr.MismatchedContainerError.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initializes the MismatchedContainerError class with the token that was not final :param token: The token that is not final :type token: syntax.SemanticType
-
bootstraparse.modules.error_mngr.MismatchedContainerError.token
bootstraparse.modules.error_mngr.MismatchedContainerError.html#token
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.MismatchedContainerError.pile
bootstraparse.modules.error_mngr.MismatchedContainerError.html#pile
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.MismatchedContainerError.line
bootstraparse.modules.error_mngr.MismatchedContainerError.html#line
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.MismatchedContainerError.label
bootstraparse.modules.error_mngr.MismatchedContainerError.html#label
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.MismatchedContainerError.name
bootstraparse.modules.error_mngr.MismatchedContainerError.html#name
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.LonelyOptionalError
bootstraparse.modules.error_mngr.LonelyOptionalError.html
ZopeInterfaceClass
Class
PUBLIC
Optional token could not be matched with last element in pile (not a container).
-
bootstraparse.modules.error_mngr.LonelyOptionalError.__init__
bootstraparse.modules.error_mngr.LonelyOptionalError.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initializes the LonelyOptionalError class with the token found and the last element in the pile Used when a token is found that is optional and cannot be matched with the last element in the pile (not a container) :param token: The token that is not final :type token: syntax...
-
bootstraparse.modules.error_mngr.LonelyOptionalError.token
bootstraparse.modules.error_mngr.LonelyOptionalError.html#token
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.LonelyOptionalError.line
bootstraparse.modules.error_mngr.LonelyOptionalError.html#line
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.LonelyOptionalError.label
bootstraparse.modules.error_mngr.LonelyOptionalError.html#label
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.error_mngr.LonelyOptionalError.name
bootstraparse.modules.error_mngr.LonelyOptionalError.html#name
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.environment.Environment
bootstraparse.modules.environment.Environment.html
ZopeInterfaceClass
Class
PUBLIC
Object containing all the important variables, with appropriate getters and setters. Also contains self integrity checks.
-
bootstraparse.modules.environment.Environment.__init__
bootstraparse.modules.environment.Environment.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initialises the environment, all parameters are set to None. Set _wasInitialised to False for all parameters.
-
bootstraparse.modules.environment.Environment._mParams
bootstraparse.modules.environment.Environment.html#_mParams
ZopeInterfaceAttribute
Instance Variable
PRIVATE
Undocumented
-
bootstraparse.modules.environment.Environment._sParams
bootstraparse.modules.environment.Environment.html#_sParams
ZopeInterfaceAttribute
Instance Variable
PRIVATE
Undocumented
-
bootstraparse.modules.environment.Environment._wasInitialised
bootstraparse.modules.environment.Environment.html#_wasInitialised
ZopeInterfaceAttribute
Instance Variable
PRIVATE
Undocumented
-
bootstraparse.modules.environment.Environment.integrity_check
bootstraparse.modules.environment.Environment.html#integrity_check
ZopeInterfaceFunction
Method
PUBLIC
Checks if all mandatory parameters are set. :return: True if all mandatory parameters are set, False otherwise.
-
bootstraparse.modules.environment.Environment.__getattr__
bootstraparse.modules.environment.Environment.html#__getattr__
ZopeInterfaceFunction
Method
PUBLIC
Getter for all parameters, looks for super if the parameter is prefaced with an underscore. Looks for mandatory parameters first, then secondary parameters. :param attribute: The name of the parameter to get...
-
bootstraparse.modules.environment.Environment.__setattr__
bootstraparse.modules.environment.Environment.html#__setattr__
ZopeInterfaceFunction
Method
PUBLIC
Setter for all parameters, looks for super if the parameter is prefaced with an underscore. :param attribute: The name of the parameter to set. :type attribute: str
-
bootstraparse.modules.config.ConfigLoader
bootstraparse.modules.config.ConfigLoader.html
ZopeInterfaceClass
Class
PUBLIC
Reads all config files in a folder Behaves like a dictionary of all config files
-
bootstraparse.modules.config.ConfigLoader.__init__
bootstraparse.modules.config.ConfigLoader.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Defines the config folder and loads all configs :param config_folder: path to config file :type config_folder: (str | list[str]) :param extensions: file extensions to load :type extensions: list[str] :raise TypeError: if config_folder is not a string or a list of strings...
-
bootstraparse.modules.config.ConfigLoader.config_folders
bootstraparse.modules.config.ConfigLoader.html#config_folders
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.config.ConfigLoader.loaded_conf
bootstraparse.modules.config.ConfigLoader.html#loaded_conf
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.config.ConfigLoader.extensions
bootstraparse.modules.config.ConfigLoader.html#extensions
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.config.ConfigLoader.reload_all
bootstraparse.modules.config.ConfigLoader.html#reload_all
ZopeInterfaceFunction
Method
PUBLIC
Reloads all configs :return: None
-
bootstraparse.modules.config.ConfigLoader.add_folder
bootstraparse.modules.config.ConfigLoader.html#add_folder
ZopeInterfaceFunction
Method
PUBLIC
Add a Folder to the list of configs :param folder: path to folder :type folder: str :return: None
-
bootstraparse.modules.config.ConfigLoader.load_from_file
bootstraparse.modules.config.ConfigLoader.html#load_from_file
ZopeInterfaceFunction
Method
PUBLIC
Loads a config file :param filepath: path to config file :type filepath: str :return: None
-
bootstraparse.modules.config.ConfigLoader.load_from_folder
bootstraparse.modules.config.ConfigLoader.html#load_from_folder
ZopeInterfaceFunction
Method
PUBLIC
Loads all configs in the config folder :param folder: path to folder :type folder: str :return: None
-
bootstraparse.modules.config.ConfigLoader.__getitem__
bootstraparse.modules.config.ConfigLoader.html#__getitem__
ZopeInterfaceFunction
Method
PUBLIC
Returns a yaml config object if in self.loaded_conf :param item: config key :type item: str :raise KeyError: if item is not in self.loaded_conf :return: config value
-
bootstraparse.modules.config.ConfigLoader.__contains__
bootstraparse.modules.config.ConfigLoader.html#__contains__
ZopeInterfaceFunction
Method
PUBLIC
Same as a dictionary. :param item: config key :type item: str :return: True if item is in self.loaded_conf
-
bootstraparse.modules.config.ConfigLoader.__repr__
bootstraparse.modules.config.ConfigLoader.html#__repr__
ZopeInterfaceFunction
Method
PUBLIC
Returns config as string :return: the dict of configs and their values :rtype: str
-
bootstraparse.modules.export.ExportRequest
bootstraparse.modules.export.html#ExportRequest
ZopeInterfaceAttribute
Variable
PUBLIC
Named tuple containing all necessary information to proceed with the final output.
-
bootstraparse.modules.export.ExportResponse
bootstraparse.modules.export.html#ExportResponse
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.export.format_optionals
bootstraparse.modules.export.html#format_optionals
ZopeInterfaceFunction
Function
PUBLIC
Function handling parser output optional object, splitting it between html_insert and class_insert on one hand and var on the other hand. :param optionals: SplitToken namedtuple :type optionals: syntax...
-
bootstraparse.modules.export.ExportManager
bootstraparse.modules.export.ExportManager.html
ZopeInterfaceClass
Class
PUBLIC
Transforms ExportRequest tuples to ExportResponse tuples with the config-provided appropriate markup.
-
bootstraparse.modules.export.ExportManager.__init__
bootstraparse.modules.export.ExportManager.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initialization function for the ExportManager. :param cnoifg: Config file :type cnoifg: config.ConfigLoader :param templates: Templates file :type templates: config.ConfigLoader
-
bootstraparse.modules.export.ExportManager.config
bootstraparse.modules.export.ExportManager.html#config
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.export.ExportManager.templates
bootstraparse.modules.export.ExportManager.html#templates
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.export.ExportManager.advanced_export
bootstraparse.modules.export.ExportManager.html#advanced_export
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.export.ExportManager.__call__
bootstraparse.modules.export.ExportManager.html#__call__
ZopeInterfaceFunction
Method
PUBLIC
Callable function for ExportManager, transforming ExportRequest tuples into ExportResponse tuples. :param export_request: ExportRequest tuples :type export_request: ExportRequest :return: ExportResponse tuples...
-
bootstraparse.modules.export.ExportManager.transform
bootstraparse.modules.export.ExportManager.html#transform
ZopeInterfaceFunction
Method
PUBLIC
Transformation function to magically poof ExportRequest tuples into ExportResponse tuples using the loaded config. :param export_request: ExportRequest tuples :type export_request: ExportRequest :return: ExportResponse tuples :rtype: ExportResponse...
-
bootstraparse.modules.export.ExportManager._get_template
bootstraparse.modules.export.ExportManager.html#_get_template
ZopeInterfaceFunction
Method
PRIVATE
Function for initializing other transform functions.
-
bootstraparse.modules.export.ExportManager.basic_transform
bootstraparse.modules.export.ExportManager.html#basic_transform
ZopeInterfaceFunction
Method
PUBLIC
Basic template for ExportResponse objects. :param export_request: ExportRequest tuples :type export_request: ExportRequest :return: ExportResponse tuples :rtype: ExportResponse
-
bootstraparse.modules.export.ExportManager.display_transform
bootstraparse.modules.export.ExportManager.html#display_transform
ZopeInterfaceFunction
Method
PUBLIC
Specific template for display. :type export_request: ExportRequest :rtype: ExportResponse
-
bootstraparse.modules.export.ExportManager.link_transform
bootstraparse.modules.export.ExportManager.html#link_transform
ZopeInterfaceFunction
Method
PUBLIC
Specific template for link. :type export_request: ExportRequest :rtype: ExportResponse
-
bootstraparse.modules.export.ExportManager.t_transform
bootstraparse.modules.export.ExportManager.html#t_transform
ZopeInterfaceFunction
Method
PUBLIC
Specific template for table content. :type export_request: ExportRequest :rtype: ExportResponse
-
bootstraparse.modules.export.ExportManager.image_transform
bootstraparse.modules.export.ExportManager.html#image_transform
ZopeInterfaceFunction
Method
PUBLIC
Specific template for images. :type export_request: ExportRequest :rtype: ExportResponse
-
bootstraparse.modules.export.ContextConverter
bootstraparse.modules.export.ContextConverter.html
ZopeInterfaceClass
Class
PUBLIC
Transforms output form context manager into final, printable versions of the containers.
-
bootstraparse.modules.export.ContextConverter.__init__
bootstraparse.modules.export.ContextConverter.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Takes a pile and the exporter object :type pile : list[context_mngr.BaseContainer] :param pile: output from the context manager. :type exporter : ExportManager :param exporter: Our ExportManager :type destination : str :param destination: Destination of the output file.
-
bootstraparse.modules.export.ContextConverter.io_output
bootstraparse.modules.export.ContextConverter.html#io_output
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.export.ContextConverter.pile
bootstraparse.modules.export.ContextConverter.html#pile
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.export.ContextConverter.exporter
bootstraparse.modules.export.ContextConverter.html#exporter
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.export.ContextConverter.io_initialized
bootstraparse.modules.export.ContextConverter.html#io_initialized
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.export.ContextConverter.destination
bootstraparse.modules.export.ContextConverter.html#destination
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.export.ContextConverter.process_pile
bootstraparse.modules.export.ContextConverter.html#process_pile
ZopeInterfaceFunction
Method
PUBLIC
Processes the pile and writes the output to the io_output object. :rtype: StringIO
-
bootstraparse.modules.export.ContextConverter.__str__
bootstraparse.modules.export.ContextConverter.html#__str__
ZopeInterfaceFunction
Method
PUBLIC
Stringifies the entirety of the converted pile
-
bootstraparse.modules.export.ContextConverter.readlines
bootstraparse.modules.export.ContextConverter.html#readlines
ZopeInterfaceFunction
Method
PUBLIC
Yields the converted pile line after line :rtype: list[str]
-
bootstraparse.modules.export.ContextConverter.__repr__
bootstraparse.modules.export.ContextConverter.html#__repr__
ZopeInterfaceFunction
Method
PUBLIC
Undocumented
-
bootstraparse.modules.export.ContextConverter.print_all
bootstraparse.modules.export.ContextConverter.html#print_all
ZopeInterfaceFunction
Method
PUBLIC
Prints the entirety of the converted pile
-
bootstraparse.modules.export.ContextConverter.__eq__
bootstraparse.modules.export.ContextConverter.html#__eq__
ZopeInterfaceFunction
Method
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.BaseContainer
bootstraparse.modules.context_mngr.BaseContainer.html
ZopeInterfaceClass
Class
PUBLIC
Creates container holding all the elements from the start of a parsed element to its end.
-
bootstraparse.modules.context_mngr.BaseContainer.type
bootstraparse.modules.context_mngr.BaseContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.BaseContainer.subtype
bootstraparse.modules.context_mngr.BaseContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.BaseContainer.__init__
bootstraparse.modules.context_mngr.BaseContainer.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
:param content: List of tokens to be added to the container :param optionals: List of optional tokens to be added to the container (from the parser) :param others: List of values to add to the .format() method :type content: (list[(syntax...
-
bootstraparse.modules.context_mngr.BaseContainer.others
bootstraparse.modules.context_mngr.BaseContainer.html#others
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.BaseContainer.content
bootstraparse.modules.context_mngr.BaseContainer.html#content
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.BaseContainer.map
bootstraparse.modules.context_mngr.BaseContainer.html#map
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.BaseContainer.optionals
bootstraparse.modules.context_mngr.BaseContainer.html#optionals
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.BaseContainer.indentation_level
bootstraparse.modules.context_mngr.BaseContainer.html#indentation_level
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.BaseContainer.get_content
bootstraparse.modules.context_mngr.BaseContainer.html#get_content
ZopeInterfaceFunction
Method
PUBLIC
Get the content of any BaseContainer object (default self.content). :param exm: ExportManager to use for exporting :param arbitrary_list: List to get the content from :type exm: export.ExportManager :type arbitrary_list: list[BaseContainer] :rtype : str...
-
bootstraparse.modules.context_mngr.BaseContainer.get_optionals
bootstraparse.modules.context_mngr.BaseContainer.html#get_optionals
ZopeInterfaceFunction
Method
PUBLIC
Get the optionals of the container. :rtype : (syntax.SemanticType | BaseContainer) :return: The optionals of the container
-
bootstraparse.modules.context_mngr.BaseContainer.get_others
bootstraparse.modules.context_mngr.BaseContainer.html#get_others
ZopeInterfaceFunction
Method
PUBLIC
Get the other values of the container. :rtype : dict[str, str] :return: The other values of the container
-
bootstraparse.modules.context_mngr.BaseContainer.export
bootstraparse.modules.context_mngr.BaseContainer.html#export
ZopeInterfaceFunction
Method
PUBLIC
Export the container to a string. :type exm: export.ExportManager :rtype : str
-
bootstraparse.modules.context_mngr.BaseContainer.add
bootstraparse.modules.context_mngr.BaseContainer.html#add
ZopeInterfaceFunction
Method
PUBLIC
Adds a list of elements to the container. :param other: List of elements to add :type other: syntax.SemanticType :return: None
-
bootstraparse.modules.context_mngr.BaseContainer.class_name
bootstraparse.modules.context_mngr.BaseContainer.html#class_name
ZopeInterfaceFunction
Method
PUBLIC
A string representation of the class name. :rtype : str
-
bootstraparse.modules.context_mngr.BaseContainer.validate
bootstraparse.modules.context_mngr.BaseContainer.html#validate
ZopeInterfaceFunction
Method
PUBLIC
Takes a list as input and checks if every element is in map. :param other: List of elements to check :type other: list[(syntax.SemanticType | BaseContainer)] :return: True if every element is in map, False otherwise...
-
bootstraparse.modules.context_mngr.BaseContainer.debug_map
bootstraparse.modules.context_mngr.BaseContainer.html#debug_map
ZopeInterfaceFunction
Method
PUBLIC
Prints the map of the container. :return: None
-
bootstraparse.modules.context_mngr.BaseContainer.__len__
bootstraparse.modules.context_mngr.BaseContainer.html#__len__
ZopeInterfaceFunction
Method
PUBLIC
:rtype : int
-
bootstraparse.modules.context_mngr.BaseContainer.__iter__
bootstraparse.modules.context_mngr.BaseContainer.html#__iter__
ZopeInterfaceFunction
Method
PUBLIC
:ytype : iter[syntax.SemanticType]
-
bootstraparse.modules.context_mngr.BaseContainer.__getitem__
bootstraparse.modules.context_mngr.BaseContainer.html#__getitem__
ZopeInterfaceFunction
Method
PUBLIC
:param item: Index of the element to get :type item: int :rtype : (syntax.SemanticType | BaseContainer)
-
bootstraparse.modules.context_mngr.BaseContainer.__setitem__
bootstraparse.modules.context_mngr.BaseContainer.html#__setitem__
ZopeInterfaceFunction
Method
PUBLIC
:param key: Index of the element to set :param value: Value to set :type key: int :type value: (syntax.SemanticType | BaseContainer)
-
bootstraparse.modules.context_mngr.BaseContainer.__getslice__
bootstraparse.modules.context_mngr.BaseContainer.html#__getslice__
ZopeInterfaceFunction
Method
PUBLIC
:param start: Start index of the slice :param end: End index of the slice :type start: int :type end: int :rtype : list[(syntax.SemanticType | BaseContainer)]
-
bootstraparse.modules.context_mngr.BaseContainer.__rshift__
bootstraparse.modules.context_mngr.BaseContainer.html#__rshift__
ZopeInterfaceFunction
Method
PUBLIC
:param other: The name of the map element to get :type other: str :rtype : (syntax.SemanticType | BaseContainer)
-
bootstraparse.modules.context_mngr.BaseContainer.__eq__
bootstraparse.modules.context_mngr.BaseContainer.html#__eq__
ZopeInterfaceFunction
Method
PUBLIC
:param other: The other object to compare to :type other: BaseContainer | list[(syntax.SemanticType | BaseContainer)] | syntax.SemanticType :rtype : bool
-
bootstraparse.modules.context_mngr.BaseContainer.__invert__
bootstraparse.modules.context_mngr.BaseContainer.html#__invert__
ZopeInterfaceFunction
Method
PUBLIC
Returns the inverted optionals of the container. :rtype : BaseContainer
-
bootstraparse.modules.context_mngr.BaseContainer.__str__
bootstraparse.modules.context_mngr.BaseContainer.html#__str__
ZopeInterfaceFunction
Method
PUBLIC
:rtype : str
-
bootstraparse.modules.context_mngr.BaseContainer.__repr__
bootstraparse.modules.context_mngr.BaseContainer.html#__repr__
ZopeInterfaceFunction
Method
PUBLIC
:rtype : str
-
bootstraparse.modules.context_mngr.BaseContainer.print_all
bootstraparse.modules.context_mngr.BaseContainer.html#print_all
ZopeInterfaceFunction
Method
PUBLIC
Prints the container and all its content.
-
bootstraparse.modules.context_mngr.BaseContainer.to_container
bootstraparse.modules.context_mngr.BaseContainer.html#to_container
ZopeInterfaceFunction
Method
PUBLIC
Returns a container with the same content as the current container. Used for compatibility with the syntax for encapsulation.
-
bootstraparse.modules.context_mngr.TextContainer
bootstraparse.modules.context_mngr.TextContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.TextContainer.export
bootstraparse.modules.context_mngr.TextContainer.html#export
ZopeInterfaceFunction
Method
PUBLIC
Export the container to a string. :type exm: export.ExportManager :rtype : str
-
bootstraparse.modules.context_mngr.EtEmContainer
bootstraparse.modules.context_mngr.EtEmContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtEmContainer.type
bootstraparse.modules.context_mngr.EtEmContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtEmContainer.subtype
bootstraparse.modules.context_mngr.EtEmContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtStrongContainer
bootstraparse.modules.context_mngr.EtStrongContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtStrongContainer.type
bootstraparse.modules.context_mngr.EtStrongContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtStrongContainer.subtype
bootstraparse.modules.context_mngr.EtStrongContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtUnderlineContainer
bootstraparse.modules.context_mngr.EtUnderlineContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtUnderlineContainer.type
bootstraparse.modules.context_mngr.EtUnderlineContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtUnderlineContainer.subtype
bootstraparse.modules.context_mngr.EtUnderlineContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtStrikethroughContainer
bootstraparse.modules.context_mngr.EtStrikethroughContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtStrikethroughContainer.type
bootstraparse.modules.context_mngr.EtStrikethroughContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtStrikethroughContainer.subtype
bootstraparse.modules.context_mngr.EtStrikethroughContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtCustomSpanContainer
bootstraparse.modules.context_mngr.EtCustomSpanContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtCustomSpanContainer.type
bootstraparse.modules.context_mngr.EtCustomSpanContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtCustomSpanContainer.export
bootstraparse.modules.context_mngr.EtCustomSpanContainer.html#export
ZopeInterfaceFunction
Method
PUBLIC
Export the container to a string. :type exm: export.ExportManager :rtype : str
-
bootstraparse.modules.context_mngr.EtCustomSpanContainer.subtype
bootstraparse.modules.context_mngr.EtCustomSpanContainer.html#subtype
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ReContextContainer
bootstraparse.modules.context_mngr.ReContextContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ReContextContainer.children
bootstraparse.modules.context_mngr.ReContextContainer.html#children
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ReContextContainer.get_content
bootstraparse.modules.context_mngr.ReContextContainer.html#get_content
ZopeInterfaceFunction
Method
PUBLIC
Get the content of any BaseContainer object (default self.content). :param exm: ExportManager to use for exporting :param arbitrary_list: List to get the content from :type exm: export.ExportManager :type arbitrary_list: list[BaseContainer] :rtype : str...
-
bootstraparse.modules.context_mngr.EtUlistContainer
bootstraparse.modules.context_mngr.EtUlistContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtUlistContainer.type
bootstraparse.modules.context_mngr.EtUlistContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtUlistContainer.subtype
bootstraparse.modules.context_mngr.EtUlistContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtUlistContainer.children
bootstraparse.modules.context_mngr.EtUlistContainer.html#children
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtOlistContainer
bootstraparse.modules.context_mngr.EtOlistContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtOlistContainer.type
bootstraparse.modules.context_mngr.EtOlistContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtOlistContainer.subtype
bootstraparse.modules.context_mngr.EtOlistContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.EtOlistContainer.children
bootstraparse.modules.context_mngr.EtOlistContainer.html#children
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.HyperLinkContainer
bootstraparse.modules.context_mngr.HyperLinkContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.HyperLinkContainer.type
bootstraparse.modules.context_mngr.HyperLinkContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.HyperLinkContainer.subtype
bootstraparse.modules.context_mngr.HyperLinkContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.HyperLinkContainer.export
bootstraparse.modules.context_mngr.HyperLinkContainer.html#export
ZopeInterfaceFunction
Method
PUBLIC
Export the container to a string. :type exm: export.ExportManager :rtype : str
-
bootstraparse.modules.context_mngr.HyperLinkContainer.get_content
bootstraparse.modules.context_mngr.HyperLinkContainer.html#get_content
ZopeInterfaceFunction
Method
PUBLIC
Get the content of any BaseContainer object (default self.content). :param exm: ExportManager to use for exporting :param arbitrary_list: List to get the content from :type exm: export.ExportManager :type arbitrary_list: list[BaseContainer] :rtype : str...
-
bootstraparse.modules.context_mngr.SeContainer
bootstraparse.modules.context_mngr.SeContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.SeContainer.type
bootstraparse.modules.context_mngr.SeContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.SeContainer.export
bootstraparse.modules.context_mngr.SeContainer.html#export
ZopeInterfaceFunction
Method
PUBLIC
Export the container to a string. :type exm: export.ExportManager :rtype : str
-
bootstraparse.modules.context_mngr.SeContainer.subtype
bootstraparse.modules.context_mngr.SeContainer.html#subtype
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.DisplayContainer
bootstraparse.modules.context_mngr.DisplayContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.DisplayContainer.type
bootstraparse.modules.context_mngr.DisplayContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.DisplayContainer.subtype
bootstraparse.modules.context_mngr.DisplayContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.DisplayContainer.export
bootstraparse.modules.context_mngr.DisplayContainer.html#export
ZopeInterfaceFunction
Method
PUBLIC
Export the container to a string. :type exm: export.ExportManager :rtype : str
-
bootstraparse.modules.context_mngr.DisplayContainer.get_content
bootstraparse.modules.context_mngr.DisplayContainer.html#get_content
ZopeInterfaceFunction
Method
PUBLIC
Get the content of any BaseContainer object (default self.content). :param exm: ExportManager to use for exporting :param arbitrary_list: List to get the content from :type exm: export.ExportManager :type arbitrary_list: list[BaseContainer] :rtype : str...
-
bootstraparse.modules.context_mngr.TableSeparatorContainer
bootstraparse.modules.context_mngr.TableSeparatorContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.TableRowContainer
bootstraparse.modules.context_mngr.TableRowContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.TableRowContainer.type
bootstraparse.modules.context_mngr.TableRowContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.TableRowContainer.subtype
bootstraparse.modules.context_mngr.TableRowContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.TableRowContainer.__init__
bootstraparse.modules.context_mngr.TableRowContainer.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
:param content: List of tokens to be added to the container :param optionals: List of optional tokens to be added to the container (from the parser) :param others: List of values to add to the .format() method :type content: (list[(syntax...
-
bootstraparse.modules.context_mngr.TableCellContainer
bootstraparse.modules.context_mngr.TableCellContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.TableCellContainer.type
bootstraparse.modules.context_mngr.TableCellContainer.html#type
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.TableCellContainer.subtype
bootstraparse.modules.context_mngr.TableCellContainer.html#subtype
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.TableCellContainer.__init__
bootstraparse.modules.context_mngr.TableCellContainer.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
:param content: List of tokens to be added to the container :param optionals: List of optional tokens to be added to the container (from the parser) :param others: List of values to add to the .format() method :type content: (list[(syntax...
-
bootstraparse.modules.context_mngr.LinebreakContainer
bootstraparse.modules.context_mngr.LinebreakContainer.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.LinebreakContainer.export
bootstraparse.modules.context_mngr.LinebreakContainer.html#export
ZopeInterfaceFunction
Method
PUBLIC
Export the container to a string. :type exm: export.ExportManager :rtype : str
-
bootstraparse.modules.context_mngr._to_container
bootstraparse.modules.context_mngr.html#_to_container
ZopeInterfaceAttribute
Variable
PRIVATE
Undocumented
-
bootstraparse.modules.context_mngr.ContextManager
bootstraparse.modules.context_mngr.ContextManager.html
ZopeInterfaceClass
Class
PUBLIC
Class in charge of piling all the parsed elements and then encapsulating them inside one another.
-
bootstraparse.modules.context_mngr.ContextManager.__init__
bootstraparse.modules.context_mngr.ContextManager.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Takes a list of parsed tokens. :type parsed_list : list[syntax.SemanticType] :param parsed_list: List of parsed tokens output by our parser. :type name: str :param name: Name of the file being parsed. ...
-
bootstraparse.modules.context_mngr.ContextManager.output
bootstraparse.modules.context_mngr.ContextManager.html#output
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ContextManager.parsed_list
bootstraparse.modules.context_mngr.ContextManager.html#parsed_list
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ContextManager.pile
bootstraparse.modules.context_mngr.ContextManager.html#pile
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ContextManager.name
bootstraparse.modules.context_mngr.ContextManager.html#name
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ContextManager.ident
bootstraparse.modules.context_mngr.ContextManager.html#ident
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ContextManager.matched_elements
bootstraparse.modules.context_mngr.ContextManager.html#matched_elements
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ContextManager.dict_lookahead
bootstraparse.modules.context_mngr.ContextManager.html#dict_lookahead
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ContextManager.contextualised
bootstraparse.modules.context_mngr.ContextManager.html#contextualised
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.context_mngr.ContextManager.encapsulate
bootstraparse.modules.context_mngr.ContextManager.html#encapsulate
ZopeInterfaceFunction
Method
PUBLIC
Method to encapsulate a number of tokens together as a final container object and replace all elements in the pile with None, except the first one which becomes the container. :type start : int :param start: Index of the pile where the encapsulation must begin...
-
bootstraparse.modules.context_mngr.ContextManager._add_matched
bootstraparse.modules.context_mngr.ContextManager.html#_add_matched
ZopeInterfaceFunction
Method
PRIVATE
Method to add a matched element to the dictionary of matched elements. :type label : str :param label: Label of the matched element. :type index: int :param index: Index of the matched element in the pile.
-
bootstraparse.modules.context_mngr.ContextManager._get_matched
bootstraparse.modules.context_mngr.ContextManager.html#_get_matched
ZopeInterfaceFunction
Method
PRIVATE
Method to get the index of the last matched element of a given label. :type label: str :param label: Label of the matched element. :rtype: int :return: Index of the last matched element
-
bootstraparse.modules.context_mngr.ContextManager.__call__
bootstraparse.modules.context_mngr.ContextManager.html#__call__
ZopeInterfaceFunction
Method
PUBLIC
Interprets the list of tokens provided and deduces context, encapsulating them to their closest neighbour and containing all tokens inbetween. :rtype: list[BaseContainer] :return: Returns the pile entirely processed as a list of containers...
-
bootstraparse.modules.context_mngr.ContextManager.__iter__
bootstraparse.modules.context_mngr.ContextManager.html#__iter__
ZopeInterfaceFunction
Method
PUBLIC
Iterator over the pile. :ytype: BaseContainer
-
bootstraparse.modules.context_mngr.ContextManager.finalize_pile
bootstraparse.modules.context_mngr.ContextManager.html#finalize_pile
ZopeInterfaceFunction
Method
PUBLIC
Function for cleaning up of the pile after full contextualisation. Removes Nones and checks for any errors or illogical containers. :return: list[BaseContainer]
-
bootstraparse.modules.context_mngr.ContextManager.lookahead
bootstraparse.modules.context_mngr.ContextManager.html#lookahead
ZopeInterfaceFunction
Method
PUBLIC
Iterates the pile beginning from index and looks for all tokens matching labels with token. :type token : syntax.BaseContainer :param token: Token to look for. :type index : int :param index: Index of the token in the pile...
-
bootstraparse.modules.context_mngr.ContextManager.recontext
bootstraparse.modules.context_mngr.ContextManager.html#recontext
ZopeInterfaceFunction
Method
PUBLIC
Function to recontextualise the content of a token. :param token: Token to recontextualise. :type token: syntax.SemanticType :return: Token to recontextualise. :rtype: syntax.SemanticType
-
bootstraparse.modules.context_mngr.ContextManager.get_last_container_in_pile
bootstraparse.modules.context_mngr.ContextManager.html#get_last_container_in_pile
ZopeInterfaceFunction
Method
PUBLIC
Returns the last element in the pile if it is a Container, raises an error otherwise. :type index : int :param index: Index of the element to check. :return: Last element in the pile if it is a Container, raises an error otherwise...
-
bootstraparse.modules.context_mngr.ContextManager.print_all
bootstraparse.modules.context_mngr.ContextManager.html#print_all
ZopeInterfaceFunction
Method
PUBLIC
Prints the pile.
-
bootstraparse.modules.syntax.SemanticType
bootstraparse.modules.syntax.SemanticType.html
ZopeInterfaceClass
Class
PUBLIC
Allows us to access basic operations and identify each token parsed.
-
bootstraparse.modules.syntax.SemanticType.label
bootstraparse.modules.syntax.SemanticType.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.SemanticType.__init__
bootstraparse.modules.syntax.SemanticType.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initialises the token. :param content: The content of the token. :type content: list[pp.ParseResults]
-
bootstraparse.modules.syntax.SemanticType.content
bootstraparse.modules.syntax.SemanticType.html#content
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.SemanticType.line_number
bootstraparse.modules.syntax.SemanticType.html#line_number
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.SemanticType.file_name
bootstraparse.modules.syntax.SemanticType.html#file_name
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.SemanticType.label_container
bootstraparse.modules.syntax.SemanticType.html#label_container
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.SemanticType.to_markup
bootstraparse.modules.syntax.SemanticType.html#to_markup
ZopeInterfaceFunction
Method
PUBLIC
Function used for testing and readability purposes. Replaces matched markup with html-like tags. :return: The markup of the token. :rtype: str
-
bootstraparse.modules.syntax.SemanticType.to_original
bootstraparse.modules.syntax.SemanticType.html#to_original
ZopeInterfaceFunction
Method
PUBLIC
Return the original string of the token. :return: The original string of the token. :rtype: str
-
bootstraparse.modules.syntax.SemanticType.__str__
bootstraparse.modules.syntax.SemanticType.html#__str__
ZopeInterfaceFunction
Method
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.SemanticType.__repr__
bootstraparse.modules.syntax.SemanticType.html#__repr__
ZopeInterfaceFunction
Method
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.SemanticType.__eq__
bootstraparse.modules.syntax.SemanticType.html#__eq__
ZopeInterfaceFunction
Method
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.SemanticType.__ne__
bootstraparse.modules.syntax.SemanticType.html#__ne__
ZopeInterfaceFunction
Method
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.SemanticType.counterpart
bootstraparse.modules.syntax.SemanticType.html#counterpart
ZopeInterfaceFunction
Method
PUBLIC
Function called by the context manager to know how to deal with the encapsulation of the token. Will return the counterpart of the token (the previous token to look for). :return: The counterpart of the token...
-
bootstraparse.modules.syntax.SemanticType.to_container
bootstraparse.modules.syntax.SemanticType.html#to_container
ZopeInterfaceFunction
Method
PUBLIC
Function called by the context manager to know how to deal with the encapsulation of the token. :param filter_func: A function that will be used to filter the content of the token. :type filter_func: (callable| None) :return: Self if containable, the expected replacement token if it can, raises an error otherwise...
-
bootstraparse.modules.syntax.TokensToMatch
bootstraparse.modules.syntax.TokensToMatch.html
ZopeInterfaceClass
Class
PUBLIC
Class used for verification in the context manager. Classes inheriting this should be added to matched_elements.
-
bootstraparse.modules.syntax.AddFirstElementToLabel
bootstraparse.modules.syntax.AddFirstElementToLabel.html
ZopeInterfaceClass
Class
PUBLIC
Class used for verification in the context manager. Adds the first element of the content to the label (for matching purposes).
-
bootstraparse.modules.syntax.AddFirstElementToLabel.__init__
bootstraparse.modules.syntax.AddFirstElementToLabel.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initialises the token. :param content: The content of the token. :type content: list[pp.ParseResults]
-
bootstraparse.modules.syntax.AddFirstElementToLabel._addendum
bootstraparse.modules.syntax.AddFirstElementToLabel.html#_addendum
ZopeInterfaceAttribute
Instance Variable
PRIVATE
Undocumented
-
bootstraparse.modules.syntax.ExplicitSemanticType
bootstraparse.modules.syntax.ExplicitSemanticType.html
ZopeInterfaceClass
Class
PUBLIC
Explicit semantic type, the label is the only information we need.
-
bootstraparse.modules.syntax.ExplicitSemanticType.counterpart
bootstraparse.modules.syntax.ExplicitSemanticType.html#counterpart
ZopeInterfaceFunction
Method
PUBLIC
Function called by the context manager to know how to deal with the encapsulation of the token. Will return the counterpart of the token (the previous token to look for). :return: The counterpart of the token...
-
bootstraparse.modules.syntax.ExplicitSemanticType.to_markup
bootstraparse.modules.syntax.ExplicitSemanticType.html#to_markup
ZopeInterfaceFunction
Method
PUBLIC
Function used for testing and readability purposes. Replaces matched markup with html-like tags. :return: The markup of the token. :rtype: str
-
bootstraparse.modules.syntax.ExplicitSemanticType.to_container
bootstraparse.modules.syntax.ExplicitSemanticType.html#to_container
ZopeInterfaceFunction
Method
PUBLIC
Check if we are trying to encapsulate this very token, don't do anything
-
bootstraparse.modules.syntax.FinalSemanticType
bootstraparse.modules.syntax.FinalSemanticType.html
ZopeInterfaceClass
Class
PUBLIC
Semantic type used by the context manager to ascertain token is possible to encapsulate.
-
bootstraparse.modules.syntax.FinalSemanticType.counterpart
bootstraparse.modules.syntax.FinalSemanticType.html#counterpart
ZopeInterfaceFunction
Method
PUBLIC
Function called by the context manager to know how to deal with the encapsulation of the token. Will return the counterpart of the token (the previous token to look for). :return: The counterpart of the token...
-
bootstraparse.modules.syntax.FinalSemanticType.to_container
bootstraparse.modules.syntax.FinalSemanticType.html#to_container
ZopeInterfaceFunction
Method
PUBLIC
Function called by the context manager to know how to deal with the encapsulation of the token. :param filter_func: A function that will be used to filter the content of the token. :type filter_func: (callable| None) :return: Self if containable, the expected replacement token if it can, raises an error otherwise...
-
bootstraparse.modules.syntax.OpenedSemanticType
bootstraparse.modules.syntax.OpenedSemanticType.html
ZopeInterfaceClass
Class
PUBLIC
Semantic type used to signify it has a matching end component and needs to be matched.
-
bootstraparse.modules.syntax.OpenedSemanticType.to_container
bootstraparse.modules.syntax.OpenedSemanticType.html#to_container
ZopeInterfaceFunction
Method
PUBLIC
Function called by the context manager to know how to deal with the encapsulation of the token. :param filter_func: A function that will be used to filter the content of the token. :type filter_func: (callable| None) :return: Self if containable, the expected replacement token if it can, raises an error otherwise...
-
bootstraparse.modules.syntax.ClosedSemanticType
bootstraparse.modules.syntax.ClosedSemanticType.html
ZopeInterfaceClass
Class
PUBLIC
Semantic type used to signify it has a matching start component and needs to be matched.
-
bootstraparse.modules.syntax.EmptySemanticType
bootstraparse.modules.syntax.EmptySemanticType.html
ZopeInterfaceClass
Class
PUBLIC
Empty semantic type, the content is the only information we need.
-
bootstraparse.modules.syntax.EmptySemanticType.to_markup
bootstraparse.modules.syntax.EmptySemanticType.html#to_markup
ZopeInterfaceFunction
Method
PUBLIC
Function used for testing and readability purposes. Replaces matched markup with html-like tags. :return: The markup of the token. :rtype: str
-
bootstraparse.modules.syntax.UnimplementedToken
bootstraparse.modules.syntax.UnimplementedToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.UnimplementedToken.label
bootstraparse.modules.syntax.UnimplementedToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.AliasToken
bootstraparse.modules.syntax.AliasToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.AliasToken.label
bootstraparse.modules.syntax.AliasToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.ImageToken
bootstraparse.modules.syntax.ImageToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.ImageToken.label
bootstraparse.modules.syntax.ImageToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TextToken
bootstraparse.modules.syntax.TextToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TextToken.label
bootstraparse.modules.syntax.TextToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TextToken.to_container
bootstraparse.modules.syntax.TextToken.html#to_container
ZopeInterfaceFunction
Method
PUBLIC
Function called by the context manager to know how to deal with the encapsulation of the token. :param filter_func: A function that will be used to filter the content of the token. :type filter_func: (callable| None) :return: Self if containable, the expected replacement token if it can, raises an error otherwise...
-
bootstraparse.modules.syntax.EtEmToken
bootstraparse.modules.syntax.EtEmToken.html
ZopeInterfaceClass
Class
PUBLIC
*
-
bootstraparse.modules.syntax.EtEmToken.label
bootstraparse.modules.syntax.EtEmToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.EtStrongToken
bootstraparse.modules.syntax.EtStrongToken.html
ZopeInterfaceClass
Class
PUBLIC
**
-
bootstraparse.modules.syntax.EtStrongToken.label
bootstraparse.modules.syntax.EtStrongToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.EtUnderlineToken
bootstraparse.modules.syntax.EtUnderlineToken.html
ZopeInterfaceClass
Class
PUBLIC
__
-
bootstraparse.modules.syntax.EtUnderlineToken.label
bootstraparse.modules.syntax.EtUnderlineToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.EtStrikethroughToken
bootstraparse.modules.syntax.EtStrikethroughToken.html
ZopeInterfaceClass
Class
PUBLIC
~~
-
bootstraparse.modules.syntax.EtStrikethroughToken.label
bootstraparse.modules.syntax.EtStrikethroughToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.EtCustomSpanToken
bootstraparse.modules.syntax.EtCustomSpanToken.html
ZopeInterfaceClass
Class
PUBLIC
(#int)
-
bootstraparse.modules.syntax.EtCustomSpanToken.label
bootstraparse.modules.syntax.EtCustomSpanToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.EtUlistToken
bootstraparse.modules.syntax.EtUlistToken.html
ZopeInterfaceClass
Class
PUBLIC
No summary
-
bootstraparse.modules.syntax.EtUlistToken.label
bootstraparse.modules.syntax.EtUlistToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.EtOlistToken
bootstraparse.modules.syntax.EtOlistToken.html
ZopeInterfaceClass
Class
PUBLIC
#.
-
bootstraparse.modules.syntax.EtOlistToken.label
bootstraparse.modules.syntax.EtOlistToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.DisplayToken
bootstraparse.modules.syntax.DisplayToken.html
ZopeInterfaceClass
Class
PUBLIC
! string ! number of ! indicates level
-
bootstraparse.modules.syntax.DisplayToken.label
bootstraparse.modules.syntax.DisplayToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.StructuralElementStartToken
bootstraparse.modules.syntax.StructuralElementStartToken.html
ZopeInterfaceClass
Class
PUBLIC
<<div|article|section|aside|header|body|nav
-
bootstraparse.modules.syntax.StructuralElementStartToken.label
bootstraparse.modules.syntax.StructuralElementStartToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.StructuralElementEndToken
bootstraparse.modules.syntax.StructuralElementEndToken.html
ZopeInterfaceClass
Class
PUBLIC
div|article|section|aside|header|body|nav>>
-
bootstraparse.modules.syntax.StructuralElementEndToken.label
bootstraparse.modules.syntax.StructuralElementEndToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.StructuralElementEndToken.counterpart
bootstraparse.modules.syntax.StructuralElementEndToken.html#counterpart
ZopeInterfaceFunction
Method
PUBLIC
Function called by the context manager to know how to deal with the encapsulation of the token. Will return the counterpart of the token (the previous token to look for). :return: The counterpart of the token...
-
bootstraparse.modules.syntax.HyperlinkToken
bootstraparse.modules.syntax.HyperlinkToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.HyperlinkToken.label
bootstraparse.modules.syntax.HyperlinkToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TableToken
bootstraparse.modules.syntax.TableToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TableToken.label
bootstraparse.modules.syntax.TableToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TableRowToken
bootstraparse.modules.syntax.TableRowToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TableRowToken.label
bootstraparse.modules.syntax.TableRowToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TableCellToken
bootstraparse.modules.syntax.TableCellToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TableCellToken.label
bootstraparse.modules.syntax.TableCellToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TableSeparatorToken
bootstraparse.modules.syntax.TableSeparatorToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.TableSeparatorToken.label
bootstraparse.modules.syntax.TableSeparatorToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.OptionalToken
bootstraparse.modules.syntax.OptionalToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.OptionalToken.label
bootstraparse.modules.syntax.OptionalToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.OptionalInsertToken
bootstraparse.modules.syntax.OptionalInsertToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.OptionalInsertToken.label
bootstraparse.modules.syntax.OptionalInsertToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.OptionalVarToken
bootstraparse.modules.syntax.OptionalVarToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.OptionalVarToken.label
bootstraparse.modules.syntax.OptionalVarToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.OptionalClassToken
bootstraparse.modules.syntax.OptionalClassToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.OptionalClassToken.label
bootstraparse.modules.syntax.OptionalClassToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.BeAssignToken
bootstraparse.modules.syntax.BeAssignToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.BeAssignToken.label
bootstraparse.modules.syntax.BeAssignToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.BeValueToken
bootstraparse.modules.syntax.BeValueToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.BeValueToken.label
bootstraparse.modules.syntax.BeValueToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.BlockQuoteToken
bootstraparse.modules.syntax.BlockQuoteToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.BlockQuoteToken.label
bootstraparse.modules.syntax.BlockQuoteToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.BlockQuoteAuthorToken
bootstraparse.modules.syntax.BlockQuoteAuthorToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.BlockQuoteAuthorToken.label
bootstraparse.modules.syntax.BlockQuoteAuthorToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.CodeToken
bootstraparse.modules.syntax.CodeToken.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.CodeToken.label
bootstraparse.modules.syntax.CodeToken.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.Linebreak
bootstraparse.modules.syntax.Linebreak.html
ZopeInterfaceClass
Class
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.Linebreak.label
bootstraparse.modules.syntax.Linebreak.html#label
ZopeInterfaceAttribute
Class Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.Linebreak.__init__
bootstraparse.modules.syntax.Linebreak.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initialises the token. :param content: The content of the token. :type content: list[pp.ParseResults]
-
bootstraparse.modules.syntax.Linebreak.content
bootstraparse.modules.syntax.Linebreak.html#content
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.Linebreak.to_container
bootstraparse.modules.syntax.Linebreak.html#to_container
ZopeInterfaceFunction
Method
PUBLIC
Check if we are trying to encapsulate this very token, don't do anything
-
bootstraparse.modules.syntax.of_type
bootstraparse.modules.syntax.html#of_type
ZopeInterfaceFunction
Function
PUBLIC
Function creating a custom function for generating the given Token type. :param token_class: SemanticType class :type token_class: type :return: returns a function creating an instance of the given class :rtype: function...
-
bootstraparse.modules.syntax.reparse
bootstraparse.modules.syntax.html#reparse
ZopeInterfaceFunction
Function
PUBLIC
Creates a function which reparses given match with specified parsing element. :param parse_element: pp object defining desired match :type parse_element: pp.ParserElement :return: returns a function parsing given match with specified parsing element :rtype: function...
-
bootstraparse.modules.syntax.SplitOptionals
bootstraparse.modules.syntax.html#SplitOptionals
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.split_optionals
bootstraparse.modules.syntax.html#split_optionals
ZopeInterfaceFunction
Function
PUBLIC
Splits the optional attributes into separate lists. :param optionals: list of optional attributes :type optionals: OptionalToken :return: SplitOptionals object containing the split optionals :rtype: SplitOptionals...
-
bootstraparse.modules.syntax.readable_markup
bootstraparse.modules.syntax.html#readable_markup
ZopeInterfaceFunction
Function
PUBLIC
Function used for testing and readability purposes. Replaces matched markup with html-like tags. :param list_of_tokens: list of matched markup tokens in analysed text. :type list_of_tokens: list :return: returns readable string...
-
bootstraparse.modules.syntax.rgx_import_file
bootstraparse.modules.syntax.html#rgx_import_file
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.quotes
bootstraparse.modules.syntax.html#quotes
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.value
bootstraparse.modules.syntax.html#value
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.assignation
bootstraparse.modules.syntax.html#assignation
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.text
bootstraparse.modules.syntax.html#text
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.var
bootstraparse.modules.syntax.html#var
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.image_element
bootstraparse.modules.syntax.html#image_element
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.alias_element
bootstraparse.modules.syntax.html#alias_element
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.expression
bootstraparse.modules.syntax.html#expression
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.html_insert
bootstraparse.modules.syntax.html#html_insert
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.class_insert
bootstraparse.modules.syntax.html#class_insert
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.optional
bootstraparse.modules.syntax.html#optional
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.structural_elements
bootstraparse.modules.syntax.html#structural_elements
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.display_element
bootstraparse.modules.syntax.html#display_element
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.il_link
bootstraparse.modules.syntax.html#il_link
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.et_em
bootstraparse.modules.syntax.html#et_em
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.et_strong
bootstraparse.modules.syntax.html#et_strong
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.et_underline
bootstraparse.modules.syntax.html#et_underline
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.et_strikethrough
bootstraparse.modules.syntax.html#et_strikethrough
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.et_custom_span
bootstraparse.modules.syntax.html#et_custom_span
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.code
bootstraparse.modules.syntax.html#code
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.markup
bootstraparse.modules.syntax.html#markup
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.enhanced_text
bootstraparse.modules.syntax.html#enhanced_text
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.se_start
bootstraparse.modules.syntax.html#se_start
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.se_end
bootstraparse.modules.syntax.html#se_end
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.se
bootstraparse.modules.syntax.html#se
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.table_row
bootstraparse.modules.syntax.html#table_row
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.table_separator
bootstraparse.modules.syntax.html#table_separator
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.blockquote
bootstraparse.modules.syntax.html#blockquote
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.blockquote_author
bootstraparse.modules.syntax.html#blockquote_author
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.table
bootstraparse.modules.syntax.html#table
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.quotation
bootstraparse.modules.syntax.html#quotation
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.multi_line
bootstraparse.modules.syntax.html#multi_line
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.one_display
bootstraparse.modules.syntax.html#one_display
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.one_olist
bootstraparse.modules.syntax.html#one_olist
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.one_ulist
bootstraparse.modules.syntax.html#one_ulist
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.one_line
bootstraparse.modules.syntax.html#one_line
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.line
bootstraparse.modules.syntax.html#line
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.image
bootstraparse.modules.syntax.html#image
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.alias
bootstraparse.modules.syntax.html#alias
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.syntax.line_to_replace
bootstraparse.modules.syntax.html#line_to_replace
ZopeInterfaceAttribute
Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser
bootstraparse.modules.preparser.PreParser.html
ZopeInterfaceClass
Class
PUBLIC
Takes a path and environment, executes all pre-parsing methods on the specified file.
-
bootstraparse.modules.preparser.PreParser.__init__
bootstraparse.modules.preparser.PreParser.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
Initializes the PreParser object. Takes the following parameters: :param file_path: the path of the file to be parsed :param _env: the environment object :param list_of_paths: the list of files that have been imported in this branch of the import tree :param dict_of_imports: Dictionary of all imports made to avoid duplicate file opening / pre-parsing :type file_path: str :type _env: environment...
-
bootstraparse.modules.preparser.PreParser._env
bootstraparse.modules.preparser.PreParser.html#_env
ZopeInterfaceAttribute
Instance Variable
PRIVATE
Undocumented
-
bootstraparse.modules.preparser.PreParser.path
bootstraparse.modules.preparser.PreParser.html#path
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.name
bootstraparse.modules.preparser.PreParser.html#name
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.base_path
bootstraparse.modules.preparser.PreParser.html#base_path
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.relative_path_resolver
bootstraparse.modules.preparser.PreParser.html#relative_path_resolver
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.list_of_paths
bootstraparse.modules.preparser.PreParser.html#list_of_paths
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.global_dict_of_imports
bootstraparse.modules.preparser.PreParser.html#global_dict_of_imports
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.local_dict_of_imports
bootstraparse.modules.preparser.PreParser.html#local_dict_of_imports
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.saved_import_list
bootstraparse.modules.preparser.PreParser.html#saved_import_list
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.tree_view
bootstraparse.modules.preparser.PreParser.html#tree_view
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.file_with_all_imports
bootstraparse.modules.preparser.PreParser.html#file_with_all_imports
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.file_with_all_replacements
bootstraparse.modules.preparser.PreParser.html#file_with_all_replacements
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.current_origin_for_read
bootstraparse.modules.preparser.PreParser.html#current_origin_for_read
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.is_global_dict_of_imports_initialized
bootstraparse.modules.preparser.PreParser.html#is_global_dict_of_imports_initialized
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.imports_done
bootstraparse.modules.preparser.PreParser.html#imports_done
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.replacements_done
bootstraparse.modules.preparser.PreParser.html#replacements_done
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.preparser.PreParser.make_temporary_files
bootstraparse.modules.preparser.PreParser.html#make_temporary_files
ZopeInterfaceFunction
Method
PUBLIC
Creates temporary files for the import list and the replacement.
-
bootstraparse.modules.preparser.PreParser.new_temporary_files
bootstraparse.modules.preparser.PreParser.html#new_temporary_files
ZopeInterfaceFunction
Method
PUBLIC
Make new temporary files, if the old one are not referenced, the garbage collector will delete them.
-
bootstraparse.modules.preparser.PreParser.do_imports
bootstraparse.modules.preparser.PreParser.html#do_imports
ZopeInterfaceFunction
Method
PUBLIC
Execute all actions needed to do the imports and setup for the next step :return: The file descriptor of the file with all imports :rtype: StringIO
-
bootstraparse.modules.preparser.PreParser.do_replacements
bootstraparse.modules.preparser.PreParser.html#do_replacements
ZopeInterfaceFunction
Method
PUBLIC
Execute all actions needed to do the replacements. :return: The file descriptor of the file with all replacements :rtype: StringIO
-
bootstraparse.modules.preparser.PreParser.readlines
bootstraparse.modules.preparser.PreParser.html#readlines
ZopeInterfaceFunction
Method
PUBLIC
Reads the original file and returns a list of lines. :return: a list of lines :rtype: list[str]
-
bootstraparse.modules.preparser.PreParser.get_all_lines
bootstraparse.modules.preparser.PreParser.html#get_all_lines
ZopeInterfaceFunction
Method
PUBLIC
Get the lines from the file on the step you are in :return: A list of lines :rtype: list[str]
-
bootstraparse.modules.preparser.PreParser.make_import_list
bootstraparse.modules.preparser.PreParser.html#make_import_list
ZopeInterfaceFunction
Method
PUBLIC
Creates a list of all files to be imported. Makes sure that the files are not already imported through a previous import statement. Recursively build a list of PreParser object for each file to be imported...
-
bootstraparse.modules.preparser.PreParser.parse_import_list
bootstraparse.modules.preparser.PreParser.html#parse_import_list
ZopeInterfaceFunction
Method
PUBLIC
Parses the import list of the file. :return: a list of files to be imported, and the line number of the import statement :rtype: list[(str, int)]
-
bootstraparse.modules.preparser.PreParser.export_with_imports
bootstraparse.modules.preparser.PreParser.html#export_with_imports
ZopeInterfaceFunction
Method
PUBLIC
Return the file object with all file imports done :return: a filelike object with all file imports done :rtype: StringIO
-
bootstraparse.modules.preparser.PreParser.parse_shortcuts_and_images
bootstraparse.modules.preparser.PreParser.html#parse_shortcuts_and_images
ZopeInterfaceFunction
Method
PUBLIC
Parses through the output files from export_with_imports and replaces shortcuts and images calls with appropriate html :return: The file descriptor of the file with all replacements :rtype: StringIO
-
bootstraparse.modules.preparser.PreParser.get_element_from_config
bootstraparse.modules.preparser.PreParser.html#get_element_from_config
ZopeInterfaceFunction
Method
PUBLIC
Fetches an element from the config (a nested dictionary) going through the list of keys Raises an error if the element is not found :param list_keys: the list of keys to go through the config :type list_keys: str...
-
bootstraparse.modules.preparser.PreParser.make_replacements
bootstraparse.modules.preparser.PreParser.html#make_replacements
ZopeInterfaceFunction
Static Method
PUBLIC
Tries to format the message or give an error message and return the original message :param message: the message to format :type message: str :param var_list: the list of variables to replace in the message :type var_list: str :keyword var_dict: the dictionary of variables to replace in the message :type var_dict: dict[str, str]...
-
bootstraparse.modules.preparser.PreParser.get_alias_from_config
bootstraparse.modules.preparser.PreParser.html#get_alias_from_config
ZopeInterfaceFunction
Method
PUBLIC
Returns the alias from the config and makes the replacements with the options provided :param shortcut: id of the shortcut to fetch :type shortcut: str :param optionals: optional parameters along with alias :type optionals: syntax...
-
bootstraparse.modules.preparser.PreParser.get_image_from_config
bootstraparse.modules.preparser.PreParser.html#get_image_from_config
ZopeInterfaceFunction
Method
PUBLIC
Returns the image from the config and makes the replacements with the options provided :param shortcut: id of the image to fetch :type shortcut: str :param optionals: optional parameters along with image :type optionals: syntax...
-
bootstraparse.modules.preparser.PreParser.__repr__
bootstraparse.modules.preparser.PreParser.html#__repr__
ZopeInterfaceFunction
Method
PUBLIC
Returns a string representation of the PreParser object.
-
bootstraparse.modules.preparser.PreParser.__str__
bootstraparse.modules.preparser.PreParser.html#__str__
ZopeInterfaceFunction
Method
PUBLIC
Returns a string representation of the PreParser object.
-
bootstraparse.modules.preparser.PreParser.__eq__
bootstraparse.modules.preparser.PreParser.html#__eq__
ZopeInterfaceFunction
Method
PUBLIC
Checks if the PreParser object is equal to another PreParser object. :return: True if the PreParser objects are equal, False otherwise :param other: the other PreParser object
-
bootstraparse.modules.preparser.PreParser.__ne__
bootstraparse.modules.preparser.PreParser.html#__ne__
ZopeInterfaceFunction
Method
PUBLIC
Checks if the PreParser object is not equal to another PreParser object. :param other: the other PreParser object :type other: PreParser :return: True if the PreParser objects are not equal, False otherwise...
-
bootstraparse.modules.preparser.PreParser.rich_tree
bootstraparse.modules.preparser.PreParser.html#rich_tree
ZopeInterfaceFunction
Method
PUBLIC
Returns a rich representation of the PreParser object. :param prefix: the prefix to add to the representation :type prefix: str :param suffix: the suffix to add to the representation :type suffix: str :param force: if True, the representation is always computed, even if it has already been done :type force: bool :param strip_prefix: the prefix to remove from the path :type strip_prefix: str :return: a rich representation of the PreParser object...
-
bootstraparse.modules.sitecrawler.SiteCrawler
bootstraparse.modules.sitecrawler.SiteCrawler.html
ZopeInterfaceClass
Class
PUBLIC
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.sitecrawler.SiteCrawler.__init__
bootstraparse.modules.sitecrawler.SiteCrawler.html#__init__
ZopeInterfaceFunction
Method
PUBLIC
:param path: The path to the directory to be crawled :param destination: The path to the directory where the website will be created :param _env: The environment object :type path: str :type destination: str :type _env: environment...
-
bootstraparse.modules.sitecrawler.SiteCrawler._env
bootstraparse.modules.sitecrawler.SiteCrawler.html#_env
ZopeInterfaceAttribute
Instance Variable
PRIVATE
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.initial_path
bootstraparse.modules.sitecrawler.SiteCrawler.html#initial_path
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.destination_path
bootstraparse.modules.sitecrawler.SiteCrawler.html#destination_path
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.force_rewrite
bootstraparse.modules.sitecrawler.SiteCrawler.html#force_rewrite
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.directories
bootstraparse.modules.sitecrawler.SiteCrawler.html#directories
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.files
bootstraparse.modules.sitecrawler.SiteCrawler.html#files
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.files_to_copy
bootstraparse.modules.sitecrawler.SiteCrawler.html#files_to_copy
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.preparsers
bootstraparse.modules.sitecrawler.SiteCrawler.html#preparsers
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.global_dict_of_imports
bootstraparse.modules.sitecrawler.SiteCrawler.html#global_dict_of_imports
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.authorised_extensions
bootstraparse.modules.sitecrawler.SiteCrawler.html#authorised_extensions
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.forbidden_folders
bootstraparse.modules.sitecrawler.SiteCrawler.html#forbidden_folders
ZopeInterfaceAttribute
Instance Variable
PUBLIC
Undocumented
-
bootstraparse.modules.sitecrawler.SiteCrawler.get_all_paths
bootstraparse.modules.sitecrawler.SiteCrawler.html#get_all_paths
ZopeInterfaceFunction
Method
PUBLIC
This method is used to get all the paths to be crawled. Its goal is to get all the paths to be crawled and to store them in the self.directories and self.files, self.files_to_copy variables.
-
bootstraparse.modules.sitecrawler.SiteCrawler.list_recursively
bootstraparse.modules.sitecrawler.SiteCrawler.html#list_recursively
ZopeInterfaceFunction
Method
PUBLIC
Recursive method to get all the paths to be crawled. :param path: The current path to be crawled :param root: The root path (initial path) :type path: str :type root: str :return: A tuple of the form (files, directories) :rtype: (list[(str, str)], list[(str, str)], list[(str, str)])...
-
bootstraparse.modules.sitecrawler.SiteCrawler.create_all_paths
bootstraparse.modules.sitecrawler.SiteCrawler.html#create_all_paths
ZopeInterfaceFunction
Method
PUBLIC
This method is used to create all the directories in the destination path.
-
bootstraparse.modules.sitecrawler.SiteCrawler.set_all_preparsers
bootstraparse.modules.sitecrawler.SiteCrawler.html#set_all_preparsers
ZopeInterfaceFunction
Method
PUBLIC
This method is used to set all the preparsers and initialize them. The preparsers are stored in the self.preparsers variable. :return: self.preparsers :rtype: list[preparser.PreParser]
-
bootstraparse.modules.sitecrawler.SiteCrawler.copy_unparsable_files
bootstraparse.modules.sitecrawler.SiteCrawler.html#copy_unparsable_files
ZopeInterfaceFunction
Method
PUBLIC
This method is used to copy all the files that could not be parsed.
-
bootstraparse.modules.sitecrawler.SiteCrawler.create_file
bootstraparse.modules.sitecrawler.SiteCrawler.html#create_file
ZopeInterfaceFunction
Method
PUBLIC
This method is used to create a file. :raises FileExistsError: If the file already exists and the force_rewrite option is False :param path: The path to the file to be created :type path: str
-
bootstraparse.modules.sitecrawler.SiteCrawler.__iter__
bootstraparse.modules.sitecrawler.SiteCrawler.html#__iter__
ZopeInterfaceFunction
Method
PUBLIC
This method is used to iterate over the preparsers and files. :yield: A tuple of the form (PreParser, file) :ytype: (preparser.PreParser, str)
-
bootstraparse.modules.parser.parse_line
bootstraparse.modules.parser.html#parse_line
ZopeInterfaceFunction
Function
PUBLIC
Takes an io string and returns the parsed output. :param io: The io string to parse. :type io: StringIO :return: The parsed output. :rtype: list[syntax.SemanticType]
-
bootstraparse.modules.sitecreator.create_website
bootstraparse.modules.sitecreator.html#create_website
ZopeInterfaceFunction
Function
PUBLIC
First function called by bparse.py, calls all other modules in the right order. :param origin: The path of the website to be built. :param destination: The destination path of the built website. :type origin: str :type destination: str :return: 0 if everything went well, 1 otherwise.
-
bootstraparse.modules.sitecreator.create_environment
bootstraparse.modules.sitecreator.html#create_environment
ZopeInterfaceFunction
Function
PUBLIC
Returns parserEnvironment as an object containing everything needed for app execution. :param origin: The path of the website to be built. :param destination: The destination path of the built website. ...
-
bootstraparse.modules.sitecreator.create_crawler
bootstraparse.modules.sitecreator.html#create_crawler
ZopeInterfaceFunction
Function
PUBLIC
Returns crawler as an object for navigation in the user files. :param origin: The path of the website to be built. :param destination: The destination path of the built website. :param _env: The environment object...
-
bootstraparse.modules.sitecreator.preparse_parse
bootstraparse.modules.sitecreator.html#preparse_parse
ZopeInterfaceFunction
Function
PUBLIC
Returns a list of containers from a preparser. :param preparser: The preparser object. :type preparser: parser.Preparser :return: List of containers. :rtype: list
-
bootstraparse.modules.sitecreator.save
bootstraparse.modules.sitecreator.html#save
ZopeInterfaceFunction
Function
PUBLIC
Saves the list of containers in the destination path. :param list_of_containers: The list of containers to be saved. :param destination: The destination path. :param env: The environment object. :type list_of_containers: list :type destination: str :type env: environment...
-
bootstraparse.__main__.parse
bootstraparse.__main__.html#parse
ZopeInterfaceFunction
Function
PUBLIC
Undocumented