ccfx 1.0.6__tar.gz → 1.0.8__tar.gz

{ccfx-1.0.6/ccfx.egg-info → ccfx-1.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ccfx
-Version: 1.0.6
+Version: 1.0.8
 Summary: This package simplifies regular common actions for quick prototyping in a user friendly way
 Author-email: Celray James CHAWANDA <celray@chawanda.com>
 License-Expression: MIT

{ccfx-1.0.6 → ccfx-1.0.8}/ccfx/ccfx.py

@@ -35,7 +35,7 @@ import math
 import requests
 from tqdm import tqdm
 import yt_dlp
-from typing import Optional
+from typing import Optional, Any
 from datetime import datetime, timedelta
 from PIL import Image
 
@@ -72,7 +72,7 @@ def getExtension(filePath:str) -> str:
     return os.path.splitext(filePath)[1].lstrip('.')
 
 
-def getMp3Metadata(fn, imagePath=None):
+def getMp3Metadata(fn: str, imagePath: Optional[str] = None) -> dict:
     '''
     This function takes a path to mp3 and returns a dictionary with
     the following keys:
@@ -127,7 +127,7 @@ def getMp3Metadata(fn, imagePath=None):
     return metadata
     
 
-def guessMimeType(imagePath):
+def guessMimeType(imagePath: str) -> str:
     ext = os.path.splitext(imagePath.lower())[1]
     if ext in ['.jpg', '.jpeg']:
         return 'image/jpeg'
@@ -240,7 +240,7 @@ def parseYoutubeChannelVideos(channelUrl: str, maxItems: Optional[int] = None) -
     return [f"https://www.youtube.com/watch?v={e['id']}" for e in entries if e.get("id")]
 
 
-def runSWATPlus(txtinoutDir: str, finalDir: str, executablePath: str = "swatplus", v: bool = True):
+def runSWATPlus(txtinoutDir: str, finalDir: str, executablePath: str = "swatplus", v: bool = True) -> None:
     os.chdir(txtinoutDir)
 
     if not v:
@@ -339,7 +339,7 @@ def formatTimedelta(delta: timedelta) -> str:
         return f"{time_fmt}"
 
 
-def setMp3Metadata(fn, metadata, imagePath=None):
+def setMp3Metadata(fn: str, metadata: dict, imagePath: Optional[str] = None) -> bool:
     '''
     This function takes a path to an mp3 and a metadata dictionary,
     then writes that metadata to the file's ID3 tags.
@@ -434,7 +434,7 @@ def deleteFile(filePath:str, v:bool = False) -> bool:
     
     return deleted
 
-def removeImageColour(inPath:str, outPath:str, colour:tuple = (255, 255, 255), tolerance:int = 30):
+def removeImageColour(inPath:str, outPath:str, colour:tuple = (255, 255, 255), tolerance:int = 30) -> None:
     '''
     Remove a specific color from an image.
     colour: RGB tuple, e.g., (255, 0, 0) for red
@@ -457,7 +457,7 @@ def removeImageColour(inPath:str, outPath:str, colour:tuple = (255, 255, 255), t
     img.putdata(new_data)
     img.save(outPath)
 
-def makeTransparent(inPath:str, outPath:str, colour:tuple = (255, 255, 255), tolerance:int = 30):
+def makeTransparent(inPath:str, outPath:str, colour:tuple = (255, 255, 255), tolerance:int = 30) -> None:
     '''
     Make some pixels in an image transparent.
     '''
@@ -519,7 +519,7 @@ def deletePath(path:str, v:bool = False) -> bool:
         deleted = False
 
 
-def downloadChunk(url, start, end, path):
+def downloadChunk(url: str, start: int, end: int, path: str) -> None:
     headers = {'Range': f'bytes={start}-{end}'}
     response = requests.get(url, headers=headers, stream=True)
     with open(path, 'wb') as f:
@@ -528,7 +528,7 @@ def downloadChunk(url, start, end, path):
                 f.write(chunk)
 
 
-def formatStringBlock(input_str, max_chars=70):
+def formatStringBlock(input_str: str, max_chars: int = 70) -> str:
     '''
     This function takes a string and formats it into a block of text
     with a maximum number of characters per line.
@@ -559,7 +559,7 @@ def formatStringBlock(input_str, max_chars=70):
 
 
 
-def downloadFile(url, save_path, exists_action='resume', num_connections=5, v=False):
+def downloadFile(url: str, save_path: str, exists_action: str = 'resume', num_connections: int = 5, v: bool = False) -> None:
     if v:
         print(f"\ndownloading {url}")
     fname = getFileBaseName(url, extension=True)
@@ -649,7 +649,7 @@ def systemPlatform() -> str:
     '''
     return platform.system()
 
-def progressBar(count, total, message=""):
+def progressBar(count: int, total: int, message: str = "") -> None:
     percent = int(count / total * 100)
     filled = int(percent / 2)
     bar = '█' * filled + '░' * (50 - filled)
@@ -669,7 +669,7 @@ def fileCount(path:str = "./", extension:str = ".*", v:bool = True) -> int:
         print(f'> there are {count} {extension if not extension ==".*" else ""} files in {path}')
     return count
 
-def resampleRaster(inFile:str, outFile:str, resolution:float, dstSRS = None, resamplingMethod = 'bilinear', replaceOutput:bool = True, v:bool = True) -> str:
+def resampleRaster(inFile:str, outFile:str, resolution:float, dstSRS = None, resamplingMethod = 'bilinear', replaceOutput:bool = True, v:bool = True) -> Optional[str]:
     '''
     Resample a raster file
     inFile: input raster file
@@ -740,7 +740,7 @@ def watchFileCount(path:str="./", extension:str = ".*", interval:float = 0.2, du
     return None
 
 
-def pythonVariable(filename, option, variable=None):
+def pythonVariable(filename: str, option: str, variable: Any = None) -> Any:
     '''
     option: save, load or open
 
@@ -774,7 +774,7 @@ def listFolders(path:str) -> list:
     else:
         return []
 
-def readFrom(filename, decode_codec = None, v=False):
+def readFrom(filename: str, decode_codec: Optional[str] = None, v: bool = False) -> Any:
     '''
     a function to read ascii files
     '''
@@ -793,16 +793,16 @@ def readFrom(filename, decode_codec = None, v=False):
 
 
 def pointsToGeodataframe(
-    rowList,
-    columnNames,
-    latIndex,
-    lonIndex,
-    auth = "EPSG",
-    code = "4326",
-    outShape = "",
-    format = "gpkg",
-    v = False,
-    includeLatLon = True ) -> geopandas.GeoDataFrame:
+    rowList: list,
+    columnNames: list,
+    latIndex: int,
+    lonIndex: int,
+    auth: str = "EPSG",
+    code: str = "4326",
+    outShape: str = "",
+    format: str = "gpkg",
+    v: bool = False,
+    includeLatLon: bool = True ) -> geopandas.GeoDataFrame:
     df = pandas.DataFrame(rowList, columns = columnNames)
     geometry = [
         Point(row[lonIndex], row[latIndex]) for row in rowList
@@ -824,10 +824,10 @@ def pointsToGeodataframe(
     return gdf
 
 
-def readFile(filename, decode_codec = None, v=False):
+def readFile(filename: str, decode_codec: Optional[str] = None, v: bool = False) -> Any:
     return readFrom(filename, decode_codec, v)
 
-def writeTo(filename, file_text, encode_codec = None, v=False) -> bool:
+def writeTo(filename: str, file_text: Any, encode_codec: Optional[str] = None, v: bool = False) -> bool:
     '''
     a function to write ascii files
     '''
@@ -846,13 +846,13 @@ def writeTo(filename, file_text, encode_codec = None, v=False) -> bool:
     if v: print("\t> wrote {0}".format(getFileBaseName(filename, extension=True)))
     return True
 
-def writeToFile(filename, file_text, encode_codec = None, v=False) -> bool:
+def writeToFile(filename: str, file_text: Any, encode_codec: Optional[str] = None, v: bool = False) -> bool:
     return writeTo(filename, file_text, encode_codec, v)
 
-def writeFile(filename, file_text, encode_codec = None, v=False) -> bool:
+def writeFile(filename: str, file_text: Any, encode_codec: Optional[str] = None, v: bool = False) -> bool:
     return writeTo(filename, file_text, encode_codec, v)
 
-def createPath(pathName, v = False):
+def createPath(pathName: str, v: bool = False) -> str:
     '''
     this function creates a directory if it does not exist
     pathName: the path to create
@@ -871,7 +871,7 @@ def createPath(pathName, v = False):
     return pathName
 
 
-def renameNetCDFvariable(input_file: str, output_file: str, old_var_name: str, new_var_name: str, v = False) -> None:
+def renameNetCDFvariable(input_file: str, output_file: str, old_var_name: str, new_var_name: str, v: bool = False) -> None:
     """
     Renames a variable in a NetCDF file using CDO if it exists.
     If the variable does not exist, the file is copied without modification.
@@ -907,7 +907,7 @@ def renameNetCDFvariable(input_file: str, output_file: str, old_var_name: str, n
         print(f"Error: {e.stderr}")
 
 
-def compressTo7z(input_dir: str, output_file: str, compressionLevel: int = 4, excludeExt: list = None, v: bool = False) -> None:
+def compressTo7z(input_dir: str, output_file: str, compressionLevel: int = 4, excludeExt: Optional[list] = None, v: bool = False) -> None:
     """
     Compresses the contents of a directory to a .7z archive with maximum compression.
     
@@ -1210,8 +1210,8 @@ def ignoreWarnings(ignore:bool = True, v:bool = False) -> None:
     return None
 
 
-def createGrid(topLeft: list = None, bottomRight: list = None, resolution: float = None, 
-               inputShape: str = None, crs: str = "EPSG:4326", saveVector: str = None) -> geopandas.GeoDataFrame:
+def createGrid(topLeft: Optional[list] = None, bottomRight: Optional[list] = None, resolution: Optional[float] = None, 
+               inputShape: Optional[str] = None, crs: str = "EPSG:4326", saveVector: Optional[str] = None) -> geopandas.GeoDataFrame:
     '''
     This function creates a grid of polygons based on either a shapefile or corner coordinates
     
@@ -1341,7 +1341,7 @@ def netcdfVariableDimensions(ncFile: str, variable: str) -> dict:
     
     return bands_info
 
-def netcdfExportTif(ncFile: str, variable: str, outputFile: Optional[str] = None, band: int = None, v:bool = True) -> gdal.Dataset:
+def netcdfExportTif(ncFile: str, variable: str, outputFile: Optional[str] = None, band: Optional[int] = None, v:bool = True) -> gdal.Dataset:
     '''
     Export a variable from a NetCDF file to a GeoTiff file
     ncFile: NetCDF file
@@ -1401,8 +1401,8 @@ def netcdfSumMaps(ncFiles:list, variable:str, band:int = 1) -> numpy.ndarray:
 def tiffWriteArray(array: numpy.ndarray, outputFile: str, 
                      geoTransform: tuple = (0, 1, 0, 0, 0, -1), 
                      projection: str = 'EPSG:4326',
-                     noData:float = None,
-                     v:bool = False) -> gdal.Dataset:
+                     noData: Optional[float] = None,
+                     v: bool = False) -> gdal.Dataset:
     '''
     Write a numpy array to a GeoTIFF file
     array         : numpy array to write
@@ -1448,7 +1448,7 @@ def copyFile(source:str, destination:str, v:bool = True) -> None:
     if v: print(f'> {source} copied to \t - {destination}')
 
 
-def copyDirectory(source:str, destination:str, recursive = True, v:bool = True, filter = []) -> None:
+def copyDirectory(source:str, destination:str, recursive: bool = True, v:bool = True, filter: list = []) -> None:
     '''
     Copy a directory from source to destination
     source: source directory
@@ -1499,7 +1499,7 @@ def copyFolder(source:str, destination:str, v:bool = True) -> None:
     copyDirectory(source, destination, v=v)
 
 
-def convertCoordinates(lon, lat, srcEPSG, dstCRS) -> tuple:
+def convertCoordinates(lon: float, lat: float, srcEPSG: str, dstCRS: str) -> tuple:
     """
     this function converts coordinates from one CRS to another
     
@@ -1516,7 +1516,7 @@ def convertCoordinates(lon, lat, srcEPSG, dstCRS) -> tuple:
     return (new_lon, new_lat)
 
 
-def extractRasterValue(rasterPath: str, lat: float, lon: float, coordProj: str = 'EPSG:4326') -> float:
+def extractRasterValue(rasterPath: str, lat: float, lon: float, coordProj: str = 'EPSG:4326') -> Optional[float]:
     """
     Extract raster value at given coordinates.
     
@@ -1561,7 +1561,7 @@ def extractRasterValue(rasterPath: str, lat: float, lon: float, coordProj: str =
     return float(value)
 
 
-def getRasterValue(rasterPath: str, lat: float, lon: float, coordProj: str = 'EPSG:4326') -> float:
+def getRasterValue(rasterPath: str, lat: float, lon: float, coordProj: str = 'EPSG:4326') -> Optional[float]:
     '''
     this function is a wrapper for extractRasterValue
     '''
@@ -1588,13 +1588,40 @@ def showProgress(count: int, end: int, message: str, barLength: int = 100) -> No
     percentStr = f'{percent:03.1f}'
     filled = int(barLength * count / end)
     bar = '█' * filled + '░' * (barLength - filled)
-    print(f'\r{bar} {percentStr}% [{count}/{end}] | {message}       ', end='', flush=True)
+    print(f'\r{message} |{bar}| {percent}% [{count}/{end}]', end='', flush=True)
     if count == end:
-        print(f'\r{bar} {percentStr}% [{count}/{end}]                          ', end='', flush=True)
+        print(f'\r{message} |{bar}| {percent}% [{count}/{end}]                          ', end='', flush=True)
         print()
 
 
-def listAllFiles(folder, extension="*"):
+def dualProgress(primaryCount: int, primaryEnd: int,
+                 secondaryCount: int, secondaryEnd: int,
+                 barLength: int = 40,
+                 message: str = '') -> None:
+    '''
+    Draw two full progress bars every frame, overwriting previous frame.
+    Bars are redrawn entirely each call.
+    '''
+
+    primaryPercent = float(primaryCount / primaryEnd * 100) if primaryEnd > 0 else 100
+    secondaryPercent = float(secondaryCount / secondaryEnd * 100) if secondaryEnd > 0 else 100
+
+    filledPrimary = int(barLength * primaryCount / primaryEnd) if primaryEnd > 0 else barLength
+    filledSecondary = int((barLength - filledPrimary) * secondaryCount / secondaryEnd) if secondaryEnd > 0 else barLength
+
+    startSection  = filledPrimary
+    middleSection = filledSecondary
+    endSection    = barLength - startSection - middleSection 
+
+    bar = '█' * startSection + '░' * middleSection + '-' * endSection
+    formattedPrimaryPercent = f'{primaryPercent:03.1f}'
+    formattedSecondaryPercent = f'{secondaryPercent:03.1f}'
+    print(f'\r{bar} {formattedPrimaryPercent.rjust(6)}% | {formattedSecondaryPercent.rjust(6)}% | {message}       ', end='', flush=True)
+    if primaryCount == primaryEnd and secondaryCount == secondaryEnd:
+        print(f'\r{bar} {formattedPrimaryPercent.rjust(6)}% | {formattedSecondaryPercent.rjust(6)}%                          ', end='', flush=True)
+
+
+def listAllFiles(folder: str, extension: str = "*") -> list:
     list_of_files = []
     # Getting the current work directory (cwd)
     thisdir = folder
@@ -1616,7 +1643,7 @@ def listAllFiles(folder, extension="*"):
     return list_of_files
 
 
-def clipFeatures(inputFeaturePath:str, boundaryFeature:str, outputFeature:str, keepOnlyTypes = None, v = False) -> geopandas.GeoDataFrame:
+def clipFeatures(inputFeaturePath:str, boundaryFeature:str, outputFeature:str, keepOnlyTypes: Optional[list] = None, v: bool = False) -> geopandas.GeoDataFrame:
     '''
     keepOnlyTypes = ['MultiPolygon', 'Polygon', 'Point', etc]
     
@@ -1996,7 +2023,7 @@ def getTimeseriesStats(data:pandas.DataFrame, observed:Optional[str] = None, sim
 
     return stats
 
-def readSWATPlusOutputs(filePath: str, column: Optional[str] = None, unit: Optional[int] = None, gis_id: Optional[int] = None, name: Optional[str] = None):
+def readSWATPlusOutputs(filePath: str, column: Optional[str] = None, unit: Optional[int] = None, gis_id: Optional[int] = None, name: Optional[str] = None) -> Optional[pandas.DataFrame]:
     '''
     Read SWAT+ output files and return a pandas DataFrame with proper date handling
     and optional filtering capabilities.

{ccfx-1.0.6 → ccfx-1.0.8}/ccfx/sqliteConnection.py

@@ -17,7 +17,7 @@ import pandas
 
 # classes
 class sqliteConnection:
-    def __init__(self, sqlite_database, connect = False):
+    def __init__(self, sqlite_database, connect = False) -> None:
         self.db_name = sqlite_database
         self.connection = None
         self.cursor = None
@@ -25,13 +25,13 @@ class sqliteConnection:
         if connect:
             self.connect()
 
-    def connect(self, v=True):
+    def connect(self, v=True) -> None:
         self.connection = sqlite3.connect(self.db_name)
         self.cursor = self.connection.cursor()
         if v:
             self.report("\t-> connection to " + self.db_name + " established...")
 
-    def updateValue(self, table_name, col_name, new_value, col_where1, val_1, v=False):
+    def updateValue(self, table_name, col_name, new_value, col_where1, val_1, v=False) -> None:
         """
         Updates a single value in a specified table where the condition matches.
         
@@ -56,7 +56,7 @@ class sqliteConnection:
             raise Exception(f"Error updating value: {str(e)}")
         
 
-    def createTable(self, table_name, initial_field_name, data_type):
+    def createTable(self, table_name, initial_field_name, data_type) -> None:
         '''
         can be text, real, etc
         '''
@@ -67,7 +67,100 @@ class sqliteConnection:
         except:
             self.report("\t! table exists")
 
-    def renameTable(self, old_table_name, new_table_name, v=False):
+    def newTable(self, tableName, columnsDict, columnOrder=None, notNull=None, foreignKeys=None) -> None:
+        """
+        Create a new table based on dictionary of columns and types.
+        
+        Args:
+            tableName (str): Name of the table to create
+            columnsDict (dict): Dictionary with column names as keys and data types as values
+                                options:
+                                INTEGER, REAL, TEXT, BLOB, etc.
+                                Example: {'id': 'INTEGER PRIMARY KEY', 'name': 'TEXT', 'age': 'INTEGER'}
+
+            columnOrder (list, optional): List specifying the order of columns
+                                Example: ['name', 'age', 'id']
+
+            notNull (list, optional): List of column names that should have NOT NULL constraint
+                                Example: ['name', 'age']
+
+            foreignKeys (dict, optional): Dictionary defining foreign key constraints
+                                Format Option 1: {currentTableField: {foreignTable: foreignField}, 'onDelete': 'CASCADE'}
+                                Format Option 2: {currentTableField: {foreignTable: foreignField, 'onDelete': 'CASCADE'}}
+                
+                                onDelete options: CASCADE, SET NULL, RESTRICT, NO ACTION, SET DEFAULT
+                                Examples: 
+                                {'user_id': {'users': 'id'}, 'onDelete': 'CASCADE'}
+                                {'user_id': {'users': 'id', 'onDelete': 'SET NULL'}}
+
+        """
+        try:
+            # Determine column order
+            if columnOrder:
+                # Use specified order, but include any columns not in the order list at the end
+                orderedColumns = []
+                for col in columnOrder:
+                    if col in columnsDict:
+                        orderedColumns.append(col)
+                # Add any remaining columns not in the order list
+                for col in columnsDict:
+                    if col not in orderedColumns:
+                        orderedColumns.append(col)
+            else:
+                orderedColumns = list(columnsDict.keys())
+            
+            # Build column definitions
+            columnDefinitions = []
+            for col in orderedColumns:
+                definition = f"{col} {columnsDict[col]}"
+                
+                # Add NOT NULL constraint if specified
+                if notNull and col in notNull:
+                    definition += " NOT NULL"
+                
+                columnDefinitions.append(definition)
+            
+            # Handle foreign key constraints
+            if foreignKeys:
+                onDeleteClause = ""
+                if 'onDelete' in foreignKeys:
+                    onDeleteClause = f" ON DELETE {foreignKeys['onDelete']}"
+                
+                for currentField, foreignRef in foreignKeys.items():
+                    if currentField != 'onDelete':  # Skip the onDelete key
+                        if isinstance(foreignRef, dict):
+                            # Check if onDelete is specified at field level
+                            if 'onDelete' in foreignRef:
+                                fieldOnDelete = f" ON DELETE {foreignRef['onDelete']}"
+                                # Get the actual foreign table and field (skip onDelete key)
+                                foreignTable = None
+                                foreignField = None
+                                for key, value in foreignRef.items():
+                                    if key != 'onDelete':
+                                        foreignTable = key
+                                        foreignField = value
+                                        break
+                            else:
+                                # Use global onDelete clause and assume dict format {table: field}
+                                fieldOnDelete = onDeleteClause
+                                foreignTable = list(foreignRef.keys())[0]
+                                foreignField = foreignRef[foreignTable]
+                            
+                            if foreignTable and foreignField:
+                                foreignKeyDef = f"FOREIGN KEY ({currentField}) REFERENCES {foreignTable}({foreignField}){fieldOnDelete}"
+                                columnDefinitions.append(foreignKeyDef)
+            
+            # Create the SQL statement
+            columnsSQL = ', '.join(columnDefinitions)
+            sql = f"CREATE TABLE {tableName} ({columnsSQL})"
+            
+            self.cursor.execute(sql)
+            self.report(f"\t-> created table {tableName} in {self.db_name}")
+            
+        except Exception as e:
+            self.report(f"\t! error creating table {tableName}: {str(e)}")
+
+    def renameTable(self, old_table_name, new_table_name, v=False) -> None:
         """
         this function gives a new name to an existing table and saves the changes
         """
@@ -77,7 +170,7 @@ class sqliteConnection:
             self.report("\t-> renamed " + old_table_name + " to " + new_table_name)
         self.commitChanges()
 
-    def tableExists(self, table_name):
+    def tableExists(self, table_name) -> bool:
         self.cursor.execute("SELECT count(name) FROM sqlite_master WHERE type='table' AND name='{table_name}'".format(
             table_name=table_name))
         if self.cursor.fetchone()[0] == 1:
@@ -85,7 +178,7 @@ class sqliteConnection:
         else:
             return False
 
-    def deleteRows(self, table_to_clean, col_where=None, col_where_value=None, v=False):
+    def deleteRows(self, table_to_clean, col_where=None, col_where_value=None, v=False) -> None:
         """
 
         """
@@ -103,17 +196,17 @@ class sqliteConnection:
         if v:
             self.report("\t-> removed all rows from " + table_to_clean)
 
-    def deleteTable(self, table_name):
+    def deleteTable(self, table_name) -> None:
         """
         this function deletes the specified table
         """
         self.cursor.execute('''DROP TABLE ''' + table_name)
         self.report("\t-> deleted table " + table_name + " from " + self.db_name)
-    
-    def dropTable(self, table_name):
+
+    def dropTable(self, table_name) -> None:
         self.deleteTable(table_name)
 
-    def undoChanges(self):
+    def undoChanges(self) -> None:
         """
         This function reverts the database to status before last commit
         """
@@ -121,7 +214,7 @@ class sqliteConnection:
         self.connection.rollback()
         self.commitChanges()
 
-    def readTableAsDict(self, table_name, key_column = 'id'):
+    def readTableAsDict(self, table_name, key_column: str = 'id') -> dict:
         # Execute a SQL query to fetch all rows from your table
         self.cursor = self.connection.execute(f"SELECT * FROM {table_name}")
 
@@ -134,7 +227,7 @@ class sqliteConnection:
 
         return data
 
-    def getColumnsWithTypes(self, table_name):
+    def getColumnsWithTypes(self, table_name) -> dict:
         c = self.cursor
 
         # Prepare and execute a PRAGMA table_info statement
@@ -145,7 +238,7 @@ class sqliteConnection:
 
         return columns_with_types
 
-    def insertDictPartial(self, table_name, data_dict):
+    def insertDictPartial(self, table_name, data_dict) -> None:
         c = self.cursor
 
         # Get the column names from the table
@@ -168,7 +261,7 @@ class sqliteConnection:
         self.commitChanges()
 
 
-    def report(self, string, printing=False):
+    def report(self, string, printing=False) -> None:
         if printing:
             print(f"\t> {string}")
         else:
@@ -176,7 +269,7 @@ class sqliteConnection:
             sys.stdout.flush()
 
 
-    def createTableFromDict(self, table_name, columns_with_types):
+    def createTableFromDict(self, table_name, columns_with_types) -> None:
 
         # Prepare a CREATE TABLE statement
         fields = ', '.join(f'{column} {data_type}' for column, data_type in columns_with_types.items())
@@ -187,7 +280,7 @@ class sqliteConnection:
         self.commitChanges()
 
 
-    def insertDict(self, table_name, data):
+    def insertDict(self, table_name, data) -> None:
         
         # Prepare an INSERT INTO statement for each dictionary
         for id, row in data.items():
@@ -204,7 +297,7 @@ class sqliteConnection:
 
 
 
-    def readTableColumns(self, table_name, column_list="all"):
+    def readTableColumns(self, table_name, column_list="all") -> list:
         """
         this function takes a list to be a string separated by commmas and
         a table and puts the columns in the table into a variable
@@ -225,7 +318,7 @@ class sqliteConnection:
         self.report("\t-> read selected table columns from " + table_name)
         return list_of_tuples
 
-    def insertField(self, table_name, field_name, data_type, to_new_line=False, messages=True):
+    def insertField(self, table_name, field_name, data_type, to_new_line=False, messages=True) -> None:
         """
         This will insert a new field into your sqlite database
 
@@ -244,7 +337,7 @@ class sqliteConnection:
                     "\r\t-> inserted into table {0} field {1}            ".format(table_name, field_name))
                 sys.stdout.flush()
 
-    def insertRow(self, table_name, ordered_content_list = [], dictionary_obj = {}, messages=False):
+    def insertRow(self, table_name, ordered_content_list = [], dictionary_obj = {}, messages=False) -> None:
         """
         ordered_list such as ['ha','he','hi']
         list should have data as strings
@@ -263,7 +356,7 @@ class sqliteConnection:
         if messages:
             self.report("\t-> inserted row into " + table_name)
 
-    def insertRows(self, table_name, list_of_tuples, messages=False):
+    def insertRows(self, table_name, list_of_tuples, messages=False) -> None:
         """
         list_of_tuples such as [('ha','he','hi')'
                                 ('ha','he','hi')]
@@ -274,7 +367,7 @@ class sqliteConnection:
         if messages:
             self.report("\t-> inserted rows into " + table_name)
 
-    def dumpCSV(self, table_name, file_name, index=False, v=False):
+    def dumpCSV(self, table_name, file_name, index=False, v=False) -> None:
         '''
         save table to csv
         '''
@@ -300,7 +393,11 @@ class sqliteConnection:
             self.report(
                 "\t-> saved {0} changes to ".format(number_of_changes) + self.db_name)
 
-    def closeConnection(self, commit=True):
+    def commit(self, v=False) -> None:
+        '''proxy to commitChanges'''
+        self.commitChanges(v)
+
+    def closeConnection(self, commit=True) -> None:
         '''
         disconnects from the database
         '''

{ccfx-1.0.6 → ccfx-1.0.8/ccfx.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ccfx
-Version: 1.0.6
+Version: 1.0.8
 Summary: This package simplifies regular common actions for quick prototyping in a user friendly way
 Author-email: Celray James CHAWANDA <celray@chawanda.com>
 License-Expression: MIT

{ccfx-1.0.6 → ccfx-1.0.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ccfx"
-version = "1.0.6"
+version = "1.0.8"
 description = "This package simplifies regular common actions for quick prototyping in a user friendly way"
 readme = "README.md"
 license = "MIT"