CHANGELOG.rst

Release Notes

v0.0.3 (2022-06-11)

New features

• Add CLI support for JSON Lines:
  • Add a -l/--lines CLI argument to specify that the input file/stream is made of one JSON per line.
  • When used, gjson applies the same query to all lines.
  • Based on the verbosity level the failing lines are completely ignored, an error message is printed to stderr or the execution is interrupted at the first error printing the full traceback.
• Add CLI support for GJSON JSON Lines queries:
  • Add support for the GJSON queries that encapsulates a JSON Lines input in an array when the query starts with .. so that they the data can be queries as if it was an array of objects in the CLI.
• Add support for custom modifiers:
  • Add a ModifierProtocol to describe the interface that custom modifiers callable need to have.
  • Add a register_modifier() method in the GJSON class to register custom modifiers.
  • Allow to pass a dictionary of modifiers to the low-level GJSONObj class constructor.
  • Add a GJSONObj.builtin_modifiers() static method that returns a set with the names of the built-in modifiers.
  • Is not possible to register a custom modifier with the same name of a built-in modifier.
  • Clarify in the documentation that only JSON objects are accepted as modifier arguments.

Bug fixes

• Query parsing: when using the queries GJSON syntax #(...) and #(...)# fix the return value in case of a key matching that doesn't match any element.
• Query parsing fixes/improvements found with the Python fuzzing engine Atheris:
  • If any query parts between delimiters is empty error out with a specific message instead of hitting a generic IndexError.
  • When a query has an integer index on a mapping object, in case the element is not present, raise a GJSONError instead of a KeyError one.
  • When the query has a wildcard matching, ensure that it's applied on a mapping object. Fail with a GJSONError otherwise.
  • Explicitly catch malformed modifier options and raise a GJSONError instead.
  • If the last part of the query is a #, check that the object is actually a sequence like object and fail with a specific message if not.
  • Ensure all the conditions are valid before attempting to extract the inner element of a sequence like object. Ignore both non-mapping like objects inside the sequence or mapping like objects that don't have the specified key.
  • When parsing the query value as JSON catch the eventual decoding error to encapsulate it into a GJSONError one.
  • When using the queries GJSON syntax #(...) and #(...)# accept also an empty query to follow the same behaviour of the upstream Go GJSON.
  • When using the queries GJSON syntax #(...) and #(...)# follow closely the upstream behaviour of Go GJSON for all items queries #(..)# with regex matching.
  • When using the queries GJSON syntax #(...) and #(...)# fix the wildcard matching regular expression when using pattern matching.
  • Fix the regex to match keys in presence of wildcards escaping only the non-wildcards and ensuring to not double-escaping any already escaped wildcard.
  • When using the queries GJSON syntax #(...) and #(...)# ensure any exception raised while comparing incompatible objects is catched and raise as a GJSONError.

Miscellanea

• tests: when matching exception messages always escape the string or use raw strings to avoid false matchings.
• pylint: remove unnecessary comments

v0.0.2 (2022-05-31)

Bug fixes

• @sort modifier: fix the actual sorting.
• tests: ensure that mapping-like objects are compared also in the order of their keys.

Miscellanea

• GitHub actions: add workflow to run tox.
• GitHub actions: fix branch name for pushes
• documentation: include also the @sort modifier that is not present in the GJSON project.
• documentation: fix link to PyPI package.
• documentation: add link to the generated docs.
• documentation: fix section hierarchy and build.

v0.0.1 (2022-05-22)

• Initial version.