Skip to content

Commit 9635dcb

Browse files
committed
DOC: Add missing filters docs
skipci
1 parent d4ac9cc commit 9635dcb

File tree

1 file changed

+110
-0
lines changed

1 file changed

+110
-0
lines changed
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Available filters
2+
3+
Lots of filters are available when using the `Dataset.files.filter`
4+
method. We've broken them down by the type of attribute the datafiles
5+
are being filtered by:
6+
7+
- Numbers (e.g. `int`, `float`):
8+
9+
- `is`
10+
- `is_not`
11+
- `equals`
12+
- `not_equals`
13+
- `lt`
14+
- `lte`
15+
- `gt`
16+
- `gte`
17+
- `in_range`
18+
- `not_in_range`
19+
20+
- Iterables (e.g. `list`, `set`, `tuple`, `dictionary`):
21+
22+
- `is`
23+
- `is_not`
24+
- `equals`
25+
- `not_equals`
26+
- `contains`
27+
- `not_contains`
28+
- `icontains`
29+
- `not_icontains`
30+
31+
- `bool`
32+
33+
- `is`
34+
- `is_not`
35+
36+
- `str`
37+
38+
- `is`
39+
- `is_not`
40+
- `equals`
41+
- `not_equals`
42+
- `iequals`
43+
- `not_iequals`
44+
- `lt` (less than)
45+
- `lte` (less than or equal)
46+
- `gt` (greater than)
47+
- `gte` (greater than or equal)
48+
- `contains`
49+
- `not_contains`
50+
- `icontains` (case-insensitive contains)
51+
- `not_icontains`
52+
- `starts_with`
53+
- `not_starts_with`
54+
- `ends_with`
55+
- `not_ends_with`
56+
- `in_range`
57+
- `not_in_range`
58+
59+
- `NoneType`
60+
61+
- `is`
62+
- `is_not`
63+
64+
- `LabelSet`
65+
66+
- `is`
67+
- `is_not`
68+
- `equals`
69+
- `not_equals`
70+
- `contains`
71+
- `not_contains`
72+
- `any_label_contains`
73+
- `not_any_label_contains`
74+
- `any_label_starts_with`
75+
- `not_any_label_starts_with`
76+
- `any_label_ends_with`
77+
- `not_any_label_ends_with`
78+
79+
- `datetime.datetime`
80+
81+
- `is`
82+
- `is_not`
83+
- `equals`
84+
- `not_equals`
85+
- `lt` (less than)
86+
- `lte` (less than or equal)
87+
- `gt` (greater than)
88+
- `gte` (greater than or equal)
89+
- `in_range`
90+
- `not_in_range`
91+
- `year_equals`
92+
- `year_in`
93+
- `month_equals`
94+
- `month_in`
95+
- `day_equals`
96+
- `day_in`
97+
- `weekday_equals`
98+
- `weekday_in`
99+
- `iso_weekday_equals`
100+
- `iso_weekday_in`
101+
- `time_equals`
102+
- `time_in`
103+
- `hour_equals`
104+
- `hour_in`
105+
- `minute_equals`
106+
- `minute_in`
107+
- `second_equals`
108+
- `second_in`
109+
- `in_date_range`
110+
- `in_time_range`

0 commit comments

Comments
 (0)