ScriptCollection 3.5.107__py3-none-any.whl → 3.5.109__py3-none-any.whl

ScriptCollection/Executables.py

@@ -628,3 +628,29 @@ def CurrentUserHasElevatedPrivileges() -> int:
         return 1
     else:
         return 0
+
+
+def Espoc() -> int:
+    GeneralUtilities.write_message_to_stdout("check...")
+    parser = argparse.ArgumentParser(description="Espoc (appreviation for 'exit started programs on close') is a tool to ensure the started processes of your program will also get terminated when the execution of your program is finished.")
+    parser.add_argument('-p', '--processid', required=True)
+    parser.add_argument('-f', '--file', required=True, help='Specifies the file where the process-ids of the started processes are stored (line by line). This file will be deleted when all started processes are terminated.')
+    args = parser.parse_args()
+    process_id = args.processid
+    process_list_file: str = args.file
+    if not os.path.isabs(process_list_file):
+        process_list_file = GeneralUtilities.resolve_relative_path(process_list_file, os.getcwd())
+    GeneralUtilities.assert_condition(GeneralUtilities.process_is_running_by_id(process_id), f"Process with id {process_id} is not running.")
+    while GeneralUtilities.process_is_running_by_id(process_id):
+        time.sleep(1)
+    GeneralUtilities.write_message_to_stdout(f"Process with id {process_id} is not running anymore. Start terminating remaining processes.")
+    if os.path.exists(process_list_file):
+        for line in GeneralUtilities.read_lines_from_file(process_list_file):
+            if GeneralUtilities.string_has_content(line):
+                current_process_id = int(line.strip())
+                GeneralUtilities.kill_process(current_process_id, True)
+        GeneralUtilities.ensure_file_does_not_exist(process_list_file)
+        GeneralUtilities.write_message_to_stdout("All started processes terminated.")
+    else:
+        GeneralUtilities.write_message_to_stdout(f"File '{process_list_file}' does not exist. No processes to terminate.")
+    return 0

ScriptCollection/ScriptCollectionCore.py

@@ -33,7 +33,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.107"
+version = "3.5.109"
 __version__ = version
 
 
@@ -603,6 +603,12 @@ class ScriptCollectionCore:
         self.assert_is_git_repository(repository_folder)
         return self.run_program_argsasarray("git", ["rev-parse", "--verify", "HEAD"], repository_folder, throw_exception_if_exitcode_is_not_zero=False)[0] == 0
 
+    @GeneralUtilities.check_arguments
+    def run_git_command_in_repository_and_submodules(self, repository_folder: str, arguments: list[str]) -> None:
+        self.assert_is_git_repository(repository_folder)
+        self.run_program_argsasarray("git", arguments, repository_folder)
+        self.run_program_argsasarray("git", ["submodule", "foreach", "--recursive", "git"]+arguments, repository_folder)
+
     @GeneralUtilities.check_arguments
     def export_filemetadata(self, folder: str, target_file: str, encoding: str = "utf-8", filter_function=None) -> None:
         folder = GeneralUtilities.resolve_relative_path_from_current_working_directory(folder)
@@ -881,7 +887,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def __create_thumbnails(self, filename: str, fps: str, folder: str, tempname_for_thumbnails: str) -> list[str]:
-        argument = ['-i', filename, '-r', str(fps), '-vf', 'scale=-1:120', '-vcodec', 'png', f'{tempname_for_thumbnails}-%002d.png']
+        argument = ['-i', filename, '-r', fps, '-vf', 'scale=-1:120', '-vcodec', 'png', f'{tempname_for_thumbnails}-%002d.png']
         self.run_program_argsasarray("ffmpeg", argument, folder, throw_exception_if_exitcode_is_not_zero=True)
         files = GeneralUtilities.get_direct_files_of_folder(folder)
         result: list[str] = []
@@ -898,8 +904,17 @@ class ScriptCollectionCore:
     def __create_thumbnail(self, outputfilename: str, folder: str, length_in_seconds: float, tempname_for_thumbnails: str, amount_of_images: int) -> None:
         duration = timedelta(seconds=length_in_seconds)
         info = GeneralUtilities.timedelta_to_simple_string(duration)
-        rows: int = 5
-        columns: int = math.ceil(amount_of_images/rows)
+        next_square_number = GeneralUtilities.get_next_square_number(amount_of_images)
+        root = math.sqrt(next_square_number)
+        rows: int = root  # 5
+        columns: int = root  # math.ceil(amount_of_images/rows)
+        argument = ['-title', f'"{outputfilename} ({info})"', '-tile', f'{rows}x{columns}', f'{tempname_for_thumbnails}*.png', f'{outputfilename}.png']
+        self.run_program_argsasarray("montage", argument, folder, throw_exception_if_exitcode_is_not_zero=True)
+
+    @GeneralUtilities.check_arguments
+    def __create_thumbnail2(self, outputfilename: str, folder: str, length_in_seconds: float, rows: int, columns: int, tempname_for_thumbnails: str, amount_of_images: int) -> None:
+        duration = timedelta(seconds=length_in_seconds)
+        info = GeneralUtilities.timedelta_to_simple_string(duration)
         argument = ['-title', f'"{outputfilename} ({info})"', '-tile', f'{rows}x{columns}', f'{tempname_for_thumbnails}*.png', f'{outputfilename}.png']
         self.run_program_argsasarray("montage", argument, folder, throw_exception_if_exitcode_is_not_zero=True)
 
@@ -912,7 +927,7 @@ class ScriptCollectionCore:
             return math.ceil(x * d) / d
 
     @GeneralUtilities.check_arguments
-    def generate_thumbnail(self, file: str, frames_per_second: str, tempname_for_thumbnails: str = None, hook=None) -> None:
+    def generate_thumbnail(self, file: str, frames_per_second: float, tempname_for_thumbnails: str = None, hook=None) -> None:
         if tempname_for_thumbnails is None:
             tempname_for_thumbnails = "t_"+str(uuid.uuid4())
 
@@ -923,16 +938,9 @@ class ScriptCollectionCore:
         preview_files: list[str] = []
         try:
             length_in_seconds = self.__calculate_lengh_in_seconds(filename, folder)
-            if (frames_per_second.endswith("fps")):
-                # frames per second, example: frames_per_second="20fps" => 20 frames per second
-                frames_per_second = self.__roundup(float(frames_per_second[:-3]), 2)
-                frames_per_second_as_string = str(frames_per_second)
-                amounf_of_previewframes = int(math.floor(length_in_seconds*frames_per_second))
-            else:
-                # concrete amount of frame, examples: frames_per_second="16" => 16 frames for entire video
-                amounf_of_previewframes = int(float(frames_per_second))
-                # self.roundup((amounf_of_previewframes-2)/length_in_seconds, 2)
-                frames_per_second_as_string = f"{amounf_of_previewframes-2}/{length_in_seconds}"
+            # frames per second, example: frames_per_second="20fps" => 20 frames per second
+            frames_per_second = self.__roundup(float(frames_per_second[:-3]), 2)
+            frames_per_second_as_string = str(frames_per_second)
             preview_files = self.__create_thumbnails(filename, frames_per_second_as_string, folder, tempname_for_thumbnails)
             if hook is not None:
                 hook(file, preview_files)
@@ -942,6 +950,29 @@ class ScriptCollectionCore:
             for thumbnail_to_delete in preview_files:
                 os.remove(thumbnail_to_delete)
 
+    @GeneralUtilities.check_arguments
+    def generate_thumbnail_by_amount_of_pictures(self, file: str, amount_of_columns: int, amount_of_rows: int, tempname_for_thumbnails: str = None, hook=None) -> None:
+        if tempname_for_thumbnails is None:
+            tempname_for_thumbnails = "t_"+str(uuid.uuid4())
+
+        file = GeneralUtilities.resolve_relative_path_from_current_working_directory(file)
+        filename = os.path.basename(file)
+        folder = os.path.dirname(file)
+        filename_without_extension = Path(file).stem
+        preview_files: list[str] = []
+        try:
+            length_in_seconds = self.__calculate_lengh_in_seconds(filename, folder)
+            amounf_of_previewframes = int(amount_of_columns*amount_of_rows)
+            frames_per_second_as_string = f"{amounf_of_previewframes-2}/{length_in_seconds}"
+            preview_files = self.__create_thumbnails(filename, frames_per_second_as_string, folder, tempname_for_thumbnails)
+            if hook is not None:
+                hook(file, preview_files)
+            actual_amounf_of_previewframes = len(preview_files)
+            self.__create_thumbnail2(filename_without_extension, folder, length_in_seconds, amount_of_rows, amount_of_columns, tempname_for_thumbnails, actual_amounf_of_previewframes)
+        finally:
+            for thumbnail_to_delete in preview_files:
+                os.remove(thumbnail_to_delete)
+
     @GeneralUtilities.check_arguments
     def extract_pdf_pages(self, file: str, from_page: int, to_page: int, outputfile: str) -> None:
         pdf_reader: PdfReader = PdfReader(file)

ScriptCollection/TasksForCommonProjectStructure.py

@@ -1025,8 +1025,9 @@ class TasksForCommonProjectStructure:
 
         if codeunit_has_testcases:
             source_testcoveragereport = os.path.join(other_folder_in_repository, "Artifacts", "TestCoverageReport")
-            target_testcoveragereport = os.path.join(target_folder, "TestCoverageReport")
-            shutil.copytree(source_testcoveragereport, target_testcoveragereport)
+            if os.path.isdir(source_testcoveragereport):  # check, because it is not a mandatory artifact. if the artifact is not available, the user gets already a warning.
+                target_testcoveragereport = os.path.join(target_folder, "TestCoverageReport")
+                shutil.copytree(source_testcoveragereport, target_testcoveragereport)
 
     @GeneralUtilities.check_arguments
     def __standardized_tasks_release_artifact(self, information: CreateReleaseInformationForProjectInCommonProjectFormat) -> None:
@@ -1560,9 +1561,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)
+
+        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:
@@ -2271,9 +2272,9 @@ class TasksForCommonProjectStructure:
     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")
