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

ScriptCollection/ScriptCollectionCore.py

@@ -33,7 +33,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.101"
+version = "3.5.103"
 __version__ = version
 
 
@@ -292,7 +292,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_push_with_retry(self, folder: str, remotename: str, localbranchname: str, remotebranchname: str, forcepush: bool = False, pushalltags: bool = True, verbosity: int = 0, amount_of_attempts: int = 5) -> None:
-        GeneralUtilities.retry_action(lambda: self.git_push(folder, remotename, localbranchname, remotebranchname, forcepush, pushalltags,verbosity), amount_of_attempts)
+        GeneralUtilities.retry_action(lambda: self.git_push(folder, remotename, localbranchname, remotebranchname, forcepush, pushalltags, verbosity), amount_of_attempts)
 
     @GeneralUtilities.check_arguments
     def git_push(self, folder: str, remotename: str, localbranchname: str, remotebranchname: str, forcepush: bool = False, pushalltags: bool = True, verbosity: int = 0) -> None:
@@ -770,6 +770,74 @@ class ScriptCollectionCore:
             if exit_code != 0:
                 raise ValueError(f"Fatal error occurrs while copying '{source}' to '{target}'. StdErr: '{stderr}'")
 
+    @GeneralUtilities.check_arguments
+    def create_file(self, path: str, error_if_already_exists: bool, create_necessary_folder: bool) -> None:
+        """This function works platform-independent also for non-local-executions if the ScriptCollection commandline-commands are available as global command on the target-system."""
+        if self.program_runner.will_be_executed_locally():
+            if not os.path.isabs(path):
+                path = os.path.join(os.getcwd(), path)
+
+            if os.path.isfile(path) and error_if_already_exists:
+                raise ValueError(f"File '{path}' already exists.")
+
+            # TODO maybe it should be checked if there is a folder with the same path which already exists.
+
+            folder = os.path.dirname(path)
+
+            if not os.path.isdir(folder):
+                if create_necessary_folder:
+                    GeneralUtilities.ensure_directory_exists(folder)  # TODO check if this also create nested folders if required
+                else:
+                    raise ValueError(f"Folder '{folder}' does not exist.")
+
+            GeneralUtilities.ensure_file_exists(path)
+        else:
+            arguments = ["--path", path]
+
+            if error_if_already_exists:
+                arguments = arguments+["--errorwhenexists"]
+
+            if create_necessary_folder:
+                arguments = arguments+["--createnecessaryfolder"]
+
+            exit_code, _, stderr, _ = self.run_program_argsasarray("sccreatefile", arguments, throw_exception_if_exitcode_is_not_zero=False)  # works platform-indepent
+            if exit_code != 0:
+                raise ValueError(f"Fatal error occurrs while create file '{path}'. StdErr: '{stderr}'")
+
+    @GeneralUtilities.check_arguments
+    def create_folder(self, path: str, error_if_already_exists: bool, create_necessary_folder: bool) -> None:
+        """This function works platform-independent also for non-local-executions if the ScriptCollection commandline-commands are available as global command on the target-system."""
+        if self.program_runner.will_be_executed_locally():
+            if not os.path.isabs(path):
+                path = os.path.join(os.getcwd(), path)
+
+            if os.path.isdir(path) and error_if_already_exists:
+                raise ValueError(f"Folder '{path}' already exists.")
+
+            # TODO maybe it should be checked if there is a file with the same path which already exists.
+
+            folder = os.path.dirname(path)
+
+            if not os.path.isdir(folder):
+                if create_necessary_folder:
+                    GeneralUtilities.ensure_directory_exists(folder)  # TODO check if this also create nested folders if required
+                else:
+                    raise ValueError(f"Folder '{folder}' does not exist.")
+
+            GeneralUtilities.ensure_directory_exists(path)
+        else:
+            arguments = ["--path", path]
+
+            if error_if_already_exists:
+                arguments = arguments+["--errorwhenexists"]
+
+            if create_necessary_folder:
+                arguments = arguments+["--createnecessaryfolder"]
+
+            exit_code, _, stderr, _ = self.run_program_argsasarray("sccreatefolder", arguments, throw_exception_if_exitcode_is_not_zero=False)  # works platform-indepent
+            if exit_code != 0:
+                raise ValueError(f"Fatal error occurrs while create folder '{path}'. StdErr: '{stderr}'")
+
     @GeneralUtilities.check_arguments
     def __sort_fmd(self, line: str):
         splitted: list = line.split(";")
