ScriptCollection 4.2.46__py3-none-any.whl → 4.2.47__py3-none-any.whl

ScriptCollection/GeneralUtilities.py

@@ -3,6 +3,7 @@ import os
 from os import listdir
 from os.path import isfile, join, isdir
 import platform
+import json
 import inspect
 import ctypes
 import hashlib
@@ -1396,3 +1397,38 @@ class GeneralUtilities:
             res = res.joinpath(part)
         result= res.read_bytes()
         return result
+
+    @staticmethod
+    @check_arguments
+    def escape_json_string_value(str_value: str) -> str:
+        """For input 'a"b\\c' this function returns 'a\\"b\\\\c'. This function does not add surrounding quotes. It only escapes the characters inside the string."""
+        json_escaped = json.dumps(str_value)
+        return json_escaped[1:-1] 
+    
+    @staticmethod
+    @check_arguments
+    def escape_json_property_value(str_value: str) -> str:
+        # remove all characters not in [a-zA-Z0-9_]
+        sanitized = re.sub(r'[^a-zA-Z0-9_]', '', str_value)
+
+        # check if result starts with [a-zA-Z_]
+        if not sanitized or len(sanitized) == 0 or not re.match(r'[a-zA-Z_]', sanitized[0]):
+            raise ValueError(f"Invalid JSON property name after sanitizing: '{sanitized}'. Value must start with [a-zA-Z_].")
+
+        return sanitized
+
+    @staticmethod
+    @check_arguments
+    def escape_yaml_string_value(str_value: str) -> str:
+        """For input 'a"b\\c' this function returns 'a\\"b\\\\c'. This function does not add surrounding quotes. It only escapes the characters inside the string."""
+        result= GeneralUtilities.escape_json_string_value(str_value)
+        #do other adaptions here if desired/required
+        return result
+
+    @staticmethod
+    @check_arguments
+    def escape_yaml_property_value(str_value: str) -> str:
+        result= GeneralUtilities.escape_json_property_value(str_value)
+        #do other adaptions here if desired/required
+        return result
+    

ScriptCollection/ScriptCollectionCore.py

@@ -35,10 +35,120 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .SCLog import SCLog, LogLevel
 
-version = "4.2.46"
+version = "4.2.47"
 __version__ = version
 
+class VSCodeWorkspaceShellTask:
+    label:str
+    description:str#nullable
+    work_dir:str#nullable
+    command:str
+    aliases:list[str]
+    allow_custom_arguments:bool
+
+    def __init__(self,label:str,description:str,work_dir:str,command:str,aliases:list[str],allow_custom_arguments:bool):
+        GeneralUtilities.assert_not_null(label,"label")
+        self.label=label
+        self.description=description
+        self.work_dir=work_dir
+        GeneralUtilities.assert_not_null(command,"command")
+        self.command=command
+        GeneralUtilities.assert_not_null(aliases,"aliases")
+        self.aliases=aliases
+        GeneralUtilities.assert_not_null(allow_custom_arguments,"allow_custom_arguments")
+        self.allow_custom_arguments=allow_custom_arguments
+
+
+    def serialize_for_vscode(self)->str:
+        aliases=",".join([f"\"{GeneralUtilities.escape_json_string_value(alias)}\"" for alias in self.aliases])
+
+        cwd:str=None
+        if self.work_dir is None:
+            cwd=GeneralUtilities.empty_string
+        else:
+            cwd=f"\"cwd\": \"{GeneralUtilities.escape_json_string_value(self.work_dir)}\""
+
+        desc:str=None
+        if self.description is None:
+            desc=GeneralUtilities.empty_string
+        else:
+            desc=f"\"description\": \"{GeneralUtilities.escape_json_string_value(self.description)}\","
+
+        result=f"""        {{
+                "label": "{GeneralUtilities.escape_json_string_value(self.label)}",
+                "command": "{GeneralUtilities.escape_json_string_value(self.command)}",
+                "type": "shell",
+                "options": {{
+                    {cwd}
+                }},
+                "aliases": [
+                    {aliases}
+                ],
+                {desc}
+                "allowcustomarguments": {str(self.allow_custom_arguments).lower()}
+            }}"""
+        return result
+
+class VSCodeWorkspaceMariaDBConnection:
+    name:str
+    previewLimit:int=50
+    server:str
+    port:int
+    database:str
+    username:str
+    password:str
+    
+    def __init__(self,name:str,server,port,database,username,password):
+        GeneralUtilities.assert_not_null(name,"name")
+        self.name=name
+        GeneralUtilities.assert_not_null(server,"server")
+        self.server=server
+        GeneralUtilities.assert_not_null(port,"port")
+        self.port=port
+        GeneralUtilities.assert_not_null(database,"database")
+        self.database=database
+        GeneralUtilities.assert_not_null(username,"username")
+        self.username=username
+        GeneralUtilities.assert_not_null(password,"password")
+        self.password=password
+
+    def serialize_for_vscode(self)->str:
+        result=f"""        {{
+                        "name": "{GeneralUtilities.escape_json_string_value(self.name)}",
+                        "mysqlOptions": {{
+                            "authProtocol": "default",
+                            "enableSsl": "Disabled"
+                        }},
+                        "previewLimit": {self.previewLimit},
+                        "server": "{GeneralUtilities.escape_json_string_value(self.server)}",
+                        "port": {self.port},
+                        "driver": "MySQL",
+                        "database": "{GeneralUtilities.escape_json_string_value(self.database)}",
+                        "username": "{GeneralUtilities.escape_json_string_value(self.username)}",
+                        "password": "{GeneralUtilities.escape_json_string_value(self.password)}"
+                    }}
+"""
+        return result
+
 
