ScriptCollection 3.5.139__py3-none-any.whl → 3.5.142__py3-none-any.whl

ScriptCollection/ScriptCollectionCore.py

@@ -33,7 +33,7 @@ from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 from .SCLog import SCLog, LogLevel
 
-version = "3.5.139"
+version = "3.5.142"
 __version__ = version
 
 
@@ -309,7 +309,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def git_pull_with_retry(self, folder: str, remote: str, localbranchname: str, remotebranchname: str, force: bool = False, amount_of_attempts: int = 5) -> None:
-        GeneralUtilities.retry_action(lambda: self.git_pull_with_retry(folder, remote, localbranchname, remotebranchname), amount_of_attempts)
+        GeneralUtilities.retry_action(lambda: self.git_pull(folder, remote, localbranchname, remotebranchname), amount_of_attempts)
 
     @GeneralUtilities.check_arguments
     def git_pull(self, folder: str, remote: str, localbranchname: str, remotebranchname: str, force: bool = False) -> None:
@@ -2380,10 +2380,18 @@ OCR-content:
     @GeneralUtilities.check_arguments
     def get_ocr_content_of_file(self, file: str, serviceaddress: str, languages: list[str]) -> str:  # serviceaddress = None means local executable
         result: str = None
+        extension = Path(file).suffix
         if serviceaddress is None:
-            result = ""  # TODO call local executable
+            program_result = self.run_program_argsasarray("simpleocr", ["--File", file, "--Languages", "+".join(languages)] + languages)
+            result = program_result[1]
         else:
-            result = ""  # TODO call remote service
+            languages_for_url = '%2B'.join(languages)
+            package_url: str = f"https://{serviceaddress}/GetOCRContent?languages={languages_for_url}&fileType={extension}"
+            headers = {'Cache-Control': 'no-cache'}
+            r = requests.put(package_url, timeout=5, headers=headers, data=GeneralUtilities.read_binary_from_file(file))
+            if r.status_code != 200:
+                raise ValueError(f"Checking for latest tor package resulted in HTTP-response-code {r.status_code}.")
+            result = GeneralUtilities.bytes_to_string(r.content)
         return result
 
     @GeneralUtilities.check_arguments

ScriptCollection/TasksForCommonProjectStructure.py

@@ -1513,7 +1513,7 @@ class TasksForCommonProjectStructure:
         project_version = self.get_version_of_project(repository_folder)
         codeunit_folder = os.path.join(repository_folder, codeunit_name)
 
-        # Check codeunit-conformity
+        # check codeunit-conformity
         # TODO check if foldername=="<codeunitname>[.codeunit.xml]" == <codeunitname> in file
         supported_codeunitspecificationversion = "2.9.4"  # should always be the latest version of the ProjectTemplates-repository
         codeunit_file = os.path.join(codeunit_folder, f"{codeunit_name}.codeunit.xml")
@@ -1523,7 +1523,7 @@ class TasksForCommonProjectStructure:
         namespaces = {'cps': 'https://projects.aniondev.de/PublicProjects/Common/ProjectTemplates/-/tree/main/Conventions/RepositoryStructure/CommonProjectStructure',  'xsi': 'http://www.w3.org/2001/XMLSchema-instance'}
         root: etree._ElementTree = etree.parse(codeunit_file)
 
-        # Check codeunit-spcecification-version
+        # check codeunit-spcecification-version
         try:
             codeunit_file_version = root.xpath('//cps:codeunit/@codeunitspecificationversion', namespaces=namespaces)[0]
             if codeunit_file_version != supported_codeunitspecificationversion:
@@ -1538,27 +1538,27 @@ class TasksForCommonProjectStructure:
                 GeneralUtilities.write_message_to_stderr(f'Warning: Codeunitfile "{codeunit_file}" can not be validated due to the following exception:')
                 GeneralUtilities.write_exception_to_stderr(exception)
 
-        # Check codeunit-name
+        # check codeunit-name
         codeunit_name_in_codeunit_file = root.xpath('//cps:codeunit/cps:name/text()', namespaces=namespaces)[0]
         if codeunit_name != codeunit_name_in_codeunit_file:
             raise ValueError(f"The folder-name ('{codeunit_name}') is not equal to the codeunit-name ('{codeunit_name_in_codeunit_file}').")
 
-        # Check owner-name
+        # check owner-name
         codeunit_ownername_in_codeunit_file = self. get_codeunit_owner_name(codeunit_file)
         GeneralUtilities.assert_condition(GeneralUtilities.string_has_content(codeunit_ownername_in_codeunit_file), "No valid name for codeunitowner given.")
 
-        # Check owner-emailaddress
+        # check owner-emailaddress
         codeunit_owneremailaddress_in_codeunit_file = self.get_codeunit_owner_emailaddress(codeunit_file)
         GeneralUtilities.assert_condition(GeneralUtilities.string_has_content(codeunit_owneremailaddress_in_codeunit_file), "No valid email-address for codeunitowner given.")
 
-        # Check development-state
+        # check development-state
         developmentstate = root.xpath('//cps:properties/@developmentstate', namespaces=namespaces)[0]
         developmentstate_active = "Active development"
         developmentstate_maintenance = "Maintenance-updates only"
         developmentstate_inactive = "Inactive"
         GeneralUtilities.assert_condition(developmentstate in (developmentstate_active, developmentstate_maintenance, developmentstate_inactive), f"Invalid development-state. Must be '{developmentstate_active}' or '{developmentstate_maintenance}' or '{developmentstate_inactive}' but was '{developmentstate}'.")
 
-        # Check for mandatory files
+        # check for mandatory files
         files = ["Other/Build/Build.py", "Other/QualityCheck/Linting.py", "Other/Reference/GenerateReference.py"]
         if self.codeunit_has_testable_sourcecode(codeunit_file):
             # TODO check if the testsettings-section appears in the codeunit-file
@@ -1574,7 +1574,7 @@ class TasksForCommonProjectStructure:
         if os.path.isfile(os.path.join(codeunit_folder, "Other", "requirements.txt")):
             self.install_requirementstxt_for_codeunit(codeunit_folder, verbosity)
 
-        # Check developer
+        # check developer
         if self.validate_developers_of_repository:
             expected_authors: list[tuple[str, str]] = []
             expected_authors_in_xml = root.xpath('//cps:codeunit/cps:developerteam/cps:developer', namespaces=namespaces)
@@ -1597,19 +1597,30 @@ class TasksForCommonProjectStructure:
 
         # TODO implement cycle-check for dependent codeunits
 
-        # Clear previously builded artifacts if desired:
+        # clear previously builded artifacts if desired:
         if clear_artifacts_folder:
             artifacts_folder = os.path.join(codeunit_folder, "Other", "Artifacts")
             GeneralUtilities.ensure_directory_does_not_exist(artifacts_folder)
 
-        # Get artifacts from dependent codeunits
+        # get artifacts from dependent codeunits
         # if assume_dependent_codeunits_are_already_built:
         #    self.build_dependent_code_units(repository_folder, codeunit_name, verbosity, target_environmenttype, additional_arguments_file, commandline_arguments)
         self.copy_artifacts_from_dependent_code_units(repository_folder, codeunit_name)
 
-        # Update codeunit-version
+        # update codeunit-version
         self.update_version_of_codeunit(common_tasks_scripts_file, codeunit_version)
 
+        # set project version
+        package_json_file = os.path.join(repository_folder, "package.json")  # TDOO move this to a general project-specific (and codeunit-independent-script)
+        if os.path.isfile(package_json_file):
+            package_json_data: str = None
+            with open(package_json_file, "r", encoding="utf-8") as f1:
+                package_json_data = json.load(f1)
+                package_json_data["version"] = project_version
+            with open(package_json_file, "w", encoding="utf-8") as f2:
+                json.dump(package_json_data, f2, indent=2)
+            GeneralUtilities.write_text_to_file(package_json_file, GeneralUtilities.read_text_from_file(package_json_file).replace("\r", ""))
+
         # set default constants
         self.set_default_constants(os.path.join(codeunit_folder))
 
