PYTHON-3376/PYTHON-3378 Update FAQ about OverflowError when decoding out of range datetimes #1025
Conversation
bcwarner
requested review from
blink1073,
juliusgeo and
ShaneHarvey
as code owners
doc/faq.rst
Outdated
| the default behavior and | ||
| :attr:`~bson.datetime_ms.DatetimeConversionOpts.DATETIME_MS`, returning | ||
| :class:`~datetime.datetime`s when possible, and | ||
| :class:`~bson.datetime_ms.DatetimeMS` when representations are out-of-range. |
There was a problem hiding this comment.
Rather than duplicating the behavior of each DatetimeConversionOpts, what if we just suggest using DATETIME_AUTO and then link to the DatetimeConversionOpts example page for the rest?
|
There's a broken link to Edit: fixed |
doc/faq.rst
Outdated
| @@ -502,6 +518,7 @@ just that field:: | |||
|
|
|||
| >>> cur = coll.find({}, projection={'dt': False}) | |||
|
|
|||
|
|
|||
|
Started making edits to |
bcwarner
changed the title
doc/faq.rst
Outdated
| For other options, please refer to | ||
| :class:`~bson.codec_options.DatetimeConversionOpts`. | ||
|
|
||
| If we need to use the default decoding behavior with datetimes not supported by |
There was a problem hiding this comment.
I'd suggest changing from "If we need to use the default decoding behavior ... filter out documents ..." -> "Another option that does not involve setting datetime_conversion is to to filter out documents ..."
doc/examples/datetimes.rst
Outdated
| >>> decode(x, codec_options=codec_clamp) | ||
| {'x': datetime.datetime(1970, 1, 1, 0, 0)} | ||
| >>> decode(x, codec_options=codec_clamp) | ||
| {'x': DatetimeMS(-2**62)} |
There was a problem hiding this comment.
Should be datetime.datetime(1, 1, 1, 0, 0) (min)?
ShaneHarvey
changed the title
|
FYI you can run the doctests locally by running |
Added to the FAQ, and tweaked another doc. Will have to be tweaked again after renaming
DatetimeConversionOpts.