tinykv 0.2.0__tar.gz → 0.3.0__tar.gz

{tinykv-0.2.0 → tinykv-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: tinykv
-Version: 0.2.0
+Version: 0.3.0
 Summary: A lightweight Python SQLite key-value store built on sqlite3.
 Keywords: python,sqlite,sqlite3,key-value store,kv
 Author-email: Flavio Veloso Soares <flaviovs@magnux.com>
@@ -11,21 +11,10 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Database
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 License-File: LICENSE
-Requires-Dist: codespell ; extra == "dev"
-Requires-Dist: flake8-bugbear ; extra == "dev"
-Requires-Dist: flake8-builtins ; extra == "dev"
-Requires-Dist: flake8-docstrings ; extra == "dev"
-Requires-Dist: flake8-tidy-imports ; extra == "dev"
-Requires-Dist: flake8-walrus ; extra == "dev"
-Requires-Dist: flake8 ; extra == "dev"
-Requires-Dist: flit ; extra == "dev"
-Requires-Dist: mypy ; extra == "dev"
-Requires-Dist: pylint ; extra == "dev"
-Requires-Dist: taskipy ; extra == "dev"
 Project-URL: Homepage, https://github.com/flaviovs/tinykv
 Project-URL: Issues, https://github.com/flaviovs/tinykv/issues
 Project-URL: Repository, https://github.com/flaviovs/tinykv
-Provides-Extra: dev
+Import-Name: tinykv
 
 TinyKV: Python SQLite key-value store
 =====================================
@@ -93,13 +82,10 @@ Let’s try again:
 
 Now it works!
 
-By default, TinyKV currently allows pickle-based value
-serialization/deserialization for compatibility.
-If `allow_pickle` is omitted, TinyKV currently behaves as if
-`allow_pickle=True` and emits a `FutureWarning`.
-Applications should not rely on this behavior and should explicitly set
-`allow_pickle=False` when handling databases that might be untrusted.
-The default is expected to change to `False` in a future release.
+By default, TinyKV does not allow pickle-based value
+serialization/deserialization. Applications must explicitly pass
+`allow_pickle=True` to enable it, and should do so only when handling trusted
+database contents.
 
 
 ## Storing and retrieving data
@@ -153,7 +139,7 @@ Same for container objects:
     ['one', 'two', 'three']
 
 In fact, you can store any pickable object when
-`allow_pickle=True` (the current default):
+`allow_pickle=True`:
 
     >>> import datetime
     >>>
@@ -167,7 +153,8 @@ In fact, you can store any pickable object when
     >>> type(a_long_time_ago)
     <class 'datetime.datetime'>
 
-For safer behavior with untrusted database contents, disable pickle:
+Pickle is disabled by default for safer behavior with untrusted database
+contents:
 
     >>> safe_kv = tinykv.TinyKV(conn, allow_pickle=False)
 
@@ -255,6 +242,10 @@ TinyKV requires the database table to exist before use. Create it with
     >>> conn = sqlite3.connect(':memory:')
     >>> tinykv.create_schema(conn)
 
+If you need idempotent setup, pass `if_not_exists=True`:
+
+    >>> tinykv.create_schema(conn, if_not_exists=True)
+
 You can use a custom table name:
 
     >>> tinykv.create_schema(conn, table='my_keys')
@@ -280,6 +271,9 @@ Miscellaneous
   `TypeError`, and empty strings raise `ValueError`. Keys are case-sensitive
   (since v0.1.4).
 
+- Keys with the format `__tinykv_XXXXX__` are reserved for TinyKV internal
+  use.
+
 - TinyKV does not open or manage transactions. Also, it operates both
   in autocommit and non-autocommit mode. All operations are atomic.
 
@@ -306,8 +300,10 @@ Miscellaneous
         ...     allow_pickle=True,
         ... )
 
-  Table names must match the pattern `[a-zA-Z_][a-zA-Z0-9_]*`. Invalid
-  names raise `ValueError`.
+  Table names must match the pattern
+  `[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z_][a-zA-Z0-9_]*)?`. The optional prefix
+  selects an attached SQLite database, for example `archive.kv`. Each
+  identifier is quoted separately. Invalid names raise `ValueError`.
 
 
 Questions? Bugs? Suggestions?

{tinykv-0.2.0 → tinykv-0.3.0}/README.md

