ScriptCollection 3.5.149__py3-none-any.whl → 3.5.151__py3-none-any.whl

ScriptCollection/ScriptCollectionCore.py

@@ -34,7 +34,7 @@ from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 from .SCLog import SCLog, LogLevel
 
-version = "3.5.149"
+version = "3.5.151"
 __version__ = version
 
 

ScriptCollection/TasksForCommonProjectStructure.py

@@ -124,6 +124,17 @@ class TasksForCommonProjectStructure:
             sc.log = log
         self.__sc = sc
 
+    @GeneralUtilities.check_arguments
+    def is_codeunit_folder(self, codeunit_folder: str) -> bool:
+        repo_folder = GeneralUtilities.resolve_relative_path("..", codeunit_folder)
+        if not self.__sc.is_git_repository(repo_folder):
+            return False
+        codeunit_name = os.path.basename(codeunit_folder)
+        codeunit_file: str = os.path.join(codeunit_folder, f"{codeunit_name}.codeunit.xml")
+        if not os.path.isfile(codeunit_file):
+            return False
+        return True
+
     @GeneralUtilities.check_arguments
     def assert_is_codeunit_folder(self, codeunit_folder: str) -> str:
         repo_folder = GeneralUtilities.resolve_relative_path("..", codeunit_folder)
@@ -474,8 +485,7 @@ class TasksForCommonProjectStructure:
         self.write_version_to_codeunit_file(codeunit_file, current_version)
 
     @GeneralUtilities.check_arguments
-    def t4_transform(self, commontasks_script_file_of_current_file: str, verbosity: int):
-        sc = ScriptCollectionCore()
+    def t4_transform(self, commontasks_script_file_of_current_file: str, verbosity: int,ignore_git_ignored_files:bool=True):
         codeunit_folder = GeneralUtilities.resolve_relative_path("../..", commontasks_script_file_of_current_file)
         self.__ensure_grylibrary_is_available(codeunit_folder)
         repository_folder: str = os.path.dirname(codeunit_folder)
@@ -483,9 +493,51 @@ class TasksForCommonProjectStructure:
         codeunit_folder = os.path.join(repository_folder, codeunitname)
         for search_result in Path(codeunit_folder).glob('**/*.tt'):
             tt_file = str(search_result)
-            relative_path_to_tt_file = str(Path(tt_file).relative_to(codeunit_folder))
-            argument = [f"--parameter=repositoryFolder={repository_folder}", f"--parameter=codeUnitName={codeunitname}", relative_path_to_tt_file]
-            sc.run_program_argsasarray("t4", argument, codeunit_folder, verbosity=verbosity)
+            relative_path_to_tt_file_from_repository = str(Path(tt_file).relative_to(repository_folder))
+            if (not ignore_git_ignored_files) or (ignore_git_ignored_files and not self.__sc.file_is_git_ignored(relative_path_to_tt_file_from_repository,repository_folder)):
+                relative_path_to_tt_file_from_codeunit_file = str(Path(tt_file).relative_to(codeunit_folder))
+                argument = [f"--parameter=repositoryFolder={repository_folder}", f"--parameter=codeUnitName={codeunitname}", relative_path_to_tt_file_from_codeunit_file]
+                self.__sc.run_program_argsasarray("t4", argument, codeunit_folder, verbosity=verbosity)
+
+    @GeneralUtilities.check_arguments
+    def get_resource_from_global_resource(self,codeunit_folder:str,resource_name:str):
+        repository_folder:str= GeneralUtilities.resolve_relative_path("..", codeunit_folder)
+        source_folder:str=os.path.join(repository_folder,"Other","Resources",resource_name)
+        target_folder:str=os.path.join(codeunit_folder,"Other","Resources",resource_name)
+        GeneralUtilities.ensure_folder_exists_and_is_empty(target_folder)
+        GeneralUtilities.copy_content_of_folder(source_folder, target_folder)
+
+    @GeneralUtilities.check_arguments
+    def clone_repository_as_resource(self,local_repository_folder:str,remote_repository_link:str, resource_name:str,repository_subname:str=None)->str:
+        commit_id:str=None
+        target_folder:str=os.path.join(local_repository_folder,"Other","Resources",resource_name)
+        if repository_subname is not None:
+            target_folder=os.path.join(target_folder,repository_subname)
+        if not os.path.isdir(target_folder):
+            GeneralUtilities.ensure_directory_exists(target_folder)
+            GeneralUtilities.write_message_to_stdout(f"Clone {remote_repository_link} into {target_folder}...")
+            self.__sc.run_program("git",f"clone --recurse-submodules {remote_repository_link} {target_folder}")
+
+            self.__sc.git_get_commit_id(target_folder)
+
+            git_folders:list[str]=[]
+            git_files:list[str]=[]
+            for dirpath, dirnames, filenames in os.walk(target_folder):
+                for dirname in dirnames:
+                    if dirname == ".git":
+                        full_path = os.path.join(dirpath, dirname)
+                        git_folders.append(full_path)
+                for filename in filenames:
+                    if filename == ".git":
+                        full_path = os.path.join(dirpath, filename)
+                        git_files.append(full_path)
+            for git_folder in git_folders:
+                if os.path.isdir(git_folder):
+                    GeneralUtilities.ensure_directory_does_not_exist(git_folder)
+            for git_file in git_files:
+                if os.path.isdir(git_file):
+                    GeneralUtilities.ensure_file_does_not_exist(git_file)
+        return commit_id
 
     @GeneralUtilities.check_arguments
     def standardized_tasks_generate_reference_by_docfx(self, generate_reference_script_file: str, verbosity: int, targetenvironmenttype: str, commandline_arguments: list[str]) -> None:
@@ -1884,7 +1936,7 @@ class TasksForCommonProjectStructure:
         GeneralUtilities.write_text_to_file(file, result)
 
     @GeneralUtilities.check_arguments
-    def do_npm_install(self, package_json_folder: str, force: bool, verbosity: int) -> None:
+    def do_npm_install(self, package_json_folder: str, force: bool, verbosity: int = 1) -> None:
         argument1 = "install"
         if force:
             argument1 = f"{argument1} --force"
@@ -2092,6 +2144,14 @@ class TasksForCommonProjectStructure:
         GeneralUtilities.ensure_directory_does_not_exist(target_folder)
         shutil.copytree(source_folder, target_folder)
 
+    @GeneralUtilities.check_arguments
+    def copy_resources_from_global_project_resources(self, codeunit_folder: str, resource_name: str) -> None:
+        self.assert_is_codeunit_folder(codeunit_folder)
+        source_folder: str = GeneralUtilities.resolve_relative_path(f"../Other/Resources/{resource_name}", codeunit_folder)
+        target_folder: str = GeneralUtilities.resolve_relative_path(f"Other/Resources/{resource_name}", codeunit_folder)
+        GeneralUtilities.ensure_directory_does_not_exist(target_folder)
+        shutil.copytree(source_folder, target_folder)
+
     @GeneralUtilities.check_arguments
     def generate_openapi_file(self, buildscript_file: str, runtime: str, verbosity: int, commandline_arguments: list[str], swagger_document_name: str = "APISpecification") -> None:
         GeneralUtilities.write_message_to_stdout("Generate OpenAPI-specification-file...")
@@ -2354,16 +2414,18 @@ class TasksForCommonProjectStructure:
         self.__sc.update_dependencies_of_dotnet_project(csproj_file, verbosity, ignored_dependencies)
 
     @GeneralUtilities.check_arguments
-    def update_dependencies_of_typical_node_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)
+    def update_dependencies_of_package_json(self, folder: str, verbosity: int, cmd_args: list[str]) -> None:
+        if self.is_codeunit_folder(folder):
+            ignored_dependencies = self.get_dependencies_which_are_ignored_from_updates(folder, True)
+        else:
+            ignored_dependencies = []
         # TODO consider ignored_dependencies
-        result = self.run_with_epew("npm", "outdated", codeunit_folder, verbosity, throw_exception_if_exitcode_is_not_zero=False)
+        result = self.run_with_epew("npm", "outdated", folder, verbosity, throw_exception_if_exitcode_is_not_zero=False)
         if result[0] == 0:
             return  # all dependencies up to date
         elif result[0] == 1:
             package_json_content = None
-            package_json_file = f"{codeunit_folder}/package.json"
+            package_json_file = f"{folder}/package.json"
             with open(package_json_file, "r", encoding="utf-8") as package_json_file_object:
                 package_json_content = json.load(package_json_file_object)
                 lines = GeneralUtilities.string_to_lines(result[1])[1:][:-1]
@@ -2377,7 +2439,7 @@ class TasksForCommonProjectStructure:
                         package_json_content["devDependencies"][package] = latest_version
             with open(package_json_file, "w", encoding="utf-8") as package_json_file_object:
                 json.dump(package_json_content, package_json_file_object, indent=4)
-            self.do_npm_install(codeunit_folder, True, verbosity)
+            self.do_npm_install(folder, True, verbosity)
         else:
             GeneralUtilities.write_message_to_stderr("Update dependencies resulted in an error.")
 
@@ -3416,7 +3478,7 @@ class TasksForCommonProjectStructure:
         self.__sc.install_requirementstxt_file(repository_folde+"/Other/requirements.txt", verbosity)
 
     @GeneralUtilities.check_arguments
-    def update_submodule(self, repository_folder: str, submodule_name: str,local_branch:str="main",remote_branch:str="main",remote:str="origin"):
+    def update_submodule(self, repository_folder: str, submodule_name: str, local_branch: str = "main", remote_branch: str = "main", remote: str = "origin"):
         submodule_folder = GeneralUtilities.resolve_relative_path("Other/Resources/Submodules/"+submodule_name, repository_folder)
         self.__sc.git_fetch(submodule_folder, remote)
         self.__sc.git_checkout(submodule_folder, local_branch)

{scriptcollection-3.5.149.dist-info → scriptcollection-3.5.151.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 3.5.149
+Version: 3.5.151
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -34,7 +34,7 @@ Requires-Dist: Pillow>=11.3.0
 Requires-Dist: psutil>=7.0.0
 Requires-Dist: pycdlib>=1.14.0
 Requires-Dist: Pygments>=2.19.2
-Requires-Dist: pylint>=3.3.7
+Requires-Dist: pylint>=3.3.8
 Requires-Dist: pyOpenSSL>=25.1.0
 Requires-Dist: PyPDF>=5.9.0
 Requires-Dist: pytest>=8.4.1

{scriptcollection-3.5.149.dist-info → scriptcollection-3.5.151.dist-info}/RECORD

@@ -7,11 +7,11 @@ ScriptCollection/ProgramRunnerBase.py,sha256=2kMIAqdc65UjBAddOZkzy_aFx9h5roZ5a4b
 ScriptCollection/ProgramRunnerEpew.py,sha256=4pjEd0r9Fcz3TTDv0MdTSd5KkigYXcWUVI1X43regfU,6477
 ScriptCollection/ProgramRunnerPopen.py,sha256=BPY7-ZMIlqT7JOKz8qlB5c0laF2Js-ijzqk09GxZC48,3821
 ScriptCollection/SCLog.py,sha256=GJ44S6VaBVwX5Dd6MIrdZn6I0dpaaYKVq9w-N0nMXlo,4496
-ScriptCollection/ScriptCollectionCore.py,sha256=2GF7AUB6QN2o3N3-KPhdHGzxwpZryfWQIPRGLUMRmRo,138093
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=GoIVDPIGua2ZJIGM4zeJL1nNLwh7X1W8BI-2z-ESgb0,241302
+ScriptCollection/ScriptCollectionCore.py,sha256=YJ6uOGQa224jtsva_OX3r8h2aIzGR9GAfJH4h-9iIAc,138093
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=9vccEWsxlW7xGXFLc2RPPFMWCkmoGxbSGu7hi9NxkeU,244959
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-3.5.149.dist-info/METADATA,sha256=Xt22-tDxFlz_5bbY-hDalMAXE7ndoPYu7QeEGLC822g,7689
-scriptcollection-3.5.149.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scriptcollection-3.5.149.dist-info/entry_points.txt,sha256=UyXXDpgVK6U0rkdbe2g-d3a7JFhLFWTUFSYWhcJE7IA,4214
-scriptcollection-3.5.149.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.149.dist-info/RECORD,,
+scriptcollection-3.5.151.dist-info/METADATA,sha256=-EuHJHBjH-Oe9njZujrMzqr5aUXDVt_20DyCPY_81RE,7689
+scriptcollection-3.5.151.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scriptcollection-3.5.151.dist-info/entry_points.txt,sha256=AvmVO9iyWImExpvzL3YYQ9AOEiUIN9guPRRG_W_VNWY,4116
+scriptcollection-3.5.151.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-3.5.151.dist-info/RECORD,,

{scriptcollection-3.5.149.dist-info → scriptcollection-3.5.151.dist-info}/entry_points.txt

@@ -28,7 +28,6 @@ scgeneratecertificate = ScriptCollection.Executables:GenerateCertificate
 scgeneratecertificateauthority = ScriptCollection.Executables:GenerateCertificateAuthority
 scgeneratecertificatesignrequest = ScriptCollection.Executables:GenerateCertificateSignRequest
 scgeneratesnkfiles = ScriptCollection.Executables:GenerateSnkFiles
-scgeneratetasksfilefromworkspacefile = ScriptCollection.Executables:GenerateTaskfileFromWorkspacefile
 scgeneratethumbnail = ScriptCollection.Executables:GenerateThumbnail
 schealthcheck = ScriptCollection.Executables:Healthcheck
 sckeyboarddiagnosis = ScriptCollection.Executables:KeyboardDiagnosis
@@ -51,7 +50,7 @@ scremovefolder = ScriptCollection.Executables:RemoveFolder
 screname = ScriptCollection.Executables:Rename
 screplacesubstringsinfilenames = ScriptCollection.Executables:ReplaceSubstringsInFilenames
 scsearchinfiles = ScriptCollection.Executables:SearchInFiles
-scsetfilecontent = ScriptCollection.Executables:SetFileContent
+scsetcontentoffile = ScriptCollection.Executables:SetContentOfFile
 scshow2faasqrcode = ScriptCollection.Executables:Show2FAAsQRCode
 scshowmissingfiles = ScriptCollection.Executables:ShowMissingFiles
 scsigncertificate = ScriptCollection.Executables:SignCertificate