beetbox / beetbox/confuse

Switch to ruamel.yaml

Open
#52 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
424
Forks
57
PR merge metrics
No merged PRs in 30d

Description

We apply a number of YAML hacks on top of PyYAML for Confit. As pointed out in https://github.com/sampsyo/beets/issues/396#issuecomment-153753069, the [ruamel.yaml](https://bitbucket.org/ruamel/yaml) fork takes care of a few of them:
- Round-tripping comments (much better than our current incomplete hacks).
- Preservation of ordered dictionaries.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue does not name files, tests, or entry points; start by locating the current PyYAML usage and the YAML-specific hacks in the repository, then review the linked discussion. Done should mean that ruamel.yaml replaces the relevant handling while preserving comments and ordered dictionaries.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.