From 6ee449b6aefc8c23ecf451d8baa9a608e905fe82 Mon Sep 17 00:00:00 2001 From: Maximilien Rigaut Date: Wed, 9 Feb 2022 20:57:22 +0100 Subject: [PATCH] Added a couple of hints --- src/bootstraparse/modules/config.py | 21 ++++++++++++++++++++- src/bootstraparse/modules/environment.py | 4 ++++ src/bootstraparse/modules/error_mngr.py | 17 +++++++++++++++++ src/bootstraparse/modules/pathresolver.py | 11 +++++++++++ src/bootstraparse/modules/preparser.py | 19 +++++++++++++------ 5 files changed, 65 insertions(+), 7 deletions(-) diff --git a/src/bootstraparse/modules/config.py b/src/bootstraparse/modules/config.py index 69ab667..97e3247 100644 --- a/src/bootstraparse/modules/config.py +++ b/src/bootstraparse/modules/config.py @@ -5,26 +5,43 @@ import yaml class ConfigLoader: """ - Reads config files. + Reads config files + :param configfile: The file to read """ def __init__(self, configfile): + """ + Loads config file + :param configfile: path to config file + :return: None + """ with open(configfile, "r") as f: self.loaded_conf = yaml.safe_load(f) def __getitem__(self, item): + """ + Returns config value + :param item: config key + :return: config value + """ try: return self.loaded_conf[item] except KeyError: print("Argument", item, "not found.") def __repr__(self): + """ + Returns config as string + :return: config as string + """ return self.loaded_conf.__repr__() class UserConfig(ConfigLoader): """ Reads user config file. + :param configfile: path to config file + :return: None """ def __init__(self, configfile): super().__init__(configfile) @@ -33,6 +50,8 @@ class UserConfig(ConfigLoader): class GlobalConfig(ConfigLoader): """ Reads global config file. + :param configfile: path to config file + :return: None """ def __init__(self, configfile): super().__init__(configfile) diff --git a/src/bootstraparse/modules/environment.py b/src/bootstraparse/modules/environment.py index e0a7767..dae78c2 100644 --- a/src/bootstraparse/modules/environment.py +++ b/src/bootstraparse/modules/environment.py @@ -32,6 +32,7 @@ class Environment: def integrity_check(self): """ Checks if all mandatory parameters are set. + :return: True if all mandatory parameters are set, False otherwise. """ for value in self._wasInitialised.values(): if value is False: @@ -41,6 +42,8 @@ class Environment: def __getattr__(self, attribute): """ Getter for all parameters. + :param attribute: The name of the parameter to get. + :return: The value of the parameter. """ if attribute[0] == "_": super().__getattribute__(attribute) @@ -54,6 +57,7 @@ class Environment: def __setattr__(self, attribute, value): """ Setter for all parameters. + :param attribute: The name of the parameter to set. """ if attribute[0] == "_": super().__setattr__(attribute, value) diff --git a/src/bootstraparse/modules/error_mngr.py b/src/bootstraparse/modules/error_mngr.py index c53cff4..8c78ae8 100644 --- a/src/bootstraparse/modules/error_mngr.py +++ b/src/bootstraparse/modules/error_mngr.py @@ -13,6 +13,12 @@ __all__ = _ERRORS+[] def initlogging(filename=None, loglevel="ERROR", filemode='w', handler=None): """ Initializes logging + :param filename: The name of the log file + :param loglevel: The level of logging + :type loglevel: str + :param filemode: The mode of the log file + :param handler: The handler to use + :return: None """ loglevel = loglevel.upper() if loglevel not in ["ERROR", "INFO", "WARNING", "DEBUG", "CRITICAL"]: @@ -33,6 +39,10 @@ def initlogging(filename=None, loglevel="ERROR", filemode='w', handler=None): def log_exception(exception, level="ERROR"): """ Logs an exception + :param exception: The exception to log + :param level: The level of the exception + :type level: str + :return: None """ level = level.lower() logging.__getattribute__(level)(traceback.format_exc()) @@ -50,6 +60,12 @@ def log_exception(exception, level="ERROR"): class ParsingError(Exception): """ Exception class for parsing errors + :param message: The message to display + :type message: str + :param line: The line number of the error + :param column: The column number of the error + :param file: The name of the file + :return: None """ def __init__(self, message=None, line=None, column=None, file=None): @@ -68,6 +84,7 @@ class ParsingError(Exception): def __str__(self): """ Returns a string representation of the ParsingError + :return: The string representation of the ParsingError """ if self.line is not None and self.column is not None and self.file is not None: return "[{}] Line {}:{} {}".format(self.file, self.line, self.column, self.args[0]) diff --git a/src/bootstraparse/modules/pathresolver.py b/src/bootstraparse/modules/pathresolver.py index 95777a5..4d763fa 100644 --- a/src/bootstraparse/modules/pathresolver.py +++ b/src/bootstraparse/modules/pathresolver.py @@ -6,15 +6,26 @@ import os class PathResolver: """ Initialised with a relative path and returns the translated absolute path + :param base_path: Relative path to be resolved """ def __init__(self, base_path): self.base_path = os.path.normpath(os.path.dirname(base_path)) def __call__(self, relative_path='.'): + """ + Returns the absolute path of the relative path + :param relative_path: Relative path to be resolved + :return: Absolute path + """ return self.give_absolute(relative_path) def give_absolute(self, relative_path='.'): + """ + Returns the absolute path of the relative path + :param relative_path: Relative path to be resolved + :return: Absolute path + """ return os.path.normpath(os.path.join(self.base_path, relative_path)) diff --git a/src/bootstraparse/modules/preparser.py b/src/bootstraparse/modules/preparser.py index 73c13b6..826dee9 100644 --- a/src/bootstraparse/modules/preparser.py +++ b/src/bootstraparse/modules/preparser.py @@ -21,11 +21,10 @@ class PreParser: """ Initializes the PreParser object. Takes the following parameters: - path: the path of the file to be parsed - __env: the environment object - path_resolver: the path resolver object, if none is specified, a new one is created with the base path - list_of_paths: the list of files that have been imported in this branch of the import tree - dict_of_imports: Dictionary of all imports made to avoid duplicate file opening / pre-parsing + :param 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 """ if list_of_paths is None: list_of_paths = [] @@ -46,6 +45,7 @@ class PreParser: def open(self): """ Opens the file and returns a file object. + :return: the file object """ self.file = open(self.relative_path_resolver(self.name), 'r') return self.file @@ -53,6 +53,7 @@ class PreParser: def readlines(self): """ Reads the file and returns a list of lines. + :return: a list of lines """ if self.file is None: self.open() @@ -63,6 +64,7 @@ class PreParser: 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. + :return: a list of PreParser objects """ import_list = self.parse_import_list() for e, _ in import_list: @@ -80,6 +82,7 @@ class PreParser: def parse_import_list(self): """ Parses the import list of the file. + :return: a list of files to be imported """ if self.saved_import_list: return self.saved_import_list @@ -99,6 +102,7 @@ class PreParser: def export_with_imports(self): """ Return the file object with all imports done + :return: a filelike object with all imports done """ temp_file = StringIO() source_line_count = 0 @@ -113,6 +117,7 @@ class PreParser: def close(self): """ Closes the file. + :return: None """ if self.file: self.file.close() @@ -127,6 +132,7 @@ class PreParser: def __repr__(self): """ Returns a string representation of the PreParser object. + :return: a string representation of the PreParser object """ return "PreParser(path={}, file={}, list_of_paths={}, dict_of_imports={})".format( self.path, self.file, self.list_of_paths, self.global_dict_of_imports) @@ -134,6 +140,7 @@ class PreParser: def __str__(self): """ Returns a string representation of the PreParser object. + :return: a string representation of the PreParser object """ return self.__repr__() @@ -143,4 +150,4 @@ if __name__ == "__main__": __env = environment.Environment() michel = PreParser(site_path, __env) michel.parse_import_list() - michel.export_with_imports() \ No newline at end of file + michel.export_with_imports()