ScriptCollection 3.5.147__py3-none-any.whl → 3.5.149__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/SCLog.py

@@ -24,7 +24,7 @@ class SCLog:
     print_as_color: bool
     zone_of_time: timezone = None
 
-    def __init__(self, log_file: str = None, loglevel: LogLevel = None,print_as_color: bool = True):
+    def __init__(self, log_file: str = None, loglevel: LogLevel = None, print_as_color: bool = True):
         self.log_file = log_file
         if loglevel is None:
             self.loglevel = LogLevel.Information
@@ -46,8 +46,8 @@ class SCLog:
     @GeneralUtilities.check_arguments
     def __log_line(self, message: str, loglevel: LogLevel = None):
 
-        print_to_console:bool=True
-        print_to_logfile:bool=self.log_file is not None
+        print_to_console: bool = True
+        print_to_logfile: bool = self.log_file is not None
 
         if loglevel is None:
             loglevel = LogLevel.Information
@@ -91,8 +91,8 @@ class SCLog:
         part3 = f"] {message}"
 
         if print_to_console:
+            print_to_std_out: bool = loglevel in (LogLevel.Debug, LogLevel.Information)
             if self.add_overhead_to_console:
-                print_to_std_out: bool = loglevel in (LogLevel.Debug, LogLevel.Information)
                 GeneralUtilities.print_text(part1, print_to_std_out)
                 if loglevel == LogLevel.Information:
                     GeneralUtilities.print_text_in_green(part2, print_to_std_out, self.print_as_color)
@@ -110,7 +110,6 @@ class SCLog:
             else:
                 GeneralUtilities.print_text(message+"\n", print_to_std_out)
 
-
         if print_to_logfile:
             GeneralUtilities.ensure_file_exists(self.log_file)
             if self.add_overhead_to_logfile:

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.147"
+version = "3.5.149"
 __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

@@ -2383,64 +2383,67 @@ class TasksForCommonProjectStructure:
 
     @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):

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 3.5.147
+Version: 3.5.149
 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.147.dist-info → scriptcollection-3.5.149.dist-info}/RECORD

@@ -1,17 +1,17 @@
 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
 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=VSQdklttjq1XlQMHbrlKLzNmTf1u_AevayWwhl0KBeM,4494
-ScriptCollection/ScriptCollectionCore.py,sha256=isnzIuTRVO_97Xc0NBaukbTcZeF7BA_aRwsWHqvPjkw,136482
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=aVwQq2kQwZmL-NAhOVo_G4ikYHsI92SGvhkmmGJlSw8,240711
+ScriptCollection/SCLog.py,sha256=GJ44S6VaBVwX5Dd6MIrdZn6I0dpaaYKVq9w-N0nMXlo,4496
+ScriptCollection/ScriptCollectionCore.py,sha256=2GF7AUB6QN2o3N3-KPhdHGzxwpZryfWQIPRGLUMRmRo,138093
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=GoIVDPIGua2ZJIGM4zeJL1nNLwh7X1W8BI-2z-ESgb0,241302
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-3.5.147.dist-info/METADATA,sha256=1rxb3N70WU29OYTWmBvSV7yHVGvs0K775qc9sHVRo0s,7694
-scriptcollection-3.5.147.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scriptcollection-3.5.147.dist-info/entry_points.txt,sha256=AvmVO9iyWImExpvzL3YYQ9AOEiUIN9guPRRG_W_VNWY,4116
-scriptcollection-3.5.147.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.147.dist-info/RECORD,,
+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.147.dist-info → scriptcollection-3.5.149.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