QDate¶

PyQt5.QtCore.QDate

Description¶

The QDate class provides date functions.

A QDate object encodes a calendar date, i.e. year, month, and day numbers, in the proleptic Gregorian calendar by default. It can read the current date from the system clock. It provides functions for comparing dates, and for manipulating dates. For example, it is possible to add and subtract days, months, and years to dates.

A QDate object is typically created by giving the year, month, and day numbers explicitly. Note that QDate interprets two digit years as presented, i.e., as years 0 through 99, without adding any offset. A QDate can also be constructed with the static function currentDate(), which creates a QDate object containing the system clock’s date. An explicit date can also be set using setDate(). The fromString() function returns a QDate given a string and a date format which is used to interpret the date within the string.

The year(), month(), and day() functions provide access to the year, month, and day numbers. Also, dayOfWeek() and dayOfYear() functions are provided. The same information is provided in textual format by the toString(), shortDayName(), longDayName(), shortMonthName(), and longMonthName() functions.

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

You can increment (or decrement) a date by a given number of days using addDays(). Similarly you can use addMonths() and addYears(). The daysTo() function returns the number of days between two dates.

The daysInMonth() and daysInYear() functions return how many days there are in this date’s month and year, respectively. The isLeapYear() function indicates whether a date is in a leap year.

Remarks¶

No Year 0¶

There is no year 0. Dates in that year are considered invalid. The year -1 is the year “1 before Christ” or “1 before current era.” The day before 1 January 1 CE, QDate(1, 1, 1), is 31 December 1 BCE, QDate(-1, 12, 31).

Range of Valid Dates¶

Dates are stored internally as a Julian Day number, an integer count of every day in a contiguous range, with 24 November 4714 BCE in the Gregorian calendar being Julian Day 0 (1 January 4713 BCE in the Julian calendar). As well as being an efficient and accurate way of storing an absolute date, it is suitable for converting a Date into other calendar systems such as Hebrew, Islamic or Chinese. The Julian Day number can be obtained using toJulianDay() and can be set using fromJulianDay().

The range of dates able to be stored by QDate as a Julian Day number is for technical reasons limited to between -784350574879 and 784354017364, which means from before 2 billion BCE to after 2 billion CE.

See also

QTime, QDateTime.

Enums¶

MonthNameType

This enum describes the types of the string representation used for the month name.

Member	Value	Description
DateFormat	0	This type of name can be used for date-to-string formatting.
StandaloneFormat	1	This type is used when you need to enumerate months or weekdays. Usually standalone names are represented in singular forms with capitalized first letter.

Methods¶

__init__(): TODO

__init__(QDate): TODO

__init__(int, int, int)

Constructs a date with year y, month m and day d.

If the specified date is invalid, the date is not set and isValid() returns false.

Warning: Years 1 to 99 are interpreted as is. Year 0 is invalid.

See also

isValid().

__init__(int, int, int, QCalendar): TODO

addDays(int) → QDate: TODO

addMonths(int) → QDate

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

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.

See also

addDays(), addYears().

addMonths(int, QCalendar) → QDate: TODO

addYears(int) → QDate

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

Note: If the ending day/month combination does not exist in the resulting year (i.e., 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 (that is, Feb 28).

See also

addDays(), addMonths().

addYears(int, QCalendar) → QDate: TODO

__bool__() → int: TODO

@staticmethod currentDate() → QDate: TODO

day() → int

Returns the day of the month (1 to 31) of this date.

Returns 0 if the date is invalid.

See also

year(), month(), dayOfWeek().

day(QCalendar) → int: TODO

dayOfWeek() → int

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

Returns 0 if the date is invalid.

See also

day(), dayOfYear(), DayOfWeek.

dayOfWeek(QCalendar) → int: TODO

dayOfYear() → int

Returns the day of the year (1 to 365 or 366 on leap years) for this date.

Returns 0 if the date is invalid.

See also

day(), dayOfWeek().

dayOfYear(QCalendar) → int: TODO

daysInMonth() → int

Returns the number of days in the month (28 to 31) for this date.

Returns 0 if the date is invalid.

See also

day(), daysInYear().

daysInMonth(QCalendar) → int: TODO

daysInYear() → int

Returns the number of days in the year (365 or 366) for this date.

Returns 0 if the date is invalid.

See also

day(), daysInMonth().

daysInYear(QCalendar) → int: TODO

daysTo(Union[QDate, datetime.date]) → int

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().

endOfDay(QTimeZone) → QDateTime: TODO

endOfDay(spec: TimeSpec = LocalTime, offsetSeconds: int = 0) → QDateTime: TODO

__eq__(Union[QDate, datetime.date]) → bool: TODO

@staticmethod fromJulianDay(int) → QDate: TODO

@staticmethod fromString(str, format: DateFormat = TextDate) → QDate: TODO

@staticmethod fromString(str, str) → QDate: TODO

@staticmethod fromString(str, str, QCalendar) → QDate: TODO

__ge__(Union[QDate, datetime.date]) → bool: TODO

getDate() → (int, int, int): TODO

__gt__(Union[QDate, datetime.date]) → bool: TODO

__hash__() → int: TODO

@staticmethod isLeapYear(int) → bool: TODO

isNull() → bool: TODO

isValid() → bool: TODO

@staticmethod isValid(int, int, int) → bool

This is an overloaded function.

Returns true if the specified date (year, month, and day) is valid; 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().

__le__(Union[QDate, datetime.date]) → bool: TODO

@staticmethod longDayName(int, type: MonthNameType = DateFormat) → str: TODO

@staticmethod longMonthName(int, type: MonthNameType = DateFormat) → str: TODO

__lt__(Union[QDate, datetime.date]) → bool: TODO

month() → int

Returns the number corresponding to the month of this date, using the following convention:

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.

See also

year(), day().

month(QCalendar) → int: TODO

__ne__(Union[QDate, datetime.date]) → bool: TODO

__repr__() → str: TODO

setDate(int, int, int) → bool

Sets the date’s year, month, and day. Returns true if the date is valid; otherwise returns false.

If the specified date is invalid, the QDate object is set to be invalid.

See also

isValid().

setDate(int, int, int, QCalendar) → bool: TODO

@staticmethod shortDayName(int, type: MonthNameType = DateFormat) → str: TODO

@staticmethod shortMonthName(int, type: MonthNameType = DateFormat) → str: TODO

startOfDay(QTimeZone) → QDateTime: TODO

startOfDay(spec: TimeSpec = LocalTime, offsetSeconds: int = 0) → QDateTime: TODO

toJulianDay() → int: TODO

toPyDate() → datetime.date: TODO

toString(format: DateFormat = TextDate) → str: TODO

toString(str) → str: TODO

toString(DateFormat, QCalendar) → str: TODO

toString(str, QCalendar) → str: TODO

weekNumber() → (int, int)

Returns the week number (1 to 53), and stores the year in *yearNumber unless yearNumber is null (the default).

Returns 0 if the date is invalid.

In accordance with ISO 8601, weeks start on Monday and the first Thursday of a year is always in week 1 of that year. Most years have 52 weeks, but some have 53.

*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().

year() → int

Returns the year of this date. Negative numbers indicate years before 1 CE, such that year -44 is 44 BCE.

Returns 0 if the date is invalid.

See also

month(), day().

year(QCalendar) → int: TODO