QDateTime#

The QDateTime class provides date and time functions. More…

Synopsis#

Functions#

def __reduce__ ()
def __repr__ ()
def addDays (days)
def addMSecs (msecs)
def addMonths (months)
def addSecs (secs)
def addYears (years)
def date ()
def daysTo (arg__1)
def isDaylightTime ()
def isNull ()
def isValid ()
def msecsTo (arg__1)
def offsetFromUtc ()
def __ne__ (rhs)
def __lt__ (rhs)
def __le__ (rhs)
def __eq__ (rhs)
def __gt__ (rhs)
def __ge__ (rhs)
def secsTo (arg__1)
def setDate (date)
def setMSecsSinceEpoch (msecs)
def setOffsetFromUtc (offsetSeconds)
def setSecsSinceEpoch (secs)
def setTime (time)
def setTimeSpec (spec)
def setTimeZone (toZone)
def swap (other)
def time ()
def timeRepresentation ()
def timeSpec ()
def timeZone ()
def timeZoneAbbreviation ()
def toLocalTime ()
def toMSecsSinceEpoch ()
def toOffsetFromUtc (offsetSeconds)
def toPython ()
def toSecsSinceEpoch ()
def toString (format[, cal=QCalendar()])
def toString ([format=Qt.TextDate])
def toString (format[, cal=QCalendar()])
def toTimeSpec (spec)
def toTimeZone (toZone)
def toUTC ()

Static functions#

def currentDateTime ()
def currentDateTime (zone)
def currentDateTimeUtc ()
def currentMSecsSinceEpoch ()
def currentSecsSinceEpoch ()
def fromMSecsSinceEpoch (msecs, timeZone)
def fromMSecsSinceEpoch (msecs, spec[, offsetFromUtc=0])
def fromMSecsSinceEpoch (msecs)
def fromSecsSinceEpoch (secs)
def fromSecsSinceEpoch (secs, spec[, offsetFromUtc=0])
def fromSecsSinceEpoch (secs, timeZone)
def fromString (string, format[, cal=QCalendar()])
def fromString (string[, format=Qt.TextDate])
def fromString (string, format[, cal=QCalendar()])
def fromString (string[, format=Qt.TextDate])
def fromString (string, format[, cal=QCalendar()])

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

A QDateTime object encodes a calendar date and a clock time (a “datetime”) in accordance with a time representation. It combines features of the QDate and QTime classes. It can read the current datetime from the system clock. It provides functions for comparing datetimes and for manipulating a datetime by adding a number of seconds, days, months, or years.

QDateTime can describe datetimes with respect to local time , to UTC , to a specified offset from UTC or to a specified time zone . Each of these time representations can be encapsulated in a suitable instance of the QTimeZone class. For example, a time zone of “Europe/Berlin” will apply the daylight-saving rules as used in Germany. In contrast, a fixed offset from UTC of +3600 seconds is one hour ahead of UTC (usually written in ISO standard notation as “UTC+01:00”), with no daylight-saving complications. When using either local time or a specified time zone, time-zone transitions (see below ) are taken into account. A QDateTime ‘s timeSpec() will tell you which of the four types of time representation is in use; its timeRepresentation() provides a full representation of that time representation, as a QTimeZone .

A QDateTime object is typically created either by giving a date and time explicitly in the constructor, or by using a static function such as currentDateTime() or fromMSecsSinceEpoch(). The date and time can be changed with setDate() and setTime() . A datetime can also be set using the setMSecsSinceEpoch() function that takes the time, in milliseconds, since the start, in UTC of the year 1970. The fromString() function returns a QDateTime , given a string and a date format used to interpret the date within the string.

currentDateTime() returns a QDateTime that expresses the current date and time with respect to a specific time representation, such as local time (its default). currentDateTimeUtc() returns a QDateTime that expresses the current date and time with respect to UTC; it is equivalent to QDateTime::currentDateTime(QTimeZone::UTC).

The date() and time() functions provide access to the date and time parts of the datetime. The same information is provided in textual format by the toString() function.

QDateTime provides a full set of operators to compare two QDateTime objects, where smaller means earlier and larger means later.

You can increment (or decrement) a datetime by a given number of milliseconds using addMSecs() , seconds using addSecs() , or days using addDays() . Similarly, you can use addMonths() and addYears() . The daysTo() function returns the number of days between two datetimes, secsTo() returns the number of seconds between two datetimes, and msecsTo() returns the number of milliseconds between two datetimes. These operations are aware of daylight-saving time (DST) and other time-zone transitions, where applicable.

Use toTimeZone() to re-express a datetime in terms of a different time representation. By passing a lightweight QTimeZone that represents local time, UTC or a fixed offset from UTC, you can convert the datetime to use the corresponding time representation; or you can pass a full time zone (whose timeSpec() is Qt::TimeZone) to use that instead.

Note

QDateTime does not account for leap seconds.

Remarks#

Note

All conversion to and from string formats is done using the C locale. For localized conversions, see QLocale .

Note

There is no year 0 in the Gregorian calendar. Dates in that year are considered invalid. The year -1 is the year “1 before Christ” or “1 before common era.” The day before 1 January 1 CE is 31 December 1 BCE.

