使用Python查询/munge JSON文件的JQish工具
qpyson的Python项目详细描述
qpyson:使用Python探索、转换和Munge JSON的瘦命令行工具
JSON查询工具jq是一个 非常强大的工具。然而,它有时有点牵扯,而且 需要深入研究jq manual并熟悉的学习曲线 用一种自定义语言。在
qpyson
是一个用于探索、转换或munge JSON的瘦命令行工具
使用Python作为处理语言。在
目标
- 使用Python处理JSON文件(filter、map、general munging)
- 用于处理或应用Python编写的转换的薄层
- 将Python函数作为字符串提供给命令行或定义 外部文件中的Python函数
- 自定义函数可以从 命令行
- 输出结果以JSON或表格形式发出(使用 tabulate用于快速查看 从命令行
非目标
- 替代
jq
- 没有用于过滤或查询的自定义DSL(直接使用Python)
- 不支持流(JSON文件加载到内存中)
安装
建议使用 virtualenv或 conda要安装的env。在
pip install qpyson
快速游览
来自Iris数据集的示例数据。在
^{pr2}$命令行工具接受编写为命令行字符串或 在外部文件以及要处理的JSON文件中引用。在
qpyson --help
qpyson: error: the following arguments are required: path_or_cmd, json_file
usage: qpyson [-f FUNCTION_NAME] [-n] [--indent INDENT] [-t]
[--table-style TABLE_STYLE]
[--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}]
[--help]
path_or_cmd json_file
Util to use Python to process (e.g., filter, map) JSON files
positional arguments:
path_or_cmd Path to python file, or python cmd
json_file Path to JSON file
optional arguments:
-f FUNCTION_NAME, --function-name FUNCTION_NAME
Function name (default: f)
-n, --no-pretty (Non-table) Pretty print the output of dicts and list
of dicts (default: False)
--indent INDENT (Non-table) Pretty print indent spacing (default: 2)
-t, --print-table Pretty print results (default: False)
--table-style TABLE_STYLE
Table fmt style using Tabulate. See
https://github.com/astanin/python-tabulate#table-
format for available options (default: simple)
--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}
Log level (default: NOTSET)
--help Show this help message and exit (default: False)
我们可以定义一个自定义函数来处理JSON数据集。默认情况下
该函数名为f
,可以通过-f
或
--function-name
命令行参数。在
qpyson "def f(d): return d[0]" examples/iris.json
{
"sepalLength": 5.1,
"sepalWidth": 3.5,
"petalLength": 1.4,
"petalWidth": 0.2,
"species": "setosa"
}
我们也可以在Python文件中编写自定义函数。在
cat examples/iris_explore.py
def f(d):
return d[0]
def f2(d, max_items: int = 10):
return d[:max_items]
def f3(d, max_items: int = 5):
return [x for x in d if x["species"] == "setosa"][:max_items]
def f4(d, sort_field: str, sort_direction: str = "asc", max_items: int = 5):
reverse = not (sort_direction == "asc")
d.sort(key=lambda x: x[sort_field], reverse=reverse)
return d[:max_items]
def f0(d):
# Identity operator
return d
def first(d):
return d[0]
def p(d, field: str = "sepalLength"):
import pandas as pd
df = pd.DataFrame.from_dict(d)
sdf = df.describe()
return sdf.to_dict()[field]
执行--help
将显示输出选项。在
qpyson examples/iris_explore.py examples/iris.json --help
usage: qpyson [-f FUNCTION_NAME] [-n] [--indent INDENT] [-t]
[--table-style TABLE_STYLE]
[--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}]
[--help]
path_or_cmd json_file
Util to use Python to process (e.g., filter, map) JSON files
positional arguments:
path_or_cmd Path to python file, or python cmd
json_file Path to JSON file
optional arguments:
-f FUNCTION_NAME, --function-name FUNCTION_NAME
Function name (default: f)
-n, --no-pretty (Non-table) Pretty print the output of dicts and list
of dicts (default: False)
--indent INDENT (Non-table) Pretty print indent spacing (default: 2)
-t, --print-table Pretty print results (default: False)
--table-style TABLE_STYLE
Table fmt style using Tabulate. See
https://github.com/astanin/python-tabulate#table-
format for available options (default: simple)
--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}
Log level (default: NOTSET)
--help Show this help message and exit (default: False)
执行函数f
,得到:
qpyson examples/iris_explore.py examples/iris.json
{
"sepalLength": 5.1,
"sepalWidth": 3.5,
"petalLength": 1.4,
"petalWidth": 0.2,
"species": "setosa"
}
可以使用--print-table
或将输出视图更改为表视图
-t
。在
qpyson examples/iris_explore.py examples/iris.json --print-table --table-style github
| sepalLength | sepalWidth | petalLength | petalWidth | species |
|---------------|--------------|---------------|--------------|-----------|
| 5.1 | 3.5 | 1.4 | 0.2 | setosa |
使用在iris_explore.py
中定义的函数f2
的一个更好的示例
qpyson examples/iris_explore.py examples/iris.json --function-name f2 --print-table
sepalLength sepalWidth petalLength petalWidth species
------------- ------------ ------------- ------------ ---------
5.1 3.5 1.4 0.2 setosa
4.9 3 1.4 0.2 setosa
4.7 3.2 1.3 0.2 setosa
4.6 3.1 1.5 0.2 setosa
5 3.6 1.4 0.2 setosa
5.4 3.9 1.7 0.4 setosa
4.6 3.4 1.4 0.3 setosa
5 3.4 1.5 0.2 setosa
4.4 2.9 1.4 0.2 setosa
4.9 3.1 1.5 0.1 setosa
可以使用必需值或可选值(使用 默认值)结合python3类型注释生成
cat examples/iris.py
# More examples that demonstrate generating commandline arguments
def f(d, sort_field: str, sort_direction: str = "asc", max_items: int = 5):
reverse = not (sort_direction == "asc")
d.sort(key=lambda x: x[sort_field], reverse=reverse)
return d[:max_items]
def g(d, field: str = "sepalLength"):
import pandas as pd
df = pd.DataFrame.from_dict(d)
sdf = df.describe()
return sdf.to_dict()[field]
调用--help
将显示自定义函数特定的参数
(例如,--max_items
和{
qpyson examples/iris.py examples/iris.json --help
usage: qpyson [-f FUNCTION_NAME] [-n] [--indent INDENT] [-t]
[--table-style TABLE_STYLE]
[--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}]
[--help] [--sort_field SORT_FIELD]
[--sort_direction SORT_DIRECTION] [--max_items MAX_ITEMS]
path_or_cmd json_file
Util to use Python to process (e.g., filter, map) JSON files
positional arguments:
path_or_cmd Path to python file, or python cmd
json_file Path to JSON file
optional arguments:
-f FUNCTION_NAME, --function-name FUNCTION_NAME
Function name (default: f)
-n, --no-pretty (Non-table) Pretty print the output of dicts and list
of dicts (default: False)
--indent INDENT (Non-table) Pretty print indent spacing (default: 2)
-t, --print-table Pretty print results (default: False)
--table-style TABLE_STYLE
Table fmt style using Tabulate. See
https://github.com/astanin/python-tabulate#table-
format for available options (default: simple)
--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}
Log level (default: NOTSET)
--help Show this help message and exit (default: False)
--sort_field SORT_FIELD
sort_field type:<class 'str'> from custom func `f`
(default: _empty)
--sort_direction SORT_DIRECTION
sort_direction type:<class 'str'> from custom func `f`
(default: asc)
--max_items MAX_ITEMS
max_items type:<class 'int'> from custom func `f`
(default: 5)
使用自定义选项调用会产生:
qpyson examples/iris.py examples/iris.json -t --max_items=3 --sort_direction=desc --sort_field sepalLength
sepalLength sepalWidth petalLength petalWidth species
------------- ------------ ------------- ------------ ---------
7.9 3.8 6.4 2 virginica
7.7 3.8 6.7 2.2 virginica
7.7 2.6 6.9 2.3 virginica
另一个例子是在引擎盖下面叫熊猫 数据汇总。在
qpyson examples/iris.py examples/iris.json -t -f g --field=sepalLength
count mean std min 25% 50% 75% max
------- ------- -------- ----- ----- ----- ----- -----
150 5.84333 0.828066 4.3 5.1 5.8 6.4 7.9
还可以创建精简的JSON咀嚼工具进行配置 以JSON作为输入的系统或工具。在
例如,具有默认值的JSON配置模板。在
cat examples/config_template.json
{
"alpha": 1234,
"beta": null,
"gamma": 90.1234
}
以及一个处理函数f
。在
cat examples/config_processor.py
def f(dx, alpha: float, beta: float, gamma: float):
"""Simple example of config munging"""
def _set(k, v):
if v:
dx[k] = v
items = [("alpha", alpha), ("beta", beta), ("gamma", gamma)]
for name, value in items:
_set(name, value)
dx["_comment"] = "Configured with qpyson"
return dx
运行--help
将显示支持的配置选项。在
qpyson examples/config_processor.py examples/config_template.json --help
usage: qpyson [-f FUNCTION_NAME] [-n] [--indent INDENT] [-t]
[--table-style TABLE_STYLE]
[--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}]
[--help] [--alpha ALPHA] [--beta BETA] [--gamma GAMMA]
path_or_cmd json_file
Util to use Python to process (e.g., filter, map) JSON files
positional arguments:
path_or_cmd Path to python file, or python cmd
json_file Path to JSON file
optional arguments:
-f FUNCTION_NAME, --function-name FUNCTION_NAME
Function name (default: f)
-n, --no-pretty (Non-table) Pretty print the output of dicts and list
of dicts (default: False)
--indent INDENT (Non-table) Pretty print indent spacing (default: 2)
-t, --print-table Pretty print results (default: False)
--table-style TABLE_STYLE
Table fmt style using Tabulate. See
https://github.com/astanin/python-tabulate#table-
format for available options (default: simple)
--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}
Log level (default: NOTSET)
--help Show this help message and exit (default: False)
--alpha ALPHA alpha type:<class 'float'> from custom func `f`
(default: _empty)
--beta BETA beta type:<class 'float'> from custom func `f`
(default: _empty)
--gamma GAMMA gamma type:<class 'float'> from custom func `f`
(default: _empty)
现在配置alpha
、beta
和{
qpyson examples/config_processor.py examples/config_template.json --alpha 1.23 --beta 2.34 --gamma 3.45
{
"alpha": 1.23,
"beta": 2.34,
"gamma": 3.45,
"_comment": "Configured with qpyson"
}
测试
测试目前是通过使用make targetdoc
使用RMarkdown完成的。在
这可能应该移植到基于非R的方法。然而,这 当前方法确实保留了文档(例如。,自述文件.md)最新的。在
相关JQ ish工具
https://github.com/dbohdan/structured-text-tools#json
- 项目
标签: