Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Sick of for loop + conditional soup when dealing with complicated lists? Querylist is here to help.
Python Makefile
tree: 3b5468a124

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
docs
querylist
.gitignore
.travis.yml
LICENSE
README.md
TODO.md
requirements.txt
setup.cfg
setup.py
tube.py

README.md

querylist Build Status

Sick of for loop + conditional soup when dealing with complicated lists? Querylist is here to help.

This package provides a data structure called a QueryList, an extension of Python's built in list data type that adds django ORM-eseque filtering, exclusion, and get methods. QueryLists allow developers to easily query and retrieve data from complex lists without the need for unnecessarily verbose iteration and selection cruft.

The package also provides BetterDict, a backwards-compatible wrapper for dictionaries that enables dot lookups and assignment for key values.

Installation

Querylist can be installed like any other python package:

> pip install querylist

Querylist is tested against Python >2.5, <3.0.

Usage

BetterDicts

BetterDicts wrap normal dicts. They have all of the same functionality one would expect from a normal dict:

>>> from querylist import BetterDict
>>> src = {'foo': 'bar', 'items': True}
>>> bd = BetterDict(src)
>>> bd == src
True
>>> bd['foo']
'bar'
>>> bd.items()
[('items', True), ('foo', 'bar')]

However, BetterDicts can also preform dot lookups and assignment of key values!

>>> bd.bar_time = True
>>> bd.foo = 'meh'
>>> bd.foo
'meh'
>>> bd.bar_time
True
>>> bd['bar_time']
True

Key values that conflict with normal dict attributes are accessible via a _bd_ attribute.

>>> bd.items
<built-in method items of BetterDict object at 0x10d3a7fb0>
>>> bd._bd_.items
True

QueryLists

QueryLists work just like lists:

>>> from querylist import QueryList
>>> site_list = [
    {
        'url': 'http://site1.tld/',
        'meta': {
            'keywords': ['Mustard', 'kittens'],
            'description': 'My cool site'
        },
        'published': True,
        'id': 1,
        'name': 'Site 1'
    }, {
        'url': 'http://site2.tld/',
        'meta': {
            'keywords': ['Catsup', 'dogs'],
            'description': 'My cool site'
        },
        'published': True,
        'id': 2,
        'name': 'SitE 2'
    }, {
        'url': 'http://site3.tld/',
        'meta': {
            'keywords': ['Mustard', 'kittens'],
            'description': 'My cool site'
        },
        'published': False,
        'id': 3,
        'name': 'Site 3'
    }
]
>>> ql = QueryList(site_list)
>>> ql == site_list
True

They also let developers, exclude objects that don't match criteria via field lookups or limit the QueryList to only the objects that do match a provided criteria:

>>> ql.exclude(published=True)
[{'url': 'http://site3.tld/', 'meta': {'keywords': ['Mustard', 'kittens'], 'description': 'My cool site'}, 'id': 3, 'name': 'Site 3', 'published': False}]
>>> ql.limit(published=True).exclude(meta__keywords__contains='Catsup')
[{'url': 'http://site1.tld/', 'meta': {'keywords': ['Mustard', 'kittens'], 'description': 'My cool site'}, 'id': 1, 'name': 'Site 1', 'published': True}]

And finally, they let developers retrieve specific objects with the get method:

>>> ql.get(id=2)
{'url': 'http://site1.tld/', 'meta': {'keywords': ['Mustard', 'kittens'], 'description': 'My cool site'}, 'id': 1, 'name': 'Site 1', 'published': True}

By default, QueryLists work exclusively with lists of dictionaries. This is achieved partly by converting the member dicts to BetterDicts on instantiation. QueryLists also supports lists of any objects that support dot lookups. QueryList.__init__() has parameters that let users easily convert lists of dictionaries to custom objects. Consider the site_list example above: instead of just letting the QueryList default to a BetterDict, we could instantiate it with a custom Site class that provides methods for publishing, unpublishing, and deleting sites. That would then allow us to write code like the following, which publishes all unpublished sites:

>>> from site_api import Site
>>> ql = QueryList(site_list, wrap=Site)
>>> [x.publish() for x in ql.exclude(published=True)]

Contributing

  1. Fork the repo and then clone it locally.
  2. Install the development requirements: pip install -r requirements.txt
  3. Use testtube's stir command (installed via #2) to monitor the project directory for changes and automatically run the test suite.
  4. Make changes and submit a pull request.

At the moment, Querylist has great test coverage. Please do your part to help keep it that way by writing tests whenever you add or change code.

Everything else

Copyright (c) Thomas Welfley. See LICENSE for details.

Something went wrong with that request. Please try again.