Range of Valid Dates#

The range of values that QDateTime can represent is dependent on the internal storage implementation. QDateTime is currently stored in a qint64 as a serial msecs value encoding the date and time. This restricts the date range to about +/- 292 million years, compared to the QDate range of +/- 2 billion years. Care must be taken when creating a QDateTime with extreme values that you do not overflow the storage. The exact range of supported values varies depending on the time representation used.

Use of Timezones#

QDateTime uses the system’s time zone information to determine the current local time zone and its offset from UTC. If the system is not configured correctly or not up-to-date, QDateTime will give wrong results.

QDateTime likewise uses system-provided information to determine the offsets of other timezones from UTC. If this information is incomplete or out of date, QDateTime will give wrong results. See the QTimeZone documentation for more details.

On modern Unix systems, this means QDateTime usually has accurate information about historical transitions (including DST, see below) whenever possible. On Windows, where the system doesn’t support historical timezone data, historical accuracy is not maintained with respect to timezone transitions, notably including DST. However, building Qt with the ICU library will equipe QTimeZone with the same timezone database as is used on Unix.

Daylight-Saving Time (DST)#

QDateTime takes into account transitions between Standard Time and Daylight-Saving Time. For example, if the transition is at 2am and the clock goes forward to 3am, then there is a “missing” hour from 02:00:00 to 02:59:59.999 which QDateTime considers to be invalid. Any date arithmetic performed will take this missing hour into account and return a valid result. For example, adding one second to 01:59:59 will get 03:00:00.

For datetimes that the system time_t can represent (from 1901-12-14 to 2038-01-18 on systems with 32-bit time_t; for the full range QDateTime can represent if the type is 64-bit), the standard system APIs are used to determine local time’s offset from UTC. For datetimes not handled by these system APIs, systemTimeZone() is used. In either case, the offset information used depends on the system and may be incomplete or, for past times, historically inaccurate. In any case, for future dates, the local time zone’s offsets and DST rules may change before that date comes around.

Offsets From UTC#

Offsets from UTC are measured in seconds east of Greenwich. The moment described by a particular date and time, such as noon on a particular day, depends on the time representation used. Those with a higher offset from UTC describe an earlier moment, and those with a lower offset a later moment, by any given combination of date and time.

There is no explicit size restriction on an offset from UTC, but there is an implicit limit imposed when using the toString() and fromString() methods which use a [+|-]hh:mm format, effectively limiting the range to +/- 99 hours and 59 minutes and whole minutes only. Note that currently no time zone has an offset outside the range of ±14 hours and all known offsets are multiples of five minutes.

See also

QDate QTime QTimeZone

class PySide6.QtCore.QDateTime#

PySide6.QtCore.QDateTime(date, time)

PySide6.QtCore.QDateTime(date, time, spec[, offsetSeconds=0])

PySide6.QtCore.QDateTime(date, time, timeZone)

PySide6.QtCore.QDateTime(other)

PySide6.QtCore.QDateTime(arg__1, arg__2, arg__3, arg__4, arg__5, arg__6)

PySide6.QtCore.QDateTime(arg__1, arg__2, arg__3, arg__4, arg__5, arg__6, arg__7[, arg__8=Qt.LocalTime])

PySide6.QtCore.QDateTime(arg__1, arg__2, arg__3, arg__4, arg__5, arg__6, arg__7[, arg__8=Qt.LocalTime])

Parameters:

offsetSeconds – int
arg__4 – int
arg__1 – int
time – PySide6.QtCore.QTime
arg__6 – int
other – PySide6.QtCore.QDateTime
spec – TimeSpec
arg__5 – int
arg__7 – int
arg__8 – TimeSpec
date – PySide6.QtCore.QDate
arg__2 – int
arg__3 – int
timeZone – PySide6.QtCore.QTimeZone

Constructs a null datetime, nominally using local time.

A null datetime is invalid, since its date and time are invalid.

See also

isValid() setMSecsSinceEpoch() setDate() setTime() setTimeZone()

Constructs a datetime with the given date and time, using local time.

If date is valid and time is not, midnight will be used as the time.

Use QDateTime(date, time) or QDateTime(date, time, QTimeZone::fromSecondsAheadOfUtc(offsetSeconds)).

Constructs a datetime with the given date and time, using the time representation implied by spec and offsetSeconds seconds.

If date is valid and time is not, the time will be set to midnight.

If spec is not OffsetFromUTC then offsetSeconds will be ignored. If spec is OffsetFromUTC and offsetSeconds is 0 then the timeSpec() will be set to UTC , i.e. an offset of 0 seconds.

If spec is TimeZone then the spec will be set to LocalTime , i.e. the current system time zone. To create a TimeZone datetime use the correct constructor.

If date lies outside the range of dates representable by QDateTime , the result is invalid. If spec is LocalTime and the system’s time-zone skipped over the given date and time, the result is invalid.

Constructs a datetime with the given date and time, using the time representation described by timeZone.

If date is valid and time is not, the time will be set to midnight. If timeZone is invalid then the datetime will be invalid.

Constructs a copy of the other datetime.

PySide6.QtCore.QDateTime.YearRange#

