ruamel_yaml_line_info

Line information for ruamel.yaml.

Quick Start

Using an Alternative Constructor

Instead of:

with open(yaml_path, encoding="utf-8") as fh:
    yaml = ruamel.yaml.YAML(typ="rt").load("".join(fh))

change the import:

with open(yaml_path, encoding="utf-8") as fh:
    yaml = ruamel_yaml_line_info.YAML(typ="rt").load("".join(fh))

and voila!

Example

Consider the following YAML:

foo: bar
block: >
  this is not
  a multiline
  block
single_quote: 'single'
double_quote: "double"

then we can get line and column information with

>>> with open(yaml_path, encoding="utf-8") as fh:
    yaml = ruamel_yaml_line_info.YAML(typ="rt").load("".join(fh))
>>> print(yaml["foo"].lc)
LineCol(0, 5)
>>> print(yaml["block"].lc)
LineCol(1, 7)
>>> print(yaml["single_quote"].lc)
LineCol(5, 14)
>>> print(yaml["double_quote"].lc)
LineCol(6, 14)

where the first value in LineCol is the 0-based line, and the second value in LineCol is the 0-based column.

See the test for more exapmles.

Patching an existing YAML object

If you already have a ruamel.yaml.YAML instance, you can add line numbers with:

with open(yaml_path, encoding="utf-8") as fh:
    yaml = ruamel.yaml.YAML(typ="rt").load("".join(fh))
    yaml = ruamel_yaml_line_info.YAML.with_line_numbers(yaml=yaml)

Recommended Installation

Install the Python package and dependency management tool poetry using official documentation. You must have Python 3.11 or greater available on your system path, which could be managed by mamba, pyenv, or another package manager. Finally, install the dependencies of the project with:

poetry install

To check successful installation, run:

python -c "import ruamel_yaml_line_info"

Installing with Conda

Install the environment manager mamba using official documentation. Create and activate a conda environment with Python 3.11 or greater:

mamba create -c conda-forge -n ruamel_yaml_line_info ruamel-yaml-line-info python=3.11
mamba activate ruamel_yaml_line_info

Alternatively, install into an existing conda environment:

mamba install -n <ENVIRONMENT> -c conda-forge ruamel-yaml-line-info

To check successful installation, run:

python -c "import ruamel_yaml_line_info"

Development and Testing

See the contributing guide for more information.