Skip to main content

Implements the Google Partial Response protocol in Python

Project description

Build Status Coverage Status PyPI Version

Overview

Implements Google Partial Response / json-mask in Python.

Requirements

  • Python 2.7
  • Python 3.6+

Installation

Install jsonmask with pip:

$ pip install jsonmask

or directly from the source code:

$ git clone https://github.com/zapier/jsonmask.git
$ cd jsonmask
$ python setup.py install

Usage

After installation, the package can imported:

$ python
>>> import jsonmask
>>> jsonmask.__version__

To prune dictionaries:

>>> import jsonmask
>>> mask = jsonmask.parse_fields('a,b(c,d)')
>>> jsonmask.apply_json_mask(
    {
        'a': {
            'nested_within_a': True,
        },
        'b' {
            'c': True,
            'd': {'Will get included?': 'Yes'},
            'e': 'Tough luck here',
        },
        'c': 'Definitely hopeless',
    },
    mask,
)

{
    'a': {
        'nested_within_a': True,
    },
    'b' {
        'c': True,
        'd': {'Will get included?': 'Yes'},
    },
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jsonmask, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size jsonmask-0.1.1-py2.py3-none-any.whl (15.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size jsonmask-0.1.1.tar.gz (5.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page