This enumerated type describes the range of years (in the Gregorian calendar) representable by QDateTime :

Constant

Description

QDateTime.YearRange.First

The later parts of this year are representable

QDateTime.YearRange.Last

The earlier parts of this year are representable

Constant	Description
QDateTime.YearRange.First	The later parts of this year are representable
QDateTime.YearRange.Last	The earlier parts of this year are representable

All dates strictly between these two years are also representable. Note, however, that the Gregorian Calendar has no year zero.

Note

QDate can describe dates in a wider range of years. For most purposes, this makes little difference, as the range of years that QDateTime can support reaches 292 million years either side of 1970.

See also

isValid() QDate

PySide6.QtCore.QDateTime.__reduce__()#

Return type:: object

PySide6.QtCore.QDateTime.__repr__()#

Return type:: object

PySide6.QtCore.QDateTime.addDays(days)#

Parameters:: days – int
Return type:: PySide6.QtCore.QDateTime

Returns a QDateTime object containing a datetime ndays days later than the datetime of this object (or earlier if ndays is negative).

If the timeSpec() is LocalTime or TimeZone and the resulting date and time fall in the Standard Time to Daylight-Saving Time transition hour then the result will be adjusted accordingly, i.e. if the transition is at 2am and the clock goes forward to 3am and the result falls between 2am and 3am then the result will be adjusted to fall after 3am.

See also

daysTo() addMonths() addYears() addSecs()

PySide6.QtCore.QDateTime.addMSecs(msecs)#

Parameters:: msecs – int
Return type:: PySide6.QtCore.QDateTime

Returns a QDateTime object containing a datetime msecs milliseconds later than the datetime of this object (or earlier if msecs is negative).

If this datetime is invalid, an invalid datetime will be returned.

See also

addSecs() msecsTo() addDays() addMonths() addYears()

PySide6.QtCore.QDateTime.addMonths(months)#

Parameters:: months – int
Return type:: PySide6.QtCore.QDateTime

Returns a QDateTime object containing a datetime nmonths months later than the datetime of this object (or earlier if nmonths is negative).

See also

daysTo() addDays() addYears() addSecs()

PySide6.QtCore.QDateTime.addSecs(secs)#

Parameters:: secs – int
Return type:: PySide6.QtCore.QDateTime

Returns a QDateTime object containing a datetime s seconds later than the datetime of this object (or earlier if s is negative).

If this datetime is invalid, an invalid datetime will be returned.

See also

addMSecs() secsTo() addDays() addMonths() addYears()

PySide6.QtCore.QDateTime.addYears(years)#

Parameters:: years – int
Return type:: PySide6.QtCore.QDateTime

Returns a QDateTime object containing a datetime nyears years later than the datetime of this object (or earlier if nyears is negative).

See also

daysTo() addDays() addMonths() addSecs()

static PySide6.QtCore.QDateTime.currentDateTime()#

Return type:: PySide6.QtCore.QDateTime

This is an overloaded function.

static PySide6.QtCore.QDateTime.currentDateTime(zone)

Parameters:: zone – PySide6.QtCore.QTimeZone
Return type:: PySide6.QtCore.QDateTime

Returns the system clock’s current datetime, using the time representation described by zone. If zone is omitted, local time is used.

See also

currentDateTimeUtc() currentDate() currentTime() toTimeSpec()

static PySide6.QtCore.QDateTime.currentDateTimeUtc()#

Return type:: PySide6.QtCore.QDateTime

Returns the system clock’s current datetime, expressed in terms of UTC.

Equivalent to currentDateTime(QTimeZone::UTC).

See also

currentDateTime() currentDate() currentTime() toTimeSpec()

static PySide6.QtCore.QDateTime.currentMSecsSinceEpoch()#

Return type:: int

Returns the current number of milliseconds since the start, in UTC, of the year 1970.

This number is like the POSIX time_t variable, but expressed in milliseconds instead of seconds.

See also

currentDateTime() currentDateTimeUtc() toTimeSpec()

static PySide6.QtCore.QDateTime.currentSecsSinceEpoch()#

Return type:: int

Returns the number of seconds since the start, in UTC, of the year 1970.

This number is like the POSIX time_t variable.

See also

currentMSecsSinceEpoch()

PySide6.QtCore.QDateTime.date()#

Return type:: PySide6.QtCore.QDate

Returns the date part of the datetime.

See also

setDate() time() timeRepresentation()

PySide6.QtCore.QDateTime.daysTo(arg__1)#

Parameters:: arg__1 – PySide6.QtCore.QDateTime
Return type:: int

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the number of days from this datetime to the other datetime. The number of days is counted as the number of times midnight is reached between this datetime to the other datetime. This means that a 10 minute difference from 23:55 to 0:05 the next day counts as one day.

If the other datetime is earlier than this datetime, the value returned is negative.

Example:

startDate = QDateTime(QDate(2012, 7, 6), QTime(8, 30, 0))
endDate = QDateTime(QDate(2012, 7, 7), QTime(16, 30, 0))
print("Days from startDate to endDate: ", startDate.daysTo(endDate))
startDate = QDateTime(QDate(2012, 7, 6), QTime(23, 55, 0))
endDate = QDateTime(QDate(2012, 7, 7), QTime(0, 5, 0))
print("Days from startDate to endDate: ", startDate.daysTo(endDate))
qSwap(startDate, endDate) # Make endDate before startDate.
print("Days from startDate to endDate: ", startDate.daysTo(endDate))

