ModuleNotFoundError: No module named 'maison.schema'

[christianversloot]

Description

With yamlfix==1.16.0 our pipelines are no longer working:

Traceback (most recent call last):
  File "/usr/local/bin/yamlfix", line 5, in <module>
    from yamlfix.entrypoints.cli import cli
  File "/usr/local/lib/python3.10/site-packages/yamlfix/__init__.py", line 10, in <module>
    from yamlfix.services import fix_code, fix_files
  File "/usr/local/lib/python3.10/site-packages/yamlfix/services.py", line 13, in <module>
    from yamlfix.adapters import SourceCodeFixer, Yaml
  File "/usr/local/lib/python3.10/site-packages/yamlfix/adapters.py", line 14, in <module>
    from yamlfix.model import YamlfixConfig, YamlNodeStyle
  File "/usr/local/lib/python3.10/site-packages/yamlfix/model.py", line 5, in <module>
    from maison.schema import ConfigSchema
ModuleNotFoundError: No module named 'maison.schema'

This presumably occurs due to a new major release (1.x -> 2.0.0) of the maison package: https://pypi.org/project/maison/#history

Steps to reproduce

1. pip install yamlfix
2. yamlfix --verbose --check anyyamlfile.yml

Current behavior

See above.

Desired behavior

No error.

Environment

------------------------------------------------------------------
     yamlfix: 1.16.0
     Python: 3.11.7
     Platform: Windows-10-10.0.19045-SP0
------------------------------------------------------------------

[armallen]

Had the same issue this morning, I temporarily added explicit version restrictions as a workaround #285

[menzenski]

This is hitting us as well. Thanks for the workaround @armallen !

[christianversloot]

Thanks! Let's hope it's fixed soon.
Another workaround which worked for us is ensuring that the latest 1.x version of maison was installed before attempting to install yamlfix in the pipeline. Because that version of maison is acceptable given the dependencies range, its installation is not overwritten, and it works with pip-installed yamlfix. Of course, it's a temporary fix only :)

[rafrafek]

Here it could be limited to <2.0 as a hotfix:

https://github.com/lyz-code/yamlfix/blob/main/pyproject.toml#L31

[rafrafek]

For pre-commit users:

.pre-commit-config.yaml:

  - repo: https://github.com/lyz-code/yamlfix
    rev: "1.16.0"
    hooks:
      - id: yamlfix
        additional_dependencies:
          - 'maison<2.0.0'

[lyz-code]

Available since 1.17.0 thanks to @armallen

[nfelt14]

Will there be a new tag created in GitHub so that we can update pre-commit configurations?

[lyz-code]

Oups, I forgot to push it. There you have it @nfelt14. Thanks for pointing it out