Doc inaccurate

[jlmeunier]

Hi,

The documentation is inaccurate for my installation.

import yaml_include
--> ModuleNotFoundError: No module named 'yaml_include'

import yamlinclude
OK
but AttributeError: module 'yamlinclude' has no attribute 'Constructor'

I had to do:
yaml.add_constructor("!inc", yamlinclude.YamlIncludeConstructor("pypath"))

The versions I use are below.

JL

Python 3.11.11

conda list |grep yaml
pyyaml 6.0.2 py311h9ecbd09_1 conda-forge
pyyaml-include 1.3 pyhd8ed1ab_1 conda-forge
yaml 0.2.5 h7b6447c_0

[tanbro]

The package name of pyyaml-include 1.x is yamlinclude, while in 2.x, it is yaml_include.
You may update it:

pip install -U pyyaml-include

Note

v2 is not compatible with v1!

[jlmeunier]

Oh, I see, thanks! Now it works fine. Not sure how I manage to get the version 1. My mistake, sorry.

BTW, I initially wanted to use your pyyaml-include "indirectly", via OmegaConf.
OmegaConf uses yaml internally, and I hoped to add a constructor globally from my main. But it does not work. If you have any idea or hint, please share! :-)

JL

[tanbro]

I see OmegaConf works with pyyaml-include 1.x. Can we pin it in the requirements.txt(eg: pyyaml-include~=1.4) ?