@@ -64,13 +64,10 @@ Let’s try again:
 
 Now it works!
 
-By default, TinyKV currently allows pickle-based value
-serialization/deserialization for compatibility.
-If `allow_pickle` is omitted, TinyKV currently behaves as if
-`allow_pickle=True` and emits a `FutureWarning`.
-Applications should not rely on this behavior and should explicitly set
-`allow_pickle=False` when handling databases that might be untrusted.
-The default is expected to change to `False` in a future release.
+By default, TinyKV does not allow pickle-based value
+serialization/deserialization. Applications must explicitly pass
+`allow_pickle=True` to enable it, and should do so only when handling trusted
+database contents.
 
 
 ## Storing and retrieving data
@@ -124,7 +121,7 @@ Same for container objects:
     ['one', 'two', 'three']
 
 In fact, you can store any pickable object when
-`allow_pickle=True` (the current default):
+`allow_pickle=True`:
 
     >>> import datetime
     >>>
@@ -138,7 +135,8 @@ In fact, you can store any pickable object when
     >>> type(a_long_time_ago)
     <class 'datetime.datetime'>
 
-For safer behavior with untrusted database contents, disable pickle:
+Pickle is disabled by default for safer behavior with untrusted database
+contents:
 
     >>> safe_kv = tinykv.TinyKV(conn, allow_pickle=False)
 
@@ -226,6 +224,10 @@ TinyKV requires the database table to exist before use. Create it with
     >>> conn = sqlite3.connect(':memory:')
     >>> tinykv.create_schema(conn)
 
+If you need idempotent setup, pass `if_not_exists=True`:
+
+    >>> tinykv.create_schema(conn, if_not_exists=True)
+
 You can use a custom table name:
 
     >>> tinykv.create_schema(conn, table='my_keys')
@@ -251,6 +253,9 @@ Miscellaneous
   `TypeError`, and empty strings raise `ValueError`. Keys are case-sensitive
   (since v0.1.4).
 
+- Keys with the format `__tinykv_XXXXX__` are reserved for TinyKV internal
+  use.
+
 - TinyKV does not open or manage transactions. Also, it operates both
   in autocommit and non-autocommit mode. All operations are atomic.
 
@@ -277,8 +282,10 @@ Miscellaneous
         ...     allow_pickle=True,
         ... )
 
-  Table names must match the pattern `[a-zA-Z_][a-zA-Z0-9_]*`. Invalid
-  names raise `ValueError`.
+  Table names must match the pattern
+  `[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z_][a-zA-Z0-9_]*)?`. The optional prefix
+  selects an attached SQLite database, for example `archive.kv`. Each
+  identifier is quoted separately. Invalid names raise `ValueError`.
 
 
 Questions? Bugs? Suggestions?

tinykv-0.3.0/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "tinykv"
+authors = [{name = "Flavio Veloso Soares", email = "flaviovs@magnux.com"}]
+license = {file = "LICENSE"}
+readme = "README.md"
+keywords = ["python", "sqlite", "sqlite3", "key-value store", "kv"]
+classifiers = [
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Topic :: Database",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.11"
+
+dynamic = ["version", "description"]
+
+[project.urls]
+Homepage = "https://github.com/flaviovs/tinykv"
+Repository = "https://github.com/flaviovs/tinykv"
+Issues = "https://github.com/flaviovs/tinykv/issues"
+
+[dependency-groups]
+dev = [
+  'ruff',
+  'flit',
+  'mypy',
+]
+
+[tool.mypy]
+files = "."
+python_version = "3.11"
+exclude = [".git", ".venv"]
+strict = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unreachable = true
+pretty = true
+
+[tool.ruff]
+line-length = 79
+include = ["**/*.py"]
+
+[tool.ruff.format]
+skip-magic-trailing-comma = false
+
+[tool.ruff.lint]
+extend-select = ["PLC0415"]
+external = ["V107"]
+select = [
+  "E", "F", "I", "B", "UP", "SIM", "RET", "ARG", "RUF", "PTH", "C4", "PIE", "D",
+  "TRY", "ERA", "ANN",
+]
+ignore = ["TRY003", "COM812"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["D"]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+known-first-party = ["traderworkbench"]
+
+[tool.ruff.lint.pydocstyle]
+# Explicitly enforce Google-style docstrings instead of PEP 257 standard.
+convention = "google"