Skip to content

Commit 3c39e0a

Browse files
Electronic-MangoElectronic-Mango
committed
Update release year filter argument names
"min_year" -> "min_release_year" "max_year" -> "max_release_year"
1 parent eaaa3a8 commit 3c39e0a

4 files changed

Lines changed: 52 additions & 45 deletions

File tree

‎docs/usage.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -513,8 +513,8 @@ additional filtering of returned entries.
513513
| Field | Description |
514514
| ------| ----------- |
515515
| `object_types` | Types like `SHOW` or `MOVIE`. Values are not enforced, but types like `SHOW_EPISODE` or `SHOW_SEASON` return shows anyway; like `SHOW`. While not enforced they **must** be valid types. It can be either a list of strings, or a single string. |
516-
| `min_year` | Minimum release year. |
517-
| `max_year` | Maximum release year. |
516+
| `min_release_year` | Minimum release year. |
517+
| `max_release_year` | Maximum release year. |
518518

519519
All filters are optional; when not configured (or set to `None`) the filtering is disabled.
520520

@@ -525,6 +525,11 @@ from simplejustwatchapi import popular, search
525525
popular_shows = popular(object_types=["SHOW"])
526526

527527
# Search for movies between 1990 and 2010:
528-
movies = search("The Matrix", min_year=1990, max_year=2010, object_types="MOVIE")
528+
movies = search(
529+
"The Matrix",
530+
min_release_year=1990,
531+
max_release_year=2010,
532+
object_types="MOVIE"
533+
)
529534
# object_types with single element can be either a list, or just a string.
530535
```

‎src/simplejustwatchapi/justwatch.py‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
returned. Requires 3-letter "short name". Check \
3636
[`providers`][simplejustwatchapi.justwatch.providers] for an example \
3737
of how you can get that value. |
38-
| `min_year` | Minimum release year of returned titles. |
39-
| `max_year` | Maximum release year of returned titles. |
38+
| `min_release_year` | Minimum release year of returned titles. |
39+
| `max_release_year` | Maximum release year of returned titles. |
4040
| `object_types` | Types of objects to filter for, it seems that only `SHOW` and \
4141
`MOVIE` are useful, but it's not strictly enforced. Types like \
4242
`SHOW_EPISODE`, or `SHOW_SEASON` can be used but they seem to \
@@ -85,8 +85,8 @@ def search(
8585
best_only: bool = True,
8686
offset: int = 0,
8787
providers: list[str] | str | None = None,
88-
min_year: int | None = None,
89-
max_year: int | None = None,
88+
min_release_year: int | None = None,
89+
max_release_year: int | None = None,
9090
object_types: list[str] | str | None = None,
9191
) -> list[MediaEntry]:
9292
"""
@@ -157,10 +157,10 @@ def search(
157157
You can look up values through [`providers`]
158158
[simplejustwatchapi.justwatch.providers] function.
159159
160-
min_year (int | None): Minimum release year of returned titles.
160+
min_release_year (int | None): Minimum release year of returned titles.
161161
If `None` (the default value), no filtering is done.
162162
163-
max_year (int | None): Maximum release year of returned titles.
163+
max_release_year (int | None): Maximum release year of returned titles.
164164
If `None` (the default value), no filtering is done.
165165
166166
object_types (list[str] | str | None): Types of objects to filter for, it seems
@@ -187,8 +187,8 @@ def search(
187187
best_only,
188188
offset,
189189
providers,
190-
min_year,
191-
max_year,
190+
min_release_year,
191+
max_release_year,
192192
object_types,
193193
)
194194
response = _post_to_jw_graphql_api(request)
@@ -202,8 +202,8 @@ def popular(
202202
best_only: bool = True,
203203
offset: int = 0,
204204
providers: list[str] | str | None = None,
205-
min_year: int | None = None,
206-
max_year: int | None = None,
205+
min_release_year: int | None = None,
206+
max_release_year: int | None = None,
207207
object_types: list[str] | str | None = None,
208208
) -> list[MediaEntry]:
209209
"""
@@ -266,10 +266,10 @@ def popular(
266266
You can look up values through [`providers`]
267267
[simplejustwatchapi.justwatch.providers] function.
268268
269-
min_year (int | None): Minimum release year of returned titles.
269+
min_release_year (int | None): Minimum release year of returned titles.
270270
If `None` (the default value), no filtering is done.
271271
272-
max_year (int | None): Maximum release year of returned titles.
272+
max_release_year (int | None): Maximum release year of returned titles.
273273
If `None` (the default value), no filtering is done.
274274
275275
object_types (list[str] | str | None): Types of objects to filter for, it seems
@@ -295,8 +295,8 @@ def popular(
295295
best_only,
296296
offset,
297297
providers,
298-
min_year,
299-
max_year,
298+
min_release_year,
299+
max_release_year,
300300
object_types,
301301
)
302302
response = _post_to_jw_graphql_api(request)

‎src/simplejustwatchapi/query.py‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ def prepare_search_request(
4444
best_only: bool,
4545
offset: int,
4646
providers: list[str] | str | None,
47-
min_year: int | None,
48-
max_year: int | None,
47+
min_release_year: int | None,
48+
max_release_year: int | None,
4949
object_types: list[str] | str | None,
5050
) -> dict[str, Any]:
5151
"""
@@ -69,8 +69,8 @@ def prepare_search_request(
6969
offset (int): Search results offset.
7070
providers (list[str] | str | None): 3-letter service identifier(s),
7171
or `None` for all providers.
72-
min_year (int | None): Minimum release year of returned titles.
73-
max_year (int | None): Maximum release year of returned titles.
72+
min_release_year (int | None): Minimum release year of returned titles.
73+
max_release_year (int | None): Maximum release year of returned titles.
7474
object_types (list[str] | str | None): Types of objects to filter for, it seems
7575
that only "SHOW" and "MOVIE" make sense.
7676
@@ -85,7 +85,7 @@ def prepare_search_request(
8585
"searchTitlesFilter": {
8686
"searchQuery": title,
8787
"packages": providers,
88-
**_list_variables(min_year, max_year, object_types),
88+
**_list_variables(min_release_year, max_release_year, object_types),
8989
},
9090
**_common_variables(best_only),
9191
**_locale_variables(country, language),
@@ -129,8 +129,8 @@ def prepare_popular_request(
129129
best_only: bool,
130130
offset: int,
131131
providers: list[str] | str | None,
132-
min_year: int | None,
133-
max_year: int | None,
132+
min_release_year: int | None,
133+
max_release_year: int | None,
134134
object_types: list[str] | str | None,
135135
) -> dict[str, Any]:
136136
"""
@@ -153,8 +153,8 @@ def prepare_popular_request(
153153
offset (int): Search results offset.
154154
providers (list[str] | str | None): 3-letter service identifier(s),
155155
or `None` for all providers.
156-
min_year (int | None): Minimum release year of returned titles.
157-
max_year (int | None): Maximum release year of returned titles.
156+
min_release_year (int | None): Minimum release year of returned titles.
157+
max_release_year (int | None): Maximum release year of returned titles.
158158
object_types (list[str] | str | None): Types of objects to filter for, it seems
159159
that only "SHOW" and "MOVIE" make sense.
160160
@@ -168,7 +168,7 @@ def prepare_popular_request(
168168
"first": count,
169169
"popularTitlesFilter": {
170170
"packages": providers,
171-
**_list_variables(min_year, max_year, object_types),
171+
**_list_variables(min_release_year, max_release_year, object_types),
172172
},
173173
**_common_variables(best_only),
174174
**_locale_variables(country, language),
@@ -529,12 +529,14 @@ def _locale_variables(country: str, language: str) -> dict[str, str]:
529529

530530

531531
def _list_variables(
532-
min_year: int | None, max_year: int | None, object_types: list[str] | str | None
532+
min_release_year: int | None,
533+
max_release_year: int | None,
534+
object_types: list[str] | str | None,
533535
) -> dict[str, Any]:
534536
"""Return dict with variables related to looking up lists of titles."""
535537
return {
536538
"objectTypes": object_types,
537-
"releaseYear": {"min": min_year, "max": max_year},
539+
"releaseYear": {"min": min_release_year, "max": max_release_year},
538540
}
539541

540542

‎test/simplejustwatchapi/test_request.py‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ def locale_variables(country, language):
3939
}
4040

4141

42-
def list_variables(min_year, max_year, object_types):
42+
def list_variables(min_release_year, max_release_year, object_types):
4343
return {
4444
"objectTypes": object_types,
45-
"releaseYear": {"min": min_year, "max": max_year},
45+
"releaseYear": {"min": min_release_year, "max": max_release_year},
4646
}
4747

4848

@@ -56,8 +56,8 @@ def list_variables(min_year, max_year, object_types):
5656
"best_only",
5757
"offset",
5858
"providers",
59-
"min_year",
60-
"max_year",
59+
"min_release_year",
60+
"max_release_year",
6161
"object_types",
6262
),
6363
argvalues=[
@@ -98,8 +98,8 @@ def test_prepare_search_request(
9898
best_only,
9999
offset,
100100
providers,
101-
min_year,
102-
max_year,
101+
min_release_year,
102+
max_release_year,
103103
object_types,
104104
):
105105
expected_request = {
@@ -109,7 +109,7 @@ def test_prepare_search_request(
109109
"searchTitlesFilter": {
110110
"searchQuery": title,
111111
"packages": providers,
112-
**list_variables(min_year, max_year, object_types),
112+
**list_variables(min_release_year, max_release_year, object_types),
113113
},
114114
**common_variables(best_only),
115115
**locale_variables(country, language),
@@ -125,8 +125,8 @@ def test_prepare_search_request(
125125
best_only,
126126
offset,
127127
providers,
128-
min_year,
129-
max_year,
128+
min_release_year,
129+
max_release_year,
130130
object_types,
131131
)
132132
assert expected_request == request
@@ -141,8 +141,8 @@ def test_prepare_search_request(
141141
"best_only",
142142
"offset",
143143
"providers",
144-
"min_year",
145-
"max_year",
144+
"min_release_year",
145+
"max_release_year",
146146
"object_types",
147147
),
148148
argvalues=[
@@ -160,8 +160,8 @@ def test_prepare_popular_request(
160160
best_only,
161161
offset,
162162
providers,
163-
min_year,
164-
max_year,
163+
min_release_year,
164+
max_release_year,
165165
object_types,
166166
):
167167
expected_request = {
@@ -170,7 +170,7 @@ def test_prepare_popular_request(
170170
"first": count,
171171
"popularTitlesFilter": {
172172
"packages": providers,
173-
**list_variables(min_year, max_year, object_types),
173+
**list_variables(min_release_year, max_release_year, object_types),
174174
},
175175
**common_variables(best_only),
176176
**locale_variables(country, language),
@@ -185,8 +185,8 @@ def test_prepare_popular_request(
185185
best_only,
186186
offset,
187187
providers,
188-
min_year,
189-
max_year,
188+
min_release_year,
189+
max_release_year,
190190
object_types,
191191
)
192192
assert expected_request == request

0 commit comments

Comments
 (0)