bplan/serializer: add binary=True to point JSONField

[goapunk]

bplan/serializer: add binary=True to point JSONField as we receive a string containing (geo)json, not actual json. This came up during testing.

Tasks

• PR name contains story or task reference
• Steps to recreate and test the changes
• Documentation (docs and inline)
• Tests (including n+1 and django_assert_num_queries where applicable)
• Changelog

[m4ra]

so point can be sent as bytestring? see my comment.

[m4ra]

with the binary=True now, I assume, this can be a bytestring? Can you add this info here, in a changelog, and a test case?

[goapunk]

@m4ra I'm not entirely sure what you mean by bytestring in this context? The documentation for binary=true is:

binary - If set to True then the field will output and validate a JSON encoded string, rather than a primitive data structure. Defaults to False.

which doesn't mention bytestrings. Maybe you have an example?

Regarding changelog: the point field is new and unreleased, so not sure what to put in the changelog for it other than what's already there in the original PR

[m4ra]

From docs again, the whole JSONFiled says:

JSONField

A field class that validates that the incoming data structure consists of valid JSON primitives. In its alternate binary mode, it will represent and validate JSON-encoded binary strings.

Signature: JSONField(binary, encoder)

binary - If set to True then the field will output and validate a JSON encoded string, rather than a primitive data structure. Defaults to False.

I understand when binary is True it can accept binary strings, misspelled it before with bytestrings.

[goapunk]

Ok, I did some testing: with binary=False it accepts actual json values (python dicts) but rejects a string (2nd example)

input = {"type":"Feature", "geometry":{"type":"Point","coordinates":[13.397788148643649,52.52958586909979]}}

whereas with binary=True it accepts a string containing json but rejects the example above:

input = '{"type":"Feature", "geometry":{"type":"Point","coordinates":[13.397788148643649,52.52958586909979]}}'

So unless I'm missing something it behaves as written in our bplan api docs, right?

[m4ra]

great, thanks for clarifying it!