Added a get_param_as_datetime() method to fetch query param as datetime #1053
Conversation
kgritesh
force-pushed
the
feature_add_param_as_datetime
branch
from
8833f94
to
dd4e778
Compare
Codecov Report
@@ Coverage Diff @@
## master #1053 +/- ##
======================================
Coverage 100% 100%
======================================
Files 37 37
Lines 2173 2181 +8
Branches 309 311 +2
======================================
+ Hits 2173 2181 +8
Continue to review full report at Codecov.
|
falcon/request.py
Outdated
|
|
||
| Args: | ||
| name (str): Parameter name, case-sensitive (e.g., 'ids'). | ||
|
|
||
| Keyword Args: | ||
| format_string (str): String used to parse the param value | ||
| into a date. Any format recognized by strptime() is | ||
| into a datetime. Any format recognized by strptime() is | ||
| supported (default ``"%Y-%m-%d"``). |
There was a problem hiding this comment.
This default string needs to be updated.
| req = resource.captured_req | ||
| store = {} | ||
| req.get_param_as_datetime('thedate', store=store) | ||
| assert len(store) != 0 |
There was a problem hiding this comment.
Just to be safe, I think it would make sense to also check the value that was added to store.
… param as datetime
kgritesh
force-pushed
the
feature_add_param_as_datetime
branch
from
1943044
to
1f29344
Compare
|
@kgriffs fixed as per your review. Pls have a look |
falcon/request.py
Outdated
| def get_param_as_date(self, name, format_string='%Y-%m-%d', | ||
| required=False, store=None): | ||
| """Return the value of a query string parameter as a date. | ||
| def get_param_as_datetime(self, name, format_string='%Y-%m-%dT%H:%M:%S', |
There was a problem hiding this comment.
Upon further reflection, I think it may be better to require the Z UTC timezone designator (i.e., %Y-%m-%dT%H:%M:%SZ) in the default format. The above format string implies ISO 8601, in which case the absence of a time zone designator would indicate local time, which is ambiguous and therefore something that we should not encourage.
Solution to #1007.