ScriptCollection 3.5.121__py3-none-any.whl → 3.5.122__py3-none-any.whl

ScriptCollection/GeneralUtilities.py

@@ -22,6 +22,7 @@ from os.path import isfile, join, isdir
 from pathlib import Path
 from shutil import copyfile
 import typing
+from typing import TextIO
 import psutil
 from defusedxml.minidom import parse
 from OpenSSL import crypto
@@ -211,6 +212,7 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def replace_xmltag_in_file(file: str, tag: str, new_value: str, encoding="utf-8") -> None:
+        GeneralUtilities.assert_condition(tag.isalnum(tag), f"Invalid tag: \"{tag}\"")
         GeneralUtilities.replace_regex_in_file(file, f"<{tag}>.*</{tag}>", f"<{tag}>{new_value}</{tag}>", encoding)
 
     @staticmethod
@@ -241,30 +243,43 @@ class GeneralUtilities:
         GeneralUtilities.write_text_to_file(file, text, encoding)
 
     @staticmethod
+    @check_arguments
     def print_text(text: str, print_to_stdout: bool = True):
         GeneralUtilities.__print_text_to_console(text, print_to_stdout)
 
     @staticmethod
-    def print_text_in_green(text: str, print_to_stdout: bool = True):
-        GeneralUtilities.__print_text_to_console(f"\033[32m{text}\033[0m", print_to_stdout)
+    @check_arguments
+    def print_text_in_green(text: str, print_to_stdout: bool = True, print_as_color: bool = True):
+        GeneralUtilities.print_text_in_color(text, 32, print_to_stdout, print_as_color)
 
     @staticmethod
-    def print_text_in_yellow(text: str, print_to_stdout: bool = True):
-        GeneralUtilities.__print_text_to_console(f"\033[33m{text}\033[0m", print_to_stdout)
+    @check_arguments
+    def print_text_in_yellow(text: str, print_to_stdout: bool = True, print_as_color: bool = True):
+        GeneralUtilities.print_text_in_color(text, 33, print_to_stdout, print_as_color)
 
     @staticmethod
-    def print_text_in_red(text: str, print_to_stdout: bool = True):
-        GeneralUtilities.__print_text_to_console(f"\033[31m{text}\033[0m", print_to_stdout)
+    @check_arguments
+    def print_text_in_red(text: str, print_to_stdout: bool = True, print_as_color: bool = True):
+        GeneralUtilities.print_text_in_color(text, 31, print_to_stdout, print_as_color)
 
     @staticmethod
-    def print_text_in_cyan(text: str, print_to_stdout: bool = True):
-        GeneralUtilities.__print_text_to_console(f"\033[36m{text}\033[0m", print_to_stdout)
+    @check_arguments
+    def print_text_in_cyan(text: str, print_to_stdout: bool = True, print_as_color: bool = True):
+        GeneralUtilities.print_text_in_color(text, 36, print_to_stdout, print_as_color)
 
     @staticmethod
-    def __print_text_to_console(text: str, print_to_stdout: bool = True):
-        output = sys.stdout if print_to_stdout else sys.stderr
-        output.write(text)
-        output.flush()
+    @check_arguments
+    def print_text_in_color(text: str, colorcode: int, print_to_stdout: bool = True, print_as_color: bool = True):
+        stream: TextIO = sys.stdout if print_to_stdout else sys.stderr
+        if print_as_color:
+            text = f"\033[{colorcode}m{text}\033[0m"
+        GeneralUtilities.__print_text_to_console(text, stream, print_to_stdout)
+
+    @staticmethod
+    @check_arguments
+    def __print_text_to_console(text: str, stream: TextIO, print_to_stdout: bool = True):
+        stream.write(text)
+        stream.flush()
 
     @staticmethod
     @check_arguments
