CODEWITHSUNDEEP
pythonjsondatedatetimeflask
nessus_pp
nessus_pp

Reputation: 1069

Keep a datetime.date in 'yyyy-mm-dd' format when using Flask's jsonify

For some reason, the jsonify function is converting my datetime.date to what appears to be an HTTP date. How can I keep the date in yyyy-mm-dd format when using jsonify?

test_date = datetime.date(2017, 4, 27)
print(test_date)  # 2017-04-27
test_date_jsonify = jsonify(test_date)
print(test_date_jsonify.get_data(as_text=True))  # Thu, 27 Apr 2017 00:00:00 GMT

As suggested in the comments, using jsonify(str(test_date)) returns the desired format. However, consider the following case:

test_dict = {"name": "name1", "date":datetime.date(2017, 4, 27)}
print(test_dict) # {"name": "name1", "date":datetime.date(2017, 4, 27)}

test_dict_jsonify = jsonify(test_dict)
print(test_dict_jsonify.get_data(as_text=True)) # {"date": "Thu, 27 Apr 2017 00:00:00 GMT", "name": "name1"}

test_dict_jsonify = jsonify(str(test_dict))
print(test_dict_jsonify.get_data(as_text=True)) # "{"date": datetime.date(2017, 4, 27), "name": "name1"}"

In this case, the str() solution does not work.

Upvotes: 46

Views: 25836

Answers (5)

Python coder
Python coder

Reputation: 1

So, if your problem is only with date, time and datetime, this could be solved very easily by using this (code change is minimal this way):

app.json.default = lambda obj: obj.isoformat() if isinstance(obj, (date, time, datetime)) else None

If you need more control over serialization (e.g., handling custom objects, enums, or special types) or you want to extend Flask’s JSON behavior rather than just override app.json.default or more importantly, you prefer structuring your code for reusability in larger applications, you can use a CustomJSONProvider to override the current default provider.

from datetime import date, datetime, time
from flask.json.provider import DefaultJSONProvider

class CustomJSONProvider(DefaultJSONProvider):
    def default(self, obj):
        try:
            if isinstance(obj, (date, time, datetime)):
                return obj.isoformat()
            iterable = iter(obj)
        except TypeError:
            pass
        else:
            return list(iterable)
        return super().default(obj)

app = Flask(__name__)
app.json_provider_class = CustomJSONProvider
app.json = CustomJSONProvider(app)

Hope this is helpful! Found that the JSONEncoder is deprecated after Flask 2.3 and finally found this solution phew.

Upvotes: 0

mechanical_meat
mechanical_meat

Reputation: 169474

edit: this answer is now too old for Flask versions 2.3+.

for those newer versions, instead customize json_provider_class; reference: https://flask.palletsprojects.com/en/2.2.x/api/?highlight=json_encoder#flask.Flask.json_provider_class

Following this snippet you can do this:

from flask.json import JSONEncoder
from datetime import date


class CustomJSONEncoder(JSONEncoder):
    def default(self, obj):
        try:
            if isinstance(obj, date):
                return obj.isoformat()
            iterable = iter(obj)
        except TypeError:
            pass
        else:
            return list(iterable)
        return JSONEncoder.default(self, obj)

app = Flask(__name__)
app.json_encoder = CustomJSONEncoder

Route:

import datetime as dt

@app.route('/', methods=['GET'])
def index():
    now = dt.datetime.now()
    return jsonify({'now': now})

Upvotes: 64

Sobigen
Sobigen

Reputation: 2179

Flask 2.2 shows a deprecation warning

'JSONEncoder' is deprecated and will be removed in Flask 2.3. Use 'Flask.json' to provide an alternate JSON implementation instead.

An update is needed to remove it and/or have it work in Flask 2.3+. Another example from the Flask repository here

from datetime import datetime, date

from flask import Flask
from flask.json.provider import DefaultJSONProvider

class UpdatedJSONProvider(DefaultJSONProvider):
    def default(self, o):
        if isinstance(o, date) or isinstance(o, datetime):
            return o.isoformat()
        return super().default(o)

app = Flask(__name__)
app.json = UpdatedJSONProvider(app)

Upvotes: 18

davidism
davidism

Reputation: 127370

datetime.date is not a JSON type, so it's not serializable by default. Instead, Flask adds a hook to dump the date to a string in RFC 1123 format, which is consistent with dates in other parts of HTTP requests and responses.

Use a custom JSON encoder if you want to change the format. Subclass JSONEncoder and set Flask.json_encoder to it.

from flask import Flask
from flask.json import JSONEncoder

class MyJSONEncoder(JSONEncoder):
    def default(self, o):
        if isinstance(o, date):
            return o.isoformat()

        return super().default(o)

class MyFlask(Flask):
    json_encoder = MyJSONEncoder

app = MyFlask(__name__)

It is a good idea to use ISO 8601 to transmit and store the value. It can be parsed unambiguously by JavaScript Date.parse (and other parsers). Choose the output format when you output, not when you store.

A string representing an RFC 2822 or ISO 8601 date (other formats may be used, but results may be unexpected).

When you load the data, there's no way to know the value was meant to be a date instead of a string (since date is not a JSON type), so you don't get a datetime.date back, you get a string. (And if you did get a date, how would it know to return date instead of datetime?)

Upvotes: 26

9000
9000

Reputation: 40894

You can change your app's .json_encoder attribute, implementing a variant of JSONEncoder that formats dates as you see fit.

Upvotes: 1

Related Questions