cf.month

cf.month(value)

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

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

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

Parameters :

value :

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

Returns :

out : cf.Comparison

The comparison object.

See also

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

Examples

>>> d = cf.dt(2002, 6, 16)
>>> d == cf.month(6)
True
>>> d == cf.month(cf.le(7))
True
>>> d == cf.month(7)
False
>>> d == cf.month(cf.wi(1, 6))
True