Install & Compatibility
Where this runs
tested against v1.3.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.920 runs
installs and imports cleanly · install 0.0s · import 0.152s · 19.9MB
glibcpy 3.10–3.920 runs
installs and imports cleanly · install 1.7s · import 0.146s · 21MB
18MB installed
● package 18MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
ordered_load
✓ from aspy.yaml import ordered_load
✗ import aspy.yaml.ordered_load
The function is directly available from the aspy.yaml package, not a submodule named 'ordered_load'.
ordered_dump
✓ from aspy.yaml import ordered_dump
✗ import aspy.yaml.ordered_dump
Similar to ordered_load, dump is a direct export.
This quickstart demonstrates how to use `ordered_load` to parse a YAML string into a Python object, ensuring that dictionary keys maintain their original order. It then shows how to use `ordered_dump` to serialize a Python object back into a YAML string, again preserving the order of keys. This is particularly useful for configuration files where order matters or for consistent output.
from aspy.yaml import ordered_load, ordered_dump
yaml_str = '''
key1: value1
key2: value2
list_key:
- itemA
- itemB
'''
# Load YAML while preserving dictionary order
data = ordered_load(yaml_str)
print(f"Loaded data (order preserved): {data}")
# Verify order
assert list(data.keys()) == ['key1', 'key2', 'list_key']
# Modify data and dump it back, preserving order
data['new_key'] = 'new_value'
output_yaml = ordered_dump(data)
print(f"\nDumped YAML (order preserved):\n{output_yaml}")
Debug
Known issues
breakingDirect use of `yaml.load` (from the underlying PyYAML library) is unsafe when parsing untrusted YAML data, as it can lead to arbitrary code execution. `aspy-yaml`'s `ordered_load` is built upon PyYAML's loading mechanisms and inherits this behavior.fixAlways use `yaml.safe_load` from PyYAML, or ensure the input source for `aspy.yaml.ordered_load` is trusted. If `ordered_load` is strictly needed, sanitize or validate input rigorously before loading.
affects: All versions of aspy-yaml and PyYAML
gotchaaspy-yaml, through PyYAML, primarily adheres to the YAML 1.1 specification. This can lead to unexpected parsing results for certain values, such as 'yes', 'no', 'on', 'off' being parsed as booleans, or octal numbers requiring a '0o' prefix in YAML 1.2 but being interpreted differently in 1.1.fixWhen authoring YAML, explicitly quote scalar values that might be misinterpreted (e.g., 'yes', 'no', '010'). For stricter YAML 1.2 compliance, consider `ruamel.yaml` as an alternative.
affects: All versions of aspy-yaml
gotchaYAML's indentation-sensitive syntax is a frequent source of errors. Incorrect spacing can lead to `ParserError` or misinterpretation of the document structure, which is common across all YAML parsers, including aspy-yaml.fixUse a linter or an IDE with YAML syntax checking. Ensure consistent use of spaces (not tabs) for indentation. Start new blocks with increased indentation and maintain the same level within a block.
affects: All versions
Errors
Common errors & fixes
ImportError: No module named aspy.yaml
The `aspy.yaml` package is not installed in the current Python environment, or there's an issue with the Python path preventing it from being found.
fixEnsure `aspy.yaml` is installed for the correct Python interpreter: `pip install aspy.yaml`. If using virtual environments, activate the correct environment before installation and running the script.
Dictionary order is not preserved after loading YAML.
This issue occurs if you are using `yaml.load` (from the base PyYAML library) instead of `aspy.yaml.ordered_load`. Standard Python dictionaries prior to 3.7 do not guarantee insertion order, and `PyYAML`'s default loader does not enforce it.
fixReplace calls to `yaml.load` with `from aspy.yaml import ordered_load` and then use `ordered_load(yaml_string)`.
yaml.scanner.ScannerError: while scanning for the next token
This error typically indicates a syntax issue in your YAML file, such as incorrect indentation, unclosed quotes, or illegal characters.
fixCarefully review the YAML content, paying close attention to indentation, proper quoting of strings (especially those containing special characters or starting with numbers/keywords), and correct formatting of lists and dictionaries. Use an online YAML validator or an IDE with YAML linting to pinpoint the exact error.
Upgrade
Version history
1.3.0latest on PyPI · released May 23, 2019
Audit
Dependencies
pyyamlrequiredCore YAML parsing and dumping functionality is provided by PyYAML.
ordereddictoptionalUsed internally for ordered dictionaries on Python versions prior to 3.7 where dictionaries were not insertion-ordered by default.