QTime

The QTime class provides clock time functions. More…

Inheritance diagram of PySide2.QtCore.QTime

Synopsis

Functions

Static functions

Detailed Description

A QTime object contains a clock time, which it can express as the numbers of hours, minutes, seconds, and milliseconds since midnight. It provides functions for comparing times and for manipulating a time by adding a number of milliseconds.

QTime uses the 24-hour clock format; it has no concept of AM/PM. Unlike QDateTime , QTime knows nothing about time zones or daylight-saving time (DST).

A QTime object is typically created either by giving the number of hours, minutes, seconds, and milliseconds explicitly, or by using the static function currentTime() , which creates a QTime object that represents the system’s local time.

The hour() , minute() , second() , and msec() functions provide access to the number of hours, minutes, seconds, and milliseconds of the time. The same information is provided in textual format by the toString() function.

The addSecs() and addMSecs() functions provide the time a given number of seconds or milliseconds later than a given time. Correspondingly, the number of seconds or milliseconds between two times can be found using secsTo() or msecsTo() .

QTime provides a full set of operators to compare two QTime objects; an earlier time is considered smaller than a later one; if A. msecsTo (B) is positive, then A < B.

See also

QDate QDateTime

class PySide2.QtCore.QTime

PySide2.QtCore.QTime(QTime)

PySide2.QtCore.QTime(h, m[, s=0[, ms=0]])

param h:

int

param m:

int

param ms:

int

param s:

int

param QTime:

PySide2.QtCore.QTime

Constructs a null time object. For a null time, isNull() returns true and isValid() returns false . If you need a zero time, use QTime (0, 0). For the start of a day, see startOfDay() .

See also

isNull() isValid()

Constructs a time with hour h , minute m , seconds s and milliseconds ms .

h must be in the range 0 to 23, m and s must be in the range 0 to 59, and ms must be in the range 0 to 999.

See also

isValid()

PySide2.QtCore.QTime.TimeFlag
PySide2.QtCore.QTime.__reduce__()
Return type:

object

PySide2.QtCore.QTime.__repr__()
Return type:

object

PySide2.QtCore.QTime.addMSecs(ms)
Parameters:

ms – int

Return type:

PySide2.QtCore.QTime

Returns a QTime object containing a time ms milliseconds later than the time of this object (or earlier if ms is negative).

Note that the time will wrap if it passes midnight. See addSecs() for an example.

Returns a null time if this time is invalid.

See also

addSecs() msecsTo() addMSecs()

PySide2.QtCore.QTime.addSecs(secs)
Parameters:

secs – int

Return type:

PySide2.QtCore.QTime

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

Note that the time will wrap if it passes midnight.

Returns a null time if this time is invalid.

Example:

n = QTime(14, 0, 0)              # n == 14:00:00
t = QTime()
t = n.addSecs(70)                # t == 14:01:10
t = n.addSecs(-70)               # t == 13:58:50
t = n.addSecs(10 * 60 * 60 + 5)  # t == 00:00:05
t = n.addSecs(-15 * 60 * 60)     # t == 23:00:00

See also

addMSecs() secsTo() addSecs()

static PySide2.QtCore.QTime.currentTime()
Return type:

PySide2.QtCore.QTime

Returns the current time as reported by the system clock.

Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy.

Furthermore, only increases within each day; it shall drop by 24 hours each time midnight passes; and, beside this, changes in it may not correspond to elapsed time, if a daylight-saving transition intervenes.

See also

currentDateTime() currentDateTimeUtc()

PySide2.QtCore.QTime.elapsed()
Return type:

int

Note

This function is deprecated.

Returns the number of milliseconds that have elapsed since the last time start() or restart() was called.

Note that the counter wraps to zero 24 hours after the last call to start() or restart.

Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy.

Warning

If the system’s clock setting has been changed since the last time start() or restart() was called, the result is undefined. This can happen when daylight-saving time is turned on or off.

See also

start() restart()

static PySide2.QtCore.QTime.fromMSecsSinceStartOfDay(msecs)
Parameters:

msecs – int

Return type:

PySide2.QtCore.QTime

Returns a new QTime instance with the time set to the number of msecs since the start of the day, i.e. since 00:00:00.

If msecs falls outside the valid range an invalid QTime will be returned.

See also

msecsSinceStartOfDay()

static PySide2.QtCore.QTime.fromString(s[, f=Qt.TextDate])
Parameters:
Return type:

PySide2.QtCore.QTime

static PySide2.QtCore.QTime.fromString(s, format)
Parameters:

  • s – str

  • format – str

Return type:

PySide2.QtCore.QTime

PySide2.QtCore.QTime.hour()
Return type:

int

Returns the hour part (0 to 23) of the time.

Returns -1 if the time is invalid.

See also

minute() second() msec()

PySide2.QtCore.QTime.isNull()
Return type:

bool

Returns true if the time is null (i.e., the QTime object was constructed using the default constructor); otherwise returns false. A null time is also an invalid time.

See also

isValid()

PySide2.QtCore.QTime.isValid()
Return type:

bool

Returns true if the time is valid; otherwise returns false . For example, the time 23:30:55.746 is valid, but 24:12:30 is invalid.

See also

isNull()

static PySide2.QtCore.QTime.isValid(h, m, s[, ms=0])
Parameters:

  • h – int

  • m – int

  • s – int

  • ms – int

Return type:

bool

This is an overloaded function.

Returns true if the specified time is valid; otherwise returns false.

