enpaul/peewee-plus
1
0
Fork 0
mirror of https://github.com/enpaul/peewee-plus.git synced 2024-11-15 02:56:53 +00:00
Code Issues Projects Releases Wiki Activity

Add documentation for sqlite module constants

Browse Source
This commit is contained in:
Ethan Paul 2021-11-24 22:52:11 -05:00
parent c042acc323
commit a753b6271a
No known key found for this signature in database
GPG Key ID: D0E2CBF1245E92BF
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
peewee_plus.py
View File

@ -1,3 +1,17 @@
"""Peewee+
:constant SQLITE_DEFAULT_VARIABLE_LIMIT: The default number of variables that a single SQL query
can contain when interfacing with SQLite. The actual
number is set at compile time and is not easily
discoverable from within Python. This default value will
be correct for the vast majority of applications.
:constant SQLITE_DEFAULT_PRAGMAS: The default pragmas that should be used when instantiating an
SQLite database connection. The value for this constant is taken
directly from the `Peewee documentation`_
.. _`Peewee documentation`: http://docs.peewee-orm.com/en/latest/peewee/database.html#recommended-settings
"""
import enum import enum
import json import json
from pathlib import Path from pathlib import Path
@ -163,13 +177,11 @@ class PathField(peewee.CharField):
self.relative_to = relative_to self.relative_to = relative_to
def db_value(self, value: Path) -> str: def db_value(self, value: Path) -> str:
"""Serialize a :class:`pathlib.Path` to a database string"""
if value.is_absolute() and self.relative_to: if value.is_absolute() and self.relative_to:
value = value.relative_to(self.relative_to) value = value.relative_to(self.relative_to)
return super().db_value(value) return super().db_value(value)
def python_value(self, value: str) -> Path: def python_value(self, value: str) -> Path:
"""Serialize a database string to a :class:`pathlib.path` object"""
return ( return (
self.relative_to / Path(super().python_value(value)) self.relative_to / Path(super().python_value(value))
if self.relative_to if self.relative_to
@ -246,7 +258,6 @@ class JSONField(peewee.TextField):
self.load_params = load_params or dict() self.load_params = load_params or dict()
def db_value(self, value: Any) -> str: def db_value(self, value: Any) -> str:
"""Convert the python value to the corresponding value to store in the database"""
try: try:
return super().db_value(json.dumps(value, **self.dump_params)) return super().db_value(json.dumps(value, **self.dump_params))
except TypeError as err: except TypeError as err:
@ -255,7 +266,6 @@ class JSONField(peewee.TextField):
) from err ) from err
def python_value(self, value: str) -> Any: def python_value(self, value: str) -> Any:
"""Convert the database-stored value to the corresponding python value"""
try: try:
return json.loads(super().python_value(value), **self.load_params) return json.loads(super().python_value(value), **self.load_params)
except json.JSONDecodeError as err: except json.JSONDecodeError as err: