Struct PyDateTime

#[repr(transparent)]
pub struct PyDateTime(PyAny);

Available on non-Py_LIMITED_API only.

Bindings for datetime.datetime.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyDateTime> or Bound<'py, PyDateTime>.

Tuple Fields

0: PyAny

Implementations

impl PyDateTime

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

impl PyDateTime

pub fn new<'py>( py: Python<'py>, year: i32, month: u8, day: u8, hour: u8, minute: u8, second: u8, microsecond: u32, tzinfo: Option<&Bound<'py, PyTzInfo>>, ) -> PyResult<Bound<'py, PyDateTime>>

Creates a new datetime.datetime object.

pub fn new_bound<'py>( py: Python<'py>, year: i32, month: u8, day: u8, hour: u8, minute: u8, second: u8, microsecond: u32, tzinfo: Option<&Bound<'py, PyTzInfo>>, ) -> PyResult<Bound<'py, PyDateTime>>

👎Deprecated since 0.23.0: renamed to PyDateTime::new

Deprecated name for PyDateTime::new.

pub fn new_with_fold<'py>( py: Python<'py>, year: i32, month: u8, day: u8, hour: u8, minute: u8, second: u8, microsecond: u32, tzinfo: Option<&Bound<'py, PyTzInfo>>, fold: bool, ) -> PyResult<Bound<'py, PyDateTime>>

Alternate constructor that takes a fold parameter. A true value for this parameter signifies this this datetime is the later of two moments with the same representation, during a repeated interval.

This typically occurs at the end of daylight savings time. Only valid if the represented time is ambiguous. See PEP 495 for more detail.

pub fn new_bound_with_fold<'py>( py: Python<'py>, year: i32, month: u8, day: u8, hour: u8, minute: u8, second: u8, microsecond: u32, tzinfo: Option<&Bound<'py, PyTzInfo>>, fold: bool, ) -> PyResult<Bound<'py, PyDateTime>>

👎Deprecated since 0.23.0: renamed to PyDateTime::new_with_fold

Deprecated name for PyDateTime::new_with_fold.

pub fn from_timestamp<'py>( py: Python<'py>, timestamp: f64, tzinfo: Option<&Bound<'py, PyTzInfo>>, ) -> PyResult<Bound<'py, PyDateTime>>

Construct a datetime object from a POSIX timestamp

This is equivalent to datetime.datetime.fromtimestamp

pub fn from_timestamp_bound<'py>( py: Python<'py>, timestamp: f64, tzinfo: Option<&Bound<'py, PyTzInfo>>, ) -> PyResult<Bound<'py, PyDateTime>>

👎Deprecated since 0.23.0: renamed to PyDateTime::from_timestamp

Deprecated name for PyDateTime::from_timestamp.

Methods from Deref<Target = PyAny>

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

Trait Implementations

impl AsRef<PyAny> for PyDateTime

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for PyDateTime

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyClassBaseType for PyDateTime

type LayoutAsBase = PyClassObjectBase<PyDateTime_DateTime>

type BaseNativeType = PyDateTime

type Initializer = PyNativeTypeInitializer<PyDateTime>

type PyClassMutability = ImmutableClass

impl PyTypeInfo for PyDateTime

const NAME: &'static str = "PyDateTime"

Class name.

const MODULE: Option<&'static str> = _

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PyDateTime

impl PyLayout<PyDateTime> for PyDateTime_DateTime

impl PySizedLayout<PyDateTime> for PyDateTime_DateTime