The time is valid if h is in the range 0 to 23, m and s are in the range 0 to 59, and ms is in the range 0 to 999.

Example:

QTime.isValid(21, 10, 30) # returns True
QTime.isValid(22, 5,  62) # returns False
PySide2.QtCore.QTime.minute()
Return type:

int

Returns the minute part (0 to 59) of the time.

Returns -1 if the time is invalid.

See also

hour() second() msec()

PySide2.QtCore.QTime.msec()
Return type:

int

Returns the millisecond part (0 to 999) of the time.

Returns -1 if the time is invalid.

See also

hour() minute() second()

PySide2.QtCore.QTime.msecsSinceStartOfDay()
Return type:

int

Returns the number of msecs since the start of the day, i.e. since 00:00:00.

See also

fromMSecsSinceStartOfDay()

PySide2.QtCore.QTime.msecsTo(arg__1)
Parameters:

arg__1 – PySide2.QtCore.QTime

Return type:

int

Returns the number of milliseconds from this time to t . If t is earlier than this time, the number of milliseconds returned is negative.

Because QTime measures time within a day and there are 86400 seconds in a day, the result is always between -86400000 and 86400000 ms.

Returns 0 if either time is invalid.

See also

secsTo() addMSecs() msecsTo()

PySide2.QtCore.QTime.__ne__(other)
Parameters:

other – PySide2.QtCore.QTime

Return type:

bool

Returns true if this time is different from t ; otherwise returns false .

PySide2.QtCore.QTime.__lt__(other)
Parameters:

other – PySide2.QtCore.QTime

Return type:

bool

PySide2.QtCore.QTime.__le__(other)
Parameters:

other – PySide2.QtCore.QTime

Return type:

bool

PySide2.QtCore.QTime.__eq__(other)
Parameters:

other – PySide2.QtCore.QTime

Return type:

bool

Returns true if this time is equal to t ; otherwise returns false .

PySide2.QtCore.QTime.__gt__(other)
Parameters:

other – PySide2.QtCore.QTime

Return type:

bool

Returns true if this time is later than t ; otherwise returns false .

PySide2.QtCore.QTime.__ge__(other)
Parameters:

other – PySide2.QtCore.QTime

Return type:

bool

Returns true if this time is later than or equal to t ; otherwise returns false .

PySide2.QtCore.QTime.restart()
Return type:

int

Note

This function is deprecated.

Sets this time to the current time and returns the number of milliseconds that have elapsed since the last time start() or was called.

This function is guaranteed to be atomic and is thus very handy for repeated measurements. Call start() to start the first measurement, and for each later measurement.

Note that the counter wraps to zero 24 hours after the last call to start() or .

Warning

If the system’s clock setting has been changed since the last time start() or was called, the result is undefined. This can happen when daylight-saving time is turned on or off.

See also

start() elapsed() currentTime()

PySide2.QtCore.QTime.second()
Return type:

int

Returns the second part (0 to 59) of the time.

Returns -1 if the time is invalid.

See also

hour() minute() msec()

PySide2.QtCore.QTime.secsTo(arg__1)
Parameters:

arg__1 – PySide2.QtCore.QTime

Return type:

int

Returns the number of seconds from this time to t . If t is earlier than this time, the number of seconds returned is negative.

Because QTime measures time within a day and there are 86400 seconds in a day, the result is always between -86400 and 86400.

does not take into account any milliseconds.

Returns 0 if either time is invalid.

See also

addSecs() secsTo()

PySide2.QtCore.QTime.setHMS(h, m, s[, ms=0])
Parameters:

  • h – int

  • m – int

  • s – int

  • ms – int

Return type:

bool

Sets the time to hour h , minute m , seconds s and milliseconds ms .

h must be in the range 0 to 23, m and s must be in the range 0 to 59, and ms must be in the range 0 to 999. Returns true if the set time is valid; otherwise returns false .

See also

isValid()

PySide2.QtCore.QTime.start()

Note

This function is deprecated.

Sets this time to the current time. This is practical for timing:

t = QTime()
t.start()
some_lengthy_task()
print ("Time elapsed: %d ms" % t.elapsed())

See also

restart() elapsed() currentTime()

PySide2.QtCore.QTime.toPython()
Return type:

object

PySide2.QtCore.QTime.toString([f=Qt.TextDate])
Parameters:

f – DateFormat

Return type:

str

This is an overloaded function.

Returns the time as a string. The format parameter determines the format of the string.

If format is TextDate , the string format is HH:mm:ss; e.g. 1 second before midnight would be “23:59:59”.

If format is ISODate , the string format corresponds to the ISO 8601 extended specification for representations of dates, represented by HH:mm:ss. To include milliseconds in the ISO 8601 date, use the format ISODateWithMs , which corresponds to HH:mm:ss.zzz.

The format options SystemLocaleDate :, SystemLocaleShortDate and SystemLocaleLongDate shall be removed in Qt 6. Their use should be replaced with: ShortFormat) or LongFormat) .

The format options LocaleDate , DefaultLocaleShortDate and DefaultLocaleLongDate shall be removed in Qt 6. Their use should be replaced with: ShortFormat) or LongFormat) .

If the format is RFC2822Date , the string is formatted in an RFC 2822 compatible way. An example of this formatting is “23:59:20”.

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

See also

fromString() toString() toString() toString()

PySide2.QtCore.QTime.toString(format)
Parameters:

format – str

Return type:

str