ScriptCollection 3.5.66__py3-none-any.whl → 3.5.68__py3-none-any.whl

ScriptCollection/Executables.py

@@ -3,6 +3,7 @@ import argparse
 import time
 import traceback
 import sys
+import shutil
 import keyboard
 from .TasksForCommonProjectStructure import TasksForCommonProjectStructure
 from .ScriptCollectionCore import ScriptCollectionCore
@@ -528,13 +529,30 @@ def Rename() -> int:
     return 0
 
 
+def Copy() -> int:
+    parser = argparse.ArgumentParser(description="This function copies a file or folder.")
+    parser.add_argument('-s', '--source', required=True)
+    parser.add_argument('-t', '--target', required=True)
+    args = parser.parse_args()
+    if os.path.isfile(args.target) or os.path.isdir(args.target):
+        raise ValueError(f"Can not copy to '{args.target}' because the target already exists.")
+    if os.path.isfile(args.source):
+        shutil.copyfile(args.source, args.target)
+    elif os.path.isdir(args.source):
+        GeneralUtilities.ensure_directory_exists(args.target)
+        GeneralUtilities.copy_content_of_folder(args.source,args.target)
+    else:
+        raise ValueError(f"'{args.source}' can not be copied because the path does not exist.")
+    return 0
+
+
 def PrintOSName() -> int:
     GeneralUtilities.write_exception_to_stderr("This function is not implemented yet.")
     if GeneralUtilities.current_system_is_windows():
         GeneralUtilities.write_message_to_stdout("Windows")
     elif GeneralUtilities.current_system_is_linux():
         GeneralUtilities.write_message_to_stdout("Linux")
-    # TODO also consider Mac, Unix, etc.
+    # TODO consider Mac, Unix, etc. too
     else:
         GeneralUtilities.write_message_to_stderr("Unknown OS.")
         return 1
@@ -548,12 +566,30 @@ def PrintCurrecntWorkingDirectory() -> int:
 
 def ListFolderContent() -> int:
     GeneralUtilities.write_exception_to_stderr("This function is not implemented yet.")
-    # TODO implement function
-    # TODO add option to include/exclude full path
+    parser = argparse.ArgumentParser(description="This function lists folder-content.")
+    parser.add_argument('-p', '--path', required=True)
+    parser.add_argument('-f', '--excludefiles', action='store_true', required=False,default=False)
+    parser.add_argument('-d', '--excludedirectories', action='store_true', required=False,default=False)
+    parser.add_argument('-n', '--printonlynamewithoutpath', action='store_true', required=False,default=False)
     # TODO add option to also list transitively list subfolder
-    # TODO add option to print only folder
-    # TODO add option to print only files
-    return 1
+    # TODO add option to show only content which matches a filter by extension or regex or glob-pattern
+    args=parser.parse_args()
+    folder=args.path
+    if not os.path.isabs(folder):
+        folder=GeneralUtilities.resolve_relative_path(folder,os.getcwd())
+    content=[]
+    if not args.excludefiles:
+        content=content+GeneralUtilities.get_direct_files_of_folder(folder)
+    if not args.excludedirectories:
+        content=content+GeneralUtilities.get_direct_folders_of_folder(folder)
+    for contentitem in content:
+        content_to_print:str=None
+        if args.printonlynamewithoutpath:
+            content_to_print=os.path.basename(contentitem)
+        else:
+            content_to_print= contentitem
+        GeneralUtilities.write_message_to_stdout(content_to_print)
+    return 0
 
 
 def ForEach() -> int:

ScriptCollection/GeneralUtilities.py

@@ -930,13 +930,14 @@ class GeneralUtilities:
         enabled = True
         while enabled:
             try:
-                action()
-                return
+                result=action()
+                return result
             except Exception:
                 amount_of_fails = amount_of_fails+1
                 GeneralUtilities.assert_condition(not (amount_of_attempts < amount_of_fails))
                 if amount_of_fails == amount_of_attempts:
                     raise
+        return None
 
     @staticmethod
     @check_arguments

ScriptCollection/ScriptCollectionCore.py

@@ -16,6 +16,7 @@ from pathlib import Path
 from subprocess import Popen
 import re
 import shutil
+from typing import IO
 import uuid
 import tempfile
 import io
@@ -31,7 +32,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.66"
+version = "3.5.68"
 __version__ = version
 
 
@@ -617,6 +618,31 @@ class ScriptCollectionCore:
         for renamed_item, original_name in renamed_items.items():
             os.rename(renamed_item, original_name)
 
+    @GeneralUtilities.check_arguments
+    def list_content(self, path: str,include_files:bool,include_folder:bool) -> list[str]:
+        if self.program_runner.will_be_executed_locally():
+            result=[]
+            if include_files:
+                result=result + GeneralUtilities.get_direct_files_of_folder(path)
+            if include_folder:
+                result=result + GeneralUtilities.get_direct_folders_of_folder(path)
+            return result
+        else:
+            arguments=["--path", path]
+            if not include_files:
+                arguments=arguments+["--excludefiles"]
+            if not include_folder:
+                arguments=arguments+["--excludedirectories"]
+            exit_code, stdout, stderr, _ = self.run_program_argsasarray("sclistfoldercontent", arguments)
+            if exit_code == 0:
+                result:list[str]=[]
+                for line in stdout.split("\n"):
+                    normalized_line=line.replace("\r","")
+                    result.append(normalized_line)
+                return result
+            else:
+                raise ValueError(f"Fatal error occurrs while checking whether file '{path}' exists. StdErr: '{stderr}'")
+
     @GeneralUtilities.check_arguments
     def is_file(self, path: str) -> bool:
         if self.program_runner.will_be_executed_locally():
@@ -1277,7 +1303,7 @@ class ScriptCollectionCore:
         return popen
 
     @staticmethod
-    def __enqueue_output(file, queue):
+    def __enqueue_output(file:IO, queue:Queue):
         for line in iter(file.readline, ''):
             queue.put(line)
         file.close()
@@ -1432,6 +1458,11 @@ class ScriptCollectionCore:
         except Exception as e:
             raise e
 
+    # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
+    @GeneralUtilities.check_arguments
+    def run_program_with_retry(self, program: str, arguments:  str = "", working_directory: str = None, verbosity: int = 1, print_errors_as_information: bool = False, log_file: str = None, timeoutInSeconds: int = 600, addLogOverhead: bool = False, title: str = None, log_namespace: str = "", arguments_for_log:  list[str] = None, throw_exception_if_exitcode_is_not_zero: bool = True, custom_argument: object = None, interactive: bool = False, print_live_output: bool = False,amount_of_attempts:int=5) -> tuple[int, str, str, int]:
+        return GeneralUtilities.retry_action(lambda: self.run_program(program, arguments,working_directory,verbosity,print_errors_as_information,log_file,timeoutInSeconds,addLogOverhead,title,log_namespace,arguments_for_log,throw_exception_if_exitcode_is_not_zero,custom_argument,interactive,print_live_output), amount_of_attempts)
+
     # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
     @GeneralUtilities.check_arguments
     def run_program(self, program: str, arguments:  str = "", working_directory: str = None, verbosity: int = 1, print_errors_as_information: bool = False, log_file: str = None, timeoutInSeconds: int = 600, addLogOverhead: bool = False, title: str = None, log_namespace: str = "", arguments_for_log:  list[str] = None, throw_exception_if_exitcode_is_not_zero: bool = True, custom_argument: object = None, interactive: bool = False, print_live_output: bool = False) -> tuple[int, str, str, int]:
@@ -1730,7 +1761,7 @@ DNS                 = {domain}
         folder = os.path.dirname(csproj_file)
         csproj_filename = os.path.basename(csproj_file)
         GeneralUtilities.write_message_to_stderr(f"Check for updates in {csproj_filename}")
-        result = self.run_program("dotnet", f"list {csproj_filename} package --outdated", folder)
+        result = self.run_program_with_retry("dotnet", f"list {csproj_filename} package --outdated", folder)
         for line in result[1].replace("\r", "").split("\n"):
             # Relevant output-lines are something like "    > NJsonSchema             10.7.0        10.7.0      10.9.0"
             if ">" in line:

ScriptCollection/TasksForCommonProjectStructure.py

@@ -1015,6 +1015,7 @@ class TasksForCommonProjectStructure:
 
     @GeneralUtilities.check_arguments
     def __standardized_tasks_release_artifact(self, information: CreateReleaseInformationForProjectInCommonProjectFormat) -> None:
+        GeneralUtilities.write_message_to_stdout("Release artifacts...")
         project_version = self.__sc.get_semver_version_from_gitversion(information.repository)
         target_folder_base = os.path.join(information.artifacts_folder, information.projectname, project_version)
         GeneralUtilities.ensure_directory_exists(target_folder_base)
@@ -1243,6 +1244,7 @@ class TasksForCommonProjectStructure:
     def merge_to_main_branch(self, repository_folder: str, source_branch: str = "other/next-release", target_branch: str = "main", verbosity: int = 1, additional_arguments_file: str = None, fast_forward_source_branch: bool = False) -> None:
         # This is an automatization for automatic merges. Usual this merge would be done by a pull request in a sourcecode-version-control-platform
         # (like GitHub, GitLab or Azure DevOps)
+        GeneralUtilities.write_message_to_stdout(f"Merge to main-branch...")
         self.__sc.assert_is_git_repository(repository_folder)
         self.assert_no_uncommitted_changes(repository_folder)
 
@@ -1262,6 +1264,7 @@ class TasksForCommonProjectStructure:
     def merge_to_stable_branch(self, create_release_file: str, createRelease_configuration: CreateReleaseConfiguration):
 
         GeneralUtilities.write_message_to_stdout(f"Create release for project {createRelease_configuration.projectname}.")
+        GeneralUtilities.write_message_to_stdout(f"Merge to stable-branch...")
         self.__sc.assert_is_git_repository(createRelease_configuration.repository_folder)
         folder_of_create_release_file_file = os.path.abspath(os.path.dirname(create_release_file))
 
@@ -2439,6 +2442,8 @@ class TasksForCommonProjectStructure:
 
     @GeneralUtilities.check_arguments
     def build_specific_codeunits(self, repository_folder: str, codeunits: list[str], verbosity: int = 1, target_environmenttype: str = "QualityCheck", additional_arguments_file: str = None, is_pre_merge: bool = False, export_target_directory: str = None, assume_dependent_codeunits_are_already_built: bool = True, commandline_arguments: list[str] = [], do_git_clean_when_no_changes: bool = False, note: str = None) -> None:
+        if verbosity>2:
+            GeneralUtilities.write_message_to_stdout(f"Start building codeunits for repository '{repository_folder}'...")
         self.__sc.assert_is_git_repository(repository_folder)
         self.__check_target_environmenttype(target_environmenttype)
         repository_folder = GeneralUtilities.resolve_relative_path_from_current_working_directory(repository_folder)
@@ -2520,6 +2525,11 @@ class TasksForCommonProjectStructure:
                 archive_file = os.path.join(os.getcwd(), f"{filename_without_extension}.zip")
                 shutil.move(archive_file, target_folder)
 
+        message2 = f"Finished build codeunits in product {repository_name}."
+        if note is not None:
+            message2 = f"{message2} ({note})"
+        GeneralUtilities.write_message_to_stdout(message2)
+
     @GeneralUtilities.check_arguments
     def __do_repository_checks(self, repository_folder: str, project_version: str) -> None:
         self.__sc.assert_is_git_repository(repository_folder)
@@ -2875,6 +2885,7 @@ class TasksForCommonProjectStructure:
     @GeneralUtilities.check_arguments
     def generic_update_dependencies(self, repository_folder: str, verbosity: int = 1):
         # Prepare
+        GeneralUtilities.write_message_to_stdout("Update dependencies...")
         self.__sc.assert_is_git_repository(repository_folder)
         codeunits = self.get_codeunits(repository_folder)
         update_dependencies_script_filename = "UpdateDependencies.py"
@@ -2949,6 +2960,7 @@ class TasksForCommonProjectStructure:
             self.generic_update_dependencies(repository_folder)
             self.assert_no_uncommitted_changes(repository_folder)
 
+        GeneralUtilities.write_message_to_stdout(f"Check reference-repository...")
         now = datetime.now()
         for unsupported_version in self.get_unsupported_versions(repository_folder, now):
             reference_folder = f"{reference_folder}/ReferenceContent/v{unsupported_version}"
@@ -2962,6 +2974,8 @@ class TasksForCommonProjectStructure:
         else:
             self.merge_to_main_branch(repository_folder, merge_source_branch, verbosity=verbosity, fast_forward_source_branch=True)
             self.__sc.git_commit(build_repository_folder, "Updated submodule due to merge to main-branch.")
