TSVZ 2.57__tar.gz → 2.62__tar.gz

tsvz-2.62/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.1
+Name: TSVZ
+Version: 2.62
+Summary: An simple in memory wrapper around a TSV file to function as a database
+Home-page: https://github.com/yufei-pan/TSVZ
+Author: Yufei Pan
+Author-email: pan@zopyr.us
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+This lib provides some helper funtions to interact with tsv ( tab seperated values ) files.
+
+TSVZ can also funtion like an in memory DB that is able to perform non-blocking read / write to TSV files.
+
+Import as a lib or use console tool:
+
+```bash
+tsvz -h
+```
+
+```bash
+TSVZ -h
+```
+
+```bash
+usage: TSVZ [-h] [-c HEADER] [-f] [-v] [-V] filename [{read,append,delete,clear}] [line ...]
+
+TSVZed: A TSV file manager
+
+positional arguments:
+  filename              The TSV file to read
+  {read,append,delete,clear}
+                        The operation to perform. Default: read
+  line                  The line to append to the TSV file. it follows as : \{key\} \{value1\} \{value2\} ... if a key without value be
+                        inserted, the value will get deleted.
+
+options:
+  -h, --help            show this help message and exit
+  -c HEADER, --header HEADER
+                        Perform checks with this header of the TSV file. seperate using \t
+  -f, --force           Force the operation. Ignore checks for column numbers / headers
+  -v, --verbose         Print verbose output
+  -V, --version         show program's version number and exit
+```

tsvz-2.62/README.md

@@ -0,0 +1,34 @@
+This lib provides some helper funtions to interact with tsv ( tab seperated values ) files.
+
+TSVZ can also funtion like an in memory DB that is able to perform non-blocking read / write to TSV files.
+
+Import as a lib or use console tool:
+
+```bash
+tsvz -h
+```
+
+```bash
+TSVZ -h
+```
+
+```bash
+usage: TSVZ [-h] [-c HEADER] [-f] [-v] [-V] filename [{read,append,delete,clear}] [line ...]
+
+TSVZed: A TSV file manager
+
+positional arguments:
+  filename              The TSV file to read
+  {read,append,delete,clear}
+                        The operation to perform. Default: read
+  line                  The line to append to the TSV file. it follows as : \{key\} \{value1\} \{value2\} ... if a key without value be
+                        inserted, the value will get deleted.
+
+options:
+  -h, --help            show this help message and exit
+  -c HEADER, --header HEADER
+                        Perform checks with this header of the TSV file. seperate using \t
+  -f, --force           Force the operation. Ignore checks for column numbers / headers
+  -v, --verbose         Print verbose output
+  -V, --version         show program's version number and exit
+```

tsvz-2.62/TSVZ.egg-info/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.1
+Name: TSVZ
+Version: 2.62
+Summary: An simple in memory wrapper around a TSV file to function as a database
+Home-page: https://github.com/yufei-pan/TSVZ
+Author: Yufei Pan
+Author-email: pan@zopyr.us
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+This lib provides some helper funtions to interact with tsv ( tab seperated values ) files.
+
+TSVZ can also funtion like an in memory DB that is able to perform non-blocking read / write to TSV files.
+
+Import as a lib or use console tool:
+
+```bash
+tsvz -h
+```
+
+```bash
+TSVZ -h
+```
+
+```bash
+usage: TSVZ [-h] [-c HEADER] [-f] [-v] [-V] filename [{read,append,delete,clear}] [line ...]
+
+TSVZed: A TSV file manager
+
+positional arguments:
+  filename              The TSV file to read
+  {read,append,delete,clear}
+                        The operation to perform. Default: read
+  line                  The line to append to the TSV file. it follows as : \{key\} \{value1\} \{value2\} ... if a key without value be
+                        inserted, the value will get deleted.
+
+options:
+  -h, --help            show this help message and exit
+  -c HEADER, --header HEADER
+                        Perform checks with this header of the TSV file. seperate using \t
+  -f, --force           Force the operation. Ignore checks for column numbers / headers
+  -v, --verbose         Print verbose output
+  -V, --version         show program's version number and exit
+```

