Hide format_iter_filters method

Author: vshlapakov

scrapinghub/client/activity.py

@@ -1,6 +1,6 @@
 from __future__ import absolute_import
 
-from .proxy import _Proxy, format_iter_filters
+from .proxy import _Proxy
 from .utils import parse_job_key
 
 
@@ -48,7 +48,7 @@ def __init__(self, *args, **kwargs):
         super(Activity, self).__init__(*args, **kwargs)
 
     def iter(self, **params):
-        params = format_iter_filters(params)
+        params = self._modify_iter_params(params)
         return self._origin.list(**params)
 
     def add(self, values, **kwargs):

scrapinghub/client/collections.py

@@ -5,7 +5,7 @@
 
 from ..hubstorage.collectionsrt import Collection as _Collection
 
-from .proxy import _Proxy, _DownloadableProxyMixin, format_iter_filters
+from .proxy import _Proxy, _DownloadableProxyMixin
 from .utils import update_kwargs
 
 
@@ -143,6 +143,7 @@ class Collection(object):
 
     def __init__(self, client, collections, type_, name):
         self._client = client
+        self._collections = collections
         self._origin = _Collection(type_, name, collections._origin)
 
     def get(self, key, **params):
@@ -188,7 +189,7 @@ def iter(self, key=None, prefix=None, prefixcount=None, startts=None,
         update_kwargs(params, key=key, prefix=prefix, prefixcount=prefixcount,
                       startts=startts, endts=endts,
                       requests_params=requests_params)
-        params = format_iter_filters(params)
+        params = self._collections._modify_iter_params(params)
         return self._origin._collections.iter_values(
             self._origin.coltype, self._origin.colname, **params)
 
@@ -197,7 +198,7 @@ def iter_raw_json(self, key=None, prefix=None, prefixcount=None,
         update_kwargs(params, key=key, prefix=prefix, prefixcount=prefixcount,
                       startts=startts, endts=endts,
                       requests_params=requests_params)
-        params = format_iter_filters(params)
+        params = self._collections._modify_iter_params(params)
         return self._origin._collections.iter_json(
             self._origin.coltype, self._origin.colname, **params)
 
@@ -220,7 +221,7 @@ def iter_raw_msgpack(self, key=None, prefix=None, prefixcount=None,
         update_kwargs(params, key=key, prefix=prefix, prefixcount=prefixcount,
                       startts=startts, endts=endts,
                       requests_params=requests_params)
-        params = format_iter_filters(params)
+        params = self._collections._modify_iter_params(params)
         return self._origin._collections.iter_msgpack(
             self._origin.coltype, self._origin.colname, **params)
 

scrapinghub/client/proxy.py

@@ -45,7 +45,7 @@ def _modify_iter_params(self, params):
         :return: an updated dictionary with parameters.
         :rtype: :class:`dict`
         """
-        return format_iter_filters(params)
+        return _format_iter_filters(params)
 
 
 class _ItemsResourceProxy(_Proxy):
@@ -137,7 +137,7 @@ def iter(self):
         return six.iteritems(next(self._origin.apiget()))
 
 
-def format_iter_filters(params):
+def _format_iter_filters(params):
     """Format iter() filter param on-the-fly.
 
     Support passing multiple filters at once as a list with tuples.

tests/client/test_utils.py

@@ -5,42 +5,42 @@
 import mock
 
 from scrapinghub.client.utils import parse_auth
-from scrapinghub.client.proxy import format_iter_filters
+from scrapinghub.client.proxy import _format_iter_filters
 
 
 def test_format_iter_filters():
     # work with empty params
-    assert format_iter_filters({}) == {}
+    assert _format_iter_filters({}) == {}
 
     # doesn't affect other params
     params = {'a': 123, 'b': 456}
-    assert format_iter_filters(params) == params
+    assert _format_iter_filters(params) == params
 
     # pass filter as-is if not list
     params = {'filter': 'some-string'}
-    assert format_iter_filters(params) == params
+    assert _format_iter_filters(params) == params
 
     # work fine with empty filter
     params = {'filter': []}
-    assert format_iter_filters(params) == params
+    assert _format_iter_filters(params) == params
 
     # pass string filters as-is
     params = {'filter': ['str1', 'str2']}
-    assert format_iter_filters(params) == params
+    assert _format_iter_filters(params) == params
 
     # converts list-formatted filters
     params = {'filter': [['field', '>=', ['val']], 'filter2']}
-    assert (format_iter_filters(params) ==
+    assert (_format_iter_filters(params) ==
             {'filter': ['["field", ">=", ["val"]]', 'filter2']})
 
     # works the same with tuple entries
     params = {'filter': [('field', '==', ['val'])]}
-    assert (format_iter_filters(params) ==
+    assert (_format_iter_filters(params) ==
             {'filter': ['["field", "==", ["val"]]']})
 
     # exception if entry is not list/tuple or string
     with pytest.raises(ValueError):
-        format_iter_filters({'filter': ['test', 123]})
+        _format_iter_filters({'filter': ['test', 123]})
 
 
 def test_parse_auth_none():