ScriptCollection 3.5.59__py3-none-any.whl → 3.5.61__py3-none-any.whl

ScriptCollection/Executables.py

@@ -416,9 +416,18 @@ def SetContentOfFile() -> int:
 
 
 def PrintFileContent() -> int:
-    GeneralUtilities.write_exception_to_stderr("This function is not implemented yet.")
-    # TODO implement function
-    return 1
+    parser = argparse.ArgumentParser(description="This function prints the size of a file")
+    parser.add_argument('-p', '--path', required=True)
+    parser.add_argument('-e', '--encoding', required=False, default="utf-8")
+    args = parser.parse_args()
+    file = args.path
+    encoding = args.encoding
+    if os.path.isfile(file):
+        GeneralUtilities.write_message_to_stdout(GeneralUtilities.read_text_from_file(file, encoding))
+        return 0
+    else:
+        GeneralUtilities.write_exception_to_stderr(f"File '{file}' does not exist.")
+        return 1
 
 
 def CreateFile() -> int:
@@ -458,9 +467,17 @@ def RegexReplaceInFile() -> int:
 
 
 def PrintFileSize() -> int:
-    GeneralUtilities.write_exception_to_stderr("This function is not implemented yet.")
-    # TODO implement function
-    return 1
+    parser = argparse.ArgumentParser(description="This function prints the size of a file")
+    parser.add_argument('-p', '--path', required=True)
+    args = parser.parse_args()
+    file = args.path
+    if os.path.isfile(file):
+        size = os.path.getsize(file)
+        GeneralUtilities.write_message_to_stdout(str(size))
+        return 0
+    else:
+        GeneralUtilities.write_exception_to_stderr(f"File '{file}' does not exist.")
+        return 1
 
 
 def FileContainsContent() -> int:
@@ -471,15 +488,35 @@ def FileContainsContent() -> int:
 
 
 def RemoveFile() -> int:
-    GeneralUtilities.write_exception_to_stderr("This function is not implemented yet.")
-    # TODO implement function
-    return 1
+    parser = argparse.ArgumentParser(description="This function removes a file.")
+    parser.add_argument('-p', '--path', required=True)
+    parser.add_argument('-e', '--errorwhennotexists', action='store_true', required=False, default=False)
+    args = parser.parse_args()
+    file = args.path
+    errorwhennotexists = args.errorwhennotexists
+    if os.path.isfile(file):
+        GeneralUtilities.ensure_file_does_not_exist(file)
+    else:
+        if errorwhennotexists:
+            GeneralUtilities.write_exception_to_stderr(f"File '{file}' does not exist.")
+            return 1
+    return 0
 
 
 def RemoveFolder() -> int:
-    GeneralUtilities.write_exception_to_stderr("This function is not implemented yet.")
-    # TODO implement function
-    return 1
+    parser = argparse.ArgumentParser(description="This function removes a folder.")
+    parser.add_argument('-p', '--path', required=True)
+    parser.add_argument('-e', '--errorwhennotexists', action='store_true', required=False, default=False)
+    args = parser.parse_args()
+    folder = args.path
+    errorwhennotexists = args.errorwhennotexists
+    if os.path.isdir(folder):
+        GeneralUtilities.ensure_directory_does_not_exist(folder)
+    else:
+        if errorwhennotexists:
+            GeneralUtilities.write_exception_to_stderr(f"Folder '{folder}' does not exist.")
+            return 1
+    return 0
 
 
 def Rename() -> int:
@@ -489,3 +526,52 @@ def Rename() -> int:
     args = parser.parse_args()
     os.rename(args.source, args.target)
     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.
+    else:
+        GeneralUtilities.write_message_to_stderr("Unknown OS.")
+        return 1
+    return 0
+
+
+def PrintCurrecntWorkingDirectory() -> int:
+    GeneralUtilities.write_message_to_stdout(os.getcwd())
+    return 0
+
+
+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
+    return 1
+
+
+def ForEach() -> int:
+    GeneralUtilities.write_exception_to_stderr("This function is not implemented yet.")
+    # TODO implement function
+    return 1
+
+
+def NpmI() -> int:
+    parser = argparse.ArgumentParser(description="Does \"npm clean install\".")
+    parser.add_argument('-d', '--directory', required=False, default=".")
+    parser.add_argument('-f', '--force', action='store_true', required=False, default=False)
+    parser.add_argument('-v', '--verbose', action='store_true', required=False, default=False)
+    args = parser.parse_args()
+    if os.path.isabs(args.directory):
+        folder = args.directory
+    else:
+        folder = GeneralUtilities.resolve_relative_path(args.directory, os.getcwd())
+    t = TasksForCommonProjectStructure()
+    t.do_npm_install(folder, args.force, 3 if args.verbose else 0)
+    return 0

