api 使用 flask restplus 记录的特定时间格式

Question

我有一个 api，它在请求正文中接受 start_time、end_time 和一个布尔值 closed_all_day。

from flask_restplus import Namespace, fields

timings = api.model('open times', {
     'start_time': fields.String(required=True, description='Time in 24 hour HH:MM format, defaulted to 00:00 if closed_all_day'),
     'end_time': fields.String(required=True, description='Time in 24 hour HH:MM format, defaulted to 00:00 if closed_all_day'),
     'closed_all_day': fields.Boolean(required=True, description='If True overwrites start_time and end_time')
})

start_time 和 end_time 的格式为 HH:MM（24 小时格式）

如果我使用

fields.Date

或

fields.DateTime

然后我得到了完整的ISO日期格式，这也不是我想要的。

有没有办法将输入限制为 HH:MM 格式？

Answer 1

方法是这样的：

from datetime import time


class TimeFormat(fields.Raw):
    def format(self, value):
        return time.strftime(value, "%H:%M")

timings = Model('timings', {
    'start_time': TimeFormat(readonly=True, description='Time in HH:MM', default='HH:MM'),
    'end_time': TimeFormat(readonly=True, description='Time in HH:MM', default='HH:MM'),
    'closed_all_day': fields.Boolean(readOnly=True, description='True or False', default=False)
})

Answer 2

我最终在其他 DateTime 和 Date classes

的启发下创建了自己的 Time class

class Time(Raw):
    """
    Return a formatted time string in %H:%M.
    """

    __schema_type__ = "string"
    __schema_format__ = "time"


    def __init__(self, time_format="%H:%M", **kwargs):
        super(Time, self).__init__(**kwargs)
        self.time_format = time_format


    def format(self, value):
        try:
            value = self.parse(value)
            if self.time_format == "iso":
                return value.isoformat()
            elif self.time_format:
                return value.strftime(self.time_format)
            else:
                raise MarshallingError("Unsupported time format %s" % self.time_format)
        except (AttributeError, ValueError) as e:
            raise MarshallingError(e)

    def parse(self, value):
        if isinstance(value, time):
            return value
        if isinstance(value, str):
            return time.fromisoformat(value)
        else:
            raise ValueError("Unsupported Time format")

api 使用 flask restplus 记录的特定时间格式

specific time format for api documenting using flask restplus

python

swagger

flask-restplus