{tsvz-2.57 → tsvz-2.62}/TSVZ.egg-info/SOURCES.txt

@@ -5,4 +5,5 @@ setup.py
 TSVZ.egg-info/PKG-INFO
 TSVZ.egg-info/SOURCES.txt
 TSVZ.egg-info/dependency_links.txt
+TSVZ.egg-info/entry_points.txt
 TSVZ.egg-info/top_level.txt

tsvz-2.62/TSVZ.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+TSVZ = TSVZ:__main__
+tsvz = TSVZ:__main__

{tsvz-2.57 → tsvz-2.62}/TSVZ.py

@@ -10,7 +10,32 @@ if os.name == 'nt':
 elif os.name == 'posix':
     import fcntl
 
-version = '2.57'
+version = '2.62'
+
+
+def pretty_format_table(data):
+	if not data:
+		return
+	if type(data) == str:
+		data = data.strip('\n').split('\n')
+	elif type(data) != list:
+		data = list(data)
+	num_cols = len(data[0])
+	col_widths = [0] * num_cols
+	# Calculate the maximum width of each column
+	for c in range(num_cols):
+		col_items = [str(row[c]) for row in data]
+		col_widths[c] = max(len(item) for item in col_items)
+	# Build the row format string
+	row_format = ' | '.join('{{:<{}}}'.format(width) for width in col_widths)
+	# Print the header
+	header = data[0]
+	outTable = []
+	outTable.append(row_format.format(*header))
+	outTable.append('-+-'.join('-' * width for width in col_widths))
+	for row in data[1:]:
+		outTable.append(row_format.format(*row))
+	return '\n'.join(outTable) + '\n'
 
 def processLine(line,taskDic,correctColumnNum,verbose = False,teeLogger = None,strict = True):
     """
@@ -138,6 +163,53 @@ def read_last_valid_line(fileName, taskDic, correctColumnNum, verbose=False, tee
     # Return empty list if no valid line found
     return last_valid_line
 
+def formatHeader(header,verbose = False,teeLogger = None):
+    """
+    Format the header string.
+
+    Parameters:
+    - header (str or list): The header string or list to format.
+    - verbose (bool, optional): Whether to print verbose output. Defaults to False.
+    - teeLogger (object, optional): The tee logger object for printing output. Defaults to None.
+
+    Returns:
+        str: The formatted header string.
+    """
+    if type(header) != str:
+        try:
+            header = '\t'.join(header)
+        except:
+            if verbose:
+                __teePrintOrNot('Invalid header, setting header to empty.','error',teeLogger=teeLogger)
+            header = ''
+    header = header.strip()
+    if header:
+        if not header.endswith('\n'):
+            header += '\n'
+    else:
+        header = ''
+    return header
+
+def __teePrintOrNot(message,level = 'info',teeLogger = None):
+    """
+    Prints the given message or logs it using the provided teeLogger.
+
+    Parameters:
+        message (str): The message to be printed or logged.
+        level (str, optional): The log level. Defaults to 'info'.
+        teeLogger (object, optional): The logger object used for logging. Defaults to None.
+
+    Returns:
+        None
+    """
+    try:
+        if teeLogger:
+            teeLogger.teelog(message,level)
+        else:
+            print(message)
+    except Exception as e:
+        print(message)
+
 def readTSV(fileName,teeLogger = None,header = '',createIfNotExist = False, lastLineOnly = False,verifyHeader = True,verbose = False,taskDic = None,encoding = 'utf8',strict = True):
     """
     Read a TSV (Tab-Separated Values) file and return the data as a dictionary.
