class documentation

class relativedelta(object): (source)

View In Hierarchy

The relativedelta type is designed to be applied to an existing datetime and can replace specific components of that datetime, or represents an interval of time. It is based on the specification of the excellent work done by M.-A. Lemburg in his `mx.DateTime <https://www.egenix.com/products/python/mxBase/mxDateTime/>`_ extension. However, notice that this type does *NOT* implement the same algorithm as his work. Do *NOT* expect it to behave like mx.DateTime's counterpart. There are two different ways to build a relativedelta instance. The first one is passing it two date/datetime classes:: relativedelta(datetime1, datetime2) The second one is passing it any number of the following keyword arguments:: relativedelta(arg1=x,arg2=y,arg3=z...) year, month, day, hour, minute, second, microsecond: Absolute information (argument is singular); adding or subtracting a relativedelta with absolute information does not perform an arithmetic operation, but rather REPLACES the corresponding value in the original datetime with the value(s) in relativedelta. years, months, weeks, days, hours, minutes, seconds, microseconds: Relative information, may be negative (argument is plural); adding or subtracting a relativedelta with relative information performs the corresponding arithmetic operation on the original datetime value with the information in the relativedelta. weekday: One of the weekday instances (MO, TU, etc) available in the relativedelta module. These instances may receive a parameter N, specifying the Nth weekday, which could be positive or negative (like MO(+1) or MO(-2)). Not specifying it is the same as specifying +1. You can also use an integer, where 0=MO. This argument is always relative e.g. if the calculated date is already Monday, using MO(1) or MO(-1) won't change the day. To effectively make it absolute, use it in combination with the day argument (e.g. day=1, MO(1) for first Monday of the month). leapdays: Will add given days to the date found, if year is a leap year, and the date found is post 28 of february. yearday, nlyearday: Set the yearday or the non-leap year day (jump leap days). These are converted to day/month/leapdays information. There are relative and absolute forms of the keyword arguments. The plural is relative, and the singular is absolute. For each argument in the order below, the absolute form is applied first (by setting each attribute to that value) and then the relative form (by adding the value to the attribute). The order of attributes considered when this relativedelta is added to a datetime is: 1. Year 2. Month 3. Day 4. Hours 5. Minutes 6. Seconds 7. Microseconds Finally, weekday is applied, using the rule described above. For example >>> from datetime import datetime >>> from dateutil.relativedelta import relativedelta, MO >>> dt = datetime(2018, 4, 9, 13, 37, 0) >>> delta = relativedelta(hours=25, day=1, weekday=MO(1)) >>> dt + delta datetime.datetime(2018, 4, 2, 14, 37) First, the day is set to 1 (the first of the month), then 25 hours are added, to get to the 2nd day and 14th hour, finally the weekday is applied, but since the 2nd is already a Monday there is no effect.

Method __abs__ Undocumented
Method __add__ Undocumented
Method __bool__ Undocumented
Method __div__ Undocumented
Method __eq__ Undocumented
Method __hash__ Undocumented
Method __init__ Undocumented
Method __mul__ Undocumented
Method __ne__ Undocumented
Method __neg__ Undocumented
Method __radd__ Undocumented
Method __repr__ Undocumented
Method __rsub__ Undocumented
Method __sub__ Undocumented
Method normalized Return a version of this object represented entirely using integer values for the relative attributes.
Method weeks.setter Undocumented
Instance Variable day Undocumented
Instance Variable days Undocumented
Instance Variable hour Undocumented
Instance Variable hours Undocumented
Instance Variable leapdays Undocumented
Instance Variable microsecond Undocumented
Instance Variable microseconds Undocumented
Instance Variable minute Undocumented
Instance Variable minutes Undocumented
Instance Variable month Undocumented
Instance Variable months Undocumented
Instance Variable second Undocumented
Instance Variable seconds Undocumented
Instance Variable weekday Undocumented
Instance Variable year Undocumented
Instance Variable years Undocumented
Property weeks Undocumented
Method _fix Undocumented
Method _set_months Undocumented
Instance Variable _has_time Undocumented
def __abs__(self): (source)

Undocumented

def __add__(self, other): (source)

Undocumented

def __bool__(self): (source)

Undocumented

def __div__(self, other): (source)

Undocumented

def __eq__(self, other): (source)

Undocumented

def __hash__(self): (source)

Undocumented

def __init__(self, dt1=None, dt2=None, years=0, months=0, days=0, leapdays=0, weeks=0, hours=0, minutes=0, seconds=0, microseconds=0, year=None, month=None, day=None, weekday=None, yearday=None, nlyearday=None, hour=None, minute=None, second=None, microsecond=None): (source)

Undocumented

def __mul__(self, other): (source)

Undocumented

def __ne__(self, other): (source)

Undocumented

def __neg__(self): (source)

Undocumented

def __radd__(self, other): (source)

Undocumented

def __repr__(self): (source)

Undocumented

def __rsub__(self, other): (source)

Undocumented

def __sub__(self, other): (source)

Undocumented

def normalized(self): (source)

Return a version of this object represented entirely using integer values for the relative attributes. >>> relativedelta(days=1.5, hours=2).normalized() relativedelta(days=+1, hours=+14) :return: Returns a :class:`dateutil.relativedelta.relativedelta` object.

@weeks.setter
def weeks(self, value): (source)

Undocumented

Undocumented

days = (source)

Undocumented

hour = (source)

Undocumented

hours = (source)

Undocumented

leapdays: int = (source)

Undocumented

microsecond = (source)

Undocumented

microseconds = (source)

Undocumented

minute = (source)

Undocumented

minutes = (source)

Undocumented

month = (source)

Undocumented

months = (source)

Undocumented

second = (source)

Undocumented

seconds = (source)

Undocumented

weekday = (source)

Undocumented

year = (source)

Undocumented

years = (source)

Undocumented

Undocumented

def _fix(self): (source)

Undocumented

def _set_months(self, months): (source)

Undocumented

_has_time: int = (source)

Undocumented