search

alex9smith / gdelt-doc-api

A Python client for the GDELT 2.0 Doc API
MIT License
91 stars 20 forks source link

Fix multi repeat OR filter #16

Closed alex9smith closed 2 years ago

alex9smith commented 2 years ago

Any query using this filter failed with the error

TypeError: argument of type 'int' is not iterable

This is because filters using OR require brackets around the statements compared with OR. These brackets must only be used when the filter is using OR - they'll cause an error if they're present for an AND filter.

Add the brackets in for only the OR filters which allows queries to complete successfully.

Fixes https://github.com/alex9smith/gdelt-doc-api/issues/15

Python 3.9.4 (default, May 10 2021, 13:51:57)
Type 'copyright', 'credits' or 'license' for more information
IPython 8.2.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]: from gdeltdoc import Filters, near, repeat, GdeltDoc, multi_repeat
   ...:
   ...: f = Filters(
   ...:     start_date = "2017-05-01",
   ...:     end_date = "2022-02-02",
   ...:     num_records = 250,
   ...:     keyword = "low carbon",
   ...:     near = near(10, 'emission', 'airport'),
   ...:     repeat = multi_repeat([(2, "airline"), (3, "airport")], "OR")
   ...: )
   ...: gd = GdeltDoc()
   ...:
   ...: # Search for articles matching the filters
   ...: articles = gd.article_search(f)

In [2]: articles
Out[2]:
                                                 url                                         url_mobile                                              title  ...                 domain language   sourcecountry
0  https://www.ainonline.com:443/aviation-news/ae...  https://www.ainonline.com/aviation-news/aerosp...           UK Airport Adds Hydrogen Fueling Station  ...          ainonline.com  English   United States
1  https://www.schengenvisainfo.com/news/denmark-...                                                     Denmark Among First EU Countries Determined to...  ...   schengenvisainfo.com  English
2  https://www.newcivilengineer.com/latest/low-em...                                                     Low emission aviation plans are not a green li...  ...   newcivilengineer.com  English  United Kingdom
3  https://www.theengineer.co.uk/decarbonise-avia...                                                                The Engineer Q & A : Green skies ahead  ...      theengineer.co.uk  English  United Kingdom
4  https://centreforaviation.com/analysis/reports...                                                     Aviation Sustainability and the Environment , ...  ...  centreforaviation.com  English           China

[5 rows x 8 columns]