# wx.DateSpan¶

Inheritance diagram for wx.DateSpan:

## Description¶

This class is a “logical time span” and is useful for implementing program logic for such things as “add one month to the date” which, in general, doesn’t mean to add 60*60*24*31 seconds to it, but to take the same date the next month (to understand that this is indeed different consider adding one month to Feb, 15 – we want to get Mar, 15, of course).

When adding a month to the date, all lesser components (days, hours, etc...) won’t be changed unless the resulting date would be invalid: for example, Jan 31 + 1 month will be Feb 28, not (non-existing) Feb 31.

Because of this feature, adding and subtracting back again the same wx.DateSpan will not, in general give back the original date: Feb 28 - 1 month will be Jan 28, not Jan 31!

wx.DateSpan objects can be either positive or negative. They may be multiplied by scalars which multiply all deltas by the scalar: i.e. 2*(1 month and 1 day) is 2 months and 2 days. They can be added together and with wx.DateTime or wx.TimeSpan, but the type of result is different for each case.

Warning

Beware about weeks: if you specify both weeks and days, the total number of days added will be 7*weeks + days! See also GetTotalDays function.

Equality operators are defined for wx.DateSpans. Two datespans are equal if and only if they both give the same target date when added to every source date. Thus Months (1) is not equal to Days (30), because they don’t give the same date when added to 1 Feb. But Days (14) is equal to Weeks (2).

Note

Finally, notice that for adding hours, minutes and so on you don’t need this class at all: wx.TimeSpan will do the job because there are no subtleties associated with those (we don’t support leap seconds).

wx.DateTime

## Class API¶

### Methods¶

__init__(years=0, months=0, weeks=0, days=0)

Constructor. Constructs the date span object for the given number of years, months, weeks and days.

Parameters:

• years (int)
• months (int)
• weeks (int)
• days (int)

Returns:

wx.DateSpan

Note

Note that the weeks and days add together if both are given.

Returns the sum of two date spans. The first version returns a new object, the second and third ones modify this object in place.

Parameters:

Returns:

wx.DateSpan

Day()

Returns a date span object corresponding to one day.

Returns:

wx.DateSpan

Days

Days()

Returns a date span object corresponding to the given number of days.

Returns:

wx.DateSpan

Day

GetDays()

Returns the number of days (only, that it not counting the weeks component!) in this date span.

Returns:

int

GetTotalDays

GetMonths()

Returns the number of the months (not counting the years) in this date span.

Returns:

int

GetTotalDays()

Returns the combined number of days in this date span, counting both weeks and days. It still doesn’t take neither months nor years into the account.

Returns:

int

GetWeeks()

Returns the number of weeks in this date span.

Returns:

int

GetTotalDays

GetYears()

Returns the number of years in this date span.

Returns:

int

Month(mon)

Returns a date span object corresponding to one month.

Parameters:

• mon (int)

Returns:

wx.DateSpan

Months

Months(mon)

Returns a date span object corresponding to the given number of months.

Parameters:

• mon (int)

Returns:

wx.DateSpan

Month

Multiply(factor)

Returns the product of the date span by the specified factor. The product is computed by multiplying each of the components by the factor. The first version returns a new object, the second and third ones modify this object in place.

Parameters:

• factor (int)

Returns:

wx.DateSpan

Neg()

Changes the sign of this date span.

Returns:

wx.DateSpan

SetDays(n)

Sets the number of days (without modifying any other components) in this date span.

Parameters:

• n (int)

Returns:

wx.DateSpan

SetMonths(n)

Sets the number of months (without modifying any other components) in this date span.

Parameters:

• n (int)

Returns:

wx.DateSpan

SetWeeks(n)

Sets the number of weeks (without modifying any other components) in this date span.

Parameters:

• n (int)

Returns:

wx.DateSpan

SetYears(n)

Sets the number of years (without modifying any other components) in this date span.

Parameters:

• n (int)

Returns:

wx.DateSpan

Subtract(other)

Returns the difference of two date spans. The first version returns a new object, the second and third ones modify this object in place.

Parameters:

Returns:

wx.DateSpan

Week()

Returns a date span object corresponding to one week.

Returns:

wx.DateSpan

Weeks

Weeks(weeks)

Returns a date span object corresponding to the given number of weeks.

Parameters:

• weeks (int)

Returns:

wx.DateSpan

Week

Year(n)

Returns a date span object corresponding to one year.

Parameters:

• n (int)

Returns:

wx.DateSpan

Years

Years(years)

Returns a date span object corresponding to the given number of years.

Parameters:

• years (int)

Returns:

wx.DateSpan

Year

### Properties¶

days
See GetDays and SetDays
months
See GetMonths and SetMonths
totalDays
See GetTotalDays
weeks
See GetWeeks and SetWeeks
years
See GetYears and SetYears