+        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)
+            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:
@@ -2282,17 +2283,17 @@ class TasksForCommonProjectStructure:
         # TODO consider ignored_dependencies
         verbosity = self.get_verbosity_from_commandline_arguments(cmd_args, verbosity)
 
-        setup_cfg=os.path.join(codeunit_folder, "setup.cfg")
+        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)
+            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
+        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,ignored_dependencies, 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
+        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)
+            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:
@@ -3292,15 +3293,15 @@ class TasksForCommonProjectStructure:
         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):
+    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):
+    def install_requirementstxt_for_repository(self, repository_folde: str, verbosity: int):
         self.__sc.install_requirementstxt_file(repository_folde+"/Other/requirements.txt", verbosity)
 
     @GeneralUtilities.check_arguments
-    def update_submodule(self, repository_folder: str, submodule_name:str):
+    def update_submodule(self, repository_folder: str, submodule_name: str):
         submodule_folder = GeneralUtilities.resolve_relative_path("Other/Resources/Submodules/"+submodule_name, repository_folder)
         self.__sc.git_fetch(submodule_folder, "origin")
         self.__sc.git_checkout(submodule_folder, "main")

{scriptcollection-3.5.107.dist-info → scriptcollection-3.5.109.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 3.5.107
+Version: 3.5.109
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -24,13 +24,14 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: build>=1.2.2.post1
 Requires-Dist: coverage>=7.8.0
-Requires-Dist: cyclonedx-bom>=5.3.0
+Requires-Dist: cyclonedx-bom>=6.0.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.2
+Requires-Dist: lxml>=5.4.0
 Requires-Dist: ntplib>=0.4.0
 Requires-Dist: Pillow>=11.2.1
+Requires-Dist: psutil>=7.0.0
 Requires-Dist: pycdlib>=1.14.0
 Requires-Dist: Pygments>=2.19.1
 Requires-Dist: pylint>=3.3.6

{scriptcollection-3.5.107.dist-info → scriptcollection-3.5.109.dist-info}/RECORD

@@ -1,16 +1,16 @@
 ScriptCollection/CertificateUpdater.py,sha256=pJopWFcwaLAEVljtC4O3SVrlpIpoJNUhT1V4mgiqLvE,8970
-ScriptCollection/Executables.py,sha256=HI9Pxs5Z9QxPGyqeJU2lWslEggFyGYANCqYVQZp6eJ0,30490
+ScriptCollection/Executables.py,sha256=BsDgpqU_XKXg-7paQdmamzU14-2kcqjz9v13r96EiEk,32319
 ScriptCollection/GeneralUtilities.py,sha256=VO4a7xctkjN5dcBXc32gz0x9U07DEagasjvYVKqLmdM,44173
 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=pMWerT9kxD823d4CHKLV7eyAMjRAsDdYaXEoCGDEYis,128371
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=9rO_W6kZiy3Lgov0HeyyDhOwriorMeJXlVDvwZ3S1UE,232511
+ScriptCollection/ScriptCollectionCore.py,sha256=X3jRXN0FRstFN7kPFLnzSZUONMbh_YOPr22cKzDgU78,130404
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=SJ7V9HilnkCBJGCCrObWwAORSI_pXW9zC4uon1O6Xbg,232705
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-3.5.107.dist-info/METADATA,sha256=nKrrtDhb2dkTemESq47FReNNmlOsk99wSZD6GJlCvkc,7664
-scriptcollection-3.5.107.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-scriptcollection-3.5.107.dist-info/entry_points.txt,sha256=fYCGWGNGijBQHhFe6UAO-BEpfEOxLyNJemukt5ElSzs,3644
-scriptcollection-3.5.107.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.107.dist-info/RECORD,,
+scriptcollection-3.5.109.dist-info/METADATA,sha256=8glqA2n3AUjhZOZV4uXRsgdyHmqgyWwcHbkLUeeKqbc,7694
+scriptcollection-3.5.109.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
+scriptcollection-3.5.109.dist-info/entry_points.txt,sha256=3qMbfZEMhc_VTJj-bcLwB8AWcn9iXSB3l0AWpuu52Bs,3689
+scriptcollection-3.5.109.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-3.5.109.dist-info/RECORD,,

{scriptcollection-3.5.107.dist-info → scriptcollection-3.5.109.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{scriptcollection-3.5.107.dist-info → scriptcollection-3.5.109.dist-info}/entry_points.txt

@@ -15,6 +15,7 @@ sccreatehashofallfiles = ScriptCollection.Executables:CreateHashOfAllFiles
 sccreateisofilewithobfuscatedfiles = ScriptCollection.Executables:CreateISOFileWithObfuscatedFiles
 sccreatesimplemergewithoutrelease = ScriptCollection.Executables:CreateSimpleMergeWithoutRelease
 sccurrentuserhaselevatedprivileges = ScriptCollection.Executables:CurrentUserHasElevatedPrivileges
+scespoc = ScriptCollection.Executables:Espoc
 scextractpdfpages = ScriptCollection.Executables:ExtractPDFPages
 scfilecontainscontent = ScriptCollection.Executables:FileContainsContent
 scfileexists = ScriptCollection.Executables:FileExists