ScriptCollection 3.5.60__py3-none-any.whl → 3.5.62__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/GeneralUtilities.py

@@ -937,3 +937,16 @@ class GeneralUtilities:
                 GeneralUtilities.assert_condition(not (amount_of_attempts < amount_of_fails))
                 if amount_of_fails == amount_of_attempts:
                     raise
+
+    @staticmethod
+    @check_arguments
+    def int_to_string(number: int, leading_zeroplaces: int, trailing_zeroplaces: int) -> str:
+        return GeneralUtilities.float_to_string(float(number), leading_zeroplaces, trailing_zeroplaces)
+
+    @staticmethod
+    @check_arguments
+    def float_to_string(number: float, leading_zeroplaces: int, trailing_zeroplaces: int) -> str:
+        plain_str = str(number)
+        GeneralUtilities.assert_condition("." in plain_str)
+        splitted: list[str] = plain_str.split(".")
+        return splitted[0].zfill(leading_zeroplaces)+"."+splitted[1].ljust(trailing_zeroplaces, '0')

ScriptCollection/ScriptCollectionCore.py

@@ -31,7 +31,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.60"
+version = "3.5.62"
 __version__ = version
 
 
@@ -1291,7 +1291,7 @@ class ScriptCollectionCore:
         return False
 
     @staticmethod
-    def __read_popen_pipes(p: Popen):
+    def __read_popen_pipes(p: Popen) -> tuple[list[str], list[str]]:
         p_id = p.pid
         with ThreadPoolExecutor(2) as pool:
             q_stdout = Queue()
@@ -1301,28 +1301,33 @@ class ScriptCollectionCore:
             pool.submit(ScriptCollectionCore.__enqueue_output, p.stderr, q_stderr)
             reading_stdout_last_time_resulted_in_exception: bool = False
             reading_stderr_last_time_resulted_in_exception: bool = False
+
+            stdout_result: list[str] = []
+            stderr_result: list[str] = []
+
             while (ScriptCollectionCore.__continue_process_reading(p_id, p, q_stdout, q_stderr, reading_stdout_last_time_resulted_in_exception, reading_stderr_last_time_resulted_in_exception)):
-                out_line = None
-                err_line = None
+
                 try:
-                    out_line = q_stdout.get_nowait()  # TODO read all avaliable lines
-                    reading_stdout_last_time_resulted_in_exception = False
+                    while not q_stdout.empty():
+                        stdout_result.append(q_stdout.get_nowait())
+                        reading_stdout_last_time_resulted_in_exception = False
                 except Empty:
                     reading_stdout_last_time_resulted_in_exception = True
 
                 try:
-                    err_line = q_stderr.get_nowait()  # TODO read all avaliable lines
-                    reading_stderr_last_time_resulted_in_exception = False
+                    while not q_stderr.empty():
+                        stderr_result.append(q_stderr.get_nowait())
+                        reading_stderr_last_time_resulted_in_exception = False
                 except Empty:
                     reading_stderr_last_time_resulted_in_exception = True
 
                 time.sleep(0.01)  # this is required to not finish too early
 
-                yield (out_line, err_line)
+            return (stdout_result, stderr_result)
 
-    # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
     @GeneralUtilities.check_arguments
     def run_program_argsasarray(self, program: str, arguments_as_array: list[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]:
+        # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
         # verbosity 1: No output will be logged.
         # verbosity 2: If the exitcode of the executed program is not 0 then the StdErr will be logged. This is supposed to be the default verbosity-level.
         # verbosity 3: Logs and prints StdOut and StdErr of the executed program in realtime.
@@ -1363,8 +1368,10 @@ class ScriptCollectionCore:
                 if log_file is not None:
                     GeneralUtilities.ensure_file_exists(log_file)
                 pid = process.pid
-                for out_line_plain, err_line_plain in ScriptCollectionCore.__read_popen_pipes(process):  # see https://stackoverflow.com/a/57084403/3905529
 
+                outputs: tuple[list[str], list[str]] = ScriptCollectionCore.__read_popen_pipes(process)
+
+                for out_line_plain in outputs[0]:
                     if out_line_plain is not None:
                         out_line: str = None
                         if isinstance(out_line_plain, str):
@@ -1385,6 +1392,7 @@ class ScriptCollectionCore:
                             if log_file is not None:
                                 GeneralUtilities.append_line_to_file(log_file, out_line)
 
+                for err_line_plain in outputs[1]:
                     if err_line_plain is not None:
                         err_line: str = None
                         if isinstance(err_line_plain, str):

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()

{ScriptCollection-3.5.60.dist-info → ScriptCollection-3.5.62.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ScriptCollection
-Version: 3.5.60
+Version: 3.5.62
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -28,14 +28,14 @@ Requires-Dist: cyclonedx-bom>=5.1.2
 Requires-Dist: defusedxml>=0.7.1
 Requires-Dist: keyboard>=0.13.5
 Requires-Dist: lcov-cobertura>=2.0.2
-Requires-Dist: lxml>=5.3.0
+Requires-Dist: lxml>=5.3.1
 Requires-Dist: ntplib>=0.4.0
 Requires-Dist: Pillow>=11.1.0
 Requires-Dist: pycdlib>=1.14.0
 Requires-Dist: Pygments>=2.19.1
 Requires-Dist: pylint>=3.3.4
 Requires-Dist: pyOpenSSL>=25.0.0
-Requires-Dist: PyPDF>=5.2.0
+Requires-Dist: PyPDF>=5.3.0
 Requires-Dist: pytest>=8.3.4
 Requires-Dist: PyYAML>=6.0.2
 Requires-Dist: qrcode>=8.0

ScriptCollection-3.5.62.dist-info/RECORD

@@ -0,0 +1,16 @@
+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=TN3Crb86-lU9YrHV9XFDUUNtX3KhT0Gq9WHyjt2XeKI,111409
+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.62.dist-info/METADATA,sha256=zPOBDBekOQ2rDLHvgehw8cB3gWbJUeSWIZbCdZehZJE,7664
+ScriptCollection-3.5.62.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+ScriptCollection-3.5.62.dist-info/entry_points.txt,sha256=wspYVXWH8kon-wRQTAFEO11JoLJ0fEnOIG7tE7R-xtQ,3502
+ScriptCollection-3.5.62.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+ScriptCollection-3.5.62.dist-info/RECORD,,

{ScriptCollection-3.5.60.dist-info → ScriptCollection-3.5.62.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

ScriptCollection-3.5.60.dist-info/RECORD

@@ -1,16 +0,0 @@
-ScriptCollection/Executables.py,sha256=j79qOgjHKgha2EW1uMfKf1Woa6rsChL0yqJgIA-YkYU,24586
-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=th3pd2sKt6kBJQ1-7WrjnYOVmbWPfDrYzRkVzmmu6C4,111227
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=IOrvyAgnA2PmXbotfxdXhwIwdciFiXvtPm2URcpDSVc,212887
-ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
-ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection-3.5.60.dist-info/METADATA,sha256=SwD2qxvbM1YxPLHJGuKrRLXgCDhJ3pcgJDcih0bPGTc,7664
-ScriptCollection-3.5.60.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ScriptCollection-3.5.60.dist-info/entry_points.txt,sha256=AQz2mMJ787Aw5Q_ItC6Q-Mo_DGYlM_OPEkovrgsrRF0,3192
-ScriptCollection-3.5.60.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-ScriptCollection-3.5.60.dist-info/RECORD,,