articlib 0.2.3__tar.gz → 0.2.5__tar.gz

{articlib-0.2.3 → articlib-0.2.5}/LICENSE

@@ -1,21 +1,21 @@
-# MIT License
-
-Copyright (c) 2023 Iñaki Arrondo
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+# MIT License
+
+Copyright (c) 2023 Iñaki Arrondo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{articlib-0.2.3 → articlib-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: articlib
-Version: 0.2.3
+Version: 0.2.5
 Summary: Small set of tools and utilities in python. Destined to be use in my personal projects.
 License: MIT
 Author: Artic42

{articlib-0.2.3 → articlib-0.2.5}/README.md

@@ -1,51 +1,51 @@
-# pythonLib
-
-This is my personal general case python modules and apps to be used in other projects
-
-## testEngine
-
-Test engine is a simple module with the propose of running automated test, this allows to create test for the rest of the library easily. Test are separated in scenario, once a test in a scenario fail the rest of the scenario is skipped. It also outputs using colored test with errors in red and pass test in green. It has the following methods:
-* testIfEqual
-* testIfFalse
-* testIfEqual
-* testIfNotEqual
-* ...
-
-## dateTime
-
-Library to manage dates for other proposes.
-
-Public methods for setting dates
-* __setToNow__
-* __setTo__ (year, month, day, hour, minute, second)
-* __setToString__ (string)
-* __setMode__ (mode)
-    * _mode1_: YYYYMMDD
-    * _mode2_: DDMMYYYY
-    * _mode3_: MMDDYYYY
-
-Public methods to get values from the object
-* __getDate__
-* __getTime__
-* __getDateTime__
-* __getYear__
-* __getMonth__
-* __getDay__
-* __getHour__
-* __getMinute__
-* __getSecond__
-* __getMode__
-* __getDateTimePathFomat__ (It prints the date and time in a format usable in paths, for files)
-
-## Log
-
-A simple log system, it creates a log iwth 7 mask levels and a maximun size of file. If you log more lines than max it creates a new log file. Available masks
-
-* INFO_MASK
-* WARN_MASK
-* ERROR_MASK
-* COMMS_SEND_MASK
-* COMMS_RECV_MASK
-* HERMES_MASK000
-* COMMS_MASK
-* DEBUG_MASK
+# pythonLib
+
+This is my personal general case python modules and apps to be used in other projects
+
+## testEngine
+
+Test engine is a simple module with the propose of running automated test, this allows to create test for the rest of the library easily. Test are separated in scenario, once a test in a scenario fail the rest of the scenario is skipped. It also outputs using colored test with errors in red and pass test in green. It has the following methods:
+* testIfEqual
+* testIfFalse
+* testIfEqual
+* testIfNotEqual
+* ...
+
+## dateTime
+
+Library to manage dates for other proposes.
+
+Public methods for setting dates
+* __setToNow__
+* __setTo__ (year, month, day, hour, minute, second)
+* __setToString__ (string)
+* __setMode__ (mode)
+    * _mode1_: YYYYMMDD
+    * _mode2_: DDMMYYYY
+    * _mode3_: MMDDYYYY
+
+Public methods to get values from the object
+* __getDate__
+* __getTime__
+* __getDateTime__
+* __getYear__
+* __getMonth__
+* __getDay__
+* __getHour__
+* __getMinute__
+* __getSecond__
+* __getMode__
+* __getDateTimePathFomat__ (It prints the date and time in a format usable in paths, for files)
+
+## Log
+
+A simple log system, it creates a log iwth 7 mask levels and a maximun size of file. If you log more lines than max it creates a new log file. Available masks
+
+* INFO_MASK
+* WARN_MASK
+* ERROR_MASK
+* COMMS_SEND_MASK
+* COMMS_RECV_MASK
+* HERMES_MASK000
+* COMMS_MASK
+* DEBUG_MASK

articlib-0.2.5/articlib/articFileUtils.py

@@ -0,0 +1,84 @@
+import os
+import shutil
+
+
+def deleteFile(path: str):
+    os.remove(path)
+
+
+def createFile(path: str):
+    file = open(path, "r")
+    file.close()
+
+
+def copyFile(source: str, destination: str):
+    shutil.copy(source, destination)
+
+
+def fileExists(path: str):
+    return os.path.isfile(path)
+
+
+def getFilesInDirectory(path: str):
+    return os.listdir(path)
+
+
+def deleteDirectory(path: str):
+    os.rmdir(path)
+
+
+def createDirectory(path: str):
+    os.makedirs(path, exist_ok=True)
+
+
+class FileIO:
+    def __init__(self, path: str, readIt: bool = False) -> None:
+        self.path = path
+        if readIt:
+            self.readFile()
+        else:
+            self.lines = []
+
+    def readFile(self) -> None:
+        filePointer = open(self.path, "r")
+        self.lines = filePointer.readlines()
+        self.lines = [line[:-1] for line in self.lines]
+        filePointer.close()
+
+    def writeFile(self) -> None:
+        filePointer = open(self.path, "w")
+        for line in self.lines:
+            filePointer.write(line + "\n")
+        filePointer.close()
+
+    def appendToFile(self) -> None:
+        filePointer = open(self.path, "a")
+        for line in self.lines:
+            filePointer.write(line + "\n")
+        filePointer.close()
+
+    def addLine(self, line: str) -> None:
+        self.lines.append(line)
+
+    def modifyLine(self, lineNumber: int, line: str) -> None:
+        self.lines[lineNumber] = line
+
+    def removeLine(self, lineNumber: int) -> None:
+        del self.lines[lineNumber]
+
+    def removeLastLine(self) -> None:
+        del self.lines[-1]
+
+    def findLine(self, text: str) -> int:
+        result = []
+        for i in range(len(self.lines)):
+            if text in self.lines[i]:
+                result.append(i)
+        return result
+
+    def findAndReplace(self, find: str, replace: str) -> None:
+        for i in range(len(self.lines)):
+            self.lines[i] = self.lines[i].replace(find, replace)
+
+    def lineCount(self) -> int:
+        return len(self.lines)

{articlib-0.2.3 → articlib-0.2.5}/articlib/articLogger.py

@@ -1,102 +1,106 @@
-import articlib.dateTime as dateTime
-import os
-
-if __name__ == "__main__":
-    pass
-
-INFO_MASK = 0b00000001
-WARN_MASK = 0b00000010
-ERROR_MASK = 0b00000100
-COMMS_SEND_MASK = 0b00001000
-COMMS_RECV_MASK = 0b00010000
-HERMES_MASK = 0b00100000
-COMMS_MASK= 0b00011000
-DEBUG_MASK = 0b01000000
-DEFAULT_MASK = INFO_MASK | COMMS_MASK | ERROR_MASK | HERMES_MASK
-
-class Logger:
-    def __init__(self):
-        self.init = False
-        self.logName = ""
-        self.maxLines = 0
-        self.lines = 0
-        self.logPath = ""
-        self.mask = 0b0
-    
-    def initialize(self, logName, maxLines = 1000, logPath = "logs", mask = DEFAULT_MASK):
-        self.init = True
-        self.logName = logName
-        self.maxLines = maxLines
-        self.lines = 0
-        self.logPath = logPath
-        self.mask = mask
-        self.date = dateTime.createDate(dateTime.YYYYMMDD)
-        self.createLogFile()
-    
-    def createLogFile(self):
-        self.date.setToNow()
-        dateSring = self.date.getDateTimePathFomat()
-        os.makedirs(self.logPath, exist_ok=True)
-        self.logFilePath = self.logPath + "/" + self.logName + "_" + dateSring + ".log"
-        if os.path.isfile(self.logFilePath):
-            self.logFile = open(self.logFilePath, "a")
-        else:
-            self.logFile = open(self.logFilePath, "w")
-            self.logFile.write(f"Log file created at {self.date.getDateTime()} with name {self.logName}\n")
-            self.lines = 0
-    
-    def addEntry(self, message, mask = INFO_MASK):
-        maskName = self.getMaskName(mask)
-        if mask & self.mask:
-            if self.init:
-                self.writeLog(message, maskName)
-    
-    def getMaskName(self, mask):
-        switcher = {
-            INFO_MASK: "INFO",
-            WARN_MASK: "WARN",
-            ERROR_MASK: "ERROR",
-            COMMS_SEND_MASK: "COMMS_SEND",
-            COMMS_RECV_MASK: "COMMS_RECV",
-            HERMES_MASK: "HERMES",
-            DEBUG_MASK: "DEBUG",
-            DEFAULT_MASK: "DEFAULT"
-        }
-        return switcher.get(mask, "UNKNOWN")
-    
-    def writeLog(self, message, maskName):
-        self.date.setToNow()
-        dateSring = self.date.getDateTime()
-        self.lines += 1
-        self.logFile.write(f"{dateSring} - {maskName} - {message}\n")
-        if self.lines >= self.maxLines:
-            self.logFile.close()
-            self.createLogFile()
-    
-    def setMask(self, mask):
-        self.mask = mask
-    
-    def getMask(self):
-        return self.mask
-    
-    def setValueInMask(self, mask):
-        self.mask = self.mask | mask
-    
-    def unsetValueInMask(self, mask):
-        self.mask = self.mask & ~mask
-    
-    def flush(self):
-        self.logFile.flush()
-        
-    def restartFile(self):
-        self.logFile.close()
-        self.lines = 0
-        self.createLogFile()
-        
-    def getLogFilePath(self):
-        return self.logFilePath        
-    
-    def close(self):
-        self.logFile.close()
-        
-log = Logger()
+import articlib.dateTime as dateTime
+import os
+
+if __name__ == "__main__":
+    pass
+
+INFO_MASK = 0b00000001
+WARN_MASK = 0b00000010
+ERROR_MASK = 0b00000100
+COMMS_SEND_MASK = 0b00001000
+COMMS_RECV_MASK = 0b00010000
+HERMES_MASK = 0b00100000
+COMMS_MASK = 0b00011000
+DEBUG_MASK = 0b01000000
+DEFAULT_MASK = INFO_MASK | COMMS_MASK | ERROR_MASK | HERMES_MASK
+
+
+class Logger:
+    def __init__(self):
+        self.init = False
+        self.logName = ""
+        self.maxLines = 0
+        self.lines = 0
+        self.logPath = ""
+        self.mask = 0b0
+
+    def initialize(self, logName, maxLines=1000, logPath="logs", mask=DEFAULT_MASK):
+        self.init = True
+        self.logName = logName
+        self.maxLines = maxLines
+        self.lines = 0
+        self.logPath = logPath
+        self.mask = mask
+        self.date = dateTime.createDate(dateTime.YYYYMMDD)
+        self.createLogFile()
+
+    def createLogFile(self):
+        self.date.setToNow()
+        dateSring = self.date.getDateTimePathFomat()
+        os.makedirs(self.logPath, exist_ok=True)
+        self.logFilePath = self.logPath + "/" + self.logName + "_" + dateSring + ".log"
+        if os.path.isfile(self.logFilePath):
+            self.logFile = open(self.logFilePath, "a")
+        else:
+            self.logFile = open(self.logFilePath, "w")
+            self.logFile.write(
+                f"Log file created at {self.date.getDateTime()} with name {self.logName}\n"
+            )
+            self.lines = 0
+
+    def addEntry(self, message, mask=INFO_MASK):
+        maskName = self.getMaskName(mask)
+        if mask & self.mask:
+            if self.init:
+                self.writeLog(message, maskName)
+
+    def getMaskName(self, mask):
+        switcher = {
+            INFO_MASK: "INFO",
+            WARN_MASK: "WARN",
+            ERROR_MASK: "ERROR",
+            COMMS_SEND_MASK: "COMMS_SEND",
+            COMMS_RECV_MASK: "COMMS_RECV",
+            HERMES_MASK: "HERMES",
+            DEBUG_MASK: "DEBUG",
+            DEFAULT_MASK: "DEFAULT",
+        }
+        return switcher.get(mask, "UNKNOWN")
+
+    def writeLog(self, message, maskName):
+        self.date.setToNow()
+        dateSring = self.date.getDateTime()
+        self.lines += 1
+        self.logFile.write(f"{dateSring} - {maskName} - {message}\n")
+        if self.lines >= self.maxLines:
+            self.logFile.close()
+            self.createLogFile()
+
+    def setMask(self, mask):
+        self.mask = mask
+
+    def getMask(self):
+        return self.mask
+
+    def setValueInMask(self, mask):
+        self.mask = self.mask | mask
+
+    def unsetValueInMask(self, mask):
+        self.mask = self.mask & ~mask
+
+    def flush(self):
+        self.logFile.flush()
+
+    def restartFile(self):
+        self.logFile.close()
+        self.lines = 0
+        self.createLogFile()
+
+    def getLogFilePath(self):
+        return self.logFilePath
+
+    def close(self):
+        self.logFile.close()
+
+
+log = Logger()

{articlib-0.2.3 → articlib-0.2.5}/articlib/consoleUtils.py

@@ -1,36 +1,46 @@
-import colorama
-from colorama import Fore, Back, Style
-
-def printRed(text):
-    print(Fore.RED + text + Style.RESET_ALL)
-
-def printGreen(text):
-    print(Fore.GREEN + text + Style.RESET_ALL)
-
-def printYellow(text):
-    print(Fore.YELLOW + text + Style.RESET_ALL)
-
-def printBlue(text):
-    print(Fore.BLUE + text + Style.RESET_ALL)
-
-def printMagenta(text):
-    print(Fore.MAGENTA + text + Style.RESET_ALL)
-    
-def printBold(text):
-    print(Style.BRIGHT + text + Style.RESET_ALL)
-    
-def printRedBold(text):
-    print(Style.BRIGHT + Fore.RED + text + Style.RESET_ALL)
-    
-def printGreenBold(text):
-    print(Style.BRIGHT + Fore.GREEN + text + Style.RESET_ALL)
-
-def printYellowBold(text):
-    print(Style.BRIGHT + Fore.YELLOW + text + Style.RESET_ALL)
-    
-def printBlueBold(text):
-    print(Style.BRIGHT + Fore.BLUE + text + Style.RESET_ALL)
-    
-def printMagentaBold(text):
-    print(Style.BRIGHT + Fore.MAGENTA + text + Style.RESET_ALL)
-    
+import colorama
+from colorama import Fore, Back, Style
+
+
+def printRed(text):
+    print(Fore.RED + text + Style.RESET_ALL)
+
+
+def printGreen(text):
+    print(Fore.GREEN + text + Style.RESET_ALL)
+
+
+def printYellow(text):
+    print(Fore.YELLOW + text + Style.RESET_ALL)
+
+
+def printBlue(text):
+    print(Fore.BLUE + text + Style.RESET_ALL)
+
+
+def printMagenta(text):
+    print(Fore.MAGENTA + text + Style.RESET_ALL)
+
+
+def printBold(text):
+    print(Style.BRIGHT + text + Style.RESET_ALL)
+
+
+def printRedBold(text):
+    print(Style.BRIGHT + Fore.RED + text + Style.RESET_ALL)
+
+
+def printGreenBold(text):
+    print(Style.BRIGHT + Fore.GREEN + text + Style.RESET_ALL)
+
+
+def printYellowBold(text):
+    print(Style.BRIGHT + Fore.YELLOW + text + Style.RESET_ALL)
+
+
+def printBlueBold(text):
+    print(Style.BRIGHT + Fore.BLUE + text + Style.RESET_ALL)
+
+
+def printMagentaBold(text):
+    print(Style.BRIGHT + Fore.MAGENTA + text + Style.RESET_ALL)