ScriptCollection 3.5.148__py3-none-any.whl → 3.5.150__py3-none-any.whl

ScriptCollection/Executables.py

@@ -1,3 +1,4 @@
+import base64
 import os
 import argparse
 import time
@@ -412,12 +413,6 @@ def FolderExists() -> int:
         return 2
 
 
-def SetContentOfFile() -> int:
-    GeneralUtilities.write_message_to_stderr("This function is not implemented yet.")
-    # TODO implement function
-    return 1
-
-
 def PrintFileContent() -> int:
     parser = argparse.ArgumentParser(description="This function prints the size of a file")
     parser.add_argument('-p', '--path', required=True)
@@ -726,3 +721,30 @@ def UpdateImagesInDockerComposeFile() -> int:
         args.file = os.path.join(os.getcwd(), "docker-compose.yml")
     iu.update_all_services_in_docker_compose_file(args.file, VersionEcholon.LatestPatch, [])
     return 0
+
+
+def SetFileContent() -> int:
+    parser = argparse.ArgumentParser(description="This function writes content into a file.")
+    parser.add_argument('-p', '--path', required=True)
+    parser.add_argument('-b', '--argumentisinbase64', action='store_true', required=False, default=False)
+    parser.add_argument('-c', '--content', required=True)
+    parser.add_argument('-e', '--encoding', required=False, default="utf-8")
+    args = parser.parse_args()
+    sc = ScriptCollectionCore()
+    content = args.content
+    if args.argumentisinbase64:
+        base64_string: str = args.content
+        base64_bytes = base64_string.encode('utf-8')
+        original_bytes = base64.b64decode(base64_bytes)
+        content = original_bytes.decode('utf-8')
+    sc.set_file_content(args.path, content, args.encoding)
+    return 0
+
+
+def GenerateTaskfileFromWorkspacefile() -> int:
+    parser = argparse.ArgumentParser(description="Generates a taskfile.yml-file from a .code-workspace-file")
+    parser.add_argument('-f', '--repositoryfolder', required=True)
+    args = parser.parse_args()
+    t = TasksForCommonProjectStructure()
+    t.generate_tasksfile_from_workspace_file(args.repositoryfolder)
+    return 0

ScriptCollection/ScriptCollectionCore.py

@@ -8,6 +8,7 @@ import time
 from io import BytesIO
 import itertools
 import math
+import base64
 import os
 from queue import Queue, Empty
 from concurrent.futures import ThreadPoolExecutor
@@ -33,7 +34,7 @@ from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 from .SCLog import SCLog, LogLevel
 
-version = "3.5.148"
+version = "3.5.150"
 __version__ = version
 
 
@@ -130,7 +131,8 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def find_file_by_extension(self, folder: str, extension_without_dot: str):
-        result = [file for file in GeneralUtilities.get_direct_files_of_folder(folder) if file.endswith(f".{extension_without_dot}")]
+        """This function works platform-independent also for non-local-executions if the ScriptCollection commandline-commands are available as global command on the target-system."""
+        result = [file for file in self.list_content(folder, True, False, False) if file.endswith(f".{extension_without_dot}")]
         result_length = len(result)
         if result_length == 0:
             raise FileNotFoundError(f"No file available in folder '{folder}' with extension '{extension_without_dot}'.")
@@ -778,6 +780,26 @@ class ScriptCollectionCore:
                 return False
             raise ValueError(f"Fatal error occurrs while checking whether folder '{path}' exists. StdErr: '{stderr}'")
 
+    @GeneralUtilities.check_arguments
+    def get_file_content(self, path: str, encoding: str = "utf-8") -> str:
+        """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():
+            return GeneralUtilities.read_text_from_file(path, encoding)
+        else:
+            result = self.run_program_argsasarray("scprintfilecontent", ["--path", path, "--encofing", encoding])  # works platform-indepent
+            return result[1].replace("\\n", "\n")
+
+    @GeneralUtilities.check_arguments
+    def set_file_content(self, path: str, content: str, encoding: str = "utf-8") -> 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():
+            GeneralUtilities.write_text_to_file(path, content, encoding)
+        else:
+            content_bytes = content.encode('utf-8')
+            base64_bytes = base64.b64encode(content_bytes)
+            base64_string = base64_bytes.decode('utf-8')
+            self.run_program_argsasarray("scsetfilecontent", ["--path", path, "--argumentisinbase64", "--content", base64_string])  # works platform-indepent
+
     @GeneralUtilities.check_arguments
     def remove(self, path: str) -> 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."""

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)
@@ -1884,7 +1895,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 +2103,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 +2373,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,70 +2398,73 @@ 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.")
 
     @GeneralUtilities.check_arguments
     def generate_tasksfile_from_workspace_file(self, repository_folder: str, append_cli_args_at_end: bool = False) -> None:
-        self.__sc.assert_is_git_repository(repository_folder)
-        sc: ScriptCollectionCore = ScriptCollectionCore()
-        workspace_file: str = sc.find_file_by_extension(repository_folder, "code-workspace")
-        task_file: str = os.path.join(repository_folder, "Taskfile.yml")
-        lines: list[str] = ["version: '3'", GeneralUtilities.empty_string, "tasks:", GeneralUtilities.empty_string]
-        workspace_file_content: str = GeneralUtilities.read_text_from_file(workspace_file)
-        jsoncontent = json.loads(workspace_file_content)
-        tasks = jsoncontent["tasks"]["tasks"]
-        tasks.sort(key=lambda x: x["label"].split("/")[-1], reverse=False)  # sort by the label of the task
-        for task in tasks:
-            if task["type"] == "shell":
-
-                description: str = task["label"]
-                name: str = GeneralUtilities.to_pascal_case(description)
-                command = task["command"]
-                relative_script_file = task["command"]
-
-                relative_script_file = "."
-                if "options" in task:
-                    options = task["options"]
-                    if "cwd" in options:
-                        cwd: str = options["cwd"]
-                        cwd = cwd.replace("${workspaceFolder}", ".")
-                        relative_script_file = cwd
-                if len(relative_script_file) == 0:
-                    relative_script_file = "."
+        """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.__sc.program_runner.will_be_executed_locally():  # works only locally, but much more performant than always running an external program
+            self.__sc.assert_is_git_repository(repository_folder)
+            workspace_file: str = self.__sc.find_file_by_extension(repository_folder, "code-workspace")
+            task_file: str = repository_folder + "/Taskfile.yml"
+            lines: list[str] = ["version: '3'", GeneralUtilities.empty_string, "tasks:", GeneralUtilities.empty_string]
+            workspace_file_content: str = self.__sc.get_file_content(workspace_file)
+            jsoncontent = json.loads(workspace_file_content)
+            tasks = jsoncontent["tasks"]["tasks"]
+            tasks.sort(key=lambda x: x["label"].split("/")[-1], reverse=False)  # sort by the label of the task
+            for task in tasks:
+                if task["type"] == "shell":
+
+                    description: str = task["label"]
+                    name: str = GeneralUtilities.to_pascal_case(description)
+                    command = task["command"]
+                    relative_script_file = task["command"]
 
-                command_with_args = command
-                if "args" in task:
-                    args = task["args"]
-                    if len(args) > 1:
-                        command_with_args = f"{command_with_args} {' '.join(args)}"
-
-                if "description" in task:
-                    additional_description = task["description"]
-                    description = f"{description} ({additional_description})"
-
-                if append_cli_args_at_end:
-                    command_with_args = f"{command_with_args} {{{{.CLI_ARGS}}}}"
-
-                cwd_literal = cwd.replace("\\", "\\\\").replace('"', '\\"')  # escape backslashes and double quotes for YAML
-                description_literal = description.replace("\\", "\\\\").replace('"', '\\"')  # escape backslashes and double quotes for YAML
-
-                lines.append(f"  {name}:")
-                lines.append(f'    desc: "{description_literal}"')
-                lines.append('    silent: true')
-                lines.append(f'    dir: "{cwd_literal}"')
-                lines.append("    cmds:")
-                lines.append(f"      - {command_with_args}")
-                lines.append('    aliases:')
-                lines.append(f'      - {name.lower()}')
-                if "aliases" in task:
-                    aliases = task["aliases"]
-                    for alias in aliases:
-                        lines.append(f'      - {alias}')
-                lines.append(GeneralUtilities.empty_string)
-
-        GeneralUtilities.write_lines_to_file(task_file, lines)
+                    relative_script_file = "."
+                    if "options" in task:
+                        options = task["options"]
+                        if "cwd" in options:
+                            cwd: str = options["cwd"]
+                            cwd = cwd.replace("${workspaceFolder}", ".")
+                            relative_script_file = cwd
+                    if len(relative_script_file) == 0:
+                        relative_script_file = "."
+
+                    command_with_args = command
+                    if "args" in task:
+                        args = task["args"]
+                        if len(args) > 1:
+                            command_with_args = f"{command_with_args} {' '.join(args)}"
+
+                    if "description" in task:
+                        additional_description = task["description"]
+                        description = f"{description} ({additional_description})"
+
+                    if append_cli_args_at_end:
+                        command_with_args = f"{command_with_args} {{{{.CLI_ARGS}}}}"
+
+                    cwd_literal = cwd.replace("\\", "\\\\").replace('"', '\\"')  # escape backslashes and double quotes for YAML
+                    description_literal = description.replace("\\", "\\\\").replace('"', '\\"')  # escape backslashes and double quotes for YAML
+
+                    lines.append(f"  {name}:")
+                    lines.append(f'    desc: "{description_literal}"')
+                    lines.append('    silent: true')
+                    lines.append(f'    dir: "{cwd_literal}"')
+                    lines.append("    cmds:")
+                    lines.append(f"      - {command_with_args}")
+                    lines.append('    aliases:')
+                    lines.append(f'      - {name.lower()}')
+                    if "aliases" in task:
+                        aliases = task["aliases"]
+                        for alias in aliases:
+                            lines.append(f'      - {alias}')
+                    lines.append(GeneralUtilities.empty_string)
+
+            self.__sc.set_file_content(task_file, "\n".join(lines))
+        else:
+            self.__sc.run_program("scgeneratetasksfilefromworkspacefile", f"--repositoryfolder {repository_folder}")
 
     @GeneralUtilities.check_arguments
     def start_local_test_service(self, file: str):
@@ -3413,7 +3437,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.148.dist-info → scriptcollection-3.5.150.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 3.5.148
+Version: 3.5.150
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -22,21 +22,21 @@ Classifier: Topic :: Terminals
 Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: build>=1.2.2.post1
-Requires-Dist: coverage>=7.9.1
-Requires-Dist: cyclonedx-bom>=6.1.1
+Requires-Dist: build>=1.3.0
+Requires-Dist: coverage>=7.10.2
+Requires-Dist: cyclonedx-bom>=7.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.4.0
+Requires-Dist: lxml>=6.0.0
 Requires-Dist: ntplib>=0.4.0
-Requires-Dist: Pillow>=11.2.1
+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: pyOpenSSL>=25.1.0
-Requires-Dist: PyPDF>=5.7.0
+Requires-Dist: PyPDF>=5.9.0
 Requires-Dist: pytest>=8.4.1
 Requires-Dist: PyYAML>=6.0.2
 Requires-Dist: qrcode>=8.2

{scriptcollection-3.5.148.dist-info → scriptcollection-3.5.150.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ScriptCollection/CertificateUpdater.py,sha256=OAxrG21k_o3W3niOOGNSZzUPJlvolOWc1lRB2dMhc3g,9212
-ScriptCollection/Executables.py,sha256=d9QkQuaS0nxTwNUGxtqKUk9dJqT5gS670LNuCz2YMw0,35349
+ScriptCollection/Executables.py,sha256=eX94RLNBarpWoZKeDo02gcP_qzmJDZcIx8XBZFVCFNc,36396
 ScriptCollection/GeneralUtilities.py,sha256=PKdzq382RYVSWeSG_6z6FiHu-SiTOi2BavJKvP-0slU,47308
 ScriptCollection/ImageUpdater.py,sha256=3B5pgAMnyne3ZogWz-suqglZGIB9FAKyWn31P9E1ST0,24491
 ScriptCollection/ProcessesRunner.py,sha256=3mu4ZxzZleQo0Op6o9EYTCFiJfb6kx5ov2YfZfT89mU,1395
@@ -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=ue-SRkt8EVrFEXTqSJ-g0V-EtaxbN67jbI1J3T3Lk_g,136482
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=aVwQq2kQwZmL-NAhOVo_G4ikYHsI92SGvhkmmGJlSw8,240711
+ScriptCollection/ScriptCollectionCore.py,sha256=5NttFPAv0ArguQgpq-4BPm37_hiUQRlpyscIVH8b8qQ,138093
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=jPgWuxmQ0_iSE1fWZesNipG0ddATCFGLoU4RaWWW_LI,242339
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-3.5.148.dist-info/METADATA,sha256=5LUruhTUIaiA13P-RyZTSV_OSgRma7YCEpMuyO4KKG4,7694
-scriptcollection-3.5.148.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scriptcollection-3.5.148.dist-info/entry_points.txt,sha256=AvmVO9iyWImExpvzL3YYQ9AOEiUIN9guPRRG_W_VNWY,4116
-scriptcollection-3.5.148.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.148.dist-info/RECORD,,
+scriptcollection-3.5.150.dist-info/METADATA,sha256=8qYKtBv7zsacVbjXt6OPfjZIDfoK4d2hIJ3qYyj-XLE,7689
+scriptcollection-3.5.150.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scriptcollection-3.5.150.dist-info/entry_points.txt,sha256=UyXXDpgVK6U0rkdbe2g-d3a7JFhLFWTUFSYWhcJE7IA,4214
+scriptcollection-3.5.150.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-3.5.150.dist-info/RECORD,,

{scriptcollection-3.5.148.dist-info → scriptcollection-3.5.150.dist-info}/entry_points.txt

@@ -28,6 +28,7 @@ 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
@@ -50,7 +51,7 @@ scremovefolder = ScriptCollection.Executables:RemoveFolder
 screname = ScriptCollection.Executables:Rename
 screplacesubstringsinfilenames = ScriptCollection.Executables:ReplaceSubstringsInFilenames
 scsearchinfiles = ScriptCollection.Executables:SearchInFiles
-scsetcontentoffile = ScriptCollection.Executables:SetContentOfFile
+scsetfilecontent = ScriptCollection.Executables:SetFileContent
 scshow2faasqrcode = ScriptCollection.Executables:Show2FAAsQRCode
 scshowmissingfiles = ScriptCollection.Executables:ShowMissingFiles
 scsigncertificate = ScriptCollection.Executables:SignCertificate