@@ -2203,46 +2271,6 @@ TXDX
     def create_local_docker_network(self, network_name: str) -> None:
         self.run_program("docker", f"network create {network_name}")
 
-    @GeneralUtilities.check_arguments
-    def create_file(self, path: str, error_if_already_exists: bool, create_necessary_folder: bool) -> None:
-        if not os.path.isabs(path):
-            path = os.path.join(os.getcwd(), path)
-
-        if os.path.isfile(path) and error_if_already_exists:
-            raise ValueError(f"File '{path}' already exists.")
-
-        # TODO maybe it should be checked if there is a folder with the same path which already exists.
-
-        folder = os.path.dirname(path)
-
-        if not os.path.isdir(folder):
-            if create_necessary_folder:
-                GeneralUtilities.ensure_directory_exists(folder)  # TODO check if this also create nested folders if required
-            else:
-                raise ValueError(f"Folder '{folder}' does not exist.")
-
-        GeneralUtilities.ensure_file_exists(path)
-
-    @GeneralUtilities.check_arguments
-    def create_folder(self, path: str, error_if_already_exists: bool, create_necessary_folder: bool) -> None:
-        if not os.path.isabs(path):
-            path = os.path.join(os.getcwd(), path)
-
-        if os.path.isdir(path) and error_if_already_exists:
-            raise ValueError(f"Folder '{path}' already exists.")
-
-        # TODO maybe it should be checked if there is a file with the same path which already exists.
-
-        folder = os.path.dirname(path)
-
-        if not os.path.isdir(folder):
-            if create_necessary_folder:
-                GeneralUtilities.ensure_directory_exists(folder)  # TODO check if this also create nested folders if required
-            else:
-                raise ValueError(f"Folder '{folder}' does not exist.")
-
-        GeneralUtilities.ensure_directory_exists(path)
-
     @GeneralUtilities.check_arguments
     def format_xml_file(self, file: str) -> None:
         encoding = "utf-8"

ScriptCollection/TasksForCommonProjectStructure.py

@@ -1237,18 +1237,17 @@ class TasksForCommonProjectStructure:
 
     @GeneralUtilities.check_arguments
     def get_codeunits(self, repository_folder: str, ignore_disabled_codeunits: bool = True) -> list[str]:
-        self.__sc.assert_is_git_repository(repository_folder)
-        result: list[str] = []
-        for direct_subfolder in GeneralUtilities.get_direct_folders_of_folder(repository_folder):
-            subfoldername = os.path.basename(direct_subfolder)
-            codeunit_file = os.path.join(direct_subfolder, f"{subfoldername}.codeunit.xml")
-            if os.path.isfile(codeunit_file):
-                if (ignore_disabled_codeunits):
-                    if (self.codeunit_is_enabled(codeunit_file)):
-                        result.append(subfoldername)
-                else:
-                    result.append(subfoldername)
-        return result
+        codeunits_with_dependent_codeunits: dict[str, set[str]] = dict[str, set[str]]()
+        subfolders = GeneralUtilities.get_direct_folders_of_folder(repository_folder)
+        for subfolder in subfolders:
+            codeunit_name: str = os.path.basename(subfolder)
+            codeunit_file = os.path.join(subfolder, f"{codeunit_name}.codeunit.xml")
+            if os.path.exists(codeunit_file):
+                if ignore_disabled_codeunits and not self.codeunit_is_enabled(codeunit_file):
+                    continue
+                codeunits_with_dependent_codeunits[codeunit_name] = self.get_dependent_code_units(codeunit_file)
+        sorted_codeunits = self._internal_get_sorted_codeunits_by_dict(codeunits_with_dependent_codeunits)
+        return sorted_codeunits
 
     @GeneralUtilities.check_arguments
     def codeunit_is_enabled(self, codeunit_file: str) -> bool:
@@ -2456,18 +2455,6 @@ class TasksForCommonProjectStructure:
         GeneralUtilities.ensure_directory_exists(ca_target_folder)
         GeneralUtilities.copy_content_of_folder(ca_source_folder, ca_target_folder)
 
