ScriptCollection 3.5.103__py3-none-any.whl → 3.5.105__py3-none-any.whl

ScriptCollection/GeneralUtilities.py

@@ -21,6 +21,7 @@ from os.path import isfile, join, isdir
 from pathlib import Path
 from shutil import copyfile
 import typing
+import psutil
 from defusedxml.minidom import parse
 from OpenSSL import crypto
 
@@ -1027,3 +1028,38 @@ class GeneralUtilities:
         GeneralUtilities.assert_condition("." in plain_str)
         splitted: list[str] = plain_str.split(".")
         return splitted[0].zfill(leading_zeroplaces)+"."+splitted[1].ljust(trailing_zeroplaces, '0')
+
+    @staticmethod
+    @check_arguments
+    def process_is_running_by_name(process_name: str) -> bool:  
+        processes: list[psutil.Process] = list(psutil.process_iter())
+        for p in processes:
+            if p.name() == process_name:
+                return True
+        return False
+
+
+    @staticmethod
+    @check_arguments
+    def process_is_running_by_id(process_id: int) -> bool: 
+        processes: list[psutil.Process] = list(psutil.process_iter())
+        for p in processes:
+            if p.pid == process_id:
+                return True
+        return False
+
+
+    @staticmethod
+    @check_arguments
+    def kill_process(process_id:int,include_child_processes:bool) -> bool:  
+        if GeneralUtilities. process_is_running_by_id(process_id):
+            GeneralUtilities.write_message_to_stdout(f"Process with id {process_id} is running. Terminating it...")
+            process = psutil.Process(process_id)
+            if include_child_processes:
+                for child in process.children(recursive=True):
+                    if GeneralUtilities.process_is_running_by_id(child.pid):
+                        child.kill()
+            if GeneralUtilities.process_is_running_by_id(process_id):
+                process.kill()
+        else:
+            GeneralUtilities.write_message_to_stdout(f"Process with id {process_id} is not running anymore.")

ScriptCollection/SCLog.py

@@ -1,2 +1,68 @@
+
+from enum import Enum
+from datetime import datetime
+from .GeneralUtilities import GeneralUtilities
+
+
+class LogLevel(Enum):
+    Error = 1
+    Warning = 2
+    Information = 3
+    Debug = 4
+
+    def __int__(self):
+        return self.value
+
+
 class SCLog:
-    pass  # TODO
+    loglevel: LogLevel
+    log_file: str
+    add_overhead: bool
+
+    def __init__(self, log_file: str = None):
+        self.add_overhead = False
+        self.loglevel = LogLevel.Information
+        self.log_file = log_file
+
+    @GeneralUtilities.check_arguments
+    def log_exception(self, message: str, ex: Exception, current_traceback):
+        self.log(f"Exception: {message}; Exception-details: {str(ex)}; Traceback:  {current_traceback.format_exc()}", LogLevel.Error)
+
+    @GeneralUtilities.check_arguments
+    def log(self, message: str, loglevel: LogLevel):
+        if loglevel is None:
+            loglevel = LogLevel.Information
+
+        if int(loglevel) > int(self.loglevel):
+            return
+
+        if loglevel == LogLevel.Warning:
+            message = f"Warning: {message}"
+        if self.add_overhead:
+            if loglevel == LogLevel.Error:
+                message = f"[Error] {message}"
+            elif loglevel == LogLevel.Warning:
+                message = f"[Warning] {message}"
+            elif loglevel == LogLevel.Debug:
+                message = f"[Debug] {message}"
+            elif loglevel == LogLevel.Information:
+                message = f"[Information] {message}"
+            else:
+                raise ValueError("Unknown loglevel.")
+
+            message = f"[{GeneralUtilities.datetime_to_string_for_logfile_entry(datetime.now())}] {message}"
+
+        if loglevel == LogLevel.Error:
+            GeneralUtilities.write_message_to_stderr(message)
+        elif loglevel == LogLevel.Warning:
+            GeneralUtilities.write_message_to_stderr(message)
+        elif loglevel == LogLevel.Debug:
+            GeneralUtilities.write_message_to_stdout(message)
+        elif loglevel == LogLevel.Information:
+            GeneralUtilities.write_message_to_stdout(message)
+        else:
+            raise ValueError("Unknown loglevel.")
+
+        if self.log_file is not None:
+            GeneralUtilities.ensure_file_exists(self.log_file)
+            GeneralUtilities.append_line_to_file(self.log_file, message)

