Skip to content

Commit

Permalink
Release 3.8.0 (#215)
Browse files Browse the repository at this point in the history
* Increase YAMLPathException specificity
* Enable users to test whether a YAML Path resolves to at least one node.
* Add optional JSON indentation
* Update tests for json-indent
* Set version to 3.8.0
  • Loading branch information
wwkimball authored Mar 30, 2023
1 parent 8fa2366 commit be7af7d
Show file tree
Hide file tree
Showing 16 changed files with 962 additions and 28 deletions.
32 changes: 32 additions & 0 deletions CHANGES
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
3.8.0
Enhancements:
* The yaml-set and yaml-merge command-line tools now support a new option:
--json-indent/-J. This applies only to JSON output. By default, JSON
documents are written/printed as single-line documents. This new option
enables users to vertically expand JSON output with a specified indentation
size for nest levels.
* Additional *YAMLPathExceptions have been added to increase the specificity of
various error conditions. You do not need to change any of your code as a
result of this change; all new exceptions are subclasses of the original
YAMLPathException. The new exceptions include:
* UnmatchedYAMLPathException: No matching nodes
* DuplicateKeyYAMLPathException: Duplicate key creation attempted
* TypeMismatchYAMLPathException: Data Type mismatch
* BadAliasYAMLPathException: Anchor/Alias/YMK error
* NoDocumentYAMLPathException: Attempt to delete the entire document
* RecursionYAMLPathException: Recursion nesting error
* The Processor class now enables consumers to verify whether a YAMLPath would
resolve to at least one node in the present document. The result is a simple
Boolean (True when the path resolves; False, otherwise). The document is not
modified by this test. See: Processor.exists(yaml_path)

Bug Fixes:
* Pursuant to the addition of the intersection operator (&) added in 3.7.0, the
text of one of the YAMLPathExceptions has been updated:
Former:
Adjoining Collectors without an operator has no meaning; try + or -
between them, {yaml_path}
New:
Adjoining Collectors without an operator has no meaning; try +, -, or &
between them, {yaml_path}

3.7.0
Enhancements:
* Support for Python 3.11 has been added.
Expand Down
Loading

0 comments on commit be7af7d

Please sign in to comment.