Merge pull request #54 from hj24/master

feat-json-field-add-ensure-ascii-choice

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
 
+## [1.2.3] - 2021-04-21
+
+- ensure_ascii is provided in JSONCharField to support storing Chinese in non-ascii way
+
 ## [1.1.0] - 2019-02-15
 
 ### added

peeweext/__init__.py

@@ -1 +1 @@
-__version__ = '1.2.2'
+__version__ = '1.2.3'

peeweext/fields.py

@@ -36,10 +36,14 @@ def db_value(self, value):
 
 
 class JSONCharField(pw.CharField):
+    def __init__(self, ensure_ascii=True, *args, **kwargs):
+        self.ensure_ascii = ensure_ascii
+        super(JSONCharField, self).__init__(*args, **kwargs)
+
     def db_value(self, value):
         if value is None:
             return value
-        data = json.dumps(value)
+        data = json.dumps(value, ensure_ascii=self.ensure_ascii)
         if len(data) > self.max_length:
             raise ValueError('Data too long for field {}.'.format(self.name))
         return data

test-requirements.txt

@@ -7,5 +7,5 @@ codeclimate-test-reporter
 coverage
 flask
 sea
-psycopg2
+psycopg2-binary
 mysqlclient

tests/test_model.py

@@ -5,6 +5,7 @@
 import datetime
 from io import StringIO
 import inspect
+import json
 
 from peeweext.fields import JSONCharField
 from peeweext import validation as val
@@ -51,12 +52,14 @@ class Category(pwdb.Model):
     id = peewee.AutoField()
     content = JSONCharField(max_length=128, default={})
     remark = JSONCharField(max_length=128, null=True)
+    title = JSONCharField(max_length=128, null=True, ensure_ascii=False)
 
 
 class MyCategory(pwmysql.Model):
     id = peewee.AutoField()
     content = JSONCharField(max_length=128, default={})
     remark = JSONCharField(max_length=128, null=True)
+    title = JSONCharField(max_length=128, null=True, ensure_ascii=False)
 
 
 class MyNotebook(pwmysql.Model):
@@ -281,6 +284,20 @@ def json_field_test(CategoryModel):
     with pytest.raises(ValueError) as exc:
         CategoryModel.create(content=list(range(10000)))
         assert exc.args[0] == 'Data too long for field content.'
+
+    # Create normal-length Chinese, but an error will be reported when ensure_ascii = True
+    with pytest.raises(ValueError) as exc:
+        items = ["测" * 100]
+        assert len(json.dumps(items)) > 128
+        assert len(json.dumps(items, ensure_ascii=False)) < 128
+
+        # ensure_ascii = True, create failed
+        category = CategoryModel.create(content=items)
+        assert exc.args[0] == 'Data too long for field content.'
+
+        # ensure_ascii = False, create successfully
+        CategoryModel.create(title=items)
+        assert category.title == ["测" * 100]
 
     # Update by save
     category.content = [1, 2]