style/refactor: some refactoring and improvements in typing annotations

Author: alexeev-prog

.gitignore

@@ -99,7 +99,7 @@ ipython_config.py
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
 #   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
+poetry.lock
 
 # pdm
 #   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
@@ -168,4 +168,4 @@ sqlsymphony-orm/format-code.py
 sqlsymphony-orm/main.py
 sqlsymphony-orm/spacetabs.sh
 .idea/
-sqlsymphony-orm/.idea
+sqlsymphony-orm/.idea

Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = "SQLSymphonyORM"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "0.4.16"
+PROJECT_NUMBER         = "0.4.17"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

SECURITY.md

@@ -7,6 +7,7 @@ currently being supported with security updates.
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 0.4.17  | :white_check_mark: |
 | 0.4.16  | :white_check_mark: |
 | 0.4.15  | :x:                |
 | 0.4.14  | :x:                |

sqlsymphony_orm/examples/main.py

@@ -7,15 +7,15 @@
 
 
 class BankAccount(Model):
-	__tablename__ = "BankAccounts"
-	__database__ = "bank.db"
+    __tablename__ = "BankAccounts"
+    __database__ = "bank.db"
 
-	id = IntegerField(primary_key=True)
-	name = TextField(null=False)
-	cash = RealField(null=False, default=0.0)
+    id = IntegerField(primary_key=True)
+    name = TextField(null=False)
+    cash = RealField(null=False, default=0.0)
 
-	def __repr__(self):
-		return f"<BankAccount {self.pk}>"
+    def __repr__(self):
+        return f"<BankAccount {self.pk}>"
 
 
 account = BankAccount(name="John", cash=100.0)
@@ -40,10 +40,10 @@ def __repr__(self):
 mm_manager = SQLiteMultiModelManager("database.db")
 mm_manager.add_model(account)
 mm_manager.model_manager(account._model_name).create_table(
-	account.table_name, account.get_formatted_sql_fields()
+    account.table_name, account.get_formatted_sql_fields()
 )
 mm_manager.model_manager(account._model_name).insert(
-	account.table_name, account.get_formatted_sql_fields(), account.pk, account
+    account.table_name, account.get_formatted_sql_fields(), account.pk, account
 )
 mm_manager.model_manager(account._model_name).commit()
 

sqlsymphony_orm/examples/main2.py

@@ -10,32 +10,32 @@
 
 
 class User(SessionModel):
-	__tablename__ = "Users"
+    __tablename__ = "Users"
 
-	id = IntegerField(primary_key=True)
-	name = TextField(null=False)
-	cash = RealField(null=False, default=0.0)
+    id = IntegerField(primary_key=True)
+    name = TextField(null=False)
+    cash = RealField(null=False, default=0.0)
 
-	def __repr__(self):
-		return f"<User {self.pk}>"
+    def __repr__(self):
+        return f"<User {self.pk}>"
 
 
 class User2(SessionModel):
-	__tablename__ = "Users"
+    __tablename__ = "Users"
 
-	id = IntegerField(primary_key=True)
-	name = TextField(null=False)
-	cash = RealField(null=False, default=0.0)
-	password = TextField(default="password1234")
+    id = IntegerField(primary_key=True)
+    name = TextField(null=False)
+    cash = RealField(null=False, default=0.0)
+    password = TextField(default="password1234")
 
-	def __repr__(self):
-		return f"<User {self.pk}>"
+    def __repr__(self):
+        return f"<User {self.pk}>"
 
 
 class Comment(SessionModel):
-	id = IntegerField(primary_key=True)
-	name = TextField(null=False)
-	user_id = IntegerField(null=False)
+    id = IntegerField(primary_key=True)
+    name = TextField(null=False)
+    user_id = IntegerField(null=False)
 
 
 user = User(name="John")
@@ -57,7 +57,7 @@ class Comment(SessionModel):
 session.commit()
 
 print(
-	session.filter(QueryBuilder().SELECT("*").FROM(User.table_name).WHERE(name="Anna"))
+    session.filter(QueryBuilder().SELECT("*").FROM(User.table_name).WHERE(name="Anna"))
 )
 print(session.get_all())
 print(session.get_all_by_model(User))

sqlsymphony_orm/examples/main3.py

@@ -1,11 +1,11 @@
 from sqlsymphony_orm.security.hashing import PlainHasher, HashAlgorithm
 
 hasher = PlainHasher(
-	HashAlgorithm.SHA512
+    HashAlgorithm.SHA512
 )  # also: SHA256, SHA512, MD5, BLAKE2B, BLAKE2S
 
 hash1 = hasher.hash("password")
 hash2 = hasher.hash("pasword")
 
-print(hasher.verify("password", hash1))	 # True
-print(hasher.verify("password", hash2))	 # False
+print(hasher.verify("password", hash1))  # True
+print(hasher.verify("password", hash2))  # False

sqlsymphony_orm/examples/main4.py

