Releases: remarshal-project/remarshal
Releases · remarshal-project/remarshal
v0.20.0
- YAML: Emit
null
instead of an empty scalar for nulls. In 0.18.0 Remarshal switched to an empty scalar (meaning,foo:
with no value after the key) to represent nulls. This was the result of migrating to the ruamel.yaml library, where it is the default. While both representations are valid YAML 1.2, people tend to write and expectnull
. The current release restores pre-0.18.0 behavior.
v0.19.1
v0.19.0
v0.18.0
Breaking changes:
- Remarshal 0.18 finally encodes and decodes YAML as YAML 1.2 rather than YAML 1.1 like earlier versions. It means no more "Norway problem" (unquoted
NO
,No
, andno
being decoded as boolean false). Remarshal can now correctly process GitHub Actions YAML. To implement this, we have migrated from PyYAML to ruamel.yaml. The option--sort-keys
no longer affects YAML output due to a lack of support in the new YAML library. Because ruamel.yaml is not yet considered stable, the 1.0 release of Remarshal is postponed. - Multiple small changes to the Python API when using Remarshal as a library. For example, the order of the arguments to the function
remarshal
has changed. A type checker like mypy or Pyright can help you upgrade. We hope to make this the biggest change before the API is declared stable in version 1.0. - Support for Python 3.7 has been dropped.
Non-breaking changes:
- TOML decoding speed-up: TOML decoding should be at least 10× faster on average. Encoding is unaffected.
- There are new format command-line options
-f
/--from
and-t
/--to
like in Pandoc and iconv(1). We have hidden (but kept)-if
and-of
with a single dash. Those are legacy options from the Go days of Remarshal. - A new
--verbose
command-line option has been added for debugging. - The command-line interface and the help message have color. Color is used sparingly. You can disable it by setting the environment variable
NO_COLOR
. - Remarshal is now tested with PyPy and on macOS.
v0.17.1
- Fixed a billion laughs DoS vulnerability when converting from YAML. More information: JVN86156389. CVE-2023-47163.
v0.17.0
- BREAKING CHANGE: Remarshal no longer turns boolean and null keys into strings by default when converting to JSON. The default is to exit with an error. The previous default could cause silent data corruption, for example, when converting a GitHub Actions workflow file with an unquoted
on
key from YAML to JSON. While this is a breaking change, it should not affect most users. - The new flag
-k
/--stringify
restores the old JSON conversion behavior of turning boolean and null keys into strings. Additionally, it turns date-time keys into strings and works for both JSON and TOML. it also converts null values to strings for TOML, since TOML does not have null.
v0.16.1
v0.16.0
- This version adds new command-line options:
--json-indent n
,-s
/--sort-keys
,--yaml-indent n
,--yaml-width n
.--json-indent n
is a synonym for--indent-json n
consistent with the YAML options. Prefer it to the older option. - Preserving key order in JSON, TOML, and YAML types is now the default. Remarshal accepts the flag
-p
/--preserve-key-order
for compatibility, but it does nothing. Pass-s
/--sort-keys
to enable the previous default behavior. - The code has type annotations.
- The readme has been improved. It suggests better ways to run and install Remarshal. The mistaken claim that you can use a blank string as the filename for standard input/output (not true since the Python rewrite in 2016) is gone.
v0.15.1
v0.15.0
This version
- Fixes conversion of YAML with boolean and null keys to JSON;
- Updates the CBOR, TOML, and YAML library, upgrading support for TOML to 1.0.0 (no longer
-rc
); - Requires Python 3.8;
- Removes some inert code that supported earlier versions of Python.