Skip to content
Novus Examples
yaml1.1 KB

YAML Quoting Styles and Escapes

All three scalar quoting styles side by side: plain scalars and what they cannot contain, single quotes where backslashes stay literal and '' means one quote, and double quotes as the only style that processes \t, \n and \uXXXX escapes.

Preview — first 28 linesyaml
# Quoting styles. Plain scalars need no quotes but cannot start with most indicators and cannot
# contain ": " or " #". Single quotes are literal except for '' meaning one quote. Double quotes
# are the only style that processes backslash escapes.
plain: no quotes are needed for this value
plain_with_colon_inside_word: http://example.invalid/path
single: 'it''s single-quoted, so backslashes \n stay literal'
double: "escapes work here: tab\tnewline\nunicode é and \U0001F680"

colon_space_needs_quotes: "key: value written inside a string"
hash_needs_quotes: "colour #4821 is not a comment"
starts_with_indicator: "@example handle"
starts_with_asterisk: "*not-an-alias"
starts_with_ampersand: "&not-an-anchor"
starts_with_percent: "%not-a-directive"
starts_with_backtick: "`reserved indicator"

multiline_double: "a double-quoted scalar wrapped
  across two lines folds to a single space"

multiline_single: 'the same folding applies
  to single-quoted scalars'

escaped_quote_double: "she said \"quoted\" here"
escaped_quote_single: 'she said ''quoted'' here'

looks_numeric_but_is_text: "007"
trailing_space_in_double: "value with a trailing space "

Specifications

Quoting Styles
3
Escape Sequences
4
Indicator Start Values
5
Multiline Folding
2
Edge Case
only double quotes process backslash escapes

Testing contract

Expected to pass
Scenario
Decode YAML scalars across all three quoting styles
Expected result
The double-quoted value contains a real tab and newline while the single-quoted value contains the two literal characters backslash and n

What is a .yaml file?

YAML (YAML Ain't Markup Language) is a human-readable data-serialization format using indentation, key-value pairs, and lists, and is a superset of JSON. It supports comments, anchors, and multiple documents per file, favoring readability for configuration. Its indentation sensitivity makes it error-prone to hand-edit.

How to use this file

Use an example YAML file to test config parsers, indentation and anchor handling, multi-document streams, and safe-loading to avoid arbitrary object construction.

How to use this file for testing

“YAML Quoting Styles and Escapes” is a deterministic Novus Examples fixture for Config parsing, Encoding detection, Editor testing. TOML and INI configuration files with nested sections and typed values — for testing config parsers and loaders.

Documented properties for this file: YAML · 1,156 bytes. Compare results against paired or grouped companions on this page when present (clean↔damaged, searchable↔scanned, or format twins) so scores stay reproducible across runs.

Download the file once, keep the path stable in CI or local scripts, and treat the spec table as the contract: dimensions, seeds, field lists, and roles are intentional. Corrupt or invalid samples are labelled as such — expect parsers to fail loudly rather than silently accept them.

Pipeline and infrastructure fixtures are inert configuration: steps reference fictional images and scripts, and nothing here executes. Run your linter, schema validator, migrator, or policy engine against them, and expect the deprecated-syntax and intentionally invalid variants to be rejected.

Point your config loader at the file and assert it reads the documented sections and typed values, including any deliberately-tricky nesting or comments.

Code examples

import yaml  # pip install pyyaml

with open("quoting-and-escapes.yaml") as f:
    data = yaml.safe_load(f)
print(data)

Generated by generation/pipelines.py. Free for any use, no attribution required — license.