From c3eeef1afffbcf9f4c8488898c7282b7cdc1024c Mon Sep 17 00:00:00 2001 From: vicky Date: Thu, 3 Feb 2022 21:18:34 +0100 Subject: [PATCH] Rendered files pyCharm compliant --- src/bootstraparse/modules/environment.py | 6 +- src/bootstraparse/modules/sitecreator.py | 10 +-- tests/modules/test_environmemt.py | 92 ++++++++++++------------ 3 files changed, 54 insertions(+), 54 deletions(-) diff --git a/src/bootstraparse/modules/environment.py b/src/bootstraparse/modules/environment.py index b04285f..55d701c 100644 --- a/src/bootstraparse/modules/environment.py +++ b/src/bootstraparse/modules/environment.py @@ -4,7 +4,7 @@ import rich -class environment(): +class Environment: """ Object containing all the important variables, with appropriate getters and setters. @@ -32,7 +32,7 @@ class environment(): # Set all parameters to uninitialised self._wasInitialised = {p: False for p in self._mParams} - def integritycheck(self): + def integrity_check(self): for value in self._wasInitialised.values(): if value is False: return False @@ -56,4 +56,4 @@ class environment(): elif attribute in self._sParams: self._sParams[attribute] = value else: - raise AttributeError(attribute) # Could also add attribute as a new entry + raise AttributeError(attribute) # Could also add attribute as a new entry diff --git a/src/bootstraparse/modules/sitecreator.py b/src/bootstraparse/modules/sitecreator.py index 03e5362..afc517b 100644 --- a/src/bootstraparse/modules/sitecreator.py +++ b/src/bootstraparse/modules/sitecreator.py @@ -29,7 +29,7 @@ def create_config(): def create_crawler(): """ - Returns crawler as an object for navigation in the userfiles. + Returns crawler as an object for navigation in the user files. """ pass @@ -58,7 +58,7 @@ def env_checker(): pass -def begin_crawling(pEnv): +def begin_crawling(p_env): """ Starts reading every file in the userfiles and adds them to the crawler object progressively. @@ -66,7 +66,7 @@ def begin_crawling(pEnv): pass -def begin_preparsing(pEnv): +def begin_pre_parsing(p_env): """ Create an importTree and checks for conflicts or loops; then replaces imports with their contents, @@ -75,7 +75,7 @@ def begin_preparsing(pEnv): pass -def begin_parsing(pEnv): +def begin_parsing(p_env): """ For each of the generated files, parses element after element and creates @@ -89,7 +89,7 @@ def begin_parsing(pEnv): def begin_export(): """ Replaces all parsed values with their attributed - correspondances as per the template_manager + correspondences as per the template_manager and exports the result as a website. """ pass diff --git a/tests/modules/test_environmemt.py b/tests/modules/test_environmemt.py index 984c935..001166d 100644 --- a/tests/modules/test_environmemt.py +++ b/tests/modules/test_environmemt.py @@ -2,71 +2,71 @@ from logging import exception import bootstraparse.modules.environment as e -def test_wasInitialised(): - testcheck = e.environment() - for k in testcheck._wasInitialised.values(): +def test_was_initialised(): + test_check = e.Environment() + for k in test_check._wasInitialised.values(): assert k is False -def test_integritycheck(): - testcheck = e.environment() - customtest_p = [p for p in testcheck._mParams.keys()] - customtest_v = [False for p in testcheck._mParams.values()] +def test_integrity_check(): + test_check = e.Environment() + custom_test_p = [p for p in test_check._mParams.keys()] + custom_test_v = [False for p in test_check._mParams.values()] # Test all False - # rich.inspect(testcheck) + # rich.inspect(test_check) - assert testcheck.integritycheck() is False + assert test_check.integrity_check() is False - customtest_v[0] = True - testcheck._wasInitialised = dict(zip(customtest_p, customtest_v)) + custom_test_v[0] = True + test_check._wasInitialised = dict(zip(custom_test_p, custom_test_v)) # Test first False - # rich.inspect(testcheck) + # rich.inspect(test_check) - assert testcheck.integritycheck() is False + assert test_check.integrity_check() is False - customtest_v[0] = False - customtest_v[-1] = True - testcheck._wasInitialised = dict(zip(customtest_p, customtest_v)) + custom_test_v[0] = False + custom_test_v[-1] = True + test_check._wasInitialised = dict(zip(custom_test_p, custom_test_v)) # Test last False - # rich.inspect(testcheck) + # rich.inspect(test_check) - assert testcheck.integritycheck() is False + assert test_check.integrity_check() is False - customtest_v[-1] = False - customtest_v[len(customtest_v)//2-1] = True - testcheck._wasInitialised = dict(zip(customtest_p, customtest_v)) + custom_test_v[-1] = False + custom_test_v[len(custom_test_v)//2-1] = True + test_check._wasInitialised = dict(zip(custom_test_p, custom_test_v)) # Test middle False - # rich.inspect(testcheck) + # rich.inspect(test_check) - assert testcheck.integritycheck() is False + assert test_check.integrity_check() is False - customtest_v = [True for p in testcheck._mParams.values()] - testcheck._wasInitialised = dict(zip(customtest_p, customtest_v)) + custom_test_v = [True for p in test_check._mParams.values()] + test_check._wasInitialised = dict(zip(custom_test_p, custom_test_v)) # Test all True - # rich.inspect(testcheck) + # rich.inspect(test_check) - assert testcheck.integritycheck() is True + assert test_check.integrity_check() is True def test_getter(): - testcheck = e.environment() - for p in testcheck._mParams: - assert testcheck.__getattr__(p) == testcheck._mParams[p] + test_check = e.Environment() + for p in test_check._mParams: + assert test_check.__getattr__(p) == test_check._mParams[p] - testcheck._sParams = { - "testparam": "testvalue" + test_check._sParams = { + "test_param": "test_value" } - assert testcheck.testparam == "testvalue" + assert test_check.test_param == "test_value" try: - testcheck.purposefullyunexistingparameter + test_check.purposefullyunexistingparameter except AttributeError: pass except Exception: assert False # Not AttributeError when getting unexisting parameter try: - testcheck._purposefullyunexistingparameter + test_check._purposefullyunexistingparameter except AttributeError: pass except Exception: @@ -74,26 +74,26 @@ def test_getter(): def test_setter(): - testcheck = e.environment() - for p in testcheck._mParams: - testcheck.__setattr__(p, "testvalue") - assert testcheck._mParams[p] == "testvalue" + test_check = e.Environment() + for p in test_check._mParams: + test_check.__setattr__(p, "test_value") + assert test_check._mParams[p] == "test_value" - testcheck._sParams = { - "testparam": "testvalue" + test_check._sParams = { + "test_param": "test_value" } - testcheck.testparam = "secondtestvalue" - assert testcheck.testparam == "secondtestvalue" + test_check.test_param = "second_test_value" + assert test_check.test_param == "second_test_value" try: - testcheck.purposefullyunexistingparameter = "testvalue" + test_check.purposefullyunexistingparameter = "test_value" except AttributeError: pass except Exception: assert False # Not AttributeError when getting unexisting parameter - testcheck._purposefullyunexistingparameter = "testvalue" - assert testcheck._purposefullyunexistingparameter == "testvalue" + test_check._purposefullyunexistingparameter = "test_value" + assert test_check._purposefullyunexistingparameter == "test_value" if __name__ == "__main__":