pyyaml-include 1.1

Extending PyYAML with a custom constructor for including YAML files within YAML files

pyyaml-include

An extending constructor of PyYAML, which including YAML files within YAML files.

Install

pip install pyyaml-include

Usage

Consider we have such YAML files:

├── 0.yaml
└── include.d
    ├── 1.yaml
    └── 2.yaml

• 1.yaml 's content:

  name: "1"
  

• 2.yaml 's content:

  name: "2"
  

To include 1.yaml, 2.yaml in 0.yaml, we shall first add YamlIncludeConstructor to PyYAML's loader, then write !include tag in 0.yaml and load it:

import yaml
from yamlinclude import YamlIncludeConstructor

YamlIncludeConstructor.add_to_loader_class(yaml.FullLoader, base_dir='/your/conf/dir')

with open('0.yaml') as f:
    data = yaml.load(f, Loader=yaml.FullLoader)

print(data)

Include files by name

• On top level:

  If 0.yaml was:

  !include include.d/1.yaml
  

  We'll get:

  {"name": "1"}
  

• In mapping:

  If 0.yaml was:

  file1: !include include.d/1.yaml
  file2: !include include.d/2.yaml
  

  We'll get:

    file1:
      name: "1"
    file2:
      name: "2"
  

• In sequence:

  If 0.yaml was:

  files:
    - !include include.d/1.yaml
    - !include include.d/2.yaml
  

  We'll get:

  files:
    - name: "1"
    - name: "2"
  

ℹ Note:

File name can be either absolute (like /usr/conf/1.5/Make.yml) or relative (like ../../cfg/img.yml).

Include files by wildcards

File name can contain shell-style wildcards. Data loaded from the file(s) found by wildcards will be set in a sequence.

If 0.yaml was:

files: !include include.d/*.yaml

We'll get:

files:
  - name: "1"
  - name: "2"

ℹ Note:

• For Python>=3.5, if recursive argument of !include YAML tag is true, the pattern “**” will match any files and zero or more directories and subdirectories.
• Using the “**” pattern in large directory trees may consume an inordinate amount of time because of recursive search.

In order to enable recursive argument, we shall write the !include tag in Mapping or Sequence mode:

• Arguments in Sequence mode:

  !include [tests/data/include.d/**/*.yaml, true]
  

• Arguments in Mapping mode:

  !include {pathname: tests/data/include.d/**/*.yaml, recursive: true}
  

Authors

liu xue yan [e-mail]

Changelog

1.1

Date: 2019-03-18

• Change:
  • Update PyYAML to 5.*
  • Argument loader_class of YamlIncludeConstructor.add_to_loader_class() renamed and required(former: loader_cls, default=None)

1.0.4

Date: 2019-01-07

• Change:

  • rename: TAG ==> DEFAULT_TAG_NAME
  • add: encoding argument

• Fix:

  • A wrong logging text format

• Misc:

  • add: .pylintrc

1.0.3

Date: 2018-12-04

• New Feature:

  • Add base_dir argument

• Misc:

  • Add some new unit-test
  • Add Python3.7 in CircleCI

1.0.2

Date: 2018-07-11

• Add:

  • encoding argument

• Bug fix:

  • encoding error if non-ascii characters on non-utf8 os.

1.0.1

Date: 2018-07-03

• Add:

  • Old Python2.6 and new Python3.7 compatibilities

  • class method add_to_loader_class

    A class method to add the constructor itself into YAML loader class

  • Sphinx docs

• Change:

  • Rename module file include.py to constructor.py

  • Rename class data member DEFAULT_TAG to TAG

1.0

Date: 2018-06-08