@@ -150,7 +222,7 @@ def readTSV(fileName,teeLogger = None,header = '',createIfNotExist = False, last
     - lastLineOnly (bool, optional): Whether to read only the last valid line of the file. Defaults to False.
     - verifyHeader (bool, optional): Whether to verify the header of the file. Defaults to True.
     - verbose (bool, optional): Whether to print verbose output. Defaults to False.
-    - taskDic (OrderedDict, optional): The dictionary to store the data. Defaults to None.
+    - taskDic (OrderedDict, optional): The dictionary to store the data. Defaults to an empty OrderedDict.
     - encoding (str, optional): The encoding of the file. Defaults to 'utf8'.
     - strict (bool, optional): Whether to raise an exception if there is a data format error. Defaults to True.
 
@@ -162,11 +234,8 @@ def readTSV(fileName,teeLogger = None,header = '',createIfNotExist = False, last
 
     """
     if taskDic is None:
-        taskDic = OrderedDict()
-
-    header = header.strip() if type(header) == str else '\t'.join(header)
-    if not header.endswith('\n'):
-        header += '\n'
+        taskDic = {}
+    header = formatHeader(header,verbose = verbose,teeLogger = teeLogger)
     if not os.path.isfile(fileName):
         if createIfNotExist:
             with open(fileName, mode ='w',encoding=encoding)as file:
@@ -186,7 +255,8 @@ def readTSV(fileName,teeLogger = None,header = '',createIfNotExist = False, last
                 #assert line.lower().replace(' ','').startswith(header.strip().lower().replace(' ','')), "Data format error!"
                 if not line.lower().replace(' ','').startswith(header.strip().lower().replace(' ','')):
                     __teePrintOrNot(f"Header mismatch: \n{line} \n!= \n{header.strip()}",teeLogger=teeLogger)
-                    raise Exception("Data format error! Header mismatch")
+                    if strict:
+                        raise Exception("Data format error! Header mismatch")
             correctColumnNum = len(header.strip().split('\t'))
             if verbose:
                 __teePrintOrNot(f"correctColumnNum: {correctColumnNum}",teeLogger=teeLogger)
@@ -201,27 +271,7 @@ def readTSV(fileName,teeLogger = None,header = '',createIfNotExist = False, last
             correctColumnNum, lineCache = processLine(line,taskDic,correctColumnNum,verbose = verbose,teeLogger = teeLogger,strict = strict)
     return taskDic
 
-def __teePrintOrNot(message,level = 'info',teeLogger = None):
-    """
-    Prints the given message or logs it using the provided teeLogger.
-
-    Parameters:
-        message (str): The message to be printed or logged.
-        level (str, optional): The log level. Defaults to 'info'.
-        teeLogger (object, optional): The logger object used for logging. Defaults to None.
-
-    Returns:
-        None
-    """
-    try:
-        if teeLogger:
-            teeLogger.teelog(message,level)
-        else:
-            print(message)
-    except Exception as e:
-        print(message)
-
-def appendTSV(fileName,lineToAppend,teeLogger = None,header = '',createIfNotExist = False,verifyHeader = True,verbose = False,encoding = 'utf8'):
+def appendTSV(fileName,lineToAppend,teeLogger = None,header = '',createIfNotExist = False,verifyHeader = True,verbose = False,encoding = 'utf8', strict = True):
     """
     Append a line of data to a TSV file.
     Parameters:
@@ -233,12 +283,12 @@ def appendTSV(fileName,lineToAppend,teeLogger = None,header = '',createIfNotExis
     - verifyHeader (bool, optional): If True, the function will verify if the existing header matches the provided header. If False, the header will not be verified.
     - verbose (bool, optional): If True, additional information will be printed during the execution.
     - encoding (str, optional): The encoding of the file.
+    - strict (bool, optional): If True, the function will raise an exception if there is a data format error. If False, the function will ignore the error and continue.
     Raises:
     - Exception: If the file does not exist and createIfNotExist is False.
     - Exception: If the existing header does not match the provided header.
     """
-    if not header.endswith('\n'):
-        header += '\n'
+    header = formatHeader(header,verbose = verbose,teeLogger = teeLogger)
     if not os.path.isfile(fileName):
         if createIfNotExist:
             with open(fileName, mode ='w',encoding=encoding)as file:
@@ -262,7 +312,8 @@ def appendTSV(fileName,lineToAppend,teeLogger = None,header = '',createIfNotExis
                 #assert line.lower().replace(' ','').startswith(header.strip().lower().replace(' ','')), "Data format error!"
                 if not line.lower().replace(' ','').startswith(header.strip().lower().replace(' ','')):
                     __teePrintOrNot(f"Header mismatch: \n{line} \n!= \n{header.strip()}",teeLogger=teeLogger)
-                    raise Exception("Data format error! Header mismatch")
+                    if strict:
+                        raise Exception("Data format error! Header mismatch")
             correctColumnNum = len(header.strip().split('\t'))
             if verbose:
                 __teePrintOrNot(f"correctColumnNum: {correctColumnNum}",teeLogger=teeLogger)
@@ -281,6 +332,39 @@ def appendTSV(fileName,lineToAppend,teeLogger = None,header = '',createIfNotExis
         if verbose:
             __teePrintOrNot(f"Appended {lineToAppend} to {fileName}",teeLogger=teeLogger)
 
+def clearTSV(fileName,teeLogger = None,header = '',verifyHeader = False,verbose = False,encoding = 'utf8'):
+    """
+    Clear the contents of a TSV file. Will create if not exist.
+    Parameters:
+    - fileName (str): The path of the TSV file.
+    - teeLogger (optional): A logger object for logging messages.
+    - header (str, optional): The header line to verify against. If provided, the function will check if the existing header matches the provided header.
+    - verifyHeader (bool, optional): If True, the function will verify if the existing header matches the provided header. If False, the header will not be verified.
+    - verbose (bool, optional): If True, additional information will be printed during the execution.
+    - encoding (str, optional): The encoding of the file.
+    """
+    header = formatHeader(header,verbose = verbose,teeLogger = teeLogger)
+    if not os.path.isfile(fileName):
+        with open(fileName, mode ='w',encoding=encoding)as file:
+            file.write(header)
+    else:
+        with open(fileName, mode ='r+',encoding=encoding)as file:
+            if header.strip() and verifyHeader:
+                line = file.readline().strip()
+                if verbose:
+                    __teePrintOrNot(f"Header: {header.strip()}",teeLogger=teeLogger)
+                    __teePrintOrNot(f"First line: {line}",teeLogger=teeLogger)
+                #assert line.lower().replace(' ','').startswith(header.strip().lower().replace(' ','')), "Data format error!"
+                if not line.lower().replace(' ','').startswith(header.strip().lower().replace(' ','')):
+                    __teePrintOrNot(f"Header mismatch: \n{line} \n!= \n{header.strip()}",teeLogger=teeLogger)
+                    raise Exception("Data format error! Header mismatch")
+                # if the header is correct, only keep the header
+                file.truncate()
+            else:
+                file.write(header)
+    if verbose:
+        __teePrintOrNot(f"Cleared {fileName}",teeLogger=teeLogger)
+
 # create a tsv class that functions like a ordered dictionary but will update the file when modified
 class TSVZed(OrderedDict):
     def __teePrintOrNot(self,message,level = 'info'):
@@ -297,7 +381,7 @@ class TSVZed(OrderedDict):
         self.version = version
         self._fileName = fileName
         self.teeLogger = teeLogger
-        self.header = header.strip() if type(header) == str else '\t'.join(header)
+        self.header = formatHeader(header,verbose = verbose,teeLogger = self.teeLogger)
         self.correctColumnNum = -1
         self.createIfNotExist = createIfNotExist
         self.verifyHeader = verifyHeader
@@ -667,3 +751,42 @@ memoryOnly:{self.memoryOnly}
             raise e  # Re-raise the exception for external handling
         finally:
             self.writeLock.release()  # Ensure the thread lock is always released
+
+
+def __main__():
+    import argparse
+    parser = argparse.ArgumentParser(description='TSVZed: A TSV file manager')
+    parser.add_argument('filename', type=str, help='The TSV file to read')
+    parser.add_argument('operation', type=str,nargs='?', choices=['read','append','delete','clear'], help='The operation to perform. Default: read', default='read')
+    parser.add_argument('line', type=str, nargs='*', help='The line to append to the TSV file. it follows as : \{key\} \{value1\} \{value2\} ... if a key without value be inserted, the value will get deleted.')
+    parser.add_argument('-c', '--header', type=str, help='Perform checks with this header of the TSV file. seperate using \\t')
+    parser.add_argument('-f', '--force', action='store_true', help='Force the operation. Ignore checks for column numbers / headers')
+    parser.add_argument('-v', '--verbose', action='store_true', help='Print verbose output')
+    parser.add_argument('-V', '--version', action='version', version=f'%(prog)s {version} by {author}')
+    args = parser.parse_args()
+
+    header = args.header.replace('\\t','\t') if args.header else ''
+
+    if args.operation == 'read':
+        # check if the file exist
+        if not os.path.isfile(args.filename):
+            print(f"File not found: {args.filename}")
+            return
+        # read the file
+        data = readTSV(args.filename, verifyHeader = False, verbose=args.verbose,strict= not args.force)
+        print(pretty_format_table(data.values()))
+    elif args.operation == 'append':
+        appendTSV(args.filename, args.line,createIfNotExist = True, header=header, verbose=args.verbose, strict= not args.force)
+    elif args.operation == 'delete':
+        appendTSV(args.filename, args.line[:1],createIfNotExist = True, header=header, verbose=args.verbose, strict= not args.force)
+    elif args.operation == 'clear':
+        clearTSV(args.filename, header=header, verbose=args.verbose, verifyHeader=not args.force)
+    else:
+        print("Invalid operation")
+        return
+    
+if __name__ == '__main__':
+    __main__()
+
+
+    

{tsvz-2.57 → tsvz-2.62}/setup.py

@@ -2,12 +2,18 @@ from setuptools import setup
 
 setup(
     name='TSVZ',
-    version='2.57',  
+    version='2.62',  
     py_modules=['TSVZ'],  # List of module names (without .py)
     description='An simple in memory wrapper around a TSV file to function as a database',
     author='Yufei Pan',
     author_email='pan@zopyr.us',
     url='https://github.com/yufei-pan/TSVZ',  # URL to the project’s homepage
+    entry_points={
+        'console_scripts': [
+            'TSVZ = TSVZ:__main__',
+			'tsvz = TSVZ:__main__',
+        ],
+    },
     classifiers=[
         'Programming Language :: Python :: 3',
         'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',

tsvz-2.57/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: TSVZ
-Version: 2.57
-Summary: An simple in memory wrapper around a TSV file to function as a database
-Home-page: https://github.com/yufei-pan/TSVZ
-Author: Yufei Pan
-Author-email: pan@zopyr.us
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-This lib provides some helper funtions to interact with tsv ( tab seperated values ) files.
-
-TSVZ can also funtion like an in memory DB that is able to perform non-blocking read / write to TSV files.

tsvz-2.57/README.md

@@ -1,3 +0,0 @@
-This lib provides some helper funtions to interact with tsv ( tab seperated values ) files.
-
-TSVZ can also funtion like an in memory DB that is able to perform non-blocking read / write to TSV files.

tsvz-2.57/TSVZ.egg-info/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: TSVZ
-Version: 2.57
-Summary: An simple in memory wrapper around a TSV file to function as a database
-Home-page: https://github.com/yufei-pan/TSVZ
-Author: Yufei Pan
-Author-email: pan@zopyr.us
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-This lib provides some helper funtions to interact with tsv ( tab seperated values ) files.
-
-TSVZ can also funtion like an in memory DB that is able to perform non-blocking read / write to TSV files.