-    @GeneralUtilities.check_arguments
-    def get_sorted_codeunits(self, repository_folder: str) -> list[str]:
-        codeunits_with_dependent_codeunits: dict[str, set[str]] = dict[str, set[str]]()
-        subfolders = GeneralUtilities.get_direct_folders_of_folder(repository_folder)
-        for subfolder in subfolders:
-            codeunit_name: str = os.path.basename(subfolder)
-            codeunit_file = os.path.join(subfolder, f"{codeunit_name}.codeunit.xml")
-            if os.path.exists(codeunit_file):
-                codeunits_with_dependent_codeunits[codeunit_name] = self.get_dependent_code_units(codeunit_file)
-        sorted_codeunits = self._internal_get_sorted_codeunits_by_dict(codeunits_with_dependent_codeunits)
-        return sorted_codeunits
-
     @GeneralUtilities.check_arguments
     def _internal_get_sorted_codeunits_by_dict(self, codeunits=dict[str, set[str]]) -> list[str]:
         result_typed = list(TopologicalSorter(codeunits).static_order())
@@ -2525,7 +2512,7 @@ class TasksForCommonProjectStructure:
         PrepareBuildCodeunits_script_name = "PrepareBuildCodeunits.py"
         prepare_build_codeunits_scripts = os.path.join(project_resources_folder, PrepareBuildCodeunits_script_name)
 
-        if do_git_clean_when_no_changes:
+        if do_git_clean_when_no_changes and not self.__sc.git_repository_has_uncommitted_changes(repository_folder):
             self.__sc.run_program("git", "clean -dfx", repository_folder)
         if os.path.isfile(prepare_build_codeunits_scripts):
             GeneralUtilities.write_message_to_stdout(f'Run "{PrepareBuildCodeunits_script_name}"')
@@ -2557,7 +2544,7 @@ class TasksForCommonProjectStructure:
             codeunit_file = os.path.join(subfolder, f"{codeunit_name}.codeunit.xml")
             GeneralUtilities.assert_condition(os.path.exists(codeunit_file), f"Codeunit-file '{codeunit_file}' does nost exist.")
             codeunits_with_dependent_codeunits[codeunit_name] = self.get_dependent_code_units(codeunit_file)
-        sorted_codeunits = self.get_sorted_codeunits(repository_folder)
+        sorted_codeunits = self.get_codeunits(repository_folder)
         sorted_codeunits = [codeunit for codeunit in sorted_codeunits if codeunit in codeunits]
         project_version = self.get_version_of_project(repository_folder)
 
@@ -2894,19 +2881,18 @@ class TasksForCommonProjectStructure:
         codeunit_version = self.get_version_of_codeunit_folder(codeunit_folder)
         build_folder = os.path.join(codeunit_folder, "Other", "Build")
         artifacts_folder = os.path.join(codeunit_folder, "Other", "Artifacts", artifact_name_of_zip)
+        manifest_folder = os.path.join(codeunit_folder, "Other", "Artifacts", "WinGet-Manifest")
         GeneralUtilities.assert_folder_exists(artifacts_folder)
         artifacts_file = ScriptCollectionCore().find_file_by_extension(artifacts_folder, "zip")
         winget_template_file = os.path.join(build_folder, "WinGet-Template.yaml")
-        winget_manifest_file = os.path.join(build_folder, "WinGet-Manifest.yaml")
+        winget_manifest_file = os.path.join(manifest_folder, "WinGet-Manifest.yaml")
         GeneralUtilities.assert_file_exists(winget_template_file)
+        GeneralUtilities.ensure_directory_exists(manifest_folder)
         GeneralUtilities.ensure_file_exists(winget_manifest_file)
         manifest_content = GeneralUtilities.read_text_from_file(winget_template_file)
         manifest_content = GeneralUtilities.replace_variable_in_string(manifest_content, "version", codeunit_version)
         manifest_content = GeneralUtilities.replace_variable_in_string(manifest_content, "sha256_hashvalue", GeneralUtilities.get_sha256_of_file(artifacts_file))
         GeneralUtilities.write_text_to_file(winget_manifest_file, manifest_content)
-        target_folder = os.path.join(codeunit_folder, "Other", "Artifacts", "WinGet-Manifest")
-        GeneralUtilities.ensure_folder_exists_and_is_empty(target_folder)
-        shutil.copy(winget_manifest_file, target_folder)
 
     @GeneralUtilities.check_arguments
     def update_year_in_license_file_in_common_scripts_file(self, common_tasks_scripts_file: str) -> None:
@@ -2960,6 +2946,7 @@ class TasksForCommonProjectStructure:
         self.assert_is_codeunit_folder(codeunit_folder)
         now = datetime.now()
         codeunit_folder = GeneralUtilities.resolve_relative_path_from_current_working_directory(codeunit_folder)
+        repository_folder = GeneralUtilities.resolve_relative_path("..", codeunit_folder)
         codeunit_name: str = os.path.basename(codeunit_folder)
         if verbosity > 2:
             GeneralUtilities.write_message_to_stdout(f"Start building codeunit {codeunit_name}")
@@ -2974,7 +2961,8 @@ class TasksForCommonProjectStructure:
 
         GeneralUtilities.write_message_to_stdout(f"Start building codeunit {codeunit_name}.")
         GeneralUtilities.write_message_to_stdout(f"Build-environmenttype: {target_environmenttype}")
-        self.__sc.run_program("git", "clean -dfx", codeunit_folder)
+        if not self.__sc.git_repository_has_uncommitted_changes(repository_folder):
+            self.__sc.run_program("git", "clean -dfx", codeunit_folder)
 
         verbosity_for_executed_programs = self.get_verbosity_from_commandline_arguments(commandline_arguments, verbosity)
 
@@ -3080,7 +3068,7 @@ class TasksForCommonProjectStructure:
         # Prepare
         GeneralUtilities.write_message_to_stdout("Update dependencies...")
         self.__sc.assert_is_git_repository(repository_folder)
-        codeunits = self.get_sorted_codeunits(repository_folder)
+        codeunits = self.get_codeunits(repository_folder)
         update_dependencies_script_filename = "UpdateDependencies.py"
         target_environmenttype = "QualityCheck"
         self.build_codeunits(repository_folder, target_environmenttype=target_environmenttype, do_git_clean_when_no_changes=True, note="Prepare dependency-update")  # Required because update dependencies is not always possible for not-buildet codeunits (depends on the programming language or package manager)

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 3.5.101
+Version: 3.5.103
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -23,7 +23,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: build>=1.2.2.post1
-Requires-Dist: coverage>=7.7.0
+Requires-Dist: coverage>=7.7.1
 Requires-Dist: cyclonedx-bom>=5.3.0
 Requires-Dist: defusedxml>=0.7.1
 Requires-Dist: keyboard>=0.13.5
@@ -33,7 +33,7 @@ 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.5
+Requires-Dist: pylint>=3.3.6
 Requires-Dist: pyOpenSSL>=25.0.0
 Requires-Dist: PyPDF>=5.4.0
 Requires-Dist: pytest>=8.3.5
@@ -41,7 +41,7 @@ Requires-Dist: PyYAML>=6.0.2
 Requires-Dist: qrcode>=8.0
 Requires-Dist: send2trash>=1.8.3
 Requires-Dist: twine>=6.1.0
-Requires-Dist: xmlschema>=3.4.3
+Requires-Dist: xmlschema>=3.4.5
 
 # ScriptCollection
 

{scriptcollection-3.5.101.dist-info → scriptcollection-3.5.103.dist-info}/RECORD

@@ -6,12 +6,12 @@ ScriptCollection/ProgramRunnerEpew.py,sha256=4pjEd0r9Fcz3TTDv0MdTSd5KkigYXcWUVI1
 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=yE-keH79iYM7q6VsMvIcCbRt1H77L6yP_yMhcBkdCYE,123984
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=FzcMzTiQFYnEcJ-2YVq4GpToJtrc_XGP2d84XlWu8eQ,230241
+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.101.dist-info/METADATA,sha256=dO-SsS0ZuDt64A3GPkq02PSPxKv8A2bCYo_lMpF7tp0,7664
-scriptcollection-3.5.101.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-scriptcollection-3.5.101.dist-info/entry_points.txt,sha256=fYCGWGNGijBQHhFe6UAO-BEpfEOxLyNJemukt5ElSzs,3644
-scriptcollection-3.5.101.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.101.dist-info/RECORD,,
+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,,

{scriptcollection-3.5.101.dist-info → scriptcollection-3.5.103.dist-info}/WHEEL

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