Version 0.9.0

Breaking Changes

• CompoundJSONPath instances are no longer updated in-place when using .union() and .intersection(). Instead, a new CompoundJSONPath is returned. CompoundJSONPath.paths is now a tuple instead of a list.

Fixes

• Fixed a bug with the parsing of JSON Pointers. When given an arbitrary string without slashes, JSONPointer would resolve to the document root. The empty string is the only valid pointer that should resolve to the document root. We now raise a JSONPointerError in such cases. See #27.
• Fixed handling of JSON documents containing only a top-level string.

Features

• Added a command line interface, exposing JSONPath, JSON Pointer and JSON Patch features (docs, source).
• Added JSONPointer.parent(), a method that returns the parent of the pointer, as a new JSONPointer (docs).
• Implemented JSONPointer.__truediv__() to allow creation of child pointers from an existing pointer using the slash (/) operator (docs).
• Added JSONPointer.join(), a method for creating child pointers. This is equivalent to using the slash (/) operator for each argument given to join() (docs).
• Added JSONPointer.exists(), a method that returns True if a the pointer can be resolved against some data, or False otherwise (docs).
• Added the RelativeJSONPointer class for building new JSONPointer instances from Relative JSON Pointer syntax (docs, API).
• Added support for a non-standard index/property pointer using #<property or index>. This is to support Relative JSON Pointer's use of hash (#) when building JSONPointer instances from relative JSON Pointers.
• Added the unicode_escape argument to JSONPathEnvironment. When True (the default), UTF-16 escaped sequences found in JSONPath string literals will be decoded.

Version 0.8.1

Fixes

• Fixed the string representation of a JSONPointer when built using JSONPointer.from_parts() and pointing to the document root. See #21.

Version 0.8.0

Breaking changes

• Changed the JSONPathMatch.parts representation of the non-standard keys selector (default ~) to be ~ followed by the key name. It used to be two "parts", ~ and key index.
• All FilterExpression subclasses must now implement children() and set_children(). These methods facilitate filter expression inspection and caching.

Fixes

• Changed findall() and finditer() to accept data arguments of any io.IOBase subclass, not just TextIO.

Features

• Added the JSONPointer class and methods for converting a JSONPathMatch to a JSONPointer. JSONPointer is compliant with RFC 6901 (docs).
• Added the JSONPatch class. JSONPatch implements RFC 6902 (docs).
• Added jsonpath.pointer.resolve(), a convenience function for resolving a JSON Pointer (docs).
• Added jsonpath.patch.apply(), a convenience function for applying a JSON Patch (docs).
• Added jsonpath.match(), a convenience function returning a JSONPathMatch instance for the first match of a path, or None if there were no matches (docs).
• Added filter expression caching. Controlled with the filter_caching argument to JSONPathEnvironment, filter expression caching is enabled by default. See [#14]
• All selectors now use env.match_class to instantiate new JSONPathMatch objects. This allows for subclassing of JSONPathMatch.
• Added jsonpath.filter.walk() for the benefit of filter expression static analysis.

Version 0.7.1

Fixes

• Fixed a bug with the filter context selector (default _) when it's used as a filter function argument.

Version 0.7.0

Breaking changes

• JSONPathIndexError now requires a token parameter. It used to be optional.
• Filter expressions that resolve JSON paths (like SelfPath and RootPath) now return a NodeList. The node list must then be explicitly unpacked by JSONPathEnvironment.compare() and any filter function that has a with_node_lists attribute set to True. This is done for the benefit of the count() filter function and standards compliance.

Features

• missing is now an allowed alias of undefined when using the isinstance() filter function.

IETF JSONPath Draft compliance

• The built-in count() filter function is now compliant with the standard, operating on a "nodelist" instead of node values.

Version 0.6.0

Breaking changes

• The "extra filter context" identifier now defaults to _. Previously it defaulted to #, but it has been decided that # is better suited as a current key/property or index identifier.

Features

• Added a non-standard keys/properties selector (docs, source).
• Added a non-standard typeof() filter function. type() is an alias for typeof() (docs, source).
• Added a non-standard isinstance() filter function. is() is an alias for isinstance() (docs, source).
• Added a current key/property or index identifier. When filtering a mapping, # will hold key associated with the current node (@). When filtering a sequence, # will hold the current index. See docs.

IETF JSONPath Draft compliance

• Don't allow leading zeros in index selectors. We now raise a JSONPathSyntaxError.
• Validate the built-in count() function's argument is array-like.

Version 0.5.0

Features

• Added the built-in match filter function.
• Added the built-in search filter function.
• Added the built-in value filter function.
• We now pass the current environment to filter function validation.
• Added support for the wildcard selector in selector segment lists.
• We now allow nested filters.

Fixes

• Fixed a bug where the current object selector (@) would evaluate to undefined when a filter is applied to an array of strings.
• Compound paths that have a trailing | or & now raise a JSONPathSyntaxError.

IETF JSONPath Draft compliance

• Removed support for dotted index selectors.
• Raise a JSONPathSyntaxError for unescaped whitespace and control characters.
• Raise a JSONPathSyntaxError for empty selector segments.
• Raise a JSONPathIndexError if an index selector is out of range.
• Raise a JSONPathSyntaxError for too many colons in a slice selector.
• Raise a JSONPathIndexError if a slice selector argument is out of range.

Version 0.4.0

IETF JSONPath Draft compliance

• Behavioral change. When applied to a JSON object, filters now have an implicit preceding wildcard selector and the "current" (@) object is set to each of the object's values. This is now consistent with applying filters to arrays and adheres to the IETF JSONPath Internet Draft.

Version 0.3.0

IETF JSONPath Draft compliance

• Added support for function extensions.
• Added the built-in length() function.
• Added the built-in count() function. count() is an alias for length().
• Support filters without parentheses.
• Adhere to IETF JSONPath draft escaping in quoted property selectors.
• Handle UTF-16 surrogate pairs in quoted property selectors.

Features

• Added the built-in keys() function.
• Added parent and children properties to JSONPathMatch. Now we can traverse the "document tree" after finding matches.
• Added a parts property to JSONPathMatch. parts is a tuple of ints, slices and strs that can be used with JSONPathEnvironment.getitem() to get the matched object from the original data structure, or equivalent data structures. It is the keys, indices and slices that make up a concrete path.