ScriptCollection/ScriptCollectionCore.py

@@ -31,7 +31,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.59"
+version = "3.5.61"
 __version__ = version
 
 
@@ -1397,7 +1397,7 @@ class ScriptCollectionCore:
                             if err_line.endswith("\n"):
                                 err_line = err_line[:-1]
                             if print_live_output:
-                                print(err_line, end='\n', file=sys.stderr,  flush=True)
+                                print(err_line, end='\n', file=sys.stdout if print_errors_as_information else sys.stderr,  flush=True)
                             if 0 < len(stderr):
                                 stderr = stderr+"\n"
                             stderr = stderr+err_line

ScriptCollection/TasksForCommonProjectStructure.py

@@ -1811,11 +1811,16 @@ class TasksForCommonProjectStructure:
             argument1 = f"{argument1} --force"
         self.run_with_epew("npm", argument1, package_json_folder, verbosity=verbosity)
 
-        argument2 = "clean-install"
+        argument2 = "install --package-lock-only"
         if force:
             argument2 = f"{argument2} --force"
         self.run_with_epew("npm", argument2, package_json_folder, verbosity=verbosity)
 
+        argument3 = "clean-install"
+        if force:
+            argument3 = f"{argument3} --force"
+        self.run_with_epew("npm", argument3, package_json_folder, verbosity=verbosity)
+
     @GeneralUtilities.check_arguments
     def run_with_epew(self, program: str, argument: 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) -> tuple[int, str, str, int]:
         sc: ScriptCollectionCore = ScriptCollectionCore()
@@ -2224,16 +2229,15 @@ class TasksForCommonProjectStructure:
 
     @GeneralUtilities.check_arguments
     def update_dependencies_of_typical_node_codeunit(self, update_script_file: str, verbosity: int, cmd_args: list[str]) -> None:
-        current_folder = os.path.dirname(update_script_file)
         codeunit_folder = GeneralUtilities.resolve_relative_path("..", os.path.dirname(update_script_file))
         ignored_dependencies = self.get_dependencies_which_are_ignored_from_updates(codeunit_folder, True)
         # TODO consider ignored_dependencies
-        result = self.run_with_epew("npm", "outdated", current_folder, verbosity, throw_exception_if_exitcode_is_not_zero=False)
+        result = self.run_with_epew("npm", "outdated", codeunit_folder, verbosity, throw_exception_if_exitcode_is_not_zero=False)
         if result[0] == 0:
             return  # all dependencies up to date
         elif result[0] == 1:
             package_json_content = None
-            package_json_file = f"{current_folder}/package.json"
+            package_json_file = f"{codeunit_folder}/package.json"
             with open(package_json_file, "r", encoding="utf-8") as package_json_file_object:
                 package_json_content = json.load(package_json_file_object)
                 lines = GeneralUtilities.string_to_lines(result[1])[1:][:-1]
@@ -2247,7 +2251,7 @@ class TasksForCommonProjectStructure:
                         package_json_content["devDependencies"][package] = latest_version
             with open(package_json_file, "w", encoding="utf-8") as package_json_file_object:
                 json.dump(package_json_content, package_json_file_object, indent=4)
-            self.run_with_epew("npm", "install --force", current_folder, verbosity)
+            self.do_npm_install(codeunit_folder, True, verbosity)
         else:
             GeneralUtilities.write_message_to_stderr("Update dependencies resulted in an error.")
 

{ScriptCollection-3.5.59.dist-info → ScriptCollection-3.5.61.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ScriptCollection
-Version: 3.5.59
+Version: 3.5.61
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -23,7 +23,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: build>=1.2.2.post1
-Requires-Dist: coverage>=7.6.10
+Requires-Dist: coverage>=7.6.11
 Requires-Dist: cyclonedx-bom>=5.1.2
 Requires-Dist: defusedxml>=0.7.1
 Requires-Dist: keyboard>=0.13.5

{ScriptCollection-3.5.59.dist-info → ScriptCollection-3.5.61.dist-info}/RECORD

@@ -1,16 +1,16 @@
-ScriptCollection/Executables.py,sha256=j79qOgjHKgha2EW1uMfKf1Woa6rsChL0yqJgIA-YkYU,24586
+ScriptCollection/Executables.py,sha256=kON_jatJe84iCJj60uUjA-Aj0ytERRe0FUDWbOWUe6s,28089
 ScriptCollection/GeneralUtilities.py,sha256=nlSZSsQVHWxf0Yzz4PjgZm39rgvIltVof8gL2YPgR7s,38805
 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=ewQxK22WBQYWEYAIFW0A1EBjqP1C_ryuKELcbpvHVPs,111180
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=JzpwSU89kewGplLwwuM9Yv41XhHev207WYl9dTMhi-w,212964
+ScriptCollection/ScriptCollectionCore.py,sha256=gmFAw9p9gVi4Z4vCtAsCS7bQUDLVMHJ66AEtuoaLx1o,111227
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=B3-KSAZOR_UKSeLsdAxyZu2ylsRSjDvlj0272TXSEfA,213090
 ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection-3.5.59.dist-info/METADATA,sha256=CsmKCOTxJcqQkbuqmnH6oTk92Cu5rh-E3FuWConJI7o,7664
-ScriptCollection-3.5.59.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ScriptCollection-3.5.59.dist-info/entry_points.txt,sha256=AQz2mMJ787Aw5Q_ItC6Q-Mo_DGYlM_OPEkovrgsrRF0,3192
-ScriptCollection-3.5.59.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-ScriptCollection-3.5.59.dist-info/RECORD,,
+ScriptCollection-3.5.61.dist-info/METADATA,sha256=lrV7TcbmII8Mz2Bd7CFXv46tw-XIr8YozP5sfDCOgbk,7664
+ScriptCollection-3.5.61.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+ScriptCollection-3.5.61.dist-info/entry_points.txt,sha256=wspYVXWH8kon-wRQTAFEO11JoLJ0fEnOIG7tE7R-xtQ,3502
+ScriptCollection-3.5.61.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+ScriptCollection-3.5.61.dist-info/RECORD,,

{ScriptCollection-3.5.59.dist-info → ScriptCollection-3.5.61.dist-info}/entry_points.txt

@@ -18,6 +18,7 @@ scfilecontainscontent = ScriptCollection.Executables:FileContainsContent
 scfileexists = ScriptCollection.Executables:FileExists
 scfilenameobfuscator = ScriptCollection.Executables:FilenameObfuscator
 scfolderexists = ScriptCollection.Executables:FolderExists
+scforeach = ScriptCollection.Executables:ForEach
 scgeneratearc42referencetemplate = ScriptCollection.Executables:GenerateARC42ReferenceTemplate
 scgeneratecertificate = ScriptCollection.Executables:GenerateCertificate
 scgeneratecertificateauthority = ScriptCollection.Executables:GenerateCertificateAuthority
@@ -26,12 +27,16 @@ scgeneratesnkfiles = ScriptCollection.Executables:GenerateSnkFiles
 scgeneratethumbnail = ScriptCollection.Executables:GenerateThumbnail
 schealthcheck = ScriptCollection.Executables:Healthcheck
 sckeyboarddiagnosis = ScriptCollection.Executables:KeyboardDiagnosis
+sclistfoldercontent = ScriptCollection.Executables:ListFolderContent
 scmergepdfs = ScriptCollection.Executables:MergePDFs
+scnpmi = ScriptCollection.Executables:NpmI
 scobfuscatefilesfolder = ScriptCollection.Executables:ObfuscateFilesFolder
 scorganizelinesinfile = ScriptCollection.Executables:OrganizeLinesInFile
 scpdftoimage = ScriptCollection.Executables:PDFToImage
+scprintcurrentworkingdirectory = ScriptCollection.Executables:PrintCurrecntWorkingDirectory
 scprintfilecontent = ScriptCollection.Executables:PrintFileContent
 scprintfilesize = ScriptCollection.Executables:PrintFileSize
+scprintosname = ScriptCollection.Executables:PrintOSName
 scregexreplaceinfile = ScriptCollection.Executables:RegexReplaceInFile
 scremoveFolder = ScriptCollection.Executables:RemoveFolder
 scremovefile = ScriptCollection.Executables:RemoveFile