@@ -2360,6 +2371,7 @@ class TasksForCommonProjectStructure:
         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"]
@@ -2381,11 +2393,18 @@ class TasksForCommonProjectStructure:
                     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("\\", "\\\\")
+
+                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}"')
+                lines.append(f'    desc: "{description_literal}"')
                 lines.append('    silent: true')
                 lines.append(f'    dir: "{cwd_literal}"')
                 lines.append("    cmds:")
@@ -2397,6 +2416,7 @@ class TasksForCommonProjectStructure:
                     for alias in aliases:
                         lines.append(f'      - {alias}')
                 lines.append(GeneralUtilities.empty_string)
+
         GeneralUtilities.write_lines_to_file(task_file, lines)
 
     @GeneralUtilities.check_arguments
@@ -2648,7 +2668,7 @@ class TasksForCommonProjectStructure:
         GeneralUtilities.write_message_to_stdout(message2)
 
     @GeneralUtilities.check_arguments
-    def __do_repository_checks(self, repository_folder: str, project_version: str) -> None:
+    def __do_repository_checks(self, repository_folder: str, project_version: str) -> None:  # TDOO move this to a general project-specific (and codeunit-independent-script)
         self.__sc.assert_is_git_repository(repository_folder)
         self.__check_if_changelog_exists(repository_folder, project_version)
         self.__check_whether_security_txt_exists(repository_folder)

{scriptcollection-3.5.139.dist-info → scriptcollection-3.5.142.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 3.5.139
+Version: 3.5.142
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -33,11 +33,11 @@ Requires-Dist: ntplib>=0.4.0
 Requires-Dist: Pillow>=11.2.1
 Requires-Dist: psutil>=7.0.0
 Requires-Dist: pycdlib>=1.14.0
-Requires-Dist: Pygments>=2.19.1
+Requires-Dist: Pygments>=2.19.2
 Requires-Dist: pylint>=3.3.7
 Requires-Dist: pyOpenSSL>=25.1.0
-Requires-Dist: PyPDF>=5.6.0
-Requires-Dist: pytest>=8.4.0
+Requires-Dist: PyPDF>=5.6.1
+Requires-Dist: pytest>=8.4.1
 Requires-Dist: PyYAML>=6.0.2
 Requires-Dist: qrcode>=8.2
 Requires-Dist: send2trash>=1.8.3

{scriptcollection-3.5.139.dist-info → scriptcollection-3.5.142.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=Dd2P8vH2PA830wAv6bchlMHHdGE_7At-F4WQY5w4XdA,4016
-ScriptCollection/ScriptCollectionCore.py,sha256=rX1wjbWTYkTVGaVzvgDYlCxSVhxfyoIr7Yn4oTJ8qy4,135815
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=boOF-cOYdfUPRf5DOgL1yfeO7GYxAn6-W3fdUV84clE,235903
+ScriptCollection/ScriptCollectionCore.py,sha256=RN10QzaK5EYJ7vw2BHlWxc_1GqBM8sPLCdaSMQQiNCA,136482
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=zBrrzssSXrBptgRaj4R_aA5-t_jEncHcjmR2EoYTqzU,237126
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-3.5.139.dist-info/METADATA,sha256=9OcBLfJLHZo4Vtr9udrIBQSbqI50JA9oVS0DkjXUCdQ,7694
-scriptcollection-3.5.139.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scriptcollection-3.5.139.dist-info/entry_points.txt,sha256=AvmVO9iyWImExpvzL3YYQ9AOEiUIN9guPRRG_W_VNWY,4116
-scriptcollection-3.5.139.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.139.dist-info/RECORD,,
+scriptcollection-3.5.142.dist-info/METADATA,sha256=VXRsnflOOEDstkfXPdrZJtVFVRaSA33zxSboT_AiOEE,7694
+scriptcollection-3.5.142.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scriptcollection-3.5.142.dist-info/entry_points.txt,sha256=AvmVO9iyWImExpvzL3YYQ9AOEiUIN9guPRRG_W_VNWY,4116
+scriptcollection-3.5.142.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-3.5.142.dist-info/RECORD,,