diff --git a/example_userfiles/index.bpr b/example_userfiles/index.bpr index a96516a..00693ec 100644 --- a/example_userfiles/index.bpr +++ b/example_userfiles/index.bpr @@ -1,4 +1,5 @@ -@[start]['bootstrap'] +@[start]['Bootstraparse'] + Structural Elements: <
+ - bootstraparse """ diff --git a/src/bootstraparse/modules/config.py b/src/bootstraparse/modules/config.py index fdc4249..3f29cab 100644 --- a/src/bootstraparse/modules/config.py +++ b/src/bootstraparse/modules/config.py @@ -1,9 +1,9 @@ """Interprets config files The Config will be loaded by the environment at runtime and should be accessed that way Usage: - from bootstraparse.modules.config import ConfigLoader - config = ConfigLoader([list of config files], extensions=[list of extensions]) - config['file']['key'] + - from bootstraparse.modules.config import ConfigLoader + - config = ConfigLoader([list of config files], extensions=[list of extensions]) + - config['file']['key'] The ConfigLoader class has load_from_file and load_from_folder methods and __getitem__ for accessing loaded elements """ import os diff --git a/src/bootstraparse/modules/context_mngr.py b/src/bootstraparse/modules/context_mngr.py index 32524dd..47e661b 100644 --- a/src/bootstraparse/modules/context_mngr.py +++ b/src/bootstraparse/modules/context_mngr.py @@ -1,15 +1,15 @@ """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, - self.content: accessible via __getitem__, __setitem__, add, __len__, __iter__ and __getslice__. - self.optionals: accessible via __rshift__ (remapped to return self.map[other]()) - and self.map: accessible via __invert__ (remapped to return self.optionals) + - self.content: accessible via __getitem__, __setitem__, add, __len__, __iter__ and __getslice__. + - self.optionals: accessible via __rshift__ (remapped to return self.map[other]()) + - and self.map: accessible via __invert__ (remapped to return self.optionals) Usage: - from bootstraparse.modules.context_mngr import ContextManager - ctx = ContextManager() - container = BaseContainer() - container[number] -> The number element in the content - "class_insert" >> container[number] -> Get an element from one of the mapped methods + - from bootstraparse.modules.context_mngr import ContextManager + - ctx = ContextManager() + - container = BaseContainer() + - container[number] -> The number element in the content + - "class_insert" >> container[number] -> Get an element from one of the mapped methods """ from bootstraparse.modules import syntax, error_mngr, export from bootstraparse.modules.error_mngr import MismatchedContainerError, log_exception, log_message, LonelyOptionalError # noqa diff --git a/src/bootstraparse/modules/environment.py b/src/bootstraparse/modules/environment.py index 7a73667..305113c 100644 --- a/src/bootstraparse/modules/environment.py +++ b/src/bootstraparse/modules/environment.py @@ -1,19 +1,20 @@ """Module for containing super important variables Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and - self.wasInitialised and integrity_check for debug. - __getattr__ and __setattr__ check for existing super, s or m parameters, returns error if not found. + - self.wasInitialised and integrity_check for debug. + - __getattr__ and __setattr__ check for existing super, s or m parameters, returns error if not found. Usage: - from bootstraparse.modules.environment import Environment - env = Environment() - env.integrity_check() -> Checks if all mandatory parameters are set. - env["config"] -> returns config object - env["template"] -> returns template object - env["export_mngr"] -> returns export manager object - env["global_path"] -> returns global path ??? - env["user_path"] -> returns user path ??? - env["site_path"] -> returns site path - env["export"] -> returns export object ??? - env["site_crawler"] -> returns site crawler object""" + - from bootstraparse.modules.environment import Environment + - env = Environment() + - env.integrity_check() -> Checks if all mandatory parameters are set. + - env["config"] -> returns config object + - env["template"] -> returns template object + - env["export_mngr"] -> returns export manager object + - env["global_path"] -> returns global path ??? + - env["user_path"] -> returns user path ??? + - env["site_path"] -> returns site path + - env["export"] -> returns export object ??? + - env["site_crawler"] -> returns site crawler object + """ from bootstraparse.modules import error_mngr diff --git a/src/bootstraparse/modules/error_mngr.py b/src/bootstraparse/modules/error_mngr.py index 6b166a2..501e59a 100644 --- a/src/bootstraparse/modules/error_mngr.py +++ b/src/bootstraparse/modules/error_mngr.py @@ -1,13 +1,13 @@ """ Dedicated module for defining and interpreting errors as well as generating error messages You're probably here for log_message or log_exception. - They take: message, level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL") + - They take: message, level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL") There's also a dict_check(dic, *args) that returns true if all args are keys in the dict. Usage: - from bootstraparse.modules.error_mngr import log_message, log_exception - log_message("This is a message", level="INFO") level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL") - log_exception(Exception("This is an exception"), level="ERROR") - dict_check({"a": 1, "b": 2}, "a", "b") # returns [True, True] + - from bootstraparse.modules.error_mngr import log_message, log_exception + - log_message("This is a message", level="INFO") level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL") + - log_exception(Exception("This is an exception"), level="ERROR") + - dict_check({"a": 1, "b": 2}, "a", "b") # returns [True, True] """ import logging diff --git a/src/bootstraparse/modules/export.py b/src/bootstraparse/modules/export.py index 48c3ed3..0bb9b69 100644 --- a/src/bootstraparse/modules/export.py +++ b/src/bootstraparse/modules/export.py @@ -1,11 +1,11 @@ """ Module for final generation of the translated website Usage: - from bootstraparse.modules.export import ExportManager, ExportRequest, ExportResponse - rqs = ExportRequest("strucural_elements", "div", "optionals", {"id": "my_id", "class": "my_class"}) - rsp = ExportResponse("start_string", "end_string") - em = ExportManager(config_file, template_file) - em(ExportRequest()) -> ExportResponse() + - from bootstraparse.modules.export import ExportManager, ExportRequest, ExportResponse + - rqs = ExportRequest("strucural_elements", "div", "optionals", {"id": "my_id", "class": "my_class"}) + - rsp = ExportResponse("start_string", "end_string") + - em = ExportManager(config_file, template_file) + - em(ExportRequest()) -> ExportResponse() """ from io import StringIO diff --git a/src/bootstraparse/modules/parser.py b/src/bootstraparse/modules/parser.py index 3b9f0bc..497912a 100644 --- a/src/bootstraparse/modules/parser.py +++ b/src/bootstraparse/modules/parser.py @@ -2,8 +2,8 @@ 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: - from bootstraparse.modules.parser import parse_line - parse_line(io) -> [element, element, element] + - from bootstraparse.modules.parser import parse_line + - parse_line(io) -> [element, element, element] """ from io import StringIO diff --git a/src/bootstraparse/modules/pathresolver.py b/src/bootstraparse/modules/pathresolver.py index de42364..6c3a149 100644 --- a/src/bootstraparse/modules/pathresolver.py +++ b/src/bootstraparse/modules/pathresolver.py @@ -3,9 +3,9 @@ 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: - from bootstraparse.modules.pathresolver import PathResolver, b_path - b_path("../relative/path/to/file") # returns absolute path to file from the bootstraparse folder - path= PathResolver("../relative/path/to/file") # Make a PathResolver object pointing at the first path given + - from bootstraparse.modules.pathresolver import PathResolver, b_path + - b_path("../relative/path/to/file") # returns absolute path to file from the bootstraparse folder + - path= PathResolver("../relative/path/to/file") # Make a PathResolver object pointing at the first path given """ import os diff --git a/src/bootstraparse/modules/preparser.py b/src/bootstraparse/modules/preparser.py index be0c281..e028c1e 100644 --- a/src/bootstraparse/modules/preparser.py +++ b/src/bootstraparse/modules/preparser.py @@ -1,12 +1,12 @@ """Module for pre-parsing user files in preparation for the parser Usage: - from bootstraparse.modules.preparser import preparser - pp = preparser(file, enviroment) - pp.do_import() # imports all the modules and adds them to the file, do the same for all the files that are to be imported # noqa - pp.do_replacements() # replaces all images and shortcuts in the file - pp.readlines() # returns the lines of ORIGINAL file - pp.get_all_lines() # returns the lines of the file after replacements and imports - """ + - from bootstraparse.modules.preparser import preparser + - pp = preparser(file, enviroment) + - pp.do_import() # imports all the modules and adds them to the file, do the same for all the files that are to be imported - # noqa + - pp.do_replacements() # replaces all images and shortcuts in the file + - pp.readlines() # returns the lines of ORIGINAL file + - pp.get_all_lines() # returns the lines of the file after replacements and imports +""" import os diff --git a/src/bootstraparse/modules/sitecrawler.py b/src/bootstraparse/modules/sitecrawler.py index 13b09fc..d310dc0 100644 --- a/src/bootstraparse/modules/sitecrawler.py +++ b/src/bootstraparse/modules/sitecrawler.py @@ -1,12 +1,12 @@ """ Module for file and directories repartition Usage: - from bootstraparse.modules import SiteCrawler - crawler = SiteCrawler(origin_path, dest_path, _env) - crawler.set_all_preparsers() - crawler.copy_unparsable_files() - for element, destination in crawler: - save(preparse_parse(element), destination, _env) + - from bootstraparse.modules import SiteCrawler + - crawler = SiteCrawler(origin_path, dest_path, _env) + - crawler.set_all_preparsers() + - crawler.copy_unparsable_files() + - for element, destination in crawler: + - - save(preparse_parse(element), destination, _env) """ import os diff --git a/src/bootstraparse/modules/sitecreator.py b/src/bootstraparse/modules/sitecreator.py index 8449d4c..78c15a1 100644 --- a/src/bootstraparse/modules/sitecreator.py +++ b/src/bootstraparse/modules/sitecreator.py @@ -1,7 +1,7 @@ """ Module sequencing the successive actions necessary for website building Usage: - create_website(origin, destination) + - create_website(origin, destination) """ import os diff --git a/src/bootstraparse/modules/tools.py b/src/bootstraparse/modules/tools.py index 521e6dd..01977c4 100644 --- a/src/bootstraparse/modules/tools.py +++ b/src/bootstraparse/modules/tools.py @@ -1,11 +1,12 @@ """ List of tools for testing -------------------------- +========================= + Usage: - from bootstraparse.modules.tools import __GLk, __GL, find_*_in_file - __GLk(n) # Returns a file link n traceback objects back - __GL() # Returns a line number at current position - find_*_in_file(file) # Try to find (class, function or variable) in file and return its line number + - from bootstraparse.modules.tools import __GLk, __GL, find_*_in_file + - __GLk(n) # Returns a file link n traceback objects back + - __GL() # Returns a line number at current position + - find_*_in_file(file) # Try to find (class, function or variable) in file and return its line number """ import inspect