+class VSCodeWorkspaceMongoDBConnection:
+    name:str
+    connection_string:str
+
+    def __init__(self,name:str,connection_string:str):
+        GeneralUtilities.assert_not_null(name,"name")
+        self.name=name
+        GeneralUtilities.assert_not_null(connection_string,"connection_string")
+        self.connection_string=connection_string
+
+    def serialize_for_vscode(self)->str:
+        result=f"""                    {{
+                        "name": "{GeneralUtilities.escape_json_string_value(self.name)}",
+                        "connectionString": "{GeneralUtilities.escape_json_string_value(self.connection_string)}"
+                    }}
+"""
+        return result
+    
 class ScriptCollectionCore:
 
     # The purpose of this property is to use it when testing your code which uses scriptcollection for external program-calls.
@@ -2810,3 +2920,63 @@ OCR-content:
 
         languages=list(languages)
         return languages
+
+    @GeneralUtilities.check_arguments
+    def parse_tasks_from_codeworkspace_file(self,code_workspace_file:str)->list[VSCodeWorkspaceShellTask]:
+        result=[]
+        jsoncontent = json.loads(GeneralUtilities.read_text_from_file(code_workspace_file))
+        tasks = jsoncontent["tasks"]["tasks"]
+        for task in tasks:
+            if task["type"] == "shell":
+                label: str = task["label"]
+                name: str = GeneralUtilities.to_pascal_case(label)
+                command:str= task["command"]
+                work_dir:str = None
+
+                if "options" in task:
+                    options = task["options"]
+                    if "cwd" in options:
+                        work_dir = options["cwd"]
+                        work_dir = work_dir.replace("${workspaceFolder}", ".")
+
+                command_with_args = command
+                if "args" in task:
+                    args = task["args"]
+                    if len(args) > 1:
+                        command_with_args = f"{command_with_args} {' '.join(args)}"
+
+                description: str =None
+                if "description" in task:
+                    description =  f'{label} ({task["description"]})'
+                else:
+                    description =  label
+
+
+                alias_list:list[str]=[]
+                name_lower=name.lower()
+                if name!=name.lower():
+                    alias_list.append(name_lower)
+
+                if "aliases" in task:
+                    aliases = task["aliases"]
+                    for alias in aliases:
+                        alias_list.append(alias)
+
+                allow_custom_arguments:bool=False
+                if "allowcustomarguments" in task:
+                    allow_custom_arguments = task["allowcustomarguments"]
+
+                result.append(VSCodeWorkspaceShellTask(name, description, work_dir, command_with_args, alias_list, allow_custom_arguments))
+        return result
+
+    @GeneralUtilities.check_arguments
+    def parse_mongodbconnection_from_codeworkspace_file(self,code_workspace_file:str)->list[VSCodeWorkspaceMongoDBConnection]:
+        result=[]
+        #TODO
+        return result
+
+    @GeneralUtilities.check_arguments
+    def parse_sqlconnection_from_codeworkspace_file(self,code_workspace_file:str)->list[VSCodeWorkspaceMariaDBConnection]:
+        result=[]
+        #TODO
+        return result

ScriptCollection/TFCPS/TFCPS_Tools_General.py

