Skip to content

PythonQt.QtCore.QDate · declarations 001

Back to PythonQt.QtCore.QDate

DateFormat instance-attribute

DateFormat: Any

MonthNameType instance-attribute

MonthNameType: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

StandaloneFormat instance-attribute

StandaloneFormat: Any

addDays

addDays(days: int) -> Any

X.addDays(days) -> PythonQt.QtCore.QDate

Supplemental documentation: Qt 5 reference:

QDate QDate::addDays(qint64 ndays) const

Returns a QDate object containing a date ndays later than the date of this object (or earlier if ndays is negative).

Returns a null date if the current date is invalid or the new date is out of range.

See also addMonths(), addYears(), and daysTo().

Upstream PySide2 reference signatures (binding differences may apply):

addDays(self, days: int) -> PySide2.QtCore.QDate

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#addDays

addMonths

addMonths(months: int) -> Any

X.addMonths(months) -> PythonQt.QtCore.QDate

Supplemental documentation: Qt 5 reference:

QDate QDate::addMonths(int nmonths, QCalendar cal) const

Returns a QDate object containing a date nmonths later than the date of this object (or earlier if nmonths is negative).

Uses cal as calendar, if supplied, else the Gregorian calendar.

Note: If the ending day/month combination does not exist in the resulting month/year, this function will return a date that is the latest valid date in the selected month.

See also addDays() and addYears().

QDate QDate::addMonths(int nmonths) const

This is an overloaded function.

Upstream PySide2 reference signatures (binding differences may apply):

addMonths(self, months: int) -> PySide2.QtCore.QDate
addMonths(self, months: int, cal: PySide2.QtCore.QCalendar) -> PySide2.QtCore.QDate

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#addMonths

addYears

addYears(years: int) -> Any

X.addYears(years) -> PythonQt.QtCore.QDate

Supplemental documentation: Qt 5 reference:

QDate QDate::addYears(int nyears, QCalendar cal) const

Returns a QDate object containing a date nyears later than the date of this object (or earlier if nyears is negative).

Uses cal as calendar, if supplied, else the Gregorian calendar.

Note: If the ending day/month combination does not exist in the resulting year (e.g., for the Gregorian calendar, if the date was Feb 29 and the final year is not a leap year), this function will return a date that is the latest valid date in the given month (in the example, Feb 28).

See also addDays() and addMonths().

QDate QDate::addYears(int nyears) const

This is an overloaded function.

Upstream PySide2 reference signatures (binding differences may apply):

addYears(self, years: int) -> PySide2.QtCore.QDate
addYears(self, years: int, cal: PySide2.QtCore.QCalendar) -> PySide2.QtCore.QDate

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#addYears

currentDate

currentDate() -> Any

X.currentDate() -> PythonQt.QtCore.QDate

Supplemental documentation: Qt 5 reference:

[static] QDate QDate::currentDate()

Returns the current date, as reported by the system clock.

See also QTime::currentTime() and QDateTime::currentDateTime().

Upstream PySide2 reference signatures (binding differences may apply):

currentDate() -> PySide2.QtCore.QDate

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#currentDate

day

day() -> int

X.day() -> int

Supplemental documentation: Qt 5 reference:

int QDate::day(QCalendar cal) const

Returns the day of the month for this date.

Uses cal as calendar if supplied, else the Gregorian calendar (for which the return ranges from 1 to 31). Returns 0 if the date is invalid.

See also year(), month(), dayOfWeek(), and QCalendar::partsFromDate().

int QDate::day() const

This is an overloaded function.

Upstream PySide2 reference signatures (binding differences may apply):

day(self) -> int
day(self, cal: PySide2.QtCore.QCalendar) -> int

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#day

dayOfWeek

dayOfWeek() -> int

X.dayOfWeek() -> int

Supplemental documentation: Qt 5 reference:

int QDate::dayOfWeek(QCalendar cal) const

Returns the weekday (1 \= Monday to 7 \= Sunday) for this date.

Uses cal as calendar if supplied, else the Gregorian calendar. Returns 0 if the date is invalid. Some calendars may give special meaning (e.g. intercallary days) to values greater than 7.

See also day(), dayOfYear(), QCalendar::dayOfWeek(), and Qt::DayOfWeek.

int QDate::dayOfWeek() const

This is an overloaded function.

Upstream PySide2 reference signatures (binding differences may apply):

dayOfWeek(self) -> int
dayOfWeek(self, cal: PySide2.QtCore.QCalendar) -> int

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#dayOfWeek

dayOfYear

dayOfYear() -> int

X.dayOfYear() -> int

Supplemental documentation: Qt 5 reference:

int QDate::dayOfYear(QCalendar cal) const

Returns the day of the year (1 for the first day) for this date.

Uses cal as calendar if supplied, else the Gregorian calendar. Returns 0 if either the date or the first day of its year is invalid.

See also day(), dayOfWeek(), and QCalendar::daysInYear().

int QDate::dayOfYear() const

This is an overloaded function.

Upstream PySide2 reference signatures (binding differences may apply):

dayOfYear(self) -> int
dayOfYear(self, cal: PySide2.QtCore.QCalendar) -> int

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#dayOfYear

daysInMonth

daysInMonth() -> int

X.daysInMonth() -> int

Supplemental documentation: Qt 5 reference:

int QDate::daysInMonth(QCalendar cal) const

Returns the number of days in the month for this date.

Uses cal as calendar if supplied, else the Gregorian calendar (for which the result ranges from 28 to 31). Returns 0 if the date is invalid.

See also day(), daysInYear(), QCalendar::daysInMonth(), QCalendar::maximumDaysInMonth(), and QCalendar::minimumDaysInMonth().

int QDate::daysInMonth() const

This is an overloaded function.

Upstream PySide2 reference signatures (binding differences may apply):

daysInMonth(self) -> int
daysInMonth(self, cal: PySide2.QtCore.QCalendar) -> int

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#daysInMonth

daysInYear

daysInYear() -> int

X.daysInYear() -> int

Supplemental documentation: Qt 5 reference:

int QDate::daysInYear(QCalendar cal) const

Returns the number of days in the year for this date.

Uses cal as calendar if supplied, else the Gregorian calendar (for which the result is 365 or 366). Returns 0 if the date is invalid.

See also day(), daysInMonth(), QCalendar::daysInYear(), and QCalendar::maximumMonthsInYear().

int QDate::daysInYear() const

This is an overloaded function.

Upstream PySide2 reference signatures (binding differences may apply):

daysInYear(self) -> int
daysInYear(self, cal: PySide2.QtCore.QCalendar) -> int

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#daysInYear

daysTo

daysTo(arg__1: Any) -> int

X.daysTo(arg__1) -> int

Supplemental documentation: Qt 5 reference:

qint64 QDate::daysTo(const QDate \&d) const

Returns the number of days from this date to d (which is negative if d is earlier than this date).

Returns 0 if either date is invalid.

Example:

QDate d1(1995, 5, 17);  // May 17, 1995
QDate d2(1995, 5, 20);  // May 20, 1995
d1.daysTo(d2);          // returns 3
d2.daysTo(d1);          // returns -3

See also addDays().

Upstream PySide2 reference signatures (binding differences may apply):

daysTo(self, arg__1: PySide2.QtCore.QDate) -> int

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#daysTo

fromJulianDay

fromJulianDay(jd_: int) -> Any

X.fromJulianDay(jd_) -> PythonQt.QtCore.QDate

Supplemental documentation: Qt 5 reference:

[static] QDate QDate::fromJulianDay(qint64 jd)

Converts the Julian day jd to a QDate.

See also toJulianDay().

Upstream PySide2 reference signatures (binding differences may apply):

fromJulianDay(jd_: int) -> PySide2.QtCore.QDate

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#fromJulianDay

fromString

fromString(s: str, f: Any) -> Any

X.fromString(s, f) -> PythonQt.QtCore.QDate

Supplemental documentation: Qt 5 reference:

[static] QDate QDate::fromString(const QString \&string, Qt::DateFormat format \= Qt::TextDate)

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

Note for Qt::TextDate: It is recommended that you use the English short month names (e.g. "Jan"). Although localized month names can also be used in Qt 5, they depend on the user's locale settings.

Note: Support for localized dates, including the format options Qt::SystemLocaleDate, Qt::SystemLocaleShortDate, Qt::SystemLocaleLongDate, Qt::LocaleDate, Qt::DefaultLocaleShortDate, and Qt::DefaultLocaleLongDate, shall be removed in Qt 6. Use QLocale::toDate() instead.

