diff --git a/bparse.py b/bparse.py index 2071ee4..28d80b8 100644 --- a/bparse.py +++ b/bparse.py @@ -1 +1 @@ -# Main program, use this to start parsing \ No newline at end of file +# Main program, use this to start parsing diff --git a/fibtest.py b/fibtest.py index f280ee5..89ca598 100644 --- a/fibtest.py +++ b/fibtest.py @@ -1,9 +1,10 @@ import os + # testing Fibonacci number function def fib(n: int) -> int: - return n if n < 2 else fib(n-1)+fib(n-2) + return n if n < 2 else fib(n - 1) + fib(n - 2) def test_fibonacci(): - assert fib(int(os.environ["FIB_INPUT"])) == 55 \ No newline at end of file + assert fib(int(os.environ["FIB_INPUT"])) == 55 diff --git a/modules/config.py b/modules/config.py index 355399e..1c0d227 100644 --- a/modules/config.py +++ b/modules/config.py @@ -21,4 +21,4 @@ class GlobalConfig(ConfigLoader): super().__init__(configfile) -conf = ConfigLoader("./example_userfiles/config/aliases.yml") \ No newline at end of file +conf = ConfigLoader("./example_userfiles/config/aliases.yml") diff --git a/modules/context_mngr.py b/modules/context_mngr.py index cbe66d2..c30b385 100644 --- a/modules/context_mngr.py +++ b/modules/context_mngr.py @@ -1 +1 @@ -# Interprets where the parser is located and resolves errors \ No newline at end of file +# Interprets where the parser is located and resolves errors diff --git a/modules/error_mngr.py b/modules/error_mngr.py index b10c7af..e424f98 100644 --- a/modules/error_mngr.py +++ b/modules/error_mngr.py @@ -1 +1 @@ -# Dedicated module for defining and interpreting errors as well as generating error messages \ No newline at end of file +# Dedicated module for defining and interpreting errors as well as generating error messages diff --git a/modules/export.py b/modules/export.py index d9f7a15..f3a899b 100644 --- a/modules/export.py +++ b/modules/export.py @@ -1 +1 @@ -# Module for final generation of the translated website \ No newline at end of file +# Module for final generation of the translated website diff --git a/modules/parser.py b/modules/parser.py index 8ce05e8..06ae106 100644 --- a/modules/parser.py +++ b/modules/parser.py @@ -1 +1 @@ -# Main parser, interprets userfiles and translates into html \ No newline at end of file +# Main parser, interprets userfiles and translates into html diff --git a/modules/preparser.py b/modules/preparser.py index 409a5ed..39b280e 100644 --- a/modules/preparser.py +++ b/modules/preparser.py @@ -1 +1 @@ -# Module for pre-parsing userfiles in preparation for the parser \ No newline at end of file +# Module for pre-parsing userfiles in preparation for the parser diff --git a/modules/sitecrawler.py b/modules/sitecrawler.py index dee44ac..e583313 100644 --- a/modules/sitecrawler.py +++ b/modules/sitecrawler.py @@ -1 +1 @@ -# Module for file and directories repartition \ No newline at end of file +# Module for file and directories repartition diff --git a/modules/sitecreator.py b/modules/sitecreator.py index 66adddc..6a92f01 100644 --- a/modules/sitecreator.py +++ b/modules/sitecreator.py @@ -1,53 +1,61 @@ # Module sequencing the successive actions necessary for website building -def bigmogol(): +def create_website(): """ First function called by bparse.py, calls all other modules in the right order. """ pass + def create_environment(): """ Returns parserEnvironment as an object containing everything needed for app execution. """ pass + def create_config(): """ Returns globalConfig as an object from parser_config.yml settings. """ pass + def create_crawler(): """ Returns crawler as an object for navigation in the userfiles. """ pass + def create_user_config(): """ Returns userConfig as an object from aliases.yml, glossary.yml and website.yml. """ pass + def create_template(): """ Returns a templateManager from templates for generating the correct html files. """ pass + def env_checker(): """ Verify all is in order for initialisation of the parserEnvironment object and initialises. """ pass + def begin_crawling(pEnv): """ Starts reading every file in the userfiles and adds them to the crawler object progressively. """ pass + def begin_preparsing(pEnv): """ Create an importTree and checks for conflicts or loops; then replaces imports with their contents, @@ -55,15 +63,18 @@ def begin_preparsing(pEnv): """ pass + def begin_parsing(pEnv): """ For each of the generated files, parses element after element and creates the graph representation of the website, - interacts with context_mngr.py to acertain integrity and deal with errors. + interacts with context_mngr.py to ascertain integrity and deal with errors. """ pass + def begin_export(): """ - Replaces all parsed values with their attributed correspondances as per the template_manager and exports the result as a website. + Replaces all parsed values with their attributed correspondances as per the template_manager + and exports the result as a website. """ - pass \ No newline at end of file + pass diff --git a/modules/template_mngr.py b/modules/template_mngr.py index 2c6bdbf..b241949 100644 --- a/modules/template_mngr.py +++ b/modules/template_mngr.py @@ -1 +1 @@ -# Module for interpreting default or custom templates. \ No newline at end of file +# Module for interpreting default or custom templates.