sqliter-py 0.1.0__tar.gz

sqliter_py-0.1.0/.gitignore

@@ -0,0 +1,217 @@
+# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
+# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,linux,python
+# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,linux,python
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,linux,python
+
+# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
+
+.python-version
+*.db
+.vscode

sqliter_py-0.1.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.3
+Name: sqliter-py
+Version: 0.1.0
+Summary: Interact with SQLite databases using Python and Pydantic
+Project-URL: Pull Requests, https://github.com/seapagan/sqliter-py/pulls
+Project-URL: Bug Tracker, https://github.com/seapagan/sqliter-py/issues
+Project-URL: Repository, https://github.com/seapagan/sqliter-py
+Author-email: Grant Ramsay <grant@gnramsay.com>
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: pydantic>=2.9.0
+Description-Content-Type: text/markdown
+
+# SQLiter
+
+An SQLite wrapper in Python using Pydantic and written primarily using ChatGPT,
+as an experiment in how viable it is to write working code using a LLM.
+
+The code was then cleaned up, typed and linted by hand.

sqliter_py-0.1.0/README.md

@@ -0,0 +1,6 @@
+# SQLiter
+
+An SQLite wrapper in Python using Pydantic and written primarily using ChatGPT,
+as an experiment in how viable it is to write working code using a LLM.
+
+The code was then cleaned up, typed and linted by hand.

sqliter_py-0.1.0/pyproject.toml

@@ -0,0 +1,99 @@
+[project]
+name = "sqliter-py"
+version = "0.1.0"
+description = "Interact with SQLite databases using Python and Pydantic"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [{ name = "Grant Ramsay", email = "grant@gnramsay.com" }]
+dependencies = ["pydantic>=2.9.0"]
+
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+# "HomeHage" = "https://xxxxxx"
+"Pull Requests" = "https://github.com/seapagan/sqliter-py/pulls"
+"Bug Tracker" = "https://github.com/seapagan/sqliter-py/issues"
+# "Changelog" = "https://github.com/seapagan/sqliter-py/blob/main/CHANGELOG.md"
+"Repository" = "https://github.com/seapagan/sqliter-py"
+
+# [project.scripts]
+# demo = "demo:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+packages = ["sqliter"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["sqliter"]
+
+[tool.uv]
+dev-dependencies = ["mypy>=1.11.2", "ruff>=0.6.4"]
+
+[tool.ruff]
+line-length = 80
+lint.select = ["ALL"] # we are being very strict!
+lint.ignore = [
+  "ANN101",
+  "ANN102",
+  "PGH003",
+  "FBT002",
+  "FBT003",
+  "B006",
+] # These rules are too strict even for us 😝
+lint.extend-ignore = [
+  "COM812",
+  "ISC001",
+] # these are ignored for ruff formatting
+
+src = ["lice2"]
+target-version = "py39" # minimum python version supported
+
+[tool.ruff.format]
+indent-style = "space"
+quote-style = "double"
+
+[tool.ruff.lint.pep8-naming]
+classmethod-decorators = ["pydantic.validator", "pydantic.root_validator"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.extend-per-file-ignores]
+"lice2/tests/**/*.py" = [
+  "S101",   # we can (and MUST!) use 'assert' in test files.
+  "ANN001", # annotations for fixtures are sometimes a pain for test files
+  "ARG00",  # test fixtures often are not directly used
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["lice2"]
+
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+
+[tool.mypy]
+python_version = "3.9"
+
+[[tool.mypy.overrides]]
+module = "pyperclip"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+disable_error_code = ["method-assign", "no-untyped-def", "attr-defined"]
+module = "tests.*"

sqliter_py-0.1.0/sqliter/__init__.py

@@ -0,0 +1,5 @@
+"""The 'sqliter' package provides an minimal ORM for  the SQLite library."""
+
+from .sqliter import SqliterDB
+
+__all__ = ["SqliterDB"]

sqliter_py-0.1.0/sqliter/model/__init__.py

@@ -0,0 +1,8 @@
+"""This module defines the BaseDBModel class.
+
+This should be subclassed by the user to interact with the database.
+"""
+
+from .model import BaseDBModel
+
+__all__ = ["BaseDBModel"]

sqliter_py-0.1.0/sqliter/model/model.py

@@ -0,0 +1,38 @@
+"""Define the Base model class."""
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class BaseDBModel(BaseModel):
+    """Custom base model for database models."""
+
+    class Meta:
+        """Configure the base model with default options."""
+
+        create_id: bool = True  # Whether to create an auto-increment ID
+        primary_key: str = "id"  # Default primary key field
+        table_name: Optional[str] = (
+            None  # Table name, defaults to class name if not set
+        )
+
+    @classmethod
+    def get_table_name(cls) -> str:
+        """Get the table name from the Meta, or default to the classname."""
+        table_name: str | None = getattr(cls.Meta, "table_name", None)
+        if table_name is not None:
+            return table_name
+        return cls.__name__.lower()  # Default to class name in lowercase
+
+    @classmethod
+    def get_primary_key(cls) -> str:
+        """Get the primary key from the Meta class or default to 'id'."""
+        return getattr(cls.Meta, "primary_key", "id")
+
+    @classmethod
+    def should_create_id(cls) -> bool:
+        """Check whether the model should create an auto-increment ID."""
+        return getattr(cls.Meta, "create_id", True)

sqliter_py-0.1.0/sqliter/query/__init__.py

@@ -0,0 +1,5 @@
+"""Define the 'QueryBuilder' class for building SQL queries."""
+
+from .query import QueryBuilder
+
+__all__ = ["QueryBuilder"]

sqliter_py-0.1.0/sqliter/query/query.py

@@ -0,0 +1,139 @@
+"""Define the 'QueryBuilder' class for building SQL queries."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Optional
+
+from typing_extensions import Self
+
+if TYPE_CHECKING:
+    from sqliter import SqliterDB
+    from sqliter.model import BaseDBModel
+
+
+class QueryBuilder:
+    """Functions to build and execute queries for a given model."""
+
+    def __init__(self, db: SqliterDB, model_class: type[BaseDBModel]) -> None:
+        """Initialize the query builder with the database, model class, etc."""
+        self.db = db
+        self.model_class = model_class
+        self.table_name = model_class.get_table_name()  # Use model_class method
+        self.filters: list[tuple[str, Any]] = []
+
+    def filter(self, **conditions: str | float | None) -> Self:
+        """Add filter conditions to the query."""
+        for field, value in conditions.items():
+            self.filters.append((field, value))
+        return self
+
+    def _execute_query(
+        self,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        order_by: Optional[str] = None,
+        *,
+        fetch_one: bool = False,
+    ) -> list[tuple[Any, ...]] | Optional[tuple[Any, ...]]:
+        """Helper function to execute the query with filters."""
+        fields = ", ".join(self.model_class.model_fields)
+        where_clause = " AND ".join(
+            [f"{field} = ?" for field, _ in self.filters]
+        )
+        sql = f"SELECT {fields} FROM {self.table_name}"  # noqa: S608
+
+        if self.filters:
+            sql += f" WHERE {where_clause}"
+
+        if order_by:
+            sql += f" ORDER BY {order_by}"
+
+        if limit is not None:
+            sql += f" LIMIT {limit}"
+
+        if offset is not None:
+            sql += f" OFFSET {offset}"
+
+        values = [value for _, value in self.filters]
+
+        with self.db.connect() as conn:
+            cursor = conn.cursor()
+            cursor.execute(sql, values)
+            return cursor.fetchall() if not fetch_one else cursor.fetchone()
+
+    def fetch_all(self) -> list[BaseDBModel]:
+        """Fetch all results matching the filters."""
+        results = self._execute_query()
+
+        if results is None:
+            return []
+
+        return [
+            self.model_class(
+                **{
+                    field: row[idx]
+                    for idx, field in enumerate(self.model_class.model_fields)
+                }
+            )
+            for row in results
+        ]
+
+    def fetch_one(self) -> BaseDBModel | None:
+        """Fetch exactly one result."""
+        result = self._execute_query(fetch_one=True)
+        if not result:
+            return None
+        return self.model_class(
+            **{
+                field: result[idx]
+                for idx, field in enumerate(self.model_class.model_fields)
+            }
+        )
+
+    def fetch_first(self) -> BaseDBModel | None:
+        """Fetch the first result of the query."""
+        result = self._execute_query(limit=1)
+        if not result:
+            return None
+        return self.model_class(
+            **{
+                field: result[0][idx]
+                for idx, field in enumerate(self.model_class.model_fields)
+            }
+        )
+
+    def fetch_last(self) -> BaseDBModel | None:
+        """Fetch the last result of the query (based on the primary key)."""
+        primary_key = self.model_class.get_primary_key()
+        result = self._execute_query(limit=1, order_by=f"{primary_key} DESC")
+        if not result:
+            return None
+        return self.model_class(
+            **{
+                field: result[0][idx]
+                for idx, field in enumerate(self.model_class.model_fields)
+            }
+        )
+
+    def count(self) -> int:
+        """Return the count of records matching the filters."""
+        where_clause = " AND ".join(
+            [f"{field} = ?" for field, _ in self.filters]
+        )
+        sql = f"SELECT COUNT(*) FROM {self.table_name}"  # noqa: S608
+
+        if self.filters:
+            sql += f" WHERE {where_clause}"
+
+        values = [value for _, value in self.filters]
+
+        with self.db.connect() as conn:
+            cursor = conn.cursor()
+            cursor.execute(sql, values)
+            result = cursor.fetchone()
+
+        return int(result[0]) if result else 0
+
+    def exists(self) -> bool:
+        """Return True if any record matches the filters."""
+        return self.count() > 0

sqliter_py-0.1.0/sqliter/sqliter.py

@@ -0,0 +1,179 @@
+"""This is the main module for the sqliter package."""
+
+from __future__ import annotations
+
+import sqlite3
+from typing import TYPE_CHECKING, Optional
+
+from typing_extensions import Self
+
+from sqliter.query.query import QueryBuilder
+
+if TYPE_CHECKING:
+    from types import TracebackType
+
+    from sqliter.model.model import BaseDBModel
+
+
+class SqliterDB:
+    """Class to manage SQLite database interactions."""
+
+    def __init__(self, db_filename: str, *, auto_commit: bool = False) -> None:
+        """Initialize the class and options."""
+        self.db_filename = db_filename
+        self.auto_commit = auto_commit
+        self.conn: Optional[sqlite3.Connection] = None
+
+    def connect(self) -> sqlite3.Connection:
+        """Create or return a connection to the SQLite database."""
+        if not self.conn:
+            self.conn = sqlite3.connect(self.db_filename)
+        return self.conn
+
+    def create_table(self, model_class: type[BaseDBModel]) -> None:
+        """Create a table based on the Pydantic model."""
+        table_name = model_class.get_table_name()
+        primary_key = model_class.get_primary_key()
+        create_id = model_class.should_create_id()
+
+        fields = ", ".join(
+            f"{field_name} TEXT" for field_name in model_class.model_fields
+        )
+
+        if create_id:
+            create_table_sql = f"""
+                CREATE TABLE IF NOT EXISTS {table_name} (
+                    id INTEGER PRIMARY KEY AUTOINCREMENT,
+                    {fields}
+                )
+            """
+        else:
+            create_table_sql = f"""
+                CREATE TABLE IF NOT EXISTS {table_name} (
+                    {fields},
+                    PRIMARY KEY ({primary_key})
+                )
+            """
+
+        with self.connect() as conn:
+            cursor = conn.cursor()
+            cursor.execute(create_table_sql)
+            conn.commit()
+
+    def _maybe_commit(self, conn: sqlite3.Connection) -> None:
+        """Commit changes if auto_commit is True."""
+        if self.auto_commit:
+            conn.commit()
+
+    def insert(self, model_instance: BaseDBModel) -> None:
+        """Insert a new record into the table defined by the Pydantic model."""
+        model_class = type(model_instance)
+        table_name = model_class.get_table_name()
+
+        fields = ", ".join(model_class.model_fields)
+        placeholders = ", ".join(["?"] * len(model_class.model_fields))
+        values = tuple(
+            getattr(model_instance, field) for field in model_class.model_fields
+        )
+
+        insert_sql = f"""
+        INSERT OR REPLACE INTO {table_name} ({fields})
+        VALUES ({placeholders})
+    """  # noqa: S608
+
+        with self.connect() as conn:
+            cursor = conn.cursor()
+            cursor.execute(insert_sql, values)
+            self._maybe_commit(conn)
+
+    def get(
+        self, model_class: type[BaseDBModel], primary_key_value: str
+    ) -> BaseDBModel | None:
+        """Retrieve a record by its PK and return a Pydantic instance."""
+        table_name = model_class.get_table_name()
+        primary_key = model_class.get_primary_key()
+
+        fields = ", ".join(model_class.model_fields)
+
+        select_sql = f"""
+            SELECT {fields} FROM {table_name} WHERE {primary_key} = ?
+        """  # noqa: S608
+
+        with self.connect() as conn:
+            cursor = conn.cursor()
+            cursor.execute(select_sql, (primary_key_value,))
+            result = cursor.fetchone()
+
+        if result:
+            result_dict = {
+                field: result[idx]
+                for idx, field in enumerate(model_class.model_fields)
+            }
+            return model_class(**result_dict)
+        return None
+
+    def update(self, model_instance: BaseDBModel) -> None:
+        """Update an existing record using the Pydantic model."""
+        model_class = type(model_instance)
+        table_name = model_class.get_table_name()
+        primary_key = model_class.get_primary_key()
+
+        fields = ", ".join(
+            f"{field} = ?"
+            for field in model_class.model_fields
+            if field != primary_key
+        )
+        values = tuple(
+            getattr(model_instance, field)
+            for field in model_class.model_fields
+            if field != primary_key
+        )
+        primary_key_value = getattr(model_instance, primary_key)
+
+        update_sql = f"""
+            UPDATE {table_name} SET {fields} WHERE {primary_key} = ?
+        """  # noqa: S608
+
+        with self.connect() as conn:
+            cursor = conn.cursor()
+            cursor.execute(update_sql, (*values, primary_key_value))
+            self._maybe_commit(conn)
+
+    def delete(
+        self, model_class: type[BaseDBModel], primary_key_value: str
+    ) -> None:
+        """Delete a record by its primary key."""
+        table_name = model_class.get_table_name()
+        primary_key = model_class.get_primary_key()
+
+        delete_sql = f"""
+            DELETE FROM {table_name} WHERE {primary_key} = ?
+        """  # noqa: S608
+
+        with self.connect() as conn:
+            cursor = conn.cursor()
+            cursor.execute(delete_sql, (primary_key_value,))
+            self._maybe_commit(conn)
+
+    def select(self, model_class: type[BaseDBModel]) -> QueryBuilder:
+        """Start a query for the given model."""
+        return QueryBuilder(self, model_class)
+
+    # --- Context manager methods ---
+    def __enter__(self) -> Self:
+        """Enter the runtime context for the 'with' statement."""
+        self.connect()
+        return self
+
+    def __exit__(
+        self,
+        exc_type: Optional[type[BaseException]],
+        exc_value: Optional[BaseException],
+        traceback: Optional[TracebackType],
+    ) -> None:
+        """Exit the runtime context and close the connection."""
+        if self.conn:
+            if not self.auto_commit:
+                self.conn.commit()
+            self.conn.close()
+            self.conn = None