Giter VIP home page Giter VIP logo

filteralchemy's Introduction

filteralchemy

Latest version

Documentation Status

Travis-CI

Code coverage

filteralchemy is a declarative query builder for SQLAlchemy. filteralchemy uses marshmallow-sqlalchemy to auto-generate filter fields and webargs to parse field parameters from the request. Use it to filter data with minimal boilerplate.

For Django users: the design of filteralchemy is strongly inspired by django-filter.

Install

pip install filteralchemy

Quickstart

import flask
from models import Album, session
from webargs.flaskparser import parser

from filteralchemy import FilterSet
from filteralchemy.operators import Equal, Less, Greater

class AlbumFilterSet(FilterSet):
    class Meta:
        model = Album
        query = session.query(Album)
        operators = (Equal, Less, Greater)
        parser = parser

app = flask.Flask(__name__)

@app.route('/albums')
def get_albums():
    query = AlbumFilterSet().filter()
    return flask.jsonify(query.all())
http :5000/albums artist==Queen genre==rock sales__gt==1000000

filteralchemy's People

Contributors

jmcarp avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

filteralchemy's Issues

Interface for filter overrides

Currently, FilterSet generates a filter for each model field and for each operator. To override, users have to declare additional filters for a field:

class MyFilterSet(FilterSet):
    class Meta:
        model = MyModel
        operators = (Equal, In)
    column__gt = Filter('column', fields.Int(), operator=Greater)
    column__lt = Filter('column', fields.Int(), operator=Less)

To reduce boilerplate, it would be helpful to specify operator patterns per column in Meta:

class MyFilterSet(FilterSet):
    class Meta:
        model = MyModel
        operators = (Equal, In)
        column_operators = {
            'column': [Greater, Less],
        }

It might be useful to specify other overrides as well. This could be done via extra Meta options, such as column_fields, etc., or by combining all overrides into a single column_overrides dict:

column_overrides = {
    'column': {
        {
            'operators': [Greater, Less],
            'field': fields.Float(),
        },
    }
}

Last thought: instead of specifying overrides for groups of filters in Meta, I was also thinking about introducing a FilterFactory that can be declared in a FilterSet:

class MyFilterSet(FilterSet):
    class Meta:
        model = MyModel
        operators = (Equal, In)
    column_filters = FilterFactory('column', fields.Float(), operators=(Equal, Greater, Less))

I'm leaning towards separate column_operators and column_fields options in Meta--I think it's simpler if class variables are all Filter declarations, and all the options for auto-generating filters live in Meta. Any preferences @sloria?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.