See also

addDays() secsTo() msecsTo()

static PySide6.QtCore.QDateTime.fromMSecsSinceEpoch(msecs, timeZone)#

Parameters:

msecs – int
timeZone – PySide6.QtCore.QTimeZone

Return type:

PySide6.QtCore.QDateTime

This is an overloaded function.

Returns a datetime representing a moment the given number msecs of milliseconds after the start, in UTC, of the year 1970, described as specified by timeZone. The default time representation is local time.

Note that there are possible values for msecs that lie outside the valid range of QDateTime , both negative and positive. The behavior of this function is undefined for those values.

See also

fromSecsSinceEpoch() toMSecsSinceEpoch() setMSecsSinceEpoch()

static PySide6.QtCore.QDateTime.fromMSecsSinceEpoch(msecs, spec[, offsetFromUtc=0])

Parameters:

msecs – int
spec – TimeSpec
offsetFromUtc – int

Return type:

PySide6.QtCore.QDateTime

This is an overloaded function.

Pass a QTimeZone instead, or omit spec and offsetSeconds.

Returns a datetime representing a moment the given number msecs of milliseconds after the start, in UTC, of the year 1970, described as specified by spec and offsetSeconds.

Note that there are possible values for msecs that lie outside the valid range of QDateTime , both negative and positive. The behavior of this function is undefined for those values.

If the spec is not OffsetFromUTC then the offsetSeconds will be ignored. If the spec is OffsetFromUTC and the offsetSeconds is 0 then UTC will be used as the spec, since UTC has zero offset.

If spec is TimeZone then LocalTime will be used in its place, equivalent to using the current system time zone (but differently represented).

See also

fromSecsSinceEpoch() toMSecsSinceEpoch() setMSecsSinceEpoch()

static PySide6.QtCore.QDateTime.fromMSecsSinceEpoch(msecs)

Parameters:: msecs – int
Return type:: PySide6.QtCore.QDateTime

This is an overloaded function.

static PySide6.QtCore.QDateTime.fromSecsSinceEpoch(secs)#

Parameters:: secs – int
Return type:: PySide6.QtCore.QDateTime

This is an overloaded function.

static PySide6.QtCore.QDateTime.fromSecsSinceEpoch(secs, spec[, offsetFromUtc=0])

Parameters:

secs – int
spec – TimeSpec
offsetFromUtc – int

Return type:

PySide6.QtCore.QDateTime

This is an overloaded function.

Pass a QTimeZone instead, or omit spec and offsetSeconds.

Returns a datetime representing a moment the given number secs of seconds after the start, in UTC, of the year 1970, described as specified by spec and offsetSeconds.

Note that there are possible values for secs that lie outside the valid range of QDateTime , both negative and positive. The behavior of this function is undefined for those values.

If spec is TimeZone then LocalTime will be used in its place, equivalent to using the current system time zone (but differently represented).

See also

fromMSecsSinceEpoch() toSecsSinceEpoch() setSecsSinceEpoch()

static PySide6.QtCore.QDateTime.fromSecsSinceEpoch(secs, timeZone)

Parameters:

secs – int
timeZone – PySide6.QtCore.QTimeZone

Return type:

PySide6.QtCore.QDateTime

This is an overloaded function.

Returns a datetime representing a moment the given number secs of seconds after the start, in UTC, of the year 1970, described as specified by timeZone. The default time representation is local time.

Note that there are possible values for secs that lie outside the valid range of QDateTime , both negative and positive. The behavior of this function is undefined for those values.

See also

fromMSecsSinceEpoch() toSecsSinceEpoch() setSecsSinceEpoch()

static PySide6.QtCore.QDateTime.fromString(string, format[, cal=QCalendar()])#

Parameters:

string – str
format – str
cal – PySide6.QtCore.QCalendar

Return type:

PySide6.QtCore.QDateTime

This is an overloaded function.

static PySide6.QtCore.QDateTime.fromString(string[, format=Qt.TextDate])

Parameters:

string – str
format – DateFormat

Return type:

PySide6.QtCore.QDateTime

This is an overloaded function.

static PySide6.QtCore.QDateTime.fromString(string, format[, cal=QCalendar()])

Parameters:

string – str
format – str
cal – PySide6.QtCore.QCalendar

Return type:

PySide6.QtCore.QDateTime

This is an overloaded function.

static PySide6.QtCore.QDateTime.fromString(string[, format=Qt.TextDate])

Parameters:

string – str
format – DateFormat

Return type:

PySide6.QtCore.QDateTime

Returns the QDateTime represented by the string, using the format given, or an invalid datetime if this is not possible.

Note for TextDate : only English short month names (e.g. “Jan” in short form or “January” in long form) are recognized.

See also

toString() toDateTime()

static PySide6.QtCore.QDateTime.fromString(string, format[, cal=QCalendar()])

Parameters:

string – str
format – str
cal – PySide6.QtCore.QCalendar

Return type:

PySide6.QtCore.QDateTime

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the QDateTime represented by the string, using the format given, or an invalid datetime if the string cannot be parsed.

Uses the calendar cal if supplied, else Gregorian.

In addition to the expressions, recognized in the format string to represent parts of the date and time, by fromString() and fromString() , this method supports:

Expression

Output

t

the timezone (offset, name, “Z” or offset with “UTC” prefix)

tt

the timezone in offset format with no colon between hours and minutes (for example “+0200”)

ttt

the timezone in offset format with a colon between hours and minutes (for example “+02:00”)

tttt

the timezone name (for example “Europe/Berlin”). The name recognized are those known to QTimeZone , which may depend on the operating system in use.

Expression	Output
t	the timezone (offset, name, “Z” or offset with “UTC” prefix)
tt	the timezone in offset format with no colon between hours and minutes (for example “+0200”)
ttt	the timezone in offset format with a colon between hours and minutes (for example “+02:00”)
tttt	the timezone name (for example “Europe/Berlin”). The name recognized are those known to `QTimeZone` , which may depend on the operating system in use.

If no ‘t’ format specifier is present, the system’s local time-zone is used. For the defaults of all other fields, see fromString() and fromString() .

For example:

dateTime = QDateTime.fromString("1.30.1", "M.d.s")
# dateTime is January 30 in 1900 at 00:00:01.
dateTime = QDateTime.fromString("12", "yy")
# dateTime is January 1 in 1912 at 00:00:00.

All other input characters will be treated as text. Any non-empty sequence of characters enclosed in single quotes will also be treated (stripped of the quotes) as text and not be interpreted as expressions.

time1 = QTime.fromString("131", "HHh")
# time1 is 13:00:00
time1 = QTime.fromString("1apA", "1amAM")
# time1 is 01:00:00
dateTime2 = QDateTime.fromString("M1d1y9800:01:02",()
                                            "'M'M'd'd'y'yyhh:mm:ss")
# dateTime is 1 January 1998 00:01:02

If the format is not satisfied, an invalid QDateTime is returned. If the format is satisfied but string represents an invalid datetime (e.g. in a gap skipped by a time-zone transition), an invalid QDateTime is returned, whose toMSecsSinceEpoch() represents a near-by datetime that is valid. Passing that to fromMSecsSinceEpoch() will produce a valid datetime that isn’t faithfully represented by the string parsed.

The expressions that don’t have leading zeroes (d, M, h, m, s, z) will be greedy. This means that they will use two digits (or three, for z) even if this will put them outside the range and/or leave too few digits for other sections.

dateTime = QDateTime.fromString("130", "Mm") # invalid()

This could have meant 1 January 00:30.00 but the M will grab two digits.

Incorrectly specified fields of the string will cause an invalid QDateTime to be returned. For example, consider the following code, where the two digit year 12 is read as 1912 (see the table below for all field defaults); the resulting datetime is invalid because 23 April 1912 was a Tuesday, not a Monday:

string = "Monday, 23 April 12 22:51:41"
format = "dddd, d MMMM yy hh:mm:ss"
invalid = QDateTime.fromString(string, format)

The correct code is:

string = "Tuesday, 23 April 12 22:51:41"
format = "dddd, d MMMM yy hh:mm:ss"
valid = QDateTime.fromString(string, format)

Note

Day and month names as well as AM/PM indicators must be given in English (C locale). If localized month and day names or localized forms of AM/PM are to be recognized, use system() .toDateTime().

Note

If a format character is repeated more times than the longest expression in the table above using it, this part of the format will be read as several expressions with no separator between them; the longest above, possibly repeated as many times as there are copies of it, ending with a residue that may be a shorter expression. Thus 'tttttt' would match "Europe/BerlinEurope/Berlin" and set the zone to Berlin time; if the datetime string contained “Europe/BerlinZ” it would “match” but produce an inconsistent result, leading to an invalid datetime.

PySide6.QtCore.QDateTime.isDaylightTime()#

Return type:: bool

Returns if this datetime falls in Daylight-Saving Time.

If the TimeSpec is not LocalTime or TimeZone then will always return false.

See also

timeSpec()

PySide6.QtCore.QDateTime.isNull()#

Return type:: bool

Returns true if both the date and the time are null; otherwise returns false. A null datetime is invalid.

See also

isNull() isNull() isValid()

PySide6.QtCore.QDateTime.isValid()#

Return type:: bool

Returns true if this datetime represents a definite moment, otherwise false.

A datetime is valid if both its date and its time are valid and the time representation used gives a valid meaning to their combination. When the time representation is a specific time-zone or local time, there may be times on some dates that the zone skips in its representation, as when a daylight-saving transition skips an hour (typically during a night in spring). For example, if DST ends at 2am with the clock advancing to 3am, then datetimes from 02:00:00 to 02:59:59.999 on that day are invalid.

See also

YearRange isValid() isValid()

PySide6.QtCore.QDateTime.msecsTo(arg__1)#

Parameters:: arg__1 – PySide6.QtCore.QDateTime
Return type:: int

Returns the number of milliseconds from this datetime to the other datetime. If the other datetime is earlier than this datetime, the value returned is negative.

Before performing the comparison, the two datetimes are converted to UTC to ensure that the result is correct if daylight-saving (DST) applies to one of the two datetimes and but not the other.

Returns 0 if either datetime is invalid.

See also

addMSecs() daysTo() msecsTo()

PySide6.QtCore.QDateTime.offsetFromUtc()#

Return type:: int

Returns this datetime’s Offset From UTC in seconds.

The result depends on timeSpec() :

Qt::UTC The offset is 0.

Qt::OffsetFromUTC The offset is the value originally set.

Qt::LocalTime The local time’s offset from UTC is returned.

Qt::TimeZone The offset used by the time-zone is returned.

For the last two, the offset at this date and time will be returned, taking account of Daylight-Saving Offset. The offset is the difference between the local time or time in the given time-zone and UTC time; it is positive in time-zones ahead of UTC (East of The Prime Meridian), negative for those behind UTC (West of The Prime Meridian).

See also

setOffsetFromUtc()

PySide6.QtCore.QDateTime.__ne__(rhs)#

Parameters:: rhs – PySide6.QtCore.QDateTime
Return type:: bool

Returns true if lhs is different from rhs; otherwise returns false.

Two datetimes using different time representations can have different offsets from UTC. In this case, they may compare equivalent even if their date() and time() differ, if that difference matches the difference in UTC offset. If their date() and time() coincide, the one with higher offset from UTC is less (earlier) than the one with lower offset. As a result, datetimes are only weakly ordered.

Since 5.14, all invalid datetimes are equivalent and less than all valid datetimes.

See also

operator==()

PySide6.QtCore.QDateTime.__lt__(rhs)#

Parameters:: rhs – PySide6.QtCore.QDateTime
Return type:: bool

Returns true if lhs is earlier than rhs; otherwise returns false.

Since 5.14, all invalid datetimes are equivalent and less than all valid datetimes.

See also

operator==()

PySide6.QtCore.QDateTime.__le__(rhs)#

Parameters:: rhs – PySide6.QtCore.QDateTime
Return type:: bool

Returns true if lhs is earlier than or equal to rhs; otherwise returns false.

Since 5.14, all invalid datetimes are equivalent and less than all valid datetimes.

See also

operator==()

PySide6.QtCore.QDateTime.__eq__(rhs)#

Parameters:: rhs – PySide6.QtCore.QDateTime
Return type:: bool

Returns true if lhs represents the same moment in time as rhs; otherwise returns false.

Since 5.14, all invalid datetimes are equivalent and less than all valid datetimes.

See also

operator!=() operator operator operator>() operator>=()

PySide6.QtCore.QDateTime.__gt__(rhs)#

Parameters:: rhs – PySide6.QtCore.QDateTime
Return type:: bool

Returns true if lhs is later than rhs; otherwise returns false.

Since 5.14, all invalid datetimes are equivalent and less than all valid datetimes.

See also

operator==()

PySide6.QtCore.QDateTime.__ge__(rhs)#

Parameters:: rhs – PySide6.QtCore.QDateTime
Return type:: bool

Returns true if lhs is later than or equal to rhs; otherwise returns false.

Since 5.14, all invalid datetimes are equivalent and less than all valid datetimes.

See also

operator==()

PySide6.QtCore.QDateTime.secsTo(arg__1)#

Parameters:: arg__1 – PySide6.QtCore.QDateTime
Return type:: int

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the number of seconds from this datetime to the other datetime. If the other datetime is earlier than this datetime, the value returned is negative.

Before performing the comparison, the two datetimes are converted to UTC to ensure that the result is correct if daylight-saving (DST) applies to one of the two datetimes but not the other.

Returns 0 if either datetime is invalid.

Example:

now = QDateTime.currentDateTime()
xmas = QDateTime(QDate(now.date().year(), 12, 25).startOfDay())
qDebug("There are %d seconds to Christmas", now.secsTo(xmas))

See also

addSecs() daysTo() secsTo()

PySide6.QtCore.QDateTime.setDate(date)#

Parameters:: date – PySide6.QtCore.QDate

Sets the date part of this datetime to date. If no time is set yet, it is set to midnight. If date is invalid, this QDateTime becomes invalid.

See also

date() setTime() setTimeZone()

PySide6.QtCore.QDateTime.setMSecsSinceEpoch(msecs)#

Parameters:: msecs – int

Sets the datetime to represent a moment a given number, msecs, of milliseconds after the start, in UTC, of the year 1970.

On systems that do not support time zones, this function will behave as if local time were UTC .

Note that passing the minimum of qint64 (std::numeric_limits<qint64>::min()) to msecs will result in undefined behavior.

See also

setSecsSinceEpoch() toMSecsSinceEpoch() fromMSecsSinceEpoch()

PySide6.QtCore.QDateTime.setOffsetFromUtc(offsetSeconds)#

Parameters:: offsetSeconds – int

Use setTimeZone ( fromSecondsAheadOfUtc (offsetSeconds)) instead

Sets the timeSpec() to OffsetFromUTC and the offset to offsetSeconds. The datetime may refer to a different point in time.

The maximum and minimum offset is 14 positive or negative hours. If offsetSeconds is larger or smaller than that, then the result is undefined.

