sqlite-database 0.7.9__tar.gz → 0.7.11__tar.gz

{sqlite_database-0.7.9 → sqlite_database-0.7.11}/.github/workflows/pylint.yml

@@ -28,4 +28,4 @@ jobs:
         pip install -r ./dev-requirements.txt
     - name: Analysing the code with pylint
       run: |
-        pylint sqlite_database --rcfile dev-config/pylint.toml
+        pylint sqlite_database --rcfile dev-config/pylint.toml -f github

{sqlite_database-0.7.9/sqlite_database.egg-info → sqlite_database-0.7.11}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: sqlite_database
-Version: 0.7.9
-Summary: A weird wrapper for SQLite Connection
+Version: 0.7.11
+Summary: Easy to use SQLite wrapper
 Home-page: https://github.com/RimuEirnarn/sqlite_database
 Author: RimuEirnarn
 Author-email: Rimu Eirnarn <rimuru720@proton.me>
@@ -50,7 +50,7 @@ Dynamic: license-file
 
 </div>
 
-SQLite Database is a weird wrapper for SQLite Connection. It's intended to be easy to use and simple.
+SQLite Database is an easy and simple way to use SQLite, almost as easy as using Laravel Eloquent ORM.
 
 > [!WARNING]
 > This project as per version number (<1.0) is not either efficient (in term of memory usage) and fast. If you found a serious problem, please let us know.
@@ -67,7 +67,7 @@ From previous versions, installations can be done using `pip install https://git
 
 ## Features
 
-Feature overview can be found in [Features.md](https://github.com/RimuEirnarn/sqlite_database/blob/main/Features.md)
+Feature overview can be found in [Features.md](https://github.com/RimuEirnarn/sqlite_database/blob/main/docs/SimpleGuide.md)
 
 It's still recommended to see the [short docs](https://sqlite-database.rtfd.io/)
 
@@ -81,9 +81,11 @@ You can submit any issue if you found a good issue. You can submit a pull reques
 
 ## Development
 
-When pulling this repository with latest commit, make sure to install all `dev-requirements.txt` depending on your intentions. It's mostly pylint and pytest.
+Thanks for considering in contributing to sqlite_database!
 
-When using `pytest`, do this: `pytest --config-file=./dev-config/pytest.ini` or check any check scripts in `bin/`
+For development kits, you only need `pytest` and `pylint`, `sphinx` is required for documentation. Please refer to their own `dev-requirements.txt` and `docs-requirements.txt`
+
+When using `pytest`, do this: `pytest --config-file=./dev-config/pytest.ini` or check any check scripts in `bin/` (e.g `bin/check.sh`)
 
 ### How to install?
 

{sqlite_database-0.7.9 → sqlite_database-0.7.11}/README.md

@@ -24,7 +24,7 @@
 
 </div>
 
-SQLite Database is a weird wrapper for SQLite Connection. It's intended to be easy to use and simple.
+SQLite Database is an easy and simple way to use SQLite, almost as easy as using Laravel Eloquent ORM.
 
 > [!WARNING]
 > This project as per version number (<1.0) is not either efficient (in term of memory usage) and fast. If you found a serious problem, please let us know.
@@ -41,7 +41,7 @@ From previous versions, installations can be done using `pip install https://git
 
 ## Features
 
-Feature overview can be found in [Features.md](https://github.com/RimuEirnarn/sqlite_database/blob/main/Features.md)
+Feature overview can be found in [Features.md](https://github.com/RimuEirnarn/sqlite_database/blob/main/docs/SimpleGuide.md)
 
 It's still recommended to see the [short docs](https://sqlite-database.rtfd.io/)
 
@@ -55,9 +55,11 @@ You can submit any issue if you found a good issue. You can submit a pull reques
 
 ## Development
 
-When pulling this repository with latest commit, make sure to install all `dev-requirements.txt` depending on your intentions. It's mostly pylint and pytest.
+Thanks for considering in contributing to sqlite_database!
 
-When using `pytest`, do this: `pytest --config-file=./dev-config/pytest.ini` or check any check scripts in `bin/`
+For development kits, you only need `pytest` and `pylint`, `sphinx` is required for documentation. Please refer to their own `dev-requirements.txt` and `docs-requirements.txt`
+
+When using `pytest`, do this: `pytest --config-file=./dev-config/pytest.ini` or check any check scripts in `bin/` (e.g `bin/check.sh`)
 
 ### How to install?
 

sqlite_database-0.7.11/TODO.md

@@ -0,0 +1,60 @@
+# TODO
+
+**NOTE**: This TODO need to be written in markdown. use `[ ]` or `[x]` to mark todos
+
+**High velocity** is required but make sure to do it with low overhead.
+
+## API Overview
+
+**Table API** is dictionary-driven API for low-level operators such as Sub Query, functions, generic CRUD, and any other else.
+
+**Model API** is a Model-driven API for higher-level operators with simplified usage, mimicking Laravel Eloquent ORM. Accessing Table API from Model API is as simple as calling `Model.get_table()`
+
+## SQLite API
+
+What API should we bring? This todo is for simplification; you can do anything with `Database.sql` property
+
+- [x] Table API function support
+- [x] Pragmas (Database, only select few)
+- [x] Table API subquery
+- [ ] Table API `as` keyword
+- [x] sqlite select data squash[^1] (squash=True, Table API)
+- [x] sqlite select `what` data. Instead of using `select *`, we should also have `what`. Bring up few data than select everything.[^2]
+- [x] Provide caching functions; not to cache sql returns but sql query, etc.[^3]
+- [ ] Model API automatic migration helpers (Design schematic is ass, hard to implement)[^4]
+
+## Other functionality
+
+The functionality here is outside of sqlite features such as export and import.
+
+- [x] CSV Export
+- [x] CSV Import
+
+
+---
+
+[^1]: The term data crunching is when `select*` is used, typically the functions returns list of `Row`, by using `crunch=True`, the return value should be `Row[str, tuple[Any]]`
+
+[^2]: If `what` parameter is specified to 1, we should return `tuple[Any, ...]` instead of `list[Row[str, Any]]` or `Row[str, Any]`
+
+[^3]: Caching should **NOT** cache query data! Provide using `combine_keyvals` to create named params
+
+[^4]: I need a way to implement migrations to advance to version `v0.7.10`, I need to know how migration works, how a Python code can translate into SQL, though I can just ask Table API query builder to parse columns. However, Table API's query builder sucks when we parse SQL query into Python objects, it can't translate inline column definitions for now. Can it? Maybe, if it can, some metadata is guaranteed lost if constraints are inlined. Table API has `rename_column` and `add_column` for convenience. Modify? Remove? not now.
+
+Migration schematics:
+
+The Schema table is described using Table API Builder column:
+
+```python
+db.create_table("_schema_meta", [
+    text("table_name").primary(),
+    integer("version").default(1),
+    text("schema_json"),
+    real("created_at"),
+    real("updated_at")
+])
+```
+
+The columns must be then normalized back to `Column` and manually compare which changes and which didn't.
+
+Any fields that was significantly changed will force new table creation, subsequently followed up and refilled. If new entries are unique, the ORM is simply fucked unless provided with custom unique field generator (i.e, uuid4())

sqlite_database-0.7.11/docs/DatabaseModes.md

@@ -0,0 +1,8 @@
+# Database Modes
+
+The basic `Database` class has different flavor, but they all works as usual.
+
+There's at least 2 implemented Databases, for now:
+
+1. Generic `Database` is what you'll use the most, single-threaded database that doesn't need explicit `.close()`
+2. Database Thread Worker `DatabaseWorker` found in `sqlite_database.workers`, intended multithreaded environment, just remember to `.close()` like regular threads.

{sqlite_database-0.7.9 → sqlite_database-0.7.11}/docs/conf.py

@@ -21,8 +21,8 @@ import sqlite_database
 sqlite_database.test_installed()
 
 project = 'sqlite_database'
-copyright = '2023, RimuEirnarn'
-author = 'RimuEirnarn'
+copyright = '2025, Rimu Aerisya (Rimu Eirnarn)'
+author = 'Rimu Aerisya (Rimu Eirnarn)'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -34,6 +34,7 @@ extensions = [
     'sphinx.ext.viewcode',
     'myst_parser',
     'sphinx.ext.napoleon',
+
 ]
 
 templates_path = ['_templates']

{sqlite_database-0.7.9 → sqlite_database-0.7.11}/docs/index.rst

@@ -1,20 +1,30 @@
 .. sqlite_database documentation master file, created by
-   sphinx-quickstart on Wed Apr 26 14:53:11 2023.
+   sphinx-quickstart on Sat Jul 26 19:21:12 2025.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-sqlite-database Documentation
+sqlite_database Documentation
 =============================
 
-SQLite Database
----------------
+.. toctree::
+    :maxdepth: 12
+
+    :caption: SQLite Database
+
+    SimpleGuide
+    ModelAPI
+    DatabaseModes
+
+
+API Documentation
+=============================
 
 .. toctree::
-   :maxdepth: 4
-   :caption: SQLite Database
+    :maxdepth: 1
 
-   SimpleGuide
-   ModelAPI
+    :caption: API Documentation
+
+    api_reference
 
 
 Indices and tables
@@ -23,3 +33,4 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+

sqlite_database-0.7.11/docs/sqlite_database.models.errors.rst

@@ -0,0 +1,7 @@
+sqlite\_database.models.errors module
+=====================================
+
+.. automodule:: sqlite_database.models.errors
+   :members:
+   :show-inheritance:
+   :undoc-members:

sqlite_database-0.7.11/docs/sqlite_database.models.helpers.rst

@@ -0,0 +1,7 @@
+sqlite\_database.models.helpers module
+======================================
+
+.. automodule:: sqlite_database.models.helpers
+   :members:
+   :show-inheritance:
+   :undoc-members:

sqlite_database-0.7.11/docs/sqlite_database.models.mixin.rst

@@ -0,0 +1,7 @@
+sqlite\_database.models.mixin module
+====================================
+
+.. automodule:: sqlite_database.models.mixin
+   :members:
+   :show-inheritance:
+   :undoc-members:

sqlite_database-0.7.11/docs/sqlite_database.models.query_builder.rst

@@ -0,0 +1,7 @@
+sqlite\_database.models.query\_builder module
+=============================================
+
+.. automodule:: sqlite_database.models.query_builder
+   :members:
+   :show-inheritance:
+   :undoc-members:

sqlite_database-0.7.11/docs/sqlite_database.models.rst

@@ -0,0 +1,22 @@
+sqlite\_database.models package
+===============================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 12
+
+   sqlite_database.models.errors
+   sqlite_database.models.helpers
+   sqlite_database.models.mixin
+   sqlite_database.models.query_builder
+   sqlite_database.models.type_checkers
+
+Module contents
+---------------
+
+.. automodule:: sqlite_database.models
+   :members:
+   :show-inheritance:
+   :undoc-members:

sqlite_database-0.7.11/docs/sqlite_database.models.type_checkers.rst

@@ -0,0 +1,7 @@
+sqlite\_database.models.type\_checkers module
+=============================================
+
+.. automodule:: sqlite_database.models.type_checkers
+   :members:
+   :show-inheritance:
+   :undoc-members:

{sqlite_database-0.7.9 → sqlite_database-0.7.11}/docs/sqlite_database.rst

@@ -1,26 +1,39 @@
-SQLite Database
-===============
+API Documentation (sqlite_database)
+========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 12
+
+   sqlite_database.models
+   sqlite_database.workers
 
 Submodules
 ----------
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 12
 
    sqlite_database.column
    sqlite_database.csv
+   sqlite_database.database
    sqlite_database.errors
+   sqlite_database.functions
    sqlite_database.locals
    sqlite_database.operators
    sqlite_database.query_builder
    sqlite_database.signature
+   sqlite_database.subquery
    sqlite_database.table
    sqlite_database.typings
+   sqlite_database.utils
 
 Module contents
 ---------------
 
 .. automodule:: sqlite_database
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

sqlite_database-0.7.11/docs/sqlite_database.subquery.rst

@@ -0,0 +1,7 @@
+sqlite\_database.subquery module
+================================
+
+.. automodule:: sqlite_database.subquery
+   :members:
+   :show-inheritance:
+   :undoc-members:

sqlite_database-0.7.11/docs/sqlite_database.workers.connection.rst

@@ -0,0 +1,7 @@
+sqlite\_database.workers.connection module
+==========================================
+
+.. automodule:: sqlite_database.workers.connection
+   :members:
+   :show-inheritance:
+   :undoc-members:

sqlite_database-0.7.11/docs/sqlite_database.workers.database.rst

@@ -0,0 +1,7 @@
+sqlite\_database.workers.database module
+========================================
+
+.. automodule:: sqlite_database.workers.database
+   :members:
+   :show-inheritance:
+   :undoc-members:

sqlite_database-0.7.11/docs/sqlite_database.workers.rst

@@ -0,0 +1,19 @@
+sqlite\_database.workers package
+================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 12
+
+   sqlite_database.workers.connection
+   sqlite_database.workers.database
+
+Module contents
+---------------
+
+.. automodule:: sqlite_database.workers
+   :members:
+   :show-inheritance:
+   :undoc-members:

{sqlite_database-0.7.9 → sqlite_database-0.7.11}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sqlite_database"
-description = "A weird wrapper for SQLite Connection"
+description = "Easy to use SQLite wrapper"
 authors = [
     {name = "Rimu Eirnarn", email = "rimuru720@proton.me"}
 ]
@@ -25,7 +25,7 @@ Repository = "https://github.com/RimuEirnarn/sqlite_database.git"
 
 [tool.setuptools]
 zip-safe = true
-packages = ["sqlite_database", "sqlite_database.models"]
+packages = ["sqlite_database", "sqlite_database.models", "sqlite_database.workers"]
 
 [project.optional-dependencies]
 dev = ["pytest", "pylint", "black"]

{sqlite_database-0.7.9 → sqlite_database-0.7.11}/sqlite_database/__init__.py

@@ -15,7 +15,7 @@ def test_installed():
     return True
 
 
-__version__ = "0.7.9"
+__version__ = "0.7.11"
 __all__ = [
     "Database",
     "Table",

{sqlite_database-0.7.9 → sqlite_database-0.7.11}/sqlite_database/_utils.py

@@ -108,20 +108,25 @@ def matches(pattern: Pattern, value: str):
     return True
 
 
-def check_one(data: str):
+def check_one(data: str, bypass_list: tuple[str, ...] | None = None):
     """check one to check if a string contains illegal character OR
     if it is a reserved SQL keyword"""
     if matches(_re_valid, data) is True:
-        raise SecurityError("Cannot parse unsafe data.")
+        exc = SecurityError("Cannot parse unsafe data.")
+        exc.add_note(f"Target: {data}")
+        raise exc
+    bp = bypass_list or []
     if data.upper() in _SQLITE_KEYWORDS:
+        if data in bp:
+            return data
         raise SecurityError(f'"{data}" is a reserved SQL keyword and cannot be used.')
     return data
 
 
-def check_iter(data: Iterable[str]):
+def check_iter(data: Iterable[str], bypass_list: tuple[str, ...] | None = None):
     """An iterable checks as it's check_one"""
     for val in data:
-        yield check_one(val)
+        check_one(val, bypass_list)
 
 
 class WithCursor(Cursor):

{sqlite_database-0.7.9 → sqlite_database-0.7.11}/sqlite_database/query_builder.py

@@ -95,6 +95,12 @@ class QueryParams:
     order: Optional[CacheOrders] = None
     data: Optional[CacheData] = None
 
+    def __post_init__(self):
+        if not all(
+            (isinstance(getattr(self, item), int) for item in ("limit", "offset"))
+        ):
+            raise TypeError("Expected limit/offset to be integer")
+
     def __hash__(self):
         """Custom hash function to ensure compatibility with lru_cache."""
         return hash(
@@ -222,6 +228,7 @@ def extract_signature(  # pylint: disable=too-many-locals
     data: dict[str, Any] = {}
 
     for key, value in filter_.items():
+        check_one(key)
         condition_id = generate_ids()
         if not isinstance(value, Signature):
             value = Signature(value, "=")
@@ -229,7 +236,8 @@ def extract_signature(  # pylint: disable=too-many-locals
 
         val = (
             Signature(
-                ":"+NAMING_FORMAT.format(
+                ":"
+                + NAMING_FORMAT.format(
                     key=key,
                     suffix=suffix,
                     call_id=call_id,
@@ -497,7 +505,8 @@ def extract_subquery(subquery: SubQuery, depth: int = 1):
             subquery.where,
             subquery.cols,
             subquery.limit,
-            subquery.orders,  # type: ignore
+            0,  # type: ignore
+            subquery.orders # type: ignore
         ),
         depth=depth,
     )
@@ -542,9 +551,16 @@ def _setup_limit_patch(table_name: str, condition: str, limit):
 def _parse_orders(order: CacheOrders):
     if isinstance(order, tuple) and not isinstance(order[0], tuple):
         ord_, order_by = order
+        # print('here')
+        check_iter(order, ("asc", "desc"))  # type: ignore
         return f"{ord_} {order_by}"
     if isinstance(order, tuple) and isinstance(order[0], tuple):
-        return ", ".join(f"{ord_} {order_by}" for ord_, order_by in order)
+
+        return ", ".join(
+            f"{ord_} {order_by}"
+            for ord_, order_by in order
+            if check_iter((ord_, order_by), ("asc", "desc"))
+        )
     raise TypeError("What?", type(order))
 
 
@@ -570,12 +586,14 @@ def _build_select(query_params: QueryParams, depth: int = 0):
         )
     check_one(query_params.table_name)
     cond, data = extract_signature(query_params.condition, depth=depth)
-    check_iter(query_params.only or ())  # type: ignore
     only_ = "*"
     if query_params.only and isinstance(query_params.only, ParsedFn):
         only_, _ = query_params.only.parse_sql()
+        check_iter(
+            (query_params.only.name, *(a for a in query_params.only.values if a != "*"))
+        )
     elif isinstance(query_params.only, tuple):
-        only_ = f"{', '.join(column_name for column_name in query_params.only)}"
+        only_ = f"{', '.join(column_name for column_name in query_params.only if check_one(column_name))}"
     elif query_params.only != "*" and isinstance(query_params.only, str):
         only_ = check_one(query_params.only)  # type: ignore
 

{sqlite_database-0.7.9 → sqlite_database-0.7.11/sqlite_database.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: sqlite_database
-Version: 0.7.9
-Summary: A weird wrapper for SQLite Connection
+Version: 0.7.11
+Summary: Easy to use SQLite wrapper
 Home-page: https://github.com/RimuEirnarn/sqlite_database
 Author: RimuEirnarn
 Author-email: Rimu Eirnarn <rimuru720@proton.me>
@@ -50,7 +50,7 @@ Dynamic: license-file
 
 </div>
 
-SQLite Database is a weird wrapper for SQLite Connection. It's intended to be easy to use and simple.
+SQLite Database is an easy and simple way to use SQLite, almost as easy as using Laravel Eloquent ORM.
 
 > [!WARNING]
 > This project as per version number (<1.0) is not either efficient (in term of memory usage) and fast. If you found a serious problem, please let us know.
@@ -67,7 +67,7 @@ From previous versions, installations can be done using `pip install https://git
 
 ## Features
 
-Feature overview can be found in [Features.md](https://github.com/RimuEirnarn/sqlite_database/blob/main/Features.md)
+Feature overview can be found in [Features.md](https://github.com/RimuEirnarn/sqlite_database/blob/main/docs/SimpleGuide.md)
 
 It's still recommended to see the [short docs](https://sqlite-database.rtfd.io/)
 
@@ -81,9 +81,11 @@ You can submit any issue if you found a good issue. You can submit a pull reques
 
 ## Development
 
-When pulling this repository with latest commit, make sure to install all `dev-requirements.txt` depending on your intentions. It's mostly pylint and pytest.
+Thanks for considering in contributing to sqlite_database!
 
-When using `pytest`, do this: `pytest --config-file=./dev-config/pytest.ini` or check any check scripts in `bin/`
+For development kits, you only need `pytest` and `pylint`, `sphinx` is required for documentation. Please refer to their own `dev-requirements.txt` and `docs-requirements.txt`
+
+When using `pytest`, do this: `pytest --config-file=./dev-config/pytest.ini` or check any check scripts in `bin/` (e.g `bin/check.sh`)
 
 ### How to install?
 

{sqlite_database-0.7.9 → sqlite_database-0.7.11}/sqlite_database.egg-info/SOURCES.txt

@@ -1,11 +1,9 @@
 .editorconfig
 .gitignore
 .readthedocs.yaml
-Features.md
 History.md
 LICENSE
 README.md
-SimpleGuide.md
 TODO.md
 dev-requirements.txt
 docs-requirements.txt
@@ -32,6 +30,7 @@ bin/need-installed/pre-commit
 dev-config/black.toml
 dev-config/pylint.toml
 dev-config/pytest.ini
+docs/DatabaseModes.md
 docs/Makefile
 docs/ModelAPI.md
 docs/SimpleGuide.md
@@ -52,14 +51,24 @@ docs/sqlite_database.model.errors.rst
 docs/sqlite_database.model.helpers.rst
 docs/sqlite_database.model.query_builder.rst
 docs/sqlite_database.model.rst
+docs/sqlite_database.models.errors.rst
+docs/sqlite_database.models.helpers.rst
+docs/sqlite_database.models.mixin.rst
+docs/sqlite_database.models.query_builder.rst
+docs/sqlite_database.models.rst
+docs/sqlite_database.models.type_checkers.rst
 docs/sqlite_database.operators.rst
 docs/sqlite_database.query_builder.rst
 docs/sqlite_database.rst
 docs/sqlite_database.signature.rst
 docs/sqlite_database.subexp.rst
+docs/sqlite_database.subquery.rst
 docs/sqlite_database.table.rst
 docs/sqlite_database.typings.rst
 docs/sqlite_database.utils.rst
+docs/sqlite_database.workers.connection.rst
+docs/sqlite_database.workers.database.rst
+docs/sqlite_database.workers.rst
 sqlite_database/__init__.py
 sqlite_database/_debug.py
 sqlite_database/_utils.py