ScriptCollection/ScriptCollectionCore.py

@@ -33,7 +33,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.103"
+version = "3.5.105"
 __version__ = version
 
 
@@ -1868,7 +1868,8 @@ DNS                 = {domain}
         self.run_program_argsasarray("openssl", ['pkcs12', '-export', '-out', f'{filename}.pfx', f'-inkey', f'{filename}.key', '-in', f'{filename}.crt', '-password', f'pass:{password}'], folder)
 
     @GeneralUtilities.check_arguments
-    def update_dependencies_of_python_in_requirementstxt_file(self, file: str, verbosity: int):
+    def update_dependencies_of_python_in_requirementstxt_file(self, file: str,ignored_dependencies:list[str], verbosity: int):
+        #TODO consider ignored_dependencies
         lines = GeneralUtilities.read_lines_from_file(file)
         new_lines = []
         for line in lines:
@@ -1898,7 +1899,8 @@ DNS                 = {domain}
             raise ValueError(f'Unexpected line in requirements-file: "{line}"')
 
     @GeneralUtilities.check_arguments
-    def update_dependencies_of_python_in_setupcfg_file(self, setup_cfg_file: str, verbosity: int):
+    def update_dependencies_of_python_in_setupcfg_file(self, setup_cfg_file: str,ignored_dependencies:list[str], verbosity: int):
+        #TODO consider ignored_dependencies
         lines = GeneralUtilities.read_lines_from_file(setup_cfg_file)
         new_lines = []
         requirement_parsing_mode = False
@@ -2277,3 +2279,6 @@ TXDX
         element = ET.XML(GeneralUtilities.read_text_from_file(file, encoding))
         ET.indent(element)
         GeneralUtilities.write_text_to_file(file, ET.tostring(element, encoding="unicode"), encoding)
+
+    def install_requirementstxt_file(self,requirements_txt_file: str, folder: str, verbosity: int):
+        self.run_program_argsasarray("pip", ["install", "-r", requirements_txt_file], folder, verbosity=verbosity)

ScriptCollection/TasksForCommonProjectStructure.py

@@ -1560,6 +1560,9 @@ class TasksForCommonProjectStructure:
             combined_file = os.path.join(codeunit_folder, file)
             if not os.path.isfile(combined_file):
                 raise ValueError(f'The mandatory file "{file}" does not exist in the codeunit-folder.')
+            
+        if os.path.isfile(os.path.join(codeunit_folder,"Other","requirements.txt")):
+            self.install_requirementstxt_for_codeunit(codeunit_folder,verbosity)
 
         # Check developer
         if self.validate_developers_of_repository:
@@ -2264,16 +2267,32 @@ class TasksForCommonProjectStructure:
         ignored_dependencies = self.get_dependencies_which_are_ignored_from_updates(codeunit_folder, True)
         # TODO implement
 
+    @GeneralUtilities.check_arguments
+    def update_dependencies_of_typical_python_repository_requirements(self, repository_folder: str, verbosity: int, cmd_args: list[str]) -> None:
+        verbosity = self.get_verbosity_from_commandline_arguments(cmd_args, verbosity)
+
+        development_requirements_file = os.path.join(repository_folder, "Other","requirements.txt")
+        if (os.path.isfile(development_requirements_file)):
+            self.__sc.update_dependencies_of_python_in_requirementstxt_file(development_requirements_file,[], verbosity)
+
     @GeneralUtilities.check_arguments
     def update_dependencies_of_typical_python_codeunit(self, update_script_file: str, verbosity: int, cmd_args: list[str]) -> None:
         codeunit_folder = GeneralUtilities.resolve_relative_path("..", os.path.dirname(update_script_file))
         ignored_dependencies = self.get_dependencies_which_are_ignored_from_updates(codeunit_folder, True)
         # TODO consider ignored_dependencies
         verbosity = self.get_verbosity_from_commandline_arguments(cmd_args, verbosity)
-        self.__sc.update_dependencies_of_python_in_setupcfg_file(os.path.join(codeunit_folder, "setup.cfg"), verbosity)
-        development_requirements_file = os.path.join(codeunit_folder, "requirements.txt")
+
+        setup_cfg=os.path.join(codeunit_folder, "setup.cfg")
+        if (os.path.isfile(setup_cfg)):
+            self.__sc.update_dependencies_of_python_in_setupcfg_file(setup_cfg,ignored_dependencies, verbosity)
+
+        development_requirements_file = os.path.join(codeunit_folder, "requirements.txt")#required for codeunits which contain python-code which need third-party dependencies
         if (os.path.isfile(development_requirements_file)):
-            self.__sc.update_dependencies_of_python_in_requirementstxt_file(development_requirements_file, verbosity)
+            self.__sc.update_dependencies_of_python_in_requirementstxt_file(development_requirements_file,ignored_dependencies, verbosity)
+
+        development_requirements_file2 = os.path.join(codeunit_folder, "Other","requirements.txt")#required for codeunits which contain python-scripts which needs third-party dependencies
+        if (os.path.isfile(development_requirements_file2)):
+            self.__sc.update_dependencies_of_python_in_requirementstxt_file(development_requirements_file2, ignored_dependencies,verbosity)
 
     @GeneralUtilities.check_arguments
     def update_dependencies_of_typical_dotnet_codeunit(self, update_script_file: str, verbosity: int, cmd_args: list[str]) -> None:
@@ -2354,10 +2373,11 @@ class TasksForCommonProjectStructure:
 
                 if append_cli_args_at_end:
                     command_with_args = f"{command_with_args} {{{{.CLI_ARGS}}}}"
+                cwd_literal = cwd.replace("\\", "\\\\")
                 lines.append(f"  {name}:")
                 lines.append(f'    desc: "{description}"')
                 lines.append('    silent: true')
-                lines.append(f'    dir: "{cwd}"')
+                lines.append(f'    dir: "{cwd_literal}"')
                 lines.append("    cmds:")
                 lines.append(f"      - {command_with_args}")
                 lines.append('    aliases:')
@@ -3270,3 +3290,11 @@ class TasksForCommonProjectStructure:
         self.__sc.git_checkout(ref_repo, update_http_documentation_arguments.main_branch_name)
         self.__sc.git_push_with_retry(ref_repo, update_http_documentation_arguments.common_remote_name, update_http_documentation_arguments.main_branch_name, update_http_documentation_arguments.main_branch_name)
         self.__sc.git_commit(GeneralUtilities.resolve_relative_path("../..", folder_of_this_file), f"Updated content of {update_http_documentation_arguments.product_name} v{update_http_documentation_arguments.new_project_version} in {update_http_documentation_arguments.reference_repository_name}-submodule")
+
+    @GeneralUtilities.check_arguments
+    def install_requirementstxt_for_codeunit(self,codeunit_folder:str,verbosity:int):
+        self.__sc.install_requirementstxt_file(codeunit_folder+"/Other/requirements.txt", verbosity)
+
+    @GeneralUtilities.check_arguments
+    def install_requirementstxt_for_repository(self, repository_folde: str,verbosity:int):
+        self.__sc.install_requirementstxt_file(repository_folde+"/Other/requirements.txt", verbosity)

ScriptCollection/UpdateCertificates.py

@@ -27,7 +27,7 @@ class CertificateUpdater:
     @GeneralUtilities.check_arguments
     def __get_latest_index_by_domain(self, domain: str) -> int:
         result = self.__get_latest_index_by_filelist(GeneralUtilities.get_all_files_of_folder(os.path.join(self.__letsencrypt_archive_folder, domain)))