+        GeneralUtilities.write_message_to_stdout(f"Finished prepare release for {generic_prepare_new_release_arguments.product_name}.")
+
 
     class GenericCreateReleaseArguments():
         current_file: str
@@ -3006,6 +3020,7 @@ class TasksForCommonProjectStructure:
 
             # create release
             new_version = self.merge_to_stable_branch(generic_create_release_arguments.current_file, createReleaseConfiguration)
+            GeneralUtilities.write_message_to_stdout(f"Finished create release for {generic_create_release_arguments.product_name}.")
             return True, new_version
 
     class UpdateHTTPDocumentationArguments:

{ScriptCollection-3.5.66.dist-info → ScriptCollection-3.5.68.dist-info}/METADATA

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

ScriptCollection-3.5.68.dist-info/RECORD

@@ -0,0 +1,16 @@
+ScriptCollection/Executables.py,sha256=dyToDh4vd0k0Ox9TE4E_4-jY46XU6A6rguOL5R6Moj4,29977
+ScriptCollection/GeneralUtilities.py,sha256=WSBawT958x_0H-hnPg3S3DGzP3KOQTADtZtP145I-M4,39473
+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/RPStream.py,sha256=NRRHL3YSP3D9MuAV2jB_--0KUKCsvJGxeKnxgrRZ9kY,1545
+ScriptCollection/ScriptCollectionCore.py,sha256=Zbc-oWrgLEqz6dB2M0EJORG_9eU1byGaziHI2iFZUSo,114066
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=F6e045gUvSxpOcHk61OVnlod_Zn9JSNXrv6I2SzWoVc,214997
+ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
+ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ScriptCollection-3.5.68.dist-info/METADATA,sha256=z55DUNqZEXZqXwh3pBsCcb5Ha8fy_XXkZa9SwB2tsh0,7664
+ScriptCollection-3.5.68.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+ScriptCollection-3.5.68.dist-info/entry_points.txt,sha256=psYFu5te0W8zF5k444Qi21IZN4UwwGbw-XR22nvKTYE,3545
+ScriptCollection-3.5.68.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+ScriptCollection-3.5.68.dist-info/RECORD,,

{ScriptCollection-3.5.66.dist-info → ScriptCollection-3.5.68.dist-info}/entry_points.txt

@@ -6,6 +6,7 @@ scbuildcodeunitsc = ScriptCollection.Executables:BuildCodeUnitsC
 sccalculatebitcoinblockhash = ScriptCollection.Executables:CalculateBitcoinBlockHash
 scchangefileextension = ScriptCollection.Executables:ChangeFileExtensions
 scchangehashofprogram = ScriptCollection.Executables:ChangeHashOfProgram
+sccopy = ScriptCollection.Executables:Copy
 sccreatechangelogentry = ScriptCollection.Executables:CreateChangelogEntry
 sccreateemptyfilewithspecificsize = ScriptCollection.Executables:CreateEmptyFileWithSpecificSize
 sccreatefile = ScriptCollection.Executables:CreateFile

ScriptCollection-3.5.66.dist-info/RECORD

@@ -1,16 +0,0 @@
-ScriptCollection/Executables.py,sha256=kON_jatJe84iCJj60uUjA-Aj0ytERRe0FUDWbOWUe6s,28089
-ScriptCollection/GeneralUtilities.py,sha256=Ah-quoBRLNO3iTCfZaAlN0fhOC42b-UEGYRMW_XxgO0,39438
-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/RPStream.py,sha256=NRRHL3YSP3D9MuAV2jB_--0KUKCsvJGxeKnxgrRZ9kY,1545
-ScriptCollection/ScriptCollectionCore.py,sha256=1mOEvi_s9UGBfwWaaBZpbCxj-MaNefvHqrGpNvoX3JA,111855
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=A5L4MujKd7RRHZGdnQtPBYvy7KqjS30wmhPHYU9g2iw,213981
-ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
-ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection-3.5.66.dist-info/METADATA,sha256=XdmGidFR142BYPXQR4Che0TJchPlG9tct8Vs9iSyJtU,7664
-ScriptCollection-3.5.66.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ScriptCollection-3.5.66.dist-info/entry_points.txt,sha256=wspYVXWH8kon-wRQTAFEO11JoLJ0fEnOIG7tE7R-xtQ,3502
-ScriptCollection-3.5.66.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-ScriptCollection-3.5.66.dist-info/RECORD,,