Merge branch 'release/3.6.4'

release 3.6.4 ascii encoded string field

Author: mgoldman-globality

.bumpversion.cfg

@@ -1,9 +1,8 @@
 [bumpversion]
-current_version = 3.6.3
+current_version = 3.6.4
 commit = False
 tag = False
 
 [bumpversion:file:setup.py]
 search = version = "{current_version}"
 replace = version = "{new_version}"
-

entrypoint.sh

@@ -31,6 +31,8 @@ elif [ "$1" = "lint" ]; then
    flake8 ${NAME}
 elif [ "$1" = "typehinting" ]; then
    # Install standard type-linting dependencies
+   pip install types-python-dateutil
+   pip install types-setuptools
    pip --quiet install mypy
    mypy ${NAME} --ignore-missing-imports
 else

microcosm_flask/fields/__init__.py

@@ -2,6 +2,7 @@
 Custom fields.
 
 """
+from microcosm_flask.fields.ascii_encoded_string_field import AsciiEncodedStringField  # noqa: F401
 from microcosm_flask.fields.enum_field import EnumField  # noqa: F401
 from microcosm_flask.fields.language_field import LanguageField  # noqa: F401
 from microcosm_flask.fields.query_string_list import QueryStringList  # noqa: F401

microcosm_flask/fields/ascii_encoded_string_field.py

@@ -0,0 +1,16 @@
+from marshmallow import fields
+
+
+"""
+AsciiEncodedStringField Marshmallow field
+An extension of the marshmallow fields.String that removes unicode
+characters on deserialization
+"""
+
+
+class AsciiEncodedStringField(fields.String):
+    def _deserialize(self, value, *args, **kwargs):
+        if value is not None:
+            value_encoded = value.encode("ascii", "ignore")
+            value = value_encoded.decode()
+        return super()._deserialize(value, *args, **kwargs)

microcosm_flask/swagger/parameters/default.py

@@ -6,7 +6,7 @@
 from marshmallow.fields import Field
 from microcosm_logging.decorators import logger
 
-from microcosm_flask.fields import LanguageField, URIField
+from microcosm_flask.fields import AsciiEncodedStringField, LanguageField, URIField
 from microcosm_flask.swagger.parameters.base import ParameterBuilder
 
 
@@ -16,6 +16,7 @@
 FIELD_MAPPINGS = {
     LanguageField: FieldInfo("string", "language"),
     URIField: FieldInfo("string", "uri"),
+    AsciiEncodedStringField: FieldInfo("string", "ascii-encoded-string"),
     fields.Boolean: FieldInfo("boolean", None),
     fields.Date: FieldInfo("string", "date"),
     fields.DateTime: FieldInfo("string", "date-time"),

microcosm_flask/tests/fields/test_ascii_string.py

@@ -0,0 +1,28 @@
+"""
+Test language field.
+
+"""
+from hamcrest import assert_that, equal_to, is_
+from marshmallow import Schema
+
+from microcosm_flask.fields import AsciiEncodedStringField
+
+
+class AsciiStringSchema(Schema):
+    str = AsciiEncodedStringField(required=True)
+
+
+comment_text_unicode = "A nice \u0420\u043e\u0441\u0441\u0438\u044fcomment"
+comment_text_cleaned = "A nice comment"
+
+
+def test_load():
+    schema = AsciiStringSchema()
+
+    result = schema.load(dict(
+        str=comment_text_unicode,
+    ))
+    assert_that(
+        result["str"],
+        is_(equal_to(comment_text_cleaned)),
+    )

setup.py

@@ -3,7 +3,7 @@
 
 
 project = "microcosm-flask"
-version = "3.6.3"
+version = "3.6.4"
 
 
 setup(
@@ -21,6 +21,7 @@
     python_requires=">=3.6",
     keywords="microcosm",
     install_requires=[
+        "Flask<2",
         "Flask>=1.0.2",
         "Flask-BasicAuth>=0.2.0",
         "Flask-Cors>=3.0.7",