-        GeneralUtilities.write_message_to_stdout(f"Debug: Latest found existing number for domain {domain}: {result}")
+        #GeneralUtilities.write_message_to_stdout(f"Debug: Latest found existing number for domain {domain}: {result}")
         return result
 
     @GeneralUtilities.check_arguments

{scriptcollection-3.5.103.dist-info → scriptcollection-3.5.105.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 3.5.103
+Version: 3.5.105
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -23,12 +23,12 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: build>=1.2.2.post1
-Requires-Dist: coverage>=7.7.1
+Requires-Dist: coverage>=7.8.0
 Requires-Dist: cyclonedx-bom>=5.3.0
 Requires-Dist: defusedxml>=0.7.1
 Requires-Dist: keyboard>=0.13.5
 Requires-Dist: lcov-cobertura>=2.1.1
-Requires-Dist: lxml>=5.3.1
+Requires-Dist: lxml>=5.3.2
 Requires-Dist: ntplib>=0.4.0
 Requires-Dist: Pillow>=11.1.0
 Requires-Dist: pycdlib>=1.14.0
@@ -38,7 +38,7 @@ Requires-Dist: pyOpenSSL>=25.0.0
 Requires-Dist: PyPDF>=5.4.0
 Requires-Dist: pytest>=8.3.5
 Requires-Dist: PyYAML>=6.0.2
-Requires-Dist: qrcode>=8.0
+Requires-Dist: qrcode>=8.1
 Requires-Dist: send2trash>=1.8.3
 Requires-Dist: twine>=6.1.0
 Requires-Dist: xmlschema>=3.4.5

scriptcollection-3.5.105.dist-info/RECORD

@@ -0,0 +1,16 @@
+ScriptCollection/Executables.py,sha256=HI9Pxs5Z9QxPGyqeJU2lWslEggFyGYANCqYVQZp6eJ0,30490
+ScriptCollection/GeneralUtilities.py,sha256=jkJu6y8Wv-j_braS_0zsjF6JzDo46NshMeeAphsXGX4,43848
+ScriptCollection/ProcessesRunner.py,sha256=3mu4ZxzZleQo0Op6o9EYTCFiJfb6kx5ov2YfZfT89mU,1395
+ScriptCollection/ProgramRunnerBase.py,sha256=2kMIAqdc65UjBAddOZkzy_aFx9h5roZ5a4bQNM6RV6Y,2480
+ScriptCollection/ProgramRunnerEpew.py,sha256=4pjEd0r9Fcz3TTDv0MdTSd5KkigYXcWUVI1X43regfU,6477
+ScriptCollection/ProgramRunnerPopen.py,sha256=BPY7-ZMIlqT7JOKz8qlB5c0laF2Js-ijzqk09GxZC48,3821
+ScriptCollection/SCLog.py,sha256=Gw27Oclcb0ten7_89PD5CdNMoO-at2hGUOYbF-x1HPQ,2296
+ScriptCollection/ScriptCollectionCore.py,sha256=U4kI7ztIm6_KL4FFRmway_y8QRrQiJgFEZTBzZ618Ys,126071
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=iemQ1J0UAengGAvCTJdc8-ipjhfLqf0Su8evQTDdLGU,231626
+ScriptCollection/UpdateCertificates.py,sha256=xRebqD2etBD7ILHL-7fg-Y-kPF0Tbmnwexv4FhwDntQ,7791
+ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scriptcollection-3.5.105.dist-info/METADATA,sha256=BK_ZzXAIr0w33y_eYM1aDhSh24Po6Mb26eXLacXe1ns,7664
+scriptcollection-3.5.105.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+scriptcollection-3.5.105.dist-info/entry_points.txt,sha256=fYCGWGNGijBQHhFe6UAO-BEpfEOxLyNJemukt5ElSzs,3644
+scriptcollection-3.5.105.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-3.5.105.dist-info/RECORD,,

ScriptCollection/RPStream.py

@@ -1,42 +0,0 @@
-import os
-import psutil
-from .GeneralUtilities import GeneralUtilities
-from .ProcessesRunner import ProcessStartInformation, ProcessesRunner
-# streams the local libcam-vid-stream to a rtsp-server
-
-
-class RPStream:
-
-    __working_directory: str = None
-    __pid_file: str = None
-
-    def __init__(self, working_directory: str):
-        self.__working_directory = working_directory
-        self.__pid_file = os.path.join(self.__working_directory, "pid.txt")
-
-    def __get_pid(self) -> str:
-        GeneralUtilities.ensure_file_exists(self.__pid_file)
-        return GeneralUtilities.read_text_from_file(self.__pid_file)
-
-    def __set_pid(self, pid: str):
-        GeneralUtilities.ensure_file_exists(self.__pid_file)
-        GeneralUtilities.write_text_to_file(self.__pid_file, pid)
-
-    def __ensure_previous_process_is_not_running(self):
-        pid = self.__get_pid()
-        if GeneralUtilities.string_has_content(pid):
-            for proc in psutil.process_iter():
-                if proc.pid == pid and proc.name() == "python":
-                    proc.kill()
-
-    def __start_stream(self):
-        prinfo: list[ProcessStartInformation] = list[ProcessStartInformation]()
-        prinfo.append(ProcessStartInformation(None, "", ""))
-        prinfo.append(ProcessStartInformation(None, "", ""))
-        processesRunner: ProcessesRunner = ProcessesRunner(prinfo)
-        self.__set_pid(str(os.getpid()))
-        processesRunner.run()
-
-    def start(self):
-        self.__ensure_previous_process_is_not_running()
-        self.__start_stream()

scriptcollection-3.5.103.dist-info/RECORD

@@ -1,17 +0,0 @@
-ScriptCollection/Executables.py,sha256=HI9Pxs5Z9QxPGyqeJU2lWslEggFyGYANCqYVQZp6eJ0,30490
-ScriptCollection/GeneralUtilities.py,sha256=unOZbHDqlxwPHXY1epy4gdGYwDbHEETF1XKZYPGX2hw,42429
-ScriptCollection/ProcessesRunner.py,sha256=3mu4ZxzZleQo0Op6o9EYTCFiJfb6kx5ov2YfZfT89mU,1395
-ScriptCollection/ProgramRunnerBase.py,sha256=2kMIAqdc65UjBAddOZkzy_aFx9h5roZ5a4bQNM6RV6Y,2480
-ScriptCollection/ProgramRunnerEpew.py,sha256=4pjEd0r9Fcz3TTDv0MdTSd5KkigYXcWUVI1X43regfU,6477
-ScriptCollection/ProgramRunnerPopen.py,sha256=BPY7-ZMIlqT7JOKz8qlB5c0laF2Js-ijzqk09GxZC48,3821
-ScriptCollection/RPStream.py,sha256=NRRHL3YSP3D9MuAV2jB_--0KUKCsvJGxeKnxgrRZ9kY,1545
-ScriptCollection/SCLog.py,sha256=l4aekBiGoNkKGtvO_Er3NY_K7ts4ZWtIGlhq07I-4LY,30
-ScriptCollection/ScriptCollectionCore.py,sha256=p9ofnNkzI-3_QsJwbh4auBAGSh-IkWKGlrLSh0eZyBE,125705
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=MpyvFNyJG7njRYvV9KULJmbn7WonR18YDeS7oI_O3UU,229780
-ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
-ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-3.5.103.dist-info/METADATA,sha256=q07vsHzykcNIo0Vixjx1YEAUj21qm1UVbgW70afB0O8,7664
-scriptcollection-3.5.103.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-scriptcollection-3.5.103.dist-info/entry_points.txt,sha256=fYCGWGNGijBQHhFe6UAO-BEpfEOxLyNJemukt5ElSzs,3644
-scriptcollection-3.5.103.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.103.dist-info/RECORD,,