Merge pull request #72 from kellyjonbrazil/dev

Dev v1.6.1

Author: kellyjonbrazil

.github/workflows/pythonapp.yml

@@ -14,12 +14,12 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

ADVANCED_USAGE.md

@@ -14,8 +14,11 @@ To set `jello` options in the `.jelloconf.py` file, import the `jello.lib.opts`
 from jello.lib import opts
 opts.mono = True            # -m option
 opts.compact = True         # -c option
+opts.empty = True           # -e option
 opts.lines = True           # -l option
 opts.raw = True             # -r option
+opts.raw_input = True       # -R option
+opts.force_color = True     # -C option
 opts.nulls = True           # -n option
 opts.schema = True          # -s option
 opts.types = True           # -t option

CHANGELOG

@@ -1,5 +1,11 @@
 jello changelog
 
+20250529 v1.6.1
+- Add the `-R` option to ingest the data as a raw string instead of converting to a dict/list
+- Add more information to query errors
+- Add the ability to add more information to the query scope
+- Add Python runtime information to `-v` option
+
 20230423 v1.6.0
 - Add the ability to directly use a JSON file or JSON Lines files as data input (`-f`)
 - Add the ability to load a query from a file (`-q`)

README.md

@@ -1,4 +1,3 @@
-[![Tests](https://github.com/kellyjonbrazil/jello/workflows/Tests/badge.svg?branch=master)](https://github.com/kellyjonbrazil/jello/actions)
 [![Pypi](https://img.shields.io/pypi/v/jello.svg)](https://pypi.org/project/jello/)
 
 >Built on `jello`:
@@ -74,6 +73,7 @@ jello '_["foo"]' -f data.json
 - `-n` print selected `null` values
 - `-q` load query from a file
 - `-r` raw output of selected strings (no quotes)
+- `-R` raw string input (don't auto convert input to dict/list)
 - `-s` print the JSON schema in grep-able format
 - `-t` print type annotations in schema view
 - `-h` help
@@ -152,6 +152,30 @@ while read -r value; do
 done < <(cat data.json | jello -rl _.foo)
 ```
 
+### Non-JSON Data Input (YAML, CSV, etc.)
+You can work with other types of data with the `-R` (raw string input) option. For example,
+if you would like to read in YAML data you can load the data as a raw string, import
+the `yaml` library, and load the string data into `_` with the `yaml` library:
+
+```bash
+$ cat values.yaml
+
+var1: value1
+var2: value2
+var3: value3
+
+$ jello -Rr '
+import yaml
+_ = yaml.safe_load(_)
+_["var2"]
+' -f values.yaml
+
+value2
+```
+
+> Note: Dot notation is not supported with the `-R` option unless the library used to
+> convert the raw string supports this. (e.g. `python-benedict`)
+
 ### Setting Custom Colors via Environment Variable
 Custom colors can be set via the `JELLO_COLORS` environment variable. Any colors set in the environment variable will take precedence over any colors set in the initialization file. (see [Advanced Usage](https://github.com/kellyjonbrazil/jello/blob/master/ADVANCED_USAGE.md))
 

jello/__init__.py

@@ -1,8 +1,8 @@
 """jello - query JSON at the command line with python syntax"""
 
 
-__version__ = '1.6.0'
+__version__ = '1.6.1'
 AUTHOR = 'Kelly Brazil'
 WEBSITE = 'https://github.com/kellyjonbrazil/jello'
-COPYRIGHT = '© 2020-2023 Kelly Brazil'
+COPYRIGHT = '© 2020-2025 Kelly Brazil'
 LICENSE = 'MIT License'

jello/cli.py

@@ -5,6 +5,7 @@
 import signal
 import shutil
 import textwrap
+import traceback
 from textwrap import TextWrapper
 import jello
 from jello.lib import opts, load_json, read_file, pyquery, Schema, Json
@@ -41,6 +42,7 @@ def print_help():
                 -n   print selected null values
                 -q   load query from a file
                 -r   raw string output (no quotes)
+                -R   raw string input (don't auto convert input to dict/list)
                 -s   print the JSON schema in grep-able format
                 -t   print type annotations in schema view
                 -v   version info
@@ -71,6 +73,16 @@ def print_exception(e=None, data='', query='', response='', ex_type='Runtime'):
     if split_length < 10:
         split_length = 10
 
+    # prepare short info where the error occurred
+    stacktrace = traceback.extract_tb(e.__traceback__)
+    stacklines = []
+    if len(stacktrace):
+        if stacktrace[-1].filename == "<string>":
+            # we get <string> as filename when exception occurs in a exec() call
+            stacklines.append(f"Jello query, line {stacktrace[-1].lineno}")
+            # lineno begins with 1, lists with 0 -> subtract 1
+            stacklines.append("  " + query.split('\n')[stacktrace[-1].lineno-1])
+
     wrapper = TextWrapper(width=term_width,
                                 initial_indent='',
                                 subsequent_indent=' ' * 12)
@@ -79,6 +91,13 @@ def print_exception(e=None, data='', query='', response='', ex_type='Runtime'):
     wrapper = TextWrapper(width=term_width,
                           initial_indent=' ' * 8,
                           subsequent_indent=' ' * 12)
+
+    # add pre-formatted stacktrace text: flatten the info into lines, normalize newlines
+    for errstring in stacklines:
+        for errline in errstring.split('\n'):
+            if len(errline.replace('\n', '')):
+                exception_message += wrapper.fill(errline.replace('\n', '')) + '\n'
+
     exception_message += wrapper.fill(f'{e}') + '\n'
 
     e_text = ''
@@ -173,6 +192,7 @@ def main(data=None, query='_'):
     opts.mono = opts.mono or ('m' in options or bool(os.getenv('NO_COLOR')))
     opts.nulls = opts.nulls or 'n' in options
     opts.raw = opts.raw or 'r' in options
+    opts.raw_input = opts.raw_input or 'R' in options
     opts.schema = opts.schema or 's' in options
     opts.types = opts.types or 't' in options
     opts.version_info = opts.version_info or 'v' in options
@@ -182,8 +202,11 @@ def main(data=None, query='_'):
         print_help()
 
     if opts.version_info:
+        py_ver: str = '.'.join((str(sys.version_info.major), str(sys.version_info.minor), str(sys.version_info.micro)))
         print(textwrap.dedent(f'''\
             jello:  Version: {jello.__version__}
+                    Python Version: {py_ver}
+                    Python Path: {sys.executable}
                     Author: {jello.AUTHOR}
                     Website: {jello.WEBSITE}
                     Copyright: {jello.COPYRIGHT}
@@ -197,11 +220,16 @@ def main(data=None, query='_'):
     if opts.empty:
         data = '{}'
 
-    # load the JSON or JSON Lines into a dict or list of dicts
-    try:
-        data = load_json(data)
-    except Exception as e:
-        print_exception(e, ex_type='JSON Load')
+    # load the data as a raw string or JSON
+    if opts.raw_input:
+        data = str(data).rstrip('\r\n')
+
+    else:
+        # load the JSON or JSON Lines into a dict or list of dicts
+        try:
+            data = load_json(data)
+        except Exception as e:
+            print_exception(e, ex_type='JSON Load')
 
     # Read .jelloconf.py (if it exists) and run the query
     response = ''

jello/lib.py

@@ -47,6 +47,7 @@ class opts:
     empty = None
     nulls = None
     raw = None
+    raw_input = None
     lines = None
     force_color = None
     mono = None
@@ -396,7 +397,7 @@ def read_file(file_path):
     with open(file_path, 'r') as f:
         return f.read()
 
-def pyquery(data, query):
+def pyquery(data, query, add_to_scope=None):
     """Sets options and runs the user's query."""
     output = None
 
@@ -475,6 +476,8 @@ def pyquery(data, query):
     # add any functions in initialization file to the scope
     scope = {'_': _, 'os': os}
     scope.update(jcnf_dict)
+    if add_to_scope is not None:
+        scope.update(add_to_scope)
 
     # run the query
     block = ast.parse(query, mode='exec')

man/jello.1

@@ -1,4 +1,4 @@
-.TH jello 1 2022-06-26 1.6.0 "Jello JSON Filter"
+.TH jello 1 2025-05-29 1.6.1 "Jello JSON Filter"
 .SH NAME
 Jello \- Filter JSON and JSON Lines data with Python syntax
 .SH SYNOPSIS
@@ -88,6 +88,8 @@ $ jello _.foo -f data.json
 .IP
 \fB-r\fP raw output of selected strings (no quotes)
 .IP
+\fB-R\fP raw string input (don't auto convert input to dict/list)
+.IP
 \fB-s\fP print the JSON schema in grep-able format
 .IP
 \fB-t\fP print type annotations in schema view
@@ -364,6 +366,33 @@ glom(_, (\[dq]parsers\[dq], [\[dq]name\[dq]]))\[aq]
   ...
 ]
 
+.fi
+.SS Non-JSON Data Input (YAML, CSV, etc.)
+.PP
+You can work with other types of data with the \fB-R\fP (raw string input) option. For example,
+if you would like to read in YAML data you can load the data as a raw string, import
+the \fByaml\fP library, and load the string data into \fB_\fP with the \fByaml\fP library:
+.IP
+.nf
+
+$ cat values.yaml
+var1: value1
+var2: value2
+var3: value3
+
+$ jello -Rr \[aq]
+import yaml
+_ = yaml.safe_load(_)
+_[\[dq]var2\[dq]]
+\[aq] -f values.yaml
+
+value2
+
+.PP
+Note: Dot notation is not supported with the \fB-R\fP option unless the library used to
+convert the raw string supports this. (e.g. \fBpython-benedict\fP)
+.IP
+
 .fi
 
 .SH ADVANCED USAGE
@@ -384,8 +413,10 @@ To set jello options in the \fB.jelloconf.py\fP file, import the \fBjello.lib.op
 from jello.lib import opts
 opts.mono = True            # -m option
 opts.compact = True         # -c option
+opts.empty = True           # -e option
 opts.lines = True           # -l option
 opts.raw = True             # -r option
+opts.raw_input = True       # -R option
 opts.force_color = True     # -C option
 opts.nulls = True           # -n option
 opts.schema = True          # -s option
@@ -521,6 +552,6 @@ Kelly Brazil (kellyjonbrazil@gmail.com)
 https://github.com/kellyjonbrazil/jello
 
 .SH COPYRIGHT
-Copyright (c) 2020-2023 Kelly Brazil
+Copyright (c) 2020-2025 Kelly Brazil
 
 License: MIT License

setup.cfg

@@ -1,2 +1,2 @@
 [metadata]
-license_file = LICENSE
+license_files = LICENSE

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name='jello',
-    version='1.6.0',
+    version='1.6.1',
     author='Kelly Brazil',
     author_email='kellyjonbrazil@gmail.com',
     description='Filter JSON and JSON Lines data with Python syntax.',