@@ -17,7 +17,7 @@ from packaging import version
 import requests
 from lxml import etree
 from ..GeneralUtilities import GeneralUtilities
-from ..ScriptCollectionCore import ScriptCollectionCore
+from ..ScriptCollectionCore import ScriptCollectionCore,VSCodeWorkspaceShellTask
 from ..SCLog import  LogLevel
 from ..ImageUpdater import ConcreteImageUpdater, ImageUpdater, VersionEcholon
 from ..OCIImages.OCIImageManager import OCIImageManager
@@ -609,62 +609,30 @@ class TFCPS_Tools_General:
             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"]
-
-                    relative_script_file = "."
-                    cwd: str = None
-                    if "options" in task:
-                        options = task["options"]
-                        if "cwd" in options:
-                            cwd = options["cwd"]
-                            cwd = cwd.replace("${workspaceFolder}", ".")
-                            cwd = cwd.replace("\\", "\\\\").replace('"', '\\"')  # escape backslashes and double quotes for YAML
-                            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}}}}"
-
-                    description_literal = description.replace("\\", "\\\\").replace('"', '\\"')  # escape backslashes and double quotes for YAML
-                    command_with_args = command_with_args.replace("\\", "\\\\").replace('"', '\\"')  # escape backslashes and double quotes for YAML
-
-                    lines.append(f"  {name}:")
-                    lines.append(f'    desc: "{description_literal}"')
-                    lines.append('    silent: true')
-                    if cwd is not None:
-                        lines.append(f'    dir: "{cwd}"')
-                    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)
-
+            lines: list[str] = [
+                "version: '3'", GeneralUtilities.empty_string,
+                "tasks:", GeneralUtilities.empty_string,
+            ]
+            tasks = self.__sc.parse_tasks_from_codeworkspace_file(workspace_file)
+            tasks.sort(key=lambda task: task.label, reverse=False) 
+            for t in tasks:
+                task:VSCodeWorkspaceShellTask = t
+                lines.append(f"  {GeneralUtilities.escape_yaml_property_value(task.label)}:")
+                if task.description is not None:
+                    lines.append(f'    desc: "{GeneralUtilities.escape_yaml_string_value(task.description)}"')
+                lines.append('    silent: true')
+                if task.work_dir is not None:
+                    lines.append(f'    dir: "{GeneralUtilities.escape_yaml_string_value(task.work_dir)}"')
+                lines.append("    cmds:")
+                command=GeneralUtilities.escape_yaml_string_value(task.command)
+                if task.allow_custom_arguments:
+                    command=command+" {{.CLI_ARGS}}"
+                lines.append(f'      - "{command}"')
+                if task.aliases!=None and len(task.aliases) > 0:
+                    lines.append("    aliases:")
+                    for alias in task.aliases:
+                        lines.append(f'      - {GeneralUtilities.escape_yaml_property_value(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}")

{scriptcollection-4.2.46.dist-info → scriptcollection-4.2.47.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 4.2.46
+Version: 4.2.47
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke

{scriptcollection-4.2.46.dist-info → scriptcollection-4.2.47.dist-info}/RECORD

@@ -1,7 +1,7 @@
 ScriptCollection/AnionBuildPlatform.py,sha256=Sw35p6gKZ4qjvaDWtrnWW3iCHdUpHSUjtq5tc2iL_AI,11522
 ScriptCollection/CertificateUpdater.py,sha256=aCBF-bym5renP5joL32ev7WZW8HHh6hNm_mz6_hQKLc,9617
 ScriptCollection/Executables.py,sha256=18zrelUGO8wlpy6mM1DE-KMX6_m5mS7dzhgdjx-vCIs,44308
-ScriptCollection/GeneralUtilities.py,sha256=ouIbf7ivnMztSIFRd-x8ziOFncfoGby-ibdL0be_Q3o,59758
+ScriptCollection/GeneralUtilities.py,sha256=jarMc5sD3ifttHaICzlVsDweL0gWzOJm4W4VtW4CEWc,61313
 ScriptCollection/HTTPMaintenanceOverheadHelper.py,sha256=TToNtyO1XzsMbBsTBf3o0xgOK0v4Jf03qw2Z0xb2nCk,2007
 ScriptCollection/ImageUpdater.py,sha256=fxyz3oZkKlqyieYiyj0Yi1dQjOJEuHhu0WvL_JHsB90,38905
 ScriptCollection/ProcessesRunner.py,sha256=o5raxIt3lknNPoPrjNzJ2bprRPJ3SnL0rrR7crraD7E,1523
@@ -10,7 +10,7 @@ ScriptCollection/ProgramRunnerMock.py,sha256=uTu-aFle1W_oKjeQEmuPsFPQpvo0kRf2FrR
 ScriptCollection/ProgramRunnerPopen.py,sha256=BPY7-ZMIlqT7JOKz8qlB5c0laF2Js-ijzqk09GxZC48,3821
 ScriptCollection/ProgramRunnerSudo.py,sha256=_khC3xuTdrPoLluBJZWfldltmmuKltABJPcbjZSFW-4,4835
 ScriptCollection/SCLog.py,sha256=8TRy1LeYMsPOIuWUcnUNNbO5pd-cNBS-3cn-kdzP8FU,4768
-ScriptCollection/ScriptCollectionCore.py,sha256=KU-wkr5KjUvJ9j4lO4rj0x3uDExoEhST8JmwD776bNE,157835
+ScriptCollection/ScriptCollectionCore.py,sha256=6ebRc8enTzphWybayRwWBor_ak9APz3fqEpnqgwWsmQ,164482
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ScriptCollection/OCIImages/AbstractImageHandler.py,sha256=Pa72cRybzBroy-OzzxZqKpFB58iY2kcf5yFfIAIPfXk,1627
 ScriptCollection/OCIImages/OCIImageManager.py,sha256=xTYnj68CRDkTjJiibSov1HSI0djmmcY6mwP6_fD0kCM,7141
@@ -31,7 +31,7 @@ ScriptCollection/TFCPS/TFCPS_Generic.py,sha256=O-0guM_LJCcZmPZJhMgTvXD2RXUJEBWWv
 ScriptCollection/TFCPS/TFCPS_MergeToMain.py,sha256=-Ev9D3bZDlUk2WFQhcmvzQ3FCS97OdsVUd0koAdmpZc,7474
 ScriptCollection/TFCPS/TFCPS_MergeToStable.py,sha256=Ajfy2pLajTuU6UpwItHt4C2a-gLF3gPc4z6BktL3Cio,22163
 ScriptCollection/TFCPS/TFCPS_PreBuildCodeunitsScript.py,sha256=f0Uq1cA_4LvmL72cal0crrbKF6PcxL13D9wBKuQ1YBw,2328
-ScriptCollection/TFCPS/TFCPS_Tools_General.py,sha256=5yyWne5o4TygR4Sby1F-g7uL-QDAGWNxljnfQMe1dzU,94066
+ScriptCollection/TFCPS/TFCPS_Tools_General.py,sha256=D8yTq-CoC8rL8FM-P9qFtfQbir8hHwnsTSniBlP1BBA,92525
 ScriptCollection/TFCPS/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ScriptCollection/TFCPS/Docker/TFCPS_CodeUnitSpecific_Docker.py,sha256=krF-SYvXyG1cAepj-5witV76suBvEumTApn7nY6Zin0,10564
 ScriptCollection/TFCPS/Docker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -48,8 +48,8 @@ ScriptCollection/TFCPS/NodeJS/TFCPS_CodeUnitSpecific_NodeJS.py,sha256=wKB5t-K7p3
 ScriptCollection/TFCPS/NodeJS/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ScriptCollection/TFCPS/Python/TFCPS_CodeUnitSpecific_Python.py,sha256=nLw_eSUd_56jjgfcAvtUyzecSZ14mYmNJl0iu-1YNVk,13496
 ScriptCollection/TFCPS/Python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-4.2.46.dist-info/METADATA,sha256=ZDl1gkJuJBya-IgvvDWL3L5gXqAdC3jdz6Zt3p3qW4A,7690
-scriptcollection-4.2.46.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-scriptcollection-4.2.46.dist-info/entry_points.txt,sha256=FUA-dAZQISQRwFDJvo-tVVTVE0vrH0f0VR9XckeRvv0,4621
-scriptcollection-4.2.46.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-4.2.46.dist-info/RECORD,,
+scriptcollection-4.2.47.dist-info/METADATA,sha256=ueN3DpRK5RaqhTzr-PpIhlB6BQN0vD_WKCOhESx2JB0,7690
+scriptcollection-4.2.47.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+scriptcollection-4.2.47.dist-info/entry_points.txt,sha256=FUA-dAZQISQRwFDJvo-tVVTVE0vrH0f0VR9XckeRvv0,4621
+scriptcollection-4.2.47.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-4.2.47.dist-info/RECORD,,