See also toString() and QLocale::toDate().

[static] QDate QDate::fromString(const QString \&string, const QString \&format)

This is an overloaded function.

[static] QDate QDate::fromString(const QString \&string, const QString \&format, QCalendar cal)

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

Uses cal as calendar if supplied, else the Gregorian calendar. Ranges of values in the format descriptions below are for the latter; they may be different for other calendars.

These expressions may be used for the format:

Expression Output
d The day as a number without a leading zero (1 to 31)
dd The day as a number with a leading zero (01 to 31)
ddd The abbreviated localized day name (e.g. 'Mon' to 'Sun'). Uses the system locale to localize the name, i.e. QLocale::system().
dddd The long localized day name (e.g. 'Monday' to 'Sunday'). Uses the system locale to localize the name, i.e. QLocale::system().
M The month as a number without a leading zero (1 to 12)
MM The month as a number with a leading zero (01 to 12)
MMM The abbreviated localized month name (e.g. 'Jan' to 'Dec'). Uses the system locale to localize the name, i.e. QLocale::system().
MMMM The long localized month name (e.g. 'January' to 'December'). Uses the system locale to localize the name, i.e. QLocale::system().
yy The year as a two digit number (00 to 99)
yyyy The year as a four digit number, possibly plus a leading minus sign for negative years.

Note: Unlike the other version of this function, day and month names must be given in the user's local language. It is only possible to use the English names if the user's language is English.

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. For example:

QDate date = QDate::fromString("1MM12car2003", "d'MM'MMcaryyyy");
// date is 1 December 2003

If the format is not satisfied, an invalid QDate is returned. The expressions that don't expect leading zeroes (d, M) will be greedy. This means that they will use two digits even if this will put them outside the accepted range of values and leaves too few digits for other sections. For example, the following format string could have meant January 30 but the M will grab two digits, resulting in an invalid date:

QDate date = QDate::fromString("130", "Md"); // invalid

For any field that is not represented in the format the following defaults are used:

Field Default value
Year 1900
Month 1
Day 1

The following examples demonstrate the default values:

QDate::fromString("1.30", "M.d");           // January 30 1900
QDate::fromString("20000110", "yyyyMMdd");  // January 10, 2000
QDate::fromString("20000110", "yyyyMd");    // January 10, 2000

Note: If localized month and day names are used, please switch to using QLocale::system().toDate() as QDate methods shall change to only recognize English (C locale) names at Qt 6.

See also toString(), QDateTime::fromString(), QTime::fromString(), and QLocale::toDate().

Upstream PySide2 reference signatures (binding differences may apply):

fromString(s: str, f: PySide2.QtCore.Qt.DateFormat=...) -> PySide2.QtCore.QDate
fromString(s: str, format: str) -> PySide2.QtCore.QDate
fromString(s: str, format: str, cal: PySide2.QtCore.QCalendar) -> PySide2.QtCore.QDate

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#fromString

getDate

getDate(year: Any, month: Any, day: Any) -> Any

X.getDate(year, month, day)

Supplemental documentation: Qt 5 reference:

void QDate::getDate(int *year, int *month, int *day) const

Extracts the date's year, month, and day, and assigns them to *year, *month, and *day. The pointers may be null.

Returns 0 if the date is invalid.

Note: In Qt versions prior to 5.7, this function is marked as non-const.

This function was introduced in Qt 4.5.

See also year(), month(), day(), isValid(), and QCalendar::partsFromDate().

Upstream PySide2 reference signatures (binding differences may apply):

getDate(self) -> typing.Tuple[int, int, int]

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#getDate

isLeapYear

isLeapYear(year: int) -> bool

X.isLeapYear(year) -> bool

Supplemental documentation: Qt 5 reference:

[static] bool QDate::isLeapYear(int year)

Returns true if the specified year is a leap year in the Gregorian calendar; otherwise returns false.

See also QCalendar::isLeapYear().

Upstream PySide2 reference signatures (binding differences may apply):

isLeapYear(year: int) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#isLeapYear

isNull

isNull() -> bool

X.isNull() -> bool

Supplemental documentation: Qt 5 reference:

bool QDate::isNull() const

Returns true if the date is null; otherwise returns false. A null date is invalid.

Note: The behavior of this function is equivalent to isValid().

See also isValid().

Upstream PySide2 reference signatures (binding differences may apply):

isNull(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#isNull

isValid

isValid(m: Any, d: Any) -> bool

X.isValid(m, d) -> bool

Supplemental documentation: Qt 5 reference:

bool QDate::isValid() const

Returns true if this date is valid; otherwise returns false.

See also isNull() and QCalendar::isDateValid().

[static] bool QDate::isValid(int year, int month, int day)

This is an overloaded function.

Returns true if the specified date (year, month, and day) is valid in the Gregorian calendar; otherwise returns false.

Example:

QDate::isValid(2002, 5, 17);  // true
QDate::isValid(2002, 2, 30);  // false (Feb 30 does not exist)
QDate::isValid(2004, 2, 29);  // true (2004 is a leap year)
QDate::isValid(2000, 2, 29);  // true (2000 is a leap year)
QDate::isValid(2006, 2, 29);  // false (2006 is not a leap year)
QDate::isValid(2100, 2, 29);  // false (2100 is not a leap year)
QDate::isValid(1202, 6, 6);   // true (even though 1202 is pre-Gregorian)

See also isNull(), setDate(), and QCalendar::isDateValid().

Upstream PySide2 reference signatures (binding differences may apply):

isValid(self) -> bool
isValid(y: int, m: int, d: int) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#isValid

longDayName

longDayName(weekday: int, type: Any) -> str

X.longDayName(weekday, type) -> str

Upstream PySide2 reference signatures (binding differences may apply):

longDayName(weekday: int, type: PySide2.QtCore.QDate.MonthNameType=...) -> str

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#longDayName

longMonthName

longMonthName(month: int, type: Any) -> str

X.longMonthName(month, type) -> str

Upstream PySide2 reference signatures (binding differences may apply):

longMonthName(month: int, type: PySide2.QtCore.QDate.MonthNameType=...) -> str

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#longMonthName

month

month() -> int

X.month() -> int

Supplemental documentation: Qt 5 reference:

int QDate::month(QCalendar cal) const

Returns the month-number for the date.

Numbers the months of the year starting with 1 for the first. Uses cal as calendar if supplied, else the Gregorian calendar, for which the month numbering is as follows:

  • 1 \= "January"
  • 2 \= "February"
  • 3 \= "March"
  • 4 \= "April"
  • 5 \= "May"
  • 6 \= "June"
  • 7 \= "July"
  • 8 \= "August"
  • 9 \= "September"
  • 10 \= "October"
  • 11 \= "November"
  • 12 \= "December"

Returns 0 if the date is invalid. Note that some calendars may have more than 12 months in some years.

See also year(), day(), and QCalendar::partsFromDate().

int QDate::month() const

This is an overloaded function.

Upstream PySide2 reference signatures (binding differences may apply):

month(self) -> int
month(self, cal: PySide2.QtCore.QCalendar) -> int

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#month

setDate

setDate(year: int, month: int, day: int) -> bool

X.setDate(year, month, day) -> bool

Supplemental documentation: Qt 5 reference:

bool QDate::setDate(int year, int month, int day)

Sets this to represent the date, in the Gregorian calendar, with the given year, month and day numbers. Returns true if the resulting date is valid, otherwise it sets this to represent an invalid date and returns false.

This function was introduced in Qt 4.2.

See also isValid() and QCalendar::dateFromParts().

bool QDate::setDate(int year, int month, int day, QCalendar cal)

Sets this to represent the date, in the given calendar cal, with the given year, month and day numbers. Returns true if the resulting date is valid, otherwise it sets this to represent an invalid date and returns false.

This function was introduced in Qt 5.14.

See also isValid() and QCalendar::dateFromParts().

Upstream PySide2 reference signatures (binding differences may apply):

setDate(self, year: int, month: int, day: int) -> bool
setDate(self, year: int, month: int, day: int, cal: PySide2.QtCore.QCalendar) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#setDate

shortDayName

shortDayName(weekday: int, type: Any) -> str

X.shortDayName(weekday, type) -> str

Upstream PySide2 reference signatures (binding differences may apply):

shortDayName(weekday: int, type: PySide2.QtCore.QDate.MonthNameType=...) -> str

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#shortDayName

shortMonthName

shortMonthName(month: int, type: Any) -> str

X.shortMonthName(month, type) -> str

Upstream PySide2 reference signatures (binding differences may apply):

shortMonthName(month: int, type: PySide2.QtCore.QDate.MonthNameType=...) -> str

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#shortMonthName

toJulianDay

toJulianDay() -> int

X.toJulianDay() -> int

Supplemental documentation: Qt 5 reference:

qint64 QDate::toJulianDay() const

Converts the date to a Julian day.

See also fromJulianDay().

Upstream PySide2 reference signatures (binding differences may apply):

toJulianDay(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#toJulianDay

toString

toString(f: Any) -> str

X.toString(f) -> str

Supplemental documentation: Qt 5 reference:

QString QDate::toString(QStringView format) const

QString QDate::toString(QStringView format, QCalendar cal) const

QString QDate::toString(const QString \&format) const

QString QDate::toString(const QString \&format, QCalendar cal) const

QString QDate::toString(Qt::DateFormat format \= Qt::TextDate) const

This is an overloaded function.

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

If the format is Qt::TextDate, the string is formatted in the default way. The day and month names will be localized names using the system locale, i.e. QLocale::system(). An example of this formatting is "Sat May 20 1995".

If the format is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, taking the form yyyy-MM-dd, where yyyy is the year, MM is the month of the year (between 01 and 12), and dd is the day of the month between 01 and 31.

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

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

If the format is Qt::RFC2822Date, the string is formatted in an RFC 2822 compatible way. An example of this formatting is "20 May 1995".

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

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

See also fromString() and QLocale::toString().

Upstream PySide2 reference signatures (binding differences may apply):

toString(self, format: PySide2.QtCore.Qt.DateFormat, cal: PySide2.QtCore.QCalendar) -> str
toString(self, format: PySide2.QtCore.Qt.DateFormat=...) -> str
toString(self, format: str) -> str
toString(self, format: str, cal: PySide2.QtCore.QCalendar) -> str

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#toString

weekNumber

weekNumber(yearNum: Any) -> int

X.weekNumber(yearNum) -> int

Supplemental documentation: Qt 5 reference:

int QDate::weekNumber(int *yearNumber \= nullptr) const

Returns the ISO 8601 week number (1 to 53).

Returns 0 if the date is invalid. Otherwise, returns the week number for the date. If yearNumber is not nullptr (its default), stores the year as *yearNumber.

In accordance with ISO 8601, each week falls in the year to which most of its days belong, in the Gregorian calendar. As ISO 8601's week starts on Monday, this is the year in which the week's Thursday falls. Most years have 52 weeks, but some have 53.

Note: *yearNumber is not always the same as year(). For example, 1 January 2000 has week number 52 in the year 1999, and 31 December 2002 has week number 1 in the year 2003.

See also isValid().

Upstream PySide2 reference signatures (binding differences may apply):

weekNumber(self) -> typing.Tuple[int, int]

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#weekNumber

year

year() -> int

X.year() -> int

Supplemental documentation: Qt 5 reference:

int QDate::year(QCalendar cal) const

Returns the year of this date.

Uses cal as calendar, if supplied, else the Gregorian calendar.

Returns 0 if the date is invalid. For some calendars, dates before their first year may all be invalid.

If using a calendar which has a year 0, check using isValid() if the return is 0. Such calendars use negative year numbers in the obvious way, with year 1 preceded by year 0, in turn preceded by year -1 and so on.

Some calendars, despite having no year 0, have a conventional numbering of the years before their first year, counting backwards from 1. For example, in the proleptic Gregorian calendar, successive years before 1 CE (the first year) are identified as 1 BCE, 2 BCE, 3 BCE and so on. For such calendars, negative year numbers are used to indicate these years before year 1, with -1 indicating the year before 1.

See also month(), day(), QCalendar::hasYearZero(), QCalendar::isProleptic(), and QCalendar::partsFromDate().

int QDate::year() const

This is an overloaded function.

Upstream PySide2 reference signatures (binding differences may apply):

year(self) -> int
year(self, cal: PySide2.QtCore.QCalendar) -> int

Source: https://doc.qt.io/archives/qt-5.15/qdate.html#year