cf.year

cf.year(value)

Return a comparison object for the year of a datetime variable.

In this context, a datetime variable is any object which has a year attribute.

If value is a cf.Comparison object then cf.year(value) is equivalent to value.addattr('year'). Otherwise cf.year(value) is equivalent to cf.eq(value, attr='year').

Parameters :

value :

Either the value that the year is to be compared with, or a cf.Comparison object for testing the year.

Returns :

out : cf.Comparison

The comparison object.

See also

year, month, day, hour, minute, second, dteq, dtge, dtgt, dtne, dtle, dtlt

Examples

>>> d = cf.dt(2002, 6, 16)
>>> d == cf.year(2002)
True
>>> d == cf.year(cf.le(2003))
True
>>> d == cf.year(2001)
False
>>> d == cf.year(cf.wi(2003, 2006))
False