Boolean API params about pyinaturalist HOT 6 CLOSED

Good catch! After looking over the API docs some more, it looks like this applies to all boolean parameters. For example:

# Returns 1 result (not expected):
get_observations({'id':43039160, 'taxon_is_active': False})
# Returns 0 results (expected):
get_observations({'id':43039160, 'taxon_is_active': 'false'})

I think this would be simple enough to address by applying some more param processing in make_inaturalist_api_get_call(), for example:

def convert_bool_params(params):      
    for k, v in params.items():       
        if isinstance(v, bool):       
            params[k] = str(v).lower()
    return params                     

I'm also going to look through the API docs some more to see if there are any other request parameter types that might need special handling.

from pyinaturalist.

Looks like we have the following parameter types in the Node API:

Array[integrer]
Array[string]  
boolean        
date           
date-time      
double         
file           
integer        
string         

Arrays should already be handled by concat_list_params(). I can submit a PR for booleans.

from pyinaturalist.

EDIT: Moved comments on datetimes to Issue #18

from pyinaturalist.

Thanks for the great PR, @JWCook! That's now merged.

I just keep this issue open so I remember to add an additional "high level" test to ensure that the new conversion functions are actually called from the various user-callable functions (I know they are, it's just for the future). For example:

• test that get_taxa(q='Lixus bardanae', is_active=False) (the first example at the top of this issue) gives the expected result.
• also test your other fix (for integer lists) is applied from those methods.

from pyinaturalist.

@niconoe I just added some more tests to PR #20 (see this commit), since that also involves request param conversion.

That adds both of your example test cases, as well as a test that dynamically gets all functions named pyinaturalist.node_api.get_* (so it will also apply to GET endpoints added in the future), and ensures that they all covert parameters.

Once that and the updates to docs are merged in, I plan to finish dry-run mode for Issue #9 (which is mostly done except for unit tests), update the rest_api endpoints with these changes, and then add a couple more endpoints.

from pyinaturalist.

I am moving those tests and other related updates to the rest_api module to a separate PR, #22, which is almost done.

from pyinaturalist.