Organized Python libraries into modules.

ZCG-coder · ZCG-coder · commit 732f617da7ee · 2024-06-04T22:42:13.000+08:00
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -82,7 +82,7 @@ jobs:
               shell: bash
 
             - name: Benchmark
-              run: python tools/benchmark.py -g
+              run: python -m tools.benchmark -g
               shell: bash
 
             - name: Upload Graphs
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -50,4 +50,4 @@ jobs:
               shell: bash
 
             - name: Lint
-              run: python tools/run_clang_tidy.py -source-filter='.*lib.*' -p build
+              run: python -m tools.run_clang_tidy -source-filter='.*lib.*' -p build
diff --git a/__init__.py b/__init__.py
@@ -0,0 +1,21 @@
+#####################################################################################################
+#  Copyright (c) 2023-2024 NWSOFT                                                                   #
+#                                                                                                   #
+#  Permission is hereby granted, free of charge, to any person obtaining a copy                     #
+#  of this software and associated documentation files (the "Software"), to deal                    #
+#  in the Software without restriction, including without limitation the rights                     #
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell                        #
+#  copies of the Software, and to permit persons to whom the Software is                            #
+#  furnished to do so, subject to the following conditions:                                         #
+#                                                                                                   #
+#  The above copyright notice and this permission notice shall be included in all                   #
+#  copies or substantial portions of the Software.                                                  #
+#                                                                                                   #
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR                       #
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,                         #
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE                      #
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER                           #
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,                    #
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE                    #
+#  SOFTWARE.                                                                                        #
+#####################################################################################################
diff --git a/lib/__init__.py b/lib/__init__.py
@@ -0,0 +1,23 @@
+#####################################################################################################
+#  Copyright (c) 2023-2024 NWSOFT                                                                   #
+#                                                                                                   #
+#  Permission is hereby granted, free of charge, to any person obtaining a copy                     #
+#  of this software and associated documentation files (the "Software"), to deal                    #
+#  in the Software without restriction, including without limitation the rights                     #
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell                        #
+#  copies of the Software, and to permit persons to whom the Software is                            #
+#  furnished to do so, subject to the following conditions:                                         #
+#                                                                                                   #
+#  The above copyright notice and this permission notice shall be included in all                   #
+#  copies or substantial portions of the Software.                                                  #
+#                                                                                                   #
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR                       #
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,                         #
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE                      #
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER                           #
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,                    #
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE                    #
+#  SOFTWARE.                                                                                        #
+#####################################################################################################
+
+pass
diff --git a/lib/config.py b/lib/config.py
diff --git a/lib/constants.py b/lib/constants.py
@@ -0,0 +1,27 @@
+#####################################################################################################
+#  Copyright (c) 2023-2024 NWSOFT                                                                   #
+#                                                                                                   #
+#  Permission is hereby granted, free of charge, to any person obtaining a copy                     #
+#  of this software and associated documentation files (the "Software"), to deal                    #
+#  in the Software without restriction, including without limitation the rights                     #
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell                        #
+#  copies of the Software, and to permit persons to whom the Software is                            #
+#  furnished to do so, subject to the following conditions:                                         #
+#                                                                                                   #
+#  The above copyright notice and this permission notice shall be included in all                   #
+#  copies or substantial portions of the Software.                                                  #
+#                                                                                                   #
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR                       #
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,                         #
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE                      #
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER                           #
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,                    #
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE                    #
+#  SOFTWARE.                                                                                        #
+#####################################################################################################
+
+import platform
+
+WINDOWS = platform.system() == "Windows"
+MACOSX = platform.system() == "Darwin"
+LINUX = platform.system() == "Linux"
diff --git a/lib/paths.py b/lib/paths.py
@@ -26,9 +26,10 @@
 
 from pathlib import Path
 
+# section Project paths
 PROJECT = "Steppable"
 
-PROJECT_PATH = Path(__file__).parent.parent.parent
+PROJECT_PATH = Path(__file__).parent.parent
 SRC_DIR = PROJECT_PATH / "src"
 TESTS_DIR = PROJECT_PATH / "tests"
 INCLUDE_DIR = PROJECT_PATH / "include"
@@ -37,7 +38,4 @@
 OBJ_DIR = BUILD_DIR / "obj.temp"
 BIN_DIR = BUILD_DIR / "bin"
 LIB_DIR = BUILD_DIR / "lib"
-
-STATIC = 0
-SHARED = 1
-EXECUTABLE = 2
+# endsection
diff --git a/lib/printing.py b/lib/printing.py
@@ -22,7 +22,7 @@
 
 import sys
 
-from building.directories import WINDOWS
+from lib.constants import WINDOWS
 
 
 def green() -> str:
diff --git a/pyproject.toml b/pyproject.toml
@@ -12,9 +12,9 @@ requires-python = ">= 3.10"
 dynamic = ["classifiers", "optional-dependencies"]
 
 dependencies = [
-    "matplotlib",
-    "black",
-    "isort",
+    "matplotlib >= 3.9.0",
+    "black >= 24.4.2",
+    "isort >= 5.13.2",
     "setuptools >= 61.0",
     "nanobind >= 1.9.2"
 ]
diff --git a/tests/random_tests/random_test_base.py b/tests/random_tests/random_test_base.py
@@ -20,46 +20,11 @@
 #  SOFTWARE.                                                                                        #
 #####################################################################################################
 
-import os
 import random
 import subprocess
 import time
 
-
-def green():
-    """
-    Changes the output color to green, only if the output console is a terminal.
-    """
-    if os.isatty(0):
-        return "\033[92m"
-    return ""
-
-
-def red():
-    """
-    Changes the output color to red, only if the output console is a terminal.
-    """
-    if os.isatty(0):
-        return "\033[91m"
-    return ""
-
-
-def reset():
-    """
-    Resets output color, only if the output console is a terminal.
-    """
-    if os.isatty(0):
-        return "\033[0;0m"
-    return ""
-
-
-def bold():
-    """
-    Changes the output color to bold, only if the output console is a terminal.
-    """
-    if os.isatty(0):
-        return "\033[1m"
-    return ""
+from lib.printing import bold, green, red, reset
 
 
 class RandomTest:
@@ -68,11 +33,11 @@ class RandomTest:
     """
 
     def __init__(
-            self,
-            executable="",
-            times: int = 100,
-            expression: str = "{} / {}",
-            rounding: bool = True,
+        self,
+        executable="",
+        times: int = 100,
+        expression: str = "{} / {}",
+        rounding: bool = True,
     ):
         self.times = times
         if executable == "":
@@ -116,7 +81,7 @@ def random_test(self):
                 python_output = eval(expression)
             print(
                 f"\033[K\033[A\rTest [{i + 1}/{self.times}|{(i + 1) / self.times * 100:2.1f}%] - ",
-                end=""
+                end="",
             )
 
             diff = abs(python_output - output)
@@ -146,7 +111,7 @@ def summary(self):
                 + reset()
             )
             for idx, (number1, number2, output, python_output) in enumerate(
-                    self.failed
+                self.failed
             ):
                 print(f"TEST {idx + 1}")
                 print(f"  {self.expression.format(number1, number2)}")
diff --git a/tests/random_tests/test_add.py b/tests/random_tests/test_add.py
@@ -21,8 +21,9 @@
 #####################################################################################################
 
 from random_test_base import RandomTest
-from pathlib import Path
 
-TOOL_PATH = Path(__file__).parent.parent.parent / "build" / "bin" / "add"
+from lib.paths import PROJECT_PATH
+
+TOOL_PATH = PROJECT_PATH / "build" / "bin" / "add"
 r = RandomTest(TOOL_PATH.as_posix(), expression="{} + {}", rounding=False)
 r.random_test()
diff --git a/tests/random_tests/test_division.py b/tests/random_tests/test_division.py
@@ -21,8 +21,9 @@
 #####################################################################################################
 
 from random_test_base import RandomTest
-from pathlib import Path
 
-TOOL_PATH = Path(__file__).parent.parent.parent / "build" / "bin" / "division"
+from lib.paths import PROJECT_PATH
+
+TOOL_PATH = PROJECT_PATH / "build" / "bin" / "division"
 r = RandomTest(TOOL_PATH.as_posix(), expression="{} / {}")
 r.random_test()
diff --git a/tests/random_tests/test_multiply.py b/tests/random_tests/test_multiply.py
@@ -20,10 +20,10 @@
 #  SOFTWARE.                                                                                        #
 #####################################################################################################
 
-from pathlib import Path
-
 from random_test_base import RandomTest
 
-TOOL_PATH = Path(__file__).parent.parent.parent / "build" / "bin" / "multiply"
+from lib.paths import PROJECT_PATH
+
+TOOL_PATH = PROJECT_PATH / "build" / "bin" / "multiply"
 r = RandomTest(TOOL_PATH.as_posix(), expression="{} * {}", rounding=False)
 r.random_test()
diff --git a/tests/random_tests/test_subtract.py b/tests/random_tests/test_subtract.py
@@ -21,8 +21,9 @@
 #####################################################################################################
 
 from random_test_base import RandomTest
-from pathlib import Path
 
-TOOL_PATH = Path(__file__).parent.parent.parent / "build" / "bin" / "subtract"
+from lib.paths import PROJECT_PATH
+
+TOOL_PATH = PROJECT_PATH / "build" / "bin" / "subtract"
 r = RandomTest(TOOL_PATH.as_posix(), expression="{} - {}", rounding=False)
 r.random_test()
diff --git a/tools/add_copyright_header.py b/tools/add_copyright_header.py
@@ -138,7 +138,7 @@ def first_n_lines(text: str, n: int) -> str:
 
 def process(file: Path):
     if (
-        file.suffix in [".cpp", ".hpp"] or file.name == "cpp.hint"
+        file.suffix in [".cpp", ".hpp", ".stp_settings"] or file.name == "cpp.hint"
     ):  # C++ Source / Header
         with open(file, "r") as f:
             contents = f.read()
@@ -195,9 +195,11 @@ def walk_into_directory(path: Path):
 if __name__ == "__main__":
     process(PROJECT_PATH / "CMakeLists.txt")
     process(PROJECT_PATH / "setup.py")
+    process(PROJECT_PATH / "__init__.py")
     process(PROJECT_PATH / "cpp.hint")
     walk_into_directory(PROJECT_PATH / "include")
     walk_into_directory(PROJECT_PATH / "lib")
+    walk_into_directory(PROJECT_PATH / "res")
     walk_into_directory(PROJECT_PATH / "src")
     walk_into_directory(PROJECT_PATH / "tests")
     walk_into_directory(PROJECT_PATH / "tools")
diff --git a/tools/benchmark.py b/tools/benchmark.py
@@ -20,14 +20,15 @@
 #  SOFTWARE.                                                                                        #
 #####################################################################################################
 
-from pathlib import Path
-import time
-from typing import Callable, List, Tuple
+import argparse
 import random
 import subprocess
-import argparse
+import time
+from pathlib import Path
+from typing import Callable, List, Tuple
+
+from lib.paths import PROJECT_PATH
 
-ROOT_PATH = Path(__file__).parent.parent
 BUILD_PATH_DEFAULT = "build"
 
 FUNCTIONS = {
@@ -133,7 +134,7 @@ def main():
 
     LIMIT = int(args.limit)
 
-    build_dir = Path(ROOT_PATH / args.build_dir).resolve()
+    build_dir = Path(PROJECT_PATH / args.build_dir).resolve()
     if not build_dir.exists():
         print(f"Build directory {build_dir} does not exist.")
         return
@@ -169,7 +170,7 @@ def main():
         if (not args.graph) and args.verbose:
             print(f"Times: {times}")
         if args.graph:
-            img_path = ROOT_PATH / "tools" / "figures" / f"benchmark_{exe.stem}.svg"
+            img_path = PROJECT_PATH / "tools" / "figures" / f"benchmark_{exe.stem}.svg"
             print(f"Saving as {img_path}")
 
             import matplotlib.pyplot as plt
diff --git a/tools/build.py b/tools/build.py
@@ -26,9 +26,9 @@
 
 import logging
 
-from building.directories import create_build_dirs
-from building.paths import BUILD_DIR
-from building.project import BuildSteppable
+from lib.paths import BUILD_DIR
+from tools.building.directories import create_build_dirs
+from tools.building.project import BuildSteppable
 
 logger = logging.getLogger(__name__)
 
diff --git a/tools/building/__init__.py b/tools/building/__init__.py
@@ -0,0 +1,23 @@
+#####################################################################################################
+#  Copyright (c) 2023-2024 NWSOFT                                                                   #
+#                                                                                                   #
+#  Permission is hereby granted, free of charge, to any person obtaining a copy                     #
+#  of this software and associated documentation files (the "Software"), to deal                    #
+#  in the Software without restriction, including without limitation the rights                     #
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell                        #
+#  copies of the Software, and to permit persons to whom the Software is                            #
+#  furnished to do so, subject to the following conditions:                                         #
+#                                                                                                   #
+#  The above copyright notice and this permission notice shall be included in all                   #
+#  copies or substantial portions of the Software.                                                  #
+#                                                                                                   #
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR                       #
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,                         #
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE                      #
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER                           #
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,                    #
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE                    #
+#  SOFTWARE.                                                                                        #
+#####################################################################################################
+
+pass
diff --git a/tools/building/compiler_detection.py b/tools/building/compiler_detection.py
@@ -31,7 +31,7 @@
 import subprocess
 from pathlib import Path
 
-from building.paths import BUILD_DIR
+from lib.paths import BUILD_DIR
 
 GCC_VERSION_RE = re.compile(r"g\+\+ (\(.+?\))? (\d+\.\d+\.\d+)")
 CLANG_VERSION_RE = re.compile(r"version (\d+\.\d+\.\d+)")
diff --git a/tools/building/constants.py b/tools/building/constants.py
diff --git a/tools/building/directories.py b/tools/building/directories.py
diff --git a/tools/building/project.py b/tools/building/project.py
diff --git a/tools/new_component.py b/tools/new_component.py
diff --git a/tools/patch_compile_commands.py b/tools/patch_compile_commands.py
diff --git a/tools/run_clang_tidy.py b/tools/run_clang_tidy.py