If offsetSeconds is 0 then the timeSpec() will be set to UTC .

See also

setTimeZone() isValid() offsetFromUtc() toOffsetFromUtc()

PySide6.QtCore.QDateTime.setSecsSinceEpoch(secs)#

Parameters:: secs – int

Sets the datetime to represent a moment a given number, secs, of seconds after the start, in UTC, of the year 1970.

On systems that do not support time zones, this function will behave as if local time were UTC .

See also

setMSecsSinceEpoch() toSecsSinceEpoch() fromSecsSinceEpoch()

PySide6.QtCore.QDateTime.setTime(time)#

Parameters:: time – PySide6.QtCore.QTime

Sets the time part of this datetime to time. If time is not valid, this function sets it to midnight. Therefore, it’s possible to clear any set time in a QDateTime by setting it to a default QTime :

QDateTime dt = QDateTime::currentDateTime();
dt.setTime(QTime());
See also

time() setDate() setTimeZone()

PySide6.QtCore.QDateTime.setTimeSpec(spec)#

Parameters:: spec – TimeSpec

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Use setTimeZone() instead

Sets the time specification used in this datetime to spec. The datetime may refer to a different point in time.

If spec is OffsetFromUTC then the timeSpec() will be set to UTC , i.e. an effective offset of 0.

If spec is TimeZone then the spec will be set to LocalTime , i.e. the current system time zone.

Example:

local = QDateTime(QDateTime.currentDateTime())
print("Local time is:", local)
UTC = QDateTime(local)
UTC.setTimeSpec(Qt.UTC)
print("UTC time is:", UTC)
print("There are", local.secsTo(UTC), "seconds difference between the datetimes.")

PySide6.QtCore.QDateTime.setTimeZone(toZone)#

Parameters:: toZone – PySide6.QtCore.QTimeZone

Sets the time zone used in this datetime to toZone.

The datetime may refer to a different point in time. It uses the time representation of toZone, which may change the meaning of its unchanged date() and time() .

If toZone is invalid then the datetime will be invalid. Otherwise, this datetime’s timeSpec() after the call will match toZone.timeSpec().

See also

timeRepresentation() timeZone() TimeSpec

PySide6.QtCore.QDateTime.swap(other)#

Parameters:: other – PySide6.QtCore.QDateTime

Swaps this datetime with other. This operation is very fast and never fails.

PySide6.QtCore.QDateTime.time()#

Return type:: PySide6.QtCore.QTime

Returns the time part of the datetime.

See also

setTime() date() timeRepresentation()

PySide6.QtCore.QDateTime.timeRepresentation()#

Return type:: PySide6.QtCore.QTimeZone

Returns a QTimeZone identifying how this datetime represents time.

The timeSpec() of the returned QTimeZone will coincide with that of this datetime; if it is not TimeZone then the returned QTimeZone is a time representation. When their timeSpec() is OffsetFromUTC , the returned QTimeZone ‘s fixedSecondsAheadOfUtc() supplies the offset. When timeSpec() is TimeZone , the QTimeZone object itself is the full representation of that time zone.

See also

timeZone() setTimeZone() asBackendZone()

PySide6.QtCore.QDateTime.timeSpec()#

Return type:: TimeSpec

Returns the time specification of the datetime.

This classifies its time representation as local time, UTC, a fixed offset from UTC (without indicating the offset) or a time zone (without giving the details of that time zone). Equivalent to timeRepresentation().timeSpec().

See also

setTimeSpec() timeRepresentation() date() time()

PySide6.QtCore.QDateTime.timeZone()#

Return type:: PySide6.QtCore.QTimeZone

Returns the time zone of the datetime.

The result is the same as timeRepresentation().asBackendZone(). In all cases, the result’s timeSpec() is TimeZone .

When timeSpec() is LocalTime , the result will describe local time at the time this method was called. It will not reflect subsequent changes to the system time zone, even when the QDateTime from which it was obtained does.

See also

timeRepresentation() setTimeZone() TimeSpec asBackendZone()

PySide6.QtCore.QDateTime.timeZoneAbbreviation()#

Return type:: str

Returns the Time Zone Abbreviation for this datetime.

The returned string depends on timeSpec() :

For UTC it is “UTC”.

For OffsetFromUTC it will be in the format “UTC[+-]00:00”.

For LocalTime , the host system is queried.

For TimeZone , the associated QTimeZone object is queried.

Note

The abbreviation is not guaranteed to be unique, i.e. different time zones may have the same abbreviation. For LocalTime and TimeZone , when returned by the host system, the abbreviation may be localized.

See also

timeSpec() abbreviation()

PySide6.QtCore.QDateTime.toLocalTime()#

Return type:: PySide6.QtCore.QDateTime

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns a copy of this datetime converted to local time.

The result represents the same moment in time as, and is equal to, this datetime.

Example:

UTC = QDateTime(QDateTime.currentDateTimeUtc())
local = QDateTime(UTC.toLocalTime())
print("UTC time is:", UTC)
print("Local time is:", local)
print("No difference between times:", UTC.secsTo(local))

PySide6.QtCore.QDateTime.toMSecsSinceEpoch()#