@@ -276,7 +291,7 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def write_message_to_stdout_advanced(message: str, add_empty_lines: bool = True, adapt_lines: bool = True, append_linebreak: bool = True):
-        new_line_character: str = "\n" if append_linebreak else ""
+        new_line_character: str = "\n" if append_linebreak else GeneralUtilities.empty_string
         for line in GeneralUtilities.string_to_lines(message, add_empty_lines, adapt_lines):
             sys.stdout.write(GeneralUtilities.str_none_safe(line)+new_line_character)
             sys.stdout.flush()
@@ -289,7 +304,7 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def write_message_to_stderr_advanced(message: str, add_empty_lines: bool = True, adapt_lines: bool = True, append_linebreak: bool = True):
-        new_line_character: str = "\n" if append_linebreak else ""
+        new_line_character: str = "\n" if append_linebreak else GeneralUtilities.empty_string
         for line in GeneralUtilities.string_to_lines(message, add_empty_lines, adapt_lines):
             sys.stderr.write(GeneralUtilities.str_none_safe(line)+new_line_character)
             sys.stderr.flush()
@@ -532,6 +547,7 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def get_clusters_and_sectors_of_disk(diskpath: str) -> None:
+        GeneralUtilities.assert_condition(GeneralUtilities.current_system_is_windows(), "get_clusters_and_sectors_of_disk(diskpath) is only available on windows.")
         sectorsPerCluster = ctypes.c_ulonglong(0)
         bytesPerSector = ctypes.c_ulonglong(0)
         rootPathName = ctypes.c_wchar_p(diskpath)

ScriptCollection/SCLog.py

@@ -1,6 +1,6 @@
 
 from enum import Enum
-from datetime import datetime
+from datetime import datetime,  timezone
 from .GeneralUtilities import GeneralUtilities
 
 
@@ -19,11 +19,14 @@ class SCLog:
     loglevel: LogLevel
     log_file: str
     add_overhead: bool
+    print_as_color: bool
+    zone_of_time: timezone = None
 
-    def __init__(self, log_file: str = None, loglevel: LogLevel = None, add_overhead: bool = False):
+    def __init__(self, log_file: str = None, loglevel: LogLevel = None, add_overhead: bool = False, print_as_color: bool = True):
         self.log_file = log_file
         self.loglevel = loglevel
         self.add_overhead = add_overhead
+        self.print_as_color = print_as_color
 
     @GeneralUtilities.check_arguments
     def log_exception(self, message: str, ex: Exception, current_traceback):
@@ -42,8 +45,8 @@ class SCLog:
         if int(loglevel) > int(self.loglevel):
             return
 
-        part1: str = ""
-        part2: str = ""
+        part1: str = GeneralUtilities.empty_string
+        part2: str = GeneralUtilities.empty_string
         part3: str = message
 
         if loglevel == LogLevel.Warning:
@@ -51,7 +54,12 @@ class SCLog:
         if loglevel == LogLevel.Debug:
             part3 = f"Debug: {message}"
         if self.add_overhead:
-            part1 = f"[{GeneralUtilities.datetime_to_string_for_logfile_entry(datetime.now())}] ["
+            moment: datetime = None
+            if self.zone_of_time is None:
+                moment = datetime.now()
+            else:
+                moment = datetime.now(self.zone_of_time)
+            part1 = f"[{GeneralUtilities.datetime_to_string_for_logfile_entry(moment)}] ["
             if loglevel == LogLevel.Information:
                 part2 = f"Information"
             elif loglevel == LogLevel.Error:
@@ -66,15 +74,14 @@ class SCLog:
 
         print_to_std_out: bool = loglevel in (LogLevel.Debug, LogLevel.Information)
         GeneralUtilities.print_text(part1, print_to_std_out)
-        # if the control-characters for colors cause problems then maybe it can be checked with sys.stdout.isatty() if colors should be printed
         if loglevel == LogLevel.Information:
-            GeneralUtilities.print_text_in_green(part2, print_to_std_out)
+            GeneralUtilities.print_text_in_green(part2, print_to_std_out, self.print_as_color)
         elif loglevel == LogLevel.Error:
-            GeneralUtilities.print_text_in_red(part2, print_to_std_out)
+            GeneralUtilities.print_text_in_red(part2, print_to_std_out, self.print_as_color)
         elif loglevel == LogLevel.Warning:
-            GeneralUtilities.print_text_in_yellow(part2, print_to_std_out)
+            GeneralUtilities.print_text_in_yellow(part2, print_to_std_out, self.print_as_color)
         elif loglevel == LogLevel.Debug:
-            GeneralUtilities.print_text_in_cyan(part2, print_to_std_out)
+            GeneralUtilities.print_text_in_cyan(part2, print_to_std_out, self.print_as_color)
         else:
             raise ValueError("Unknown loglevel.")
         GeneralUtilities.print_text(part3+"\n", print_to_std_out)

ScriptCollection/ScriptCollectionCore.py

@@ -33,7 +33,7 @@ from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 from .SCLog import SCLog, LogLevel
 
-version = "3.5.121"
+version = "3.5.122"
 __version__ = version
 
 

{scriptcollection-3.5.121.dist-info → scriptcollection-3.5.122.dist-info}/METADATA

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

{scriptcollection-3.5.121.dist-info → scriptcollection-3.5.122.dist-info}/RECORD

@@ -1,17 +1,17 @@
 ScriptCollection/CertificateUpdater.py,sha256=OAxrG21k_o3W3niOOGNSZzUPJlvolOWc1lRB2dMhc3g,9212
 ScriptCollection/Executables.py,sha256=ht-RZFu4g34Sr09b_L0c2QpKcjLWX-wFtKSMDMZYqsw,32266
-ScriptCollection/GeneralUtilities.py,sha256=hqAKRF99uu2RCSBgjX4qjYn3IlImwm6rehRvt8hbNFQ,46407
+ScriptCollection/GeneralUtilities.py,sha256=j-8AgY-aK4MFgEg5vl2VcuahW-vCeHm3rcGbru117pM,47319
 ScriptCollection/ImageUpdater.py,sha256=lel1nevTN7fgdoCDE6Xg8YY6XPsZaOQiCIyWXbmVnh0,20882
 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/SCLog.py,sha256=GEvh0m4OXz_0703XgY-LyAy9RDYg8x1baNZSrWhhu2A,3127
-ScriptCollection/ScriptCollectionCore.py,sha256=eoVmIEoaU_B8sIgaJTN1e7ocurjsLyT2VzxvrsQLyV4,127859
+ScriptCollection/SCLog.py,sha256=6AIeza7KJ-9q13cNnbNTXgVlJqW6EAexowyni0hKTnQ,3450
+ScriptCollection/ScriptCollectionCore.py,sha256=LKmQ3Yh6SKW_Z_BVFICbisdEkxaPCiTLOEhDEFxk0p0,127859
 ScriptCollection/TasksForCommonProjectStructure.py,sha256=4aEuIf89jbgKE4uMYm4DlPDe9Iu1Zujo8wPOzDld09w,234867
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-3.5.121.dist-info/METADATA,sha256=guQOcS7sLrfO50qZx1bILbJ5sgUGP2b4IdJb-BG5ZcE,7694
-scriptcollection-3.5.121.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-scriptcollection-3.5.121.dist-info/entry_points.txt,sha256=3qMbfZEMhc_VTJj-bcLwB8AWcn9iXSB3l0AWpuu52Bs,3689
-scriptcollection-3.5.121.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.121.dist-info/RECORD,,
+scriptcollection-3.5.122.dist-info/METADATA,sha256=k388tO8xs4bpHohNp39DFKsTYg45SaFzOzLtYrkdd6Q,7694
+scriptcollection-3.5.122.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+scriptcollection-3.5.122.dist-info/entry_points.txt,sha256=3qMbfZEMhc_VTJj-bcLwB8AWcn9iXSB3l0AWpuu52Bs,3689
+scriptcollection-3.5.122.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-3.5.122.dist-info/RECORD,,