ScriptCollection 3.5.61__py3-none-any.whl → 3.5.63__py3-none-any.whl

ScriptCollection/GeneralUtilities.py

@@ -937,3 +937,16 @@ class GeneralUtilities:
                 GeneralUtilities.assert_condition(not (amount_of_attempts < amount_of_fails))
                 if amount_of_fails == amount_of_attempts:
                     raise
+
+    @staticmethod
+    @check_arguments
+    def int_to_string(number: int, leading_zeroplaces: int, trailing_zeroplaces: int) -> str:
+        return GeneralUtilities.float_to_string(float(number), leading_zeroplaces, trailing_zeroplaces)
+
+    @staticmethod
+    @check_arguments
+    def float_to_string(number: float, leading_zeroplaces: int, trailing_zeroplaces: int) -> str:
+        plain_str = str(number)
+        GeneralUtilities.assert_condition("." in plain_str)
+        splitted: list[str] = plain_str.split(".")
+        return splitted[0].zfill(leading_zeroplaces)+"."+splitted[1].ljust(trailing_zeroplaces, '0')

ScriptCollection/ScriptCollectionCore.py

@@ -31,7 +31,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.61"
+version = "3.5.63"
 __version__ = version
 
 
@@ -1291,7 +1291,7 @@ class ScriptCollectionCore:
         return False
 
     @staticmethod
-    def __read_popen_pipes(p: Popen):
+    def __read_popen_pipes(p: Popen) -> tuple[list[str], list[str]]:
         p_id = p.pid
         with ThreadPoolExecutor(2) as pool:
             q_stdout = Queue()
@@ -1301,32 +1301,32 @@ class ScriptCollectionCore:
             pool.submit(ScriptCollectionCore.__enqueue_output, p.stderr, q_stderr)
             reading_stdout_last_time_resulted_in_exception: bool = False
             reading_stderr_last_time_resulted_in_exception: bool = False
+
+            stdout_result: list[str] = []
+            stderr_result: list[str] = []
+
             while (ScriptCollectionCore.__continue_process_reading(p_id, p, q_stdout, q_stderr, reading_stdout_last_time_resulted_in_exception, reading_stderr_last_time_resulted_in_exception)):
-                out_line = None
-                err_line = None
+
                 try:
-                    out_line = q_stdout.get_nowait()  # TODO read all avaliable lines
-                    reading_stdout_last_time_resulted_in_exception = False
+                    while not q_stdout.empty():
+                        stdout_result.append(q_stdout.get_nowait())
+                        reading_stdout_last_time_resulted_in_exception = False
                 except Empty:
                     reading_stdout_last_time_resulted_in_exception = True
 
                 try:
-                    err_line = q_stderr.get_nowait()  # TODO read all avaliable lines
-                    reading_stderr_last_time_resulted_in_exception = False
+                    while not q_stderr.empty():
+                        stderr_result.append(q_stderr.get_nowait())
+                        reading_stderr_last_time_resulted_in_exception = False
                 except Empty:
                     reading_stderr_last_time_resulted_in_exception = True
 
                 time.sleep(0.01)  # this is required to not finish too early
 
-                yield (out_line, err_line)
+            return (stdout_result, stderr_result)
 
-    # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
     @GeneralUtilities.check_arguments
-    def run_program_argsasarray(self, program: str, arguments_as_array: list[str] = [], working_directory: str = None, verbosity: int = 1, print_errors_as_information: bool = False, log_file: str = None, timeoutInSeconds: int = 600, addLogOverhead: bool = False, title: str = None, log_namespace: str = "", arguments_for_log:  list[str] = None, throw_exception_if_exitcode_is_not_zero: bool = True, custom_argument: object = None, interactive: bool = False) -> tuple[int, str, str, int]:
-        # verbosity 1: No output will be logged.
-        # verbosity 2: If the exitcode of the executed program is not 0 then the StdErr will be logged. This is supposed to be the default verbosity-level.
-        # verbosity 3: Logs and prints StdOut and StdErr of the executed program in realtime.
-        # verbosity 4: Same as loglevel 3 but with some more overhead-information.
+    def run_program_argsasarray(self, program: str, arguments_as_array: list[str] = [], working_directory: str = None, verbosity: int = 0, print_errors_as_information: bool = False, log_file: str = None, timeoutInSeconds: int = 600, addLogOverhead: bool = False, title: str = None, log_namespace: str = "", arguments_for_log:  list[str] = None, throw_exception_if_exitcode_is_not_zero: bool = True, custom_argument: object = None, interactive: bool = False, print_live_output: bool = False) -> tuple[int, str, str, int]:
         if self.call_program_runner_directly:
             return self.program_runner.run_program_argsasarray(program, arguments_as_array, working_directory, custom_argument, interactive)
         try:
@@ -1348,11 +1348,10 @@ class ScriptCollectionCore:
             else:
                 info_for_log = title
 
-            if verbosity >= 3:
+            verbose = verbosity > 0
+            if verbose:
                 GeneralUtilities.write_message_to_stdout(f"Run '{info_for_log}'.")
 
-            print_live_output = 1 < verbosity
-
             exit_code: int = None
             stdout: str = ""
             stderr: str = ""
@@ -1363,8 +1362,10 @@ class ScriptCollectionCore:
                 if log_file is not None:
                     GeneralUtilities.ensure_file_exists(log_file)
                 pid = process.pid
-                for out_line_plain, err_line_plain in ScriptCollectionCore.__read_popen_pipes(process):  # see https://stackoverflow.com/a/57084403/3905529
 
+                outputs: tuple[list[str], list[str]] = ScriptCollectionCore.__read_popen_pipes(process)
+
+                for out_line_plain in outputs[0]:
                     if out_line_plain is not None:
                         out_line: str = None
                         if isinstance(out_line_plain, str):
@@ -1385,6 +1386,7 @@ class ScriptCollectionCore:
                             if log_file is not None:
                                 GeneralUtilities.append_line_to_file(log_file, out_line)
 
+                for err_line_plain in outputs[1]:
                     if err_line_plain is not None:
                         err_line: str = None
                         if isinstance(err_line_plain, str):
@@ -1405,11 +1407,16 @@ class ScriptCollectionCore:
                                 GeneralUtilities.append_line_to_file(log_file, err_line)
 
             exit_code = process.returncode
+            GeneralUtilities.assert_condition(exit_code is not None, f"Exitcode of program-run of '{info_for_log}' is None.")
+
+            result_message = f"Program '{info_for_log}' resulted in exitcode {exit_code}."
+
+            if verbose:
+                GeneralUtilities.write_message_to_stdout(result_message)
 
             if throw_exception_if_exitcode_is_not_zero and exit_code != 0:
-                raise ValueError(f"Program '{working_directory}>{program} {arguments_for_log_as_string}' resulted in exitcode {exit_code}. (StdOut: '{stdout}', StdErr: '{stderr}')")
+                raise ValueError(f"{result_message} (StdOut: '{stdout}', StdErr: '{stderr}')")
 
-            GeneralUtilities.assert_condition(exit_code is not None, f"Exitcode of program-run of '{info_for_log}' is None.")
             result = (exit_code, stdout, stderr, pid)
             return result
         except Exception as e:
@@ -1417,10 +1424,10 @@ class ScriptCollectionCore:
 
     # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
     @GeneralUtilities.check_arguments
-    def run_program(self, program: str, arguments:  str = "", working_directory: str = None, verbosity: int = 1, print_errors_as_information: bool = False, log_file: str = None, timeoutInSeconds: int = 600, addLogOverhead: bool = False, title: str = None, log_namespace: str = "", arguments_for_log:  list[str] = None, throw_exception_if_exitcode_is_not_zero: bool = True, custom_argument: object = None, interactive: bool = False) -> tuple[int, str, str, int]:
+    def run_program(self, program: str, arguments:  str = "", working_directory: str = None, verbosity: int = 1, print_errors_as_information: bool = False, log_file: str = None, timeoutInSeconds: int = 600, addLogOverhead: bool = False, title: str = None, log_namespace: str = "", arguments_for_log:  list[str] = None, throw_exception_if_exitcode_is_not_zero: bool = True, custom_argument: object = None, interactive: bool = False, print_live_output: bool = False) -> tuple[int, str, str, int]:
         if self.call_program_runner_directly:
             return self.program_runner.run_program(program, arguments, working_directory, custom_argument, interactive)
-        return self.run_program_argsasarray(program, GeneralUtilities.arguments_to_array(arguments), working_directory, verbosity, print_errors_as_information, log_file, timeoutInSeconds, addLogOverhead, title, log_namespace, arguments_for_log, throw_exception_if_exitcode_is_not_zero, custom_argument, interactive)
+        return self.run_program_argsasarray(program, GeneralUtilities.arguments_to_array(arguments), working_directory, verbosity, print_errors_as_information, log_file, timeoutInSeconds, addLogOverhead, title, log_namespace, arguments_for_log, throw_exception_if_exitcode_is_not_zero, custom_argument, interactive, print_live_output)
 
     # Return-values program_runner: Pid
     @GeneralUtilities.check_arguments

{ScriptCollection-3.5.61.dist-info → ScriptCollection-3.5.63.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ScriptCollection
-Version: 3.5.61
+Version: 3.5.63
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -23,19 +23,19 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: build>=1.2.2.post1
-Requires-Dist: coverage>=7.6.11
+Requires-Dist: coverage>=7.6.12
 Requires-Dist: cyclonedx-bom>=5.1.2
 Requires-Dist: defusedxml>=0.7.1
 Requires-Dist: keyboard>=0.13.5
 Requires-Dist: lcov-cobertura>=2.0.2
-Requires-Dist: lxml>=5.3.0
+Requires-Dist: lxml>=5.3.1
 Requires-Dist: ntplib>=0.4.0
 Requires-Dist: Pillow>=11.1.0
 Requires-Dist: pycdlib>=1.14.0
 Requires-Dist: Pygments>=2.19.1
 Requires-Dist: pylint>=3.3.4
 Requires-Dist: pyOpenSSL>=25.0.0
-Requires-Dist: PyPDF>=5.2.0
+Requires-Dist: PyPDF>=5.3.0
 Requires-Dist: pytest>=8.3.4
 Requires-Dist: PyYAML>=6.0.2
 Requires-Dist: qrcode>=8.0

{ScriptCollection-3.5.61.dist-info → ScriptCollection-3.5.63.dist-info}/RECORD

@@ -1,16 +1,16 @@
 ScriptCollection/Executables.py,sha256=kON_jatJe84iCJj60uUjA-Aj0ytERRe0FUDWbOWUe6s,28089
-ScriptCollection/GeneralUtilities.py,sha256=nlSZSsQVHWxf0Yzz4PjgZm39rgvIltVof8gL2YPgR7s,38805
+ScriptCollection/GeneralUtilities.py,sha256=Ah-quoBRLNO3iTCfZaAlN0fhOC42b-UEGYRMW_XxgO0,39438
 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/ScriptCollectionCore.py,sha256=gmFAw9p9gVi4Z4vCtAsCS7bQUDLVMHJ66AEtuoaLx1o,111227
+ScriptCollection/ScriptCollectionCore.py,sha256=MmquG7F2-HqTLfdIh3i5fTFWoYGVW6VYDYLCKL7cf0c,111127
 ScriptCollection/TasksForCommonProjectStructure.py,sha256=B3-KSAZOR_UKSeLsdAxyZu2ylsRSjDvlj0272TXSEfA,213090
 ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection-3.5.61.dist-info/METADATA,sha256=lrV7TcbmII8Mz2Bd7CFXv46tw-XIr8YozP5sfDCOgbk,7664
-ScriptCollection-3.5.61.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ScriptCollection-3.5.61.dist-info/entry_points.txt,sha256=wspYVXWH8kon-wRQTAFEO11JoLJ0fEnOIG7tE7R-xtQ,3502
-ScriptCollection-3.5.61.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-ScriptCollection-3.5.61.dist-info/RECORD,,
+ScriptCollection-3.5.63.dist-info/METADATA,sha256=z5ogco0bttHzdHE8RCxBd_0QyvCLmBCnvcHNSJ3A2xk,7664
+ScriptCollection-3.5.63.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+ScriptCollection-3.5.63.dist-info/entry_points.txt,sha256=wspYVXWH8kon-wRQTAFEO11JoLJ0fEnOIG7tE7R-xtQ,3502
+ScriptCollection-3.5.63.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+ScriptCollection-3.5.63.dist-info/RECORD,,