ScriptCollection 3.5.67__py3-none-any.whl → 3.5.69__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,19 +566,29 @@ 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
-    # TODO add option to also list transitively list subfolder
-    # TODO add option to print only folder
-    # TODO add option to print only files
     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 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())
-    for file in GeneralUtilities.get_direct_files_of_folder(folder):
-        GeneralUtilities.write_message_to_stdout(file)
+    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
 
 

ScriptCollection/ScriptCollectionCore.py

@@ -32,7 +32,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.67"
+version = "3.5.69"
 __version__ = version
 
 
@@ -619,11 +619,34 @@ class ScriptCollectionCore:
             os.rename(renamed_item, original_name)
 
     @GeneralUtilities.check_arguments
-    def list_files(self, path: str) -> list[str]:
+    def is_git_repository(self, folder: str) -> bool:
+        """This function works platform-independent also for non-local-executions if the ScriptCollection commandline-commands are available as global command on the target-system."""
+        combined = f"{folder}/.git"
+        # TODO consider check for bare-repositories
+        return self.is_folder(combined) or self.is_file(combined)
+
+    @GeneralUtilities.check_arguments
+    def assert_is_git_repository(self, folder: str) -> 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."""
+        GeneralUtilities.assert_condition(self.is_git_repository(folder), f"'{folder}' is not a git-repository.")
+
+    @GeneralUtilities.check_arguments
+    def list_content(self, path: str,include_files:bool,include_folder:bool) -> list[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.get_direct_files_of_folder(path)
+            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:
-            exit_code, stdout, stderr, _ = self.run_program_argsasarray("scfileexists", ["--path", path])
+            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"):
@@ -635,6 +658,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def is_file(self, path: str) -> bool:
+        """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 os.path.isfile(path)  # works only locally, but much more performant than always running an external program
         else:
@@ -649,6 +673,7 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def is_folder(self, path: str) -> bool:
+        """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():  # works only locally, but much more performant than always running an external program
             return os.path.isdir(path)
         else:
@@ -662,14 +687,22 @@ class ScriptCollectionCore:
             raise ValueError(f"Fatal error occurrs while checking whether folder '{path}' exists. StdErr: '{stderr}'")
 
     @GeneralUtilities.check_arguments
-    def is_git_repository(self, folder: str) -> bool:
-        combined = f"{folder}/.git"
-        # TODO consider check for bare-repositories
-        return self.is_file(combined) or self.is_folder(combined)
-
-    @GeneralUtilities.check_arguments
-    def assert_is_git_repository(self, folder: str) -> str:
-        GeneralUtilities.assert_condition(self.is_git_repository(folder), f"'{folder}' is not a git-repository.")
+    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."""
+        if self.program_runner.will_be_executed_locally():  # works only locally, but much more performant than always running an external program
+            if os.path.isdir(path):
+                GeneralUtilities.ensure_directory_does_not_exist(path)
+            if os.path.isfile(path):
+                GeneralUtilities.ensure_file_does_not_exist(path)
+        else:
+            if self.is_file(path):
+                exit_code, _, stderr, _ = self.run_program_argsasarray("scremovefile", ["--path", path], throw_exception_if_exitcode_is_not_zero=False)  # works platform-indepent
+                if exit_code != 0:
+                    raise ValueError(f"Fatal error occurrs while removing file '{path}'. StdErr: '{stderr}'")
+            if self.is_folder(path):
+                exit_code, _, stderr, _ = self.run_program_argsasarray("scremovefolder", ["--path", path], throw_exception_if_exitcode_is_not_zero=False)  # works platform-indepent
+                if exit_code != 0:
+                    raise ValueError(f"Fatal error occurrs while removing folder '{path}'. StdErr: '{stderr}'")
 
     @GeneralUtilities.check_arguments
     def __sort_fmd(self, line: str):

ScriptCollection/TasksForCommonProjectStructure.py

@@ -1302,7 +1302,9 @@ class TasksForCommonProjectStructure:
         # hint: arguments can be overwritten by commandline_arguments
         folder_of_this_file = os.path.dirname(create_release_file)
         verbosity = TasksForCommonProjectStructure.get_verbosity_from_commandline_arguments(commandline_arguments, verbosity)
-        self.__sc.run_program("python", f"CreateRelease.py --overwrite_verbosity {str(verbosity)}", folder_of_this_file,  verbosity=verbosity, log_file=logfile, addLogOverhead=addLogOverhead)
+        result=self.__sc.run_program("python", f"CreateRelease.py --overwrite_verbosity {str(verbosity)}", folder_of_this_file,  verbosity=verbosity, log_file=logfile, addLogOverhead=addLogOverhead,print_live_output=True,throw_exception_if_exitcode_is_not_zero=False)
+        if result[0]!=0:
+            raise ValueError(f"CreateRelease.py resulted in exitcode {result[0]}.")
 
     @GeneralUtilities.check_arguments
     def __standardized_tasks_merge_to_stable_branch(self, information: MergeToStableBranchInformationForProjectInCommonProjectFormat) -> str:
@@ -2438,7 +2440,7 @@ class TasksForCommonProjectStructure:
         self.__sc.assert_is_git_repository(repository_folder)
         repository_folder = GeneralUtilities.resolve_relative_path_from_current_working_directory(repository_folder)
         codeunits = self.get_codeunits(repository_folder, False)
-        self.build_specific_codeunits(repository_folder, codeunits, verbosity, target_environmenttype, additional_arguments_file, is_pre_merge, export_target_directory, False, commandline_arguments, do_git_clean_when_no_changes)
+        self.build_specific_codeunits(repository_folder, codeunits, verbosity, target_environmenttype, additional_arguments_file, is_pre_merge, export_target_directory, False, commandline_arguments, do_git_clean_when_no_changes,note)
 
     @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:
@@ -2463,7 +2465,9 @@ class TasksForCommonProjectStructure:
         prepare_build_codeunits_scripts = os.path.join(project_resources_folder, PrepareBuildCodeunits_script_name)
         if os.path.isfile(prepare_build_codeunits_scripts):
             GeneralUtilities.write_message_to_stdout(f'Run "{PrepareBuildCodeunits_script_name}"')
-            self.__sc.run_program("python", f"{PrepareBuildCodeunits_script_name}", project_resources_folder, print_live_output=1 < verbosity)
+            result=self.__sc.run_program("python", f"{PrepareBuildCodeunits_script_name}", project_resources_folder,throw_exception_if_exitcode_is_not_zero=False, print_live_output=True)
+            if result[0]!=0:
+                raise ValueError(f"PrepareBuildCodeunits.py resulted in exitcode {result[0]}.")
 
         for subfolder in subfolders:
             codeunit_name: str = os.path.basename(subfolder)

{ScriptCollection-3.5.67.dist-info → ScriptCollection-3.5.69.dist-info}/METADATA

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

{ScriptCollection-3.5.67.dist-info → ScriptCollection-3.5.69.dist-info}/RECORD

@@ -1,16 +1,16 @@
-ScriptCollection/Executables.py,sha256=jGJIVEjRuOEpcC6ZvCny22DgHZPtr4pmKZj6b-Zn-fA,28514
+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=Gjr-4UES3iYDUuYoBTN8XIaLbuzTq4FyMD_6cuOseAY,113595
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=F6e045gUvSxpOcHk61OVnlod_Zn9JSNXrv6I2SzWoVc,214997
+ScriptCollection/ScriptCollectionCore.py,sha256=qrFos1Od9o4paGQwKAKbeFZd72CwMbctYwVr2PI5SqU,116344
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=MtbaO3Sgew-cSSapf5XJ_7-ui2w3QGYwpvacX-l2K_w,215356
 ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection-3.5.67.dist-info/METADATA,sha256=jSXXQC_Q1zoKYsvPm38722Tok5dvc3a7dtulFS9j9Uk,7664
-ScriptCollection-3.5.67.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ScriptCollection-3.5.67.dist-info/entry_points.txt,sha256=wspYVXWH8kon-wRQTAFEO11JoLJ0fEnOIG7tE7R-xtQ,3502
-ScriptCollection-3.5.67.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-ScriptCollection-3.5.67.dist-info/RECORD,,
+ScriptCollection-3.5.69.dist-info/METADATA,sha256=K88GUkBl1Hf3WB0WQ67vdgCEzR4Pn6z3wkkPd5uH0eA,7664
+ScriptCollection-3.5.69.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+ScriptCollection-3.5.69.dist-info/entry_points.txt,sha256=psYFu5te0W8zF5k444Qi21IZN4UwwGbw-XR22nvKTYE,3545
+ScriptCollection-3.5.69.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+ScriptCollection-3.5.69.dist-info/RECORD,,

{ScriptCollection-3.5.67.dist-info → ScriptCollection-3.5.69.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