Merge pull request #77 from sckott/occ-count

occurrences count changes

.github/workflows/python.yml

@@ -10,6 +10,9 @@ jobs:
         python-version: [3.6, 3.7, 3.8, 3.9]
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      GBIF_USER: ${{ secrets.GBIF_USER }}
+      GBIF_PWD: ${{ secrets.GBIF_PWD }}
+      GBIF_EMAIL: ${{ secrets.GBIF_EMAIL }}
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}

pygbif/gbifutils.py

@@ -143,11 +143,21 @@ def check_data(x, y):
 
 
 def len2(x):
-    if x.__class__ is str:
+    if isinstance(x, int):
+        return len([x])
+    elif isinstance(x, str):
         return len([x])
     else:
         return len(x)
 
+def stuff(**kwargs):
+    return kwargs
+
+def check_param_lens(**kwargs):
+    tmp = {k: v for k, v in kwargs.items() if v is not None}
+    for k,v in tmp.items():
+        if len2(v) > 1:
+            raise TypeError(k + " must be length 1")
 
 def get_meta(x):
     if has_meta(x):

pygbif/occurrences/count.py

@@ -1,4 +1,4 @@
-from pygbif.gbifutils import gbif_baseurl, bool2str, gbif_GET
+from pygbif.gbifutils import gbif_baseurl, bool2str, gbif_GET, check_param_lens
 
 
 def count(
@@ -16,6 +16,10 @@ def count(
     """
     Returns occurrence counts for a predefined set of dimensions
 
+    For all parameters below, only one value allowed per function call.
+    See :func:`~occurrences.search` for passing more than one value
+    per parameter.
+
     :param taxonKey: [int] A GBIF occurrence identifier
     :param basisOfRecord: [str] A GBIF occurrence identifier
     :param country: [str] A GBIF occurrence identifier
@@ -36,6 +40,10 @@ def count(
         occurrences.count(isGeoreferenced = True)
         occurrences.count(basisOfRecord = 'OBSERVATION')
     """
+    check_param_lens(taxonKey=taxonKey,basisOfRecord=basisOfRecord,
+        country=country,isGeoreferenced=isGeoreferenced,
+        datasetKey=datasetKey,publishingCountry=publishingCountry,
+        typeStatus=typeStatus,issue=issue,year=year)
     url = gbif_baseurl + "occurrence/count"
     isGeoreferenced = bool2str(isGeoreferenced)
     out = gbif_GET(

test/test-occurrences-count.py

@@ -1,4 +1,5 @@
 """Tests for occurrences module - count methods"""
+import pytest
 import vcr
 from pygbif import occurrences
 
@@ -35,6 +36,10 @@ def test_count():
     res = occurrences.count(taxonKey=3329049)
     assert int == res.__class__
 
+def test_count_param_length():
+    "occurrences.count_param_length"
+    with pytest.raises(TypeError):
+        occurrences.count(datasetKey=['foo', 'bar'])
 
 @vcr.use_cassette("test/vcr_cassettes/test_count_basisofrecord.yaml")
 def test_count_basisofrecord():
@@ -79,7 +84,6 @@ def test_count_schema():
     assert dict == res[0].__class__
     assert "dimensions" == list(res[0].keys())[0]
 
-
 @vcr.use_cassette("test/vcr_cassettes/test_count_publishingcountries.yaml")
 def test_count_publishingcountries():
     "occurrences.count_publishingcountries - basic test"