@@ -1,14 +1,14 @@
 from sqlsymphony_orm.security.hashing import SaltedHasher, HashAlgorithm
 
 hasher = SaltedHasher(
-	HashAlgorithm.SHA512, salt="SALT"
+    HashAlgorithm.SHA512, salt="SALT"
 )  # also: SHA256, SHA512, MD5, BLAKE2B, BLAKE2S
 hasher2 = SaltedHasher(
-	HashAlgorithm.SHA512, salt="SALT2"
+    HashAlgorithm.SHA512, salt="SALT2"
 )  # also: SHA256, SHA512, MD5, BLAKE2B, BLAKE2S
 
 hash1 = hasher.hash("password")
 hash2 = hasher2.hash("password")
 
-print(hasher.verify("password", hash1))	 # True
-print(hasher.verify("password", hash2))	 # False
+print(hasher.verify("password", hash1))  # True
+print(hasher.verify("password", hash2))  # False

sqlsymphony_orm/examples/main5.py

@@ -9,18 +9,18 @@
 
 
 class User(SessionModel):
-	__tablename__ = "Users"
+    __tablename__ = "Users"
 
-	id = IntegerField(primary_key=True)
-	name = TextField(null=False)
-	cash = RealField(null=False, default=0.0)
+    id = IntegerField(primary_key=True)
+    name = TextField(null=False)
+    cash = RealField(null=False, default=0.0)
 
-	def __repr__(self):
-		return f"<User {self.pk}>"
+    def __repr__(self):
+        return f"<User {self.pk}>"
 
 
 print(
-	session.filter(QueryBuilder().SELECT("*").FROM(User.table_name).WHERE(name="Anna"))
+    session.filter(QueryBuilder().SELECT("*").FROM(User.table_name).WHERE(name="Anna"))
 )
 print(session.get_all_by_model(User))
 

sqlsymphony_orm/format-code.py

@@ -8,7 +8,7 @@
 RED = "\033[31m"
 GREEN = "\033[32m"
 YELLOW = "\033[33m"
-NC = "\033[0m"	# No Color
+NC = "\033[0m"  # No Color
 BOLD = "\033[1m"  # No Color
 
 # File Extension filter. You can add new extension
@@ -22,100 +22,100 @@
 
 
 def print_usage():
-	"""Print the usage instructions."""
-	print(f"{YELLOW}Usage: convert_tabs(file_path, tab_size, conversion_type){NC}")
-	print("<conversion_type>: 'spaces' or 'tabs'")
+    """Print the usage instructions."""
+    print(f"{YELLOW}Usage: convert_tabs(file_path, tab_size, conversion_type){NC}")
+    print("<conversion_type>: 'spaces' or 'tabs'")
 
 
 def print_error(message):
-	"""Print error messages."""
-	print(f"{RED}Error: {message}{NC}")
+    """Print error messages."""
+    print(f"{RED}Error: {message}{NC}")
 
 
 def validate_positive_integer(value):
-	"""Validate if the value is a positive integer."""
-	try:
-		int_value = int(value)
-		if int_value < 1:
-			raise ValueError
-		return int_value
-	except ValueError:
-		print_error("Tab size must be a positive integer.")
-		return None
+    """Validate if the value is a positive integer."""
+    try:
+        int_value = int(value)
+        if int_value < 1:
+            raise ValueError
+        return int_value
+    except ValueError:
+        print_error("Tab size must be a positive integer.")
+        return None
 
 
 def file_exists(file_path):
-	"""Check if the file exists."""
-	if not os.path.isfile(file_path):
-		print_error(f"File not found: {file_path}")
-		return False
-	return True
+    """Check if the file exists."""
+    if not os.path.isfile(file_path):
+        print_error(f"File not found: {file_path}")
+        return False
+    return True
 
 
 def convert_tabs(file_path, tab_size, conversion_type):
-	"""Convert tabs to spaces or spaces to tabs based on conversion type."""
-	try:
-		if conversion_type == "spaces":
-			print(f"{BOLD}Converting tabs to spaces...{NC}")
-			subprocess.run(
-				["expand", "-t", str(tab_size), file_path],
-				stdout=open(f"{file_path}.tmp", "w"),
-			)
-		elif conversion_type == "tabs":
-			print(f"{BOLD}Converting spaces to tabs...{NC}")
-			subprocess.run(
-				["unexpand", "-t", str(tab_size), file_path],
-				stdout=open(f"{file_path}.tmp", "w"),
-			)
-		else:
-			print_error(
-				f"Invalid conversion type: {conversion_type}. Use 'spaces' or 'tabs'."
-			)
-			return
-
-		os.replace(f"{file_path}.tmp", file_path)
-		print(f"{GREEN}Conversion completed successfully: {file_path}{NC}")
-	except Exception as e:
-		print_error(f"Conversion failed: {str(e)}")
+    """Convert tabs to spaces or spaces to tabs based on conversion type."""
+    try:
+        if conversion_type == "spaces":
+            print(f"{BOLD}Converting tabs to spaces...{NC}")
+            subprocess.run(
+                ["expand", "-t", str(tab_size), file_path],
+                stdout=open(f"{file_path}.tmp", "w"),
+            )
+        elif conversion_type == "tabs":
+            print(f"{BOLD}Converting spaces to tabs...{NC}")
+            subprocess.run(
+                ["unexpand", "-t", str(tab_size), file_path],
+                stdout=open(f"{file_path}.tmp", "w"),
+            )
+        else:
+            print_error(
+                f"Invalid conversion type: {conversion_type}. Use 'spaces' or 'tabs'."
+            )
+            return
+
+        os.replace(f"{file_path}.tmp", file_path)
+        print(f"{GREEN}Conversion completed successfully: {file_path}{NC}")
+    except Exception as e:
+        print_error(f"Conversion failed: {str(e)}")
 
 
 def convert_file(file_path, tab_size, conversion_type):
-	"""Main function to manage conversion."""
-	tab_size = validate_positive_integer(tab_size)
-	if tab_size is None:
-		return
+    """Main function to manage conversion."""
+    tab_size = validate_positive_integer(tab_size)
+    if tab_size is None:
+        return
 
-	if not file_exists(file_path):
-		return
+    if not file_exists(file_path):
+        return
 
-	convert_tabs(file_path, tab_size, conversion_type)
+    convert_tabs(file_path, tab_size, conversion_type)
 
 
 def main():
-	# Set the current working directory for scanning c/c++ sources (including
-	# header files) and apply the clang formatting
-	# Please note "-style" is for standard style options
-	# and "-i" is in-place editing
-
-	if len(sys.argv) > 1:
-		print(f"{BOLD}Format {sys.argv[1]}{NC}")
-		os.system(f"{RUFF} check {sys.argv[1]} --fix")
-		os.system(f"{RUFF} format {sys.argv[1]}")
-		print(f"{GREEN}Formatting completed successfully: {sys.argv[1]}{NC}")
-		convert_file(f"{sys.argv[1]}", "4", "tabs")
-		return
-
-	for root, dirs, files in os.walk(os.getcwd()):
-		if len(set(root.split("/")).intersection(IGNORED_DIRS)) > 0:
-			continue
-		for file in files:
-			if file.endswith(py_extensions):
-				print(f"{BOLD}Format {file}: {root}/{file}{NC}")
-				os.system(f"{RUFF} check {root}/{file} --fix")
-				os.system(f"{RUFF} format {root}/{file}")
-				print(f"{GREEN}Formatting completed successfully: {root}/{file}{NC}")
-				convert_file(f"{root}/{file}", "4", "tabs")
+    # Set the current working directory for scanning c/c++ sources (including
+    # header files) and apply the clang formatting
+    # Please note "-style" is for standard style options
+    # and "-i" is in-place editing
+
+    if len(sys.argv) > 1:
+        print(f"{BOLD}Format {sys.argv[1]}{NC}")
+        os.system(f"{RUFF} check {sys.argv[1]} --fix")
+        os.system(f"{RUFF} format {sys.argv[1]}")
+        print(f"{GREEN}Formatting completed successfully: {sys.argv[1]}{NC}")
+        convert_file(f"{sys.argv[1]}", "4", "tabs")
+        return
+
+    for root, dirs, files in os.walk(os.getcwd()):
+        if len(set(root.split("/")).intersection(IGNORED_DIRS)) > 0:
+            continue
+        for file in files:
+            if file.endswith(py_extensions):
+                print(f"{BOLD}Format {file}: {root}/{file}{NC}")
+                os.system(f"{RUFF} check {root}/{file} --fix")
+                os.system(f"{RUFF} format {root}/{file}")
+                print(f"{GREEN}Formatting completed successfully: {root}/{file}{NC}")
+                convert_file(f"{root}/{file}", "4", "tabs")
 
 
 if __name__ == "__main__":
-	main()
+    main()

sqlsymphony_orm/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sqlsymphony_orm"
-version = "0.4.16"
+version = "0.4.17"
 description = "The elegant and powerful SQLite3 ORM for Python"
 authors = ["alexeev-prog <[email protected]>"]
 readme = "README.md"
@@ -21,7 +21,7 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [project]
-keywords = ["sqlsymphony", "async", "async database", "async ORM", "aiosqlite", "OOP", "database", "sql", "sqlite", "ORM", "db", 'sqlite3', 'sqlalchemy', 'fast', 'simple']
+keywords = ["sqlsymphony", "database", "ORM", "sqlite", "OOP", "database", "sql", "sqlite", "db", 'sqlite3', 'sqlalchemy', 'fast', 'simple']
 license = {text = "GNU GPL v3"}
 requires-python = ">=3.9"
 dynamic = ["version"]