Return type:: int

Returns the datetime as a number of milliseconds after the start, in UTC, of the year 1970.

On systems that do not support time zones, this function will behave as if local time were UTC .

The behavior for this function is undefined if the datetime stored in this object is not valid. However, for all valid dates, this function returns a unique value.

See also

toSecsSinceEpoch() setMSecsSinceEpoch() fromMSecsSinceEpoch()

PySide6.QtCore.QDateTime.toOffsetFromUtc(offsetSeconds)#

Parameters:: offsetSeconds – int
Return type:: PySide6.QtCore.QDateTime

Returns a copy of this datetime converted to a spec of OffsetFromUTC with the given offsetSeconds. Equivalent to toTimeZone(QTimeZone::fromSecondsAheadOfUtc(offsetSeconds)).

If the offsetSeconds equals 0 then a UTC datetime will be returned.

The result represents the same moment in time as, and is equal to, this datetime.

See also

setOffsetFromUtc() offsetFromUtc() toTimeZone()

PySide6.QtCore.QDateTime.toPython()#

Return type:: object

PySide6.QtCore.QDateTime.toSecsSinceEpoch()#

Return type:: int

Returns the datetime as a number of seconds after the start, in UTC, of the year 1970.

On systems that do not support time zones, this function will behave as if local time were UTC .

The behavior for this function is undefined if the datetime stored in this object is not valid. However, for all valid dates, this function returns a unique value.

See also

toMSecsSinceEpoch() fromSecsSinceEpoch() setSecsSinceEpoch()

PySide6.QtCore.QDateTime.toString(format[, cal=QCalendar()])#

Parameters:

format – str
cal – PySide6.QtCore.QCalendar

Return type:

str

PySide6.QtCore.QDateTime.toString([format=Qt.TextDate])

Parameters:: format – DateFormat
Return type:: str

This is an overloaded function.

Returns the datetime as a string in the format given.

If the format is TextDate , the string is formatted in the default way. The day and month names will be in English. An example of this formatting is “Wed May 20 03:40:13 1998”. For localized formatting, see toString() .

If the format is ISODate , the string format corresponds to the ISO 8601 extended specification for representations of dates and times, taking the form yyyy-MM-ddTHH:mm:ss[Z|[+|-]HH:mm], depending on the timeSpec() of the QDateTime . If the timeSpec() is UTC , Z will be appended to the string; if the timeSpec() is OffsetFromUTC , the offset in hours and minutes from UTC will be appended to the string. To include milliseconds in the ISO 8601 date, use the format ISODateWithMs , which corresponds to yyyy-MM-ddTHH:mm:ss.zzz[Z|[+|-]HH:mm].

If the format is RFC2822Date , the string is formatted following RFC 2822.

If the datetime is invalid, an empty string will be returned.

Warning

The ISODate format is only valid for years in the range 0 to 9999.

PySide6.QtCore.QDateTime.toString(format[, cal=QCalendar()])

Parameters:

format – str
cal – PySide6.QtCore.QCalendar

Return type:

str

PySide6.QtCore.QDateTime.toTimeSpec(spec)#

Parameters:: spec – TimeSpec
Return type:: PySide6.QtCore.QDateTime

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Use toTimeZone() instead.

Returns a copy of this datetime converted to the given time spec.

The result represents the same moment in time as, and is equal to, this datetime.

If spec is OffsetFromUTC then it is set to UTC . To set to a fixed offset from UTC, use toTimeZone() or toOffsetFromUtc() .

If spec is TimeZone then it is set to LocalTime , i.e. the local Time Zone. To set a specified time-zone, use toTimeZone() .

Example:

local = QDateTime(QDateTime.currentDateTime())
UTC = QDateTime(local.toTimeSpec(Qt.UTC))
print("Local time is:", local)
print("UTC time is:", UTC)
print("No difference between times:", local.secsTo(UTC))

PySide6.QtCore.QDateTime.toTimeZone(toZone)#

Parameters:: toZone – PySide6.QtCore.QTimeZone
Return type:: PySide6.QtCore.QDateTime

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns a copy of this datetime converted to the given timeZone.

The result represents the same moment in time as, and is equal to, this datetime.

The result describes the moment in time in terms of timeZone's time representation. For example:

local = QDateTime(QDateTime.currentDateTime())
UTC = QDateTime(local.toTimeSpec(QTimeZone.UTC))
print("Local time is:", local)
print("UTC time is:", UTC)
print("No difference between times represented:", local.secsTo(UTC))

If timeZone is invalid then the datetime will be invalid. Otherwise the returned datetime’s timeSpec() will match timeZone.timeSpec().

See also

timeRepresentation() toLocalTime() toUTC() toOffsetFromUtc()

PySide6.QtCore.QDateTime.toUTC()#

Return type:: PySide6.QtCore.QDateTime

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns a copy of this datetime converted to UTC.

The result represents the same moment in time as, and is equal to, this datetime.

Example:

local = QDateTime(QDateTime.currentDateTime())
UTC = QDateTime(local.toUTC())
print("Local time is:", local)
print("UTC time is:", UTC)
print("No difference between times:", local.secsTo(UTC))