Skip to content

Allow a sequence as input to some cf.Query constructors #976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidhassell merged 1 commit into from
Nov 10, 2026
Merged

Allow a sequence as input to some cf.Query constructors #976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ Version NEXTVERSION

**2026-10-??**

* Allow a sequence as input to `cf.year`, `cf.month`, `cf.day`,
`cf.hour`, `cf.minute`, and `cf.second`
(https://github.com/NCAS-CMS/cf-python/issues/974)
* Fix problems creating CFA variables with `cf.write` from
aggregation-promoted field ancillaries
(https://github.com/NCAS-CMS/cf-python/issues/971)
Expand Down
102 changes: 72 additions & 30 deletions cf/query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1974,6 +1974,24 @@ def contains(value, units=None):
)


def _YMDhms(value, attr):
"""Worker function for time duration functions.

See `cf.year`, `cf.month`, `cf.day`, `cf.hour`, `cf.minute`,
`cf.second` for details.

.. versionadded:: NEXTVERSION

"""
if isinstance(value, Query):
return value.addattr(attr)

if np.array(value).ndim == 1:
return Query("set", value, attr=attr)

return Query("eq", value, attr=attr)


def year(value):
"""A `Query` object for a "year" condition.

Expand All @@ -1984,7 +2002,10 @@ def year(value):
:Parameter:

value:
The query condition's value.
The query condition's value. If *value* is a sequence then
it is automatically converted to a "member of set"
condition for the values, e.g. ``[1959, 1961]`` is
equivalent to ``cf.set([1959, 1961])``.

:Returns:

Expand All @@ -2002,12 +2023,13 @@ def year(value):
False
>>> d == cf.year(cf.wi(2003, 2006))
False
>>> d == cf.year([2002, 2006])
True
>>> d == cf.year(cf.set([2002, 2006]))
True

"""
if isinstance(value, Query):
return value.addattr("year")
else:
return Query("eq", value, attr="year")
return _YMDhms(value, "year")


def month(value):
Expand All @@ -2020,7 +2042,10 @@ def month(value):
:Parameter:

value:
The query condition's value.
The query condition's value. If *value* is a sequence then
it is automatically converted to a "member of set"
condition for the values, e.g. ``[12, 1]`` is equivalent
to ``cf.set([12, 1])``.

:Returns:

Expand All @@ -2038,12 +2063,13 @@ def month(value):
False
>>> d == cf.month(cf.wi(1, 6))
True
>>> d == cf.month([5, 6])
True
>>> d == cf.month(cf.set([5, 6]))
True

"""
if isinstance(value, Query):
return value.addattr("month")
else:
return Query("eq", value, attr="month")
return _YMDhms(value, "month")


def day(value):
Expand All @@ -2056,7 +2082,10 @@ def day(value):
:Parameter:

value:
The query condition's value.
The query condition's value. If *value* is a sequence then
it is automatically converted to a "member of set"
condition for the values, e.g. ``[12, 1]`` is equivalent
to ``cf.set([12, 1])``.

:Returns:

Expand All @@ -2074,12 +2103,13 @@ def day(value):
False
>>> d == cf.day(cf.wi(1, 21))
True
>>> d == cf.day([5, 16])
True
>>> d == cf.day(cf.set([5, 16]))
True

"""
if isinstance(value, Query):
return value.addattr("day")
else:
return Query("eq", value, attr="day")
return _YMDhms(value, "day")


def hour(value):
Expand All @@ -2092,7 +2122,10 @@ def hour(value):
:Parameter:

value:
The query condition's value.
The query condition's value. If *value* is a sequence then
it is automatically converted to a "member of set"
condition for the values, e.g. ``[12, 1]`` is equivalent
to ``cf.set([12, 1])``.

:Returns:

Expand Down Expand Up @@ -2131,12 +2164,13 @@ def hour(value):
False
>>> d == cf.hour(cf.wi(6, 23))
True
>>> d == cf.hour([5, 18])
True
>>> d == cf.hour(cf.set([5, 18]))
True

"""
if isinstance(value, Query):
return value.addattr("hour")
else:
return Query("eq", value, attr="hour")
return _YMDhms(value, "hour")


def minute(value):
Expand All @@ -2149,7 +2183,10 @@ def minute(value):
:Parameter:

value:
The query condition's value.
The query condition's value. If *value* is a sequence then
it is automatically converted to a "member of set"
condition for the values, e.g. ``[12, 1]`` is equivalent
to ``cf.set([12, 1])``.

:Returns:

Expand All @@ -2167,12 +2204,13 @@ def minute(value):
False
>>> d == cf.minute(cf.wi(15, 45))
True
>>> d == cf.minute([5, 30])
True
>>> d == cf.minute(cf.set([5, 30]))
True

"""
if isinstance(value, Query):
return value.addattr("minute")
else:
return Query("eq", value, attr="minute")
return _YMDhms(value, "minute")


def second(value):
Expand All @@ -2185,7 +2223,10 @@ def second(value):
:Parameter:

value:
The query condition's value.
The query condition's value. If *value* is a sequence then
it is automatically converted to a "member of set"
condition for the values, e.g. ``[12, 1]`` is equivalent
to ``cf.set([12, 1])``.

:Returns:

Expand All @@ -2203,12 +2244,13 @@ def second(value):
False
>>> d == cf.second(cf.wi(0, 30))
True
>>> d == cf.second([5, 0])
True
>>> d == cf.second(cf.set([5, 0]))
True

"""
if isinstance(value, Query):
return value.addattr("second")
else:
return Query("eq", value, attr="second")
return _YMDhms(value, "second")


def cellsize(value, units=None):
Expand Down
70 changes: 64 additions & 6 deletions cf/test/test_Query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,26 +277,84 @@ def test_Query_year_month_day_hour_minute_second(self):
cf.Data([[True, False], [False, True]])
)
)
self.assertTrue(
(d == cf.year([2000])).equals(
cf.Data([[True, False], [False, True]])
)
)
self.assertTrue(
(d == cf.year([2000, 2001])).equals(
cf.Data([[True, True], [True, True]])
)
)
self.assertTrue(
(d == cf.month(12)).equals(cf.Data([[True, False], [False, True]]))
)
self.assertTrue(
(d == cf.month([12])).equals(
cf.Data([[True, False], [False, True]])
)
)
self.assertTrue(
(d == cf.month([12, 1])).equals(
cf.Data([[True, True], [True, True]])
)
)
self.assertTrue(
(d == cf.day(3)).equals(cf.Data([[False, True], [False, False]]))
)
d = cf.Data([[1.0, 5], [6, 2]], "hours since 2000-12-29 21:57:57")
self.assertTrue(
(d == cf.day([3])).equals(cf.Data([[False, True], [False, False]]))
)
self.assertTrue(
(d == cf.day([3, 30])).equals(
cf.Data([[True, True], [False, False]])
)
)
d = cf.Data([[1.0, 5], [6, 2]], "hours since 2000-12-29 21:58:59")
self.assertTrue(
(d == cf.hour(2)).equals(cf.Data([[False, True], [False, False]]))
)
d = cf.Data([[1.0, 5], [6, 2]], "minutes since 2000-12-29 21:57:57")
self.assertTrue(
(d == cf.minute(2)).equals(
(d == cf.hour([2])).equals(
cf.Data([[False, True], [False, False]])
)
)
d = cf.Data([[1.0, 5], [6, 2]], "seconds since 2000-12-29 21:57:57")
self.assertTrue(
(d == cf.second(2)).equals(
cf.Data([[False, True], [False, False]])
(d == cf.hour([2, 3])).equals(
cf.Data([[False, True], [True, False]])
)
)
d = cf.Data([[1.0, 5], [6, 2]], "minutes since 2000-12-29 21:58:59")
self.assertTrue(
(d == cf.minute(59)).equals(
cf.Data([[True, False], [False, False]])
)
)
self.assertTrue(
(d == cf.minute([59])).equals(
cf.Data([[True, False], [False, False]])
)
)
self.assertTrue(
(d == cf.minute([59, 0])).equals(
cf.Data([[True, False], [False, True]])
)
)
d = cf.Data([[1.0, 5], [6, 2]], "seconds since 2000-12-29 21:58:59")
self.assertTrue(
(d == cf.second(0)).equals(
cf.Data([[True, False], [False, False]])
)
)
self.assertTrue(
(d == cf.second([0])).equals(
cf.Data([[True, False], [False, False]])
)
)
self.assertTrue(
(d == cf.second([0, 1])).equals(
cf.Data([[True, False], [False, True]])
)
)
d = cf.Data([[1.0, 5.0], [6, 2]], "days since 2000-12-29 21:57:57")
Expand Down
Loading