datetime_ms
– Support for BSON UTC Datetime¶
Tools for representing the BSON datetime type.
Added in version 4.3.
- class bson.datetime_ms.DatetimeMS(value)¶
Represents a BSON UTC datetime.
BSON UTC datetimes are defined as an int64 of milliseconds since the Unix epoch. The principal use of DatetimeMS is to represent datetimes outside the range of the Python builtin
datetime
class when encoding/decoding BSON.To decode UTC datetimes as a
DatetimeMS
, datetime_conversion inCodecOptions
must be set to ‘datetime_ms’ or ‘datetime_auto’. See Handling out of range datetimes for details.- Parameters:
value (Union[int, datetime.datetime]) – An instance of
datetime.datetime
to be represented as milliseconds since the Unix epoch, or int of milliseconds since the Unix epoch.
- as_datetime(codec_options=(<class 'dict'>, False, 0, 'strict', None, TypeRegistry(type_codecs=[], fallback_encoder=None), DatetimeConversion.DATETIME))¶
Create a Python
datetime
from this DatetimeMS object.- Parameters:
codec_options (CodecOptions[Any]) – A CodecOptions instance for specifying how the resulting DatetimeMS object will be formatted using
tz_aware
andtz_info
. Defaults toDEFAULT_CODEC_OPTIONS
.- Return type: