From 95173d50718810bed179b92478fb0e141f142c9e Mon Sep 17 00:00:00 2001 From: Maximilien Rigaut Date: Wed, 15 Jun 2022 19:22:56 +0200 Subject: [PATCH] sitecreator.py : Doc and rtypes --- src/bootstraparse/modules/sitecreator.py | 36 +++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/src/bootstraparse/modules/sitecreator.py b/src/bootstraparse/modules/sitecreator.py index 2706f02..ecaec58 100644 --- a/src/bootstraparse/modules/sitecreator.py +++ b/src/bootstraparse/modules/sitecreator.py @@ -8,6 +8,11 @@ def create_website(origin, destination): """ 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. """ env = create_environment(origin, destination) crwlr = create_crawler(origin, destination, env) @@ -22,6 +27,12 @@ def create_environment(origin, destination): """ 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. + :type origin: str + :type destination: str + :return: Environment object. + :rtype: environment.Environment """ env = environment.Environment() env.config = config.ConfigLoader(pathresolver.b_path("configs")) @@ -42,12 +53,26 @@ def create_environment(origin, destination): def create_crawler(origin, destination, _env): """ Returns crawler as an object for navigation in the user files. - rtype: sitecrawler.SiteCrawler + :param origin: The path of the website to be built. + :param destination: The destination path of the built website. + :param _env: The environment object. + :type origin: str + :type destination: str + :type _env: environment.Environment + :return: Crawler object. + :rtype: sitecrawler.SiteCrawler """ return sitecrawler.SiteCrawler(origin, destination, _env) def preparse_parse(preparser): + """ + Returns a list of containers from a preparser. + :param preparser: The preparser object. + :type preparser: parser.Preparser + :return: List of containers. + :rtype: list + """ io = preparser.do_replacements() parsed_list = parser.parse_line(io) output = context_mngr.ContextManager(parsed_list, name=preparser.name)() @@ -55,6 +80,15 @@ def preparse_parse(preparser): def save(list_of_containers, destination, env): + """ + 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.Environment + """ with open(destination, "w") as output_file: output_file.write(export.ContextConverter(list_of_containers, env.export_mngr, destination).process_pile().read())