collection-filter's Introduction

Python collection filter

https://github.com/kudo/collection-filter

This library provides a DSL filter for list or dict data. It is original designed for RESTful API partial response. Tested with Python 2.6, 2.7.

Quick Start

To install, use pip:

$ pip install collection-filter

Then:

$ python

>>> from collection_filter import collection_filter

# Query a dict
>>> collection_filter({'foo': 1, 'bar': 2}, 'foo')
{'foo': 1}

# Query a dict with multiple elements (seperated by comma)
>>> collection_filter({'foo': 1, 'bar': 2}, 'foo,bar')
{'foo': 1, 'bar': 2}

# Query a dict deeply
>>> collection_filter({'foo': {'bar': 2, 'orange': 'sweet'}}, 'foo.bar')
{'foo': {'bar': 2}}

# Query a list
>>> collection_filter([{'foo': 1, 'bar': 2}, {'foo': 3, 'bar': 4}], '[].foo')
[{'foo': 1}, {'foo': 3}]

# list/dict combination example
>>> collection_filter({'foo': 'bar', 'aListOfDict': [{'foo': 1, 'bar': 2}]}, 'aListOfDict[].foo')
{'aListOfDict': [{'foo': 1}]}

Syntax

Currently support operators

Operator	Description
,	Multiple field query sperated by comma
[]	To indicate the data should be handled as list
.	Dot notation should follow with a symbol name which to specify a field in current dict data

Copyright and License

Licensed under a MIT license.

collection-filter's People

Contributors

Stargazers

Watchers

collection-filter's Issues

Unable to handle 'aKey[].foo,aKey[].bar' case

Given aKey[].foo,aKey[].bar will get a empty result

Exception for deep list filter

Given

collection_filter({'aList': [{'anotherList': [{'foo': 1, 'bar': 2}]}]}, 'aList[].anotherList[].foo')

Will throw exception:

---------------------------------------------------------------------------
AssertionError                            Traceback (most recent call last)
<ipython-input-11-0e52659d65b7> in <module>()
----> 1 collection_filter({'aList': [{'anotherList': [{'foo': 1, 'bar': 2}]}]}, 'aList[].anotherList[].foo')

/Users/kudo/.virtualenvs/biienv/lib/python2.7/site-packages/collection_filter-0.5-py2.7.egg/collection_filter/collection_filter.pyc in collection_filter(data, fields)
    111         # [2] For each dot notated sub field, do further query recursively
    112         next_field, remain_query = _get_next_field(field)
--> 113         subset = _inner_filter(copy.deepcopy(data), next_field, remain_query)
    114         if data_as_list:
    115             # [3-1] For list, set each element as merged dictionary

/Users/kudo/.virtualenvs/biienv/lib/python2.7/site-packages/collection_filter-0.5-py2.7.egg/collection_filter/collection_filter.pyc in _inner_filter(data, field, remain_query, expect_list)
     80                                    next_field,
     81                                    remain_query,
---> 82                                    expect_list=expect_list)
     83
     84         # Return {field: result} if there are existed next query

/Users/kudo/.virtualenvs/biienv/lib/python2.7/site-packages/collection_filter-0.5-py2.7.egg/collection_filter/collection_filter.pyc in _inner_filter(data, field, remain_query, expect_list)
     51                                       field,
     52                                       remain_query,
---> 53                                       expect_list=False)
     54         return data
     55     else:

/Users/kudo/.virtualenvs/biienv/lib/python2.7/site-packages/collection_filter-0.5-py2.7.egg/collection_filter/collection_filter.pyc in _inner_filter(data, field, remain_query, expect_list)
     80                                    next_field,
     81                                    remain_query,
---> 82                                    expect_list=expect_list)
     83
     84         # Return {field: result} if there are existed next query

/Users/kudo/.virtualenvs/biienv/lib/python2.7/site-packages/collection_filter-0.5-py2.7.egg/collection_filter/collection_filter.pyc in _inner_filter(data, field, remain_query, expect_list)
     55     else:
     56         # `data` is dict
---> 57         assert type(data) == dict
     58         if not field:
     59             # If current field query is empty, try to fetch next query

AssertionError: