yamllint
pyyaml
Our great sponsors
yamllint | pyyaml | |
---|---|---|
11 | 16 | |
2,706 | 2,425 | |
- | 1.3% | |
8.3 | 3.9 | |
about 2 months ago | 12 days ago | |
Python | Python | |
GNU General Public License v3.0 only | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
yamllint
- yamllint – A Linter for YAML Files
-
IT Pro Tuesday #227 - Notification Tool, SPF/DKIM/DMARC Tutorial, YAML Linter & More
yamllint, as the name suggests, is a linter for YAML files. It checks syntax validity, as well as looking for more-complex errors like key repetition and cosmetic problems such as line length, trailing spaces, indentation etc. This one was indly recommended by yankdevil.
-
StrictYAML
StrictYAML removes features that might be useful for some usecases, such as Node anchors+Refs and Flow Style.
I don't think the cost of an additional standard is worth it in this case.
While YAML has issues, they aren't much of problem if you use a linter, such as yamllint [1].
1. https://github.com/adrienverge/yamllint
-
Data and System Visualization Tools That Will Boost Your Productivity
On top of the above-mentioned tools, it's also a good idea to use YAML linter such this one or its CLI equivalent, which will validate and cleanup your documents.
- Anyone actually fluent in YAML?
-
Let CI check & fix your yamls
yamlfixer automates the fixing of problems reported by yamllint by parsing its output.
-
Modern Python setup for quality development
repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.0.1 hooks: - id: check-added-large-files - id: check-ast - id: check-builtin-literals - id: check-case-conflict - id: check-docstring-first - id: check-executables-have-shebangs - id: check-json - id: check-merge-conflict - id: check-symlinks - id: check-toml - id: check-vcs-permalinks - id: check-xml - id: check-yaml args: [--allow-multiple-documents] - id: debug-statements - id: detect-aws-credentials args: [--allow-missing-credentials] - id: destroyed-symlinks - id: end-of-file-fixer - id: fix-byte-order-marker - id: fix-encoding-pragma args: [--remove] - id: forbid-new-submodules - id: mixed-line-ending args: [--fix=auto] - id: name-tests-test args: [--django] - id: requirements-txt-fixer - id: trailing-whitespace - repo: local hooks: - id: black name: black entry: poetry run black language: system types: [python] - id: flake8 name: flake8 entry: poetry run flake8 language: system types: [python] - repo: https://github.com/pycqa/isort rev: "5.9.1" hooks: - id: isort args: - --profile - black - --filter-files - repo: https://github.com/adrienverge/yamllint.git rev: v1.26.1 hooks: - id: yamllint args: [-c=.yamllint.yaml] - repo: https://gitlab.com/devopshq/gitlab-ci-linter rev: v1.0.2 hooks: - id: gitlab-ci-linter args: - "--server" - "https://your.gitlab.server" # Need env var GITLAB_PRIVATE_TOKEN with gitlab api read token - repo: https://github.com/commitizen-tools/commitizen rev: v2.17.11 hooks: - id: commitizen stages: [commit-msg] - repo: https://github.com/jumanjihouse/pre-commit-hooks rev: 2.1.5 # or specific git tag hooks: - id: forbid-binary - id: shellcheck - id: shfmt
-
YAML formatter recommendation
If you wanted a linter.
-
CloudFormation Noob - using YAML
Or, run Yamllint externally. I do this, because I have more control: https://github.com/adrienverge/yamllint
-
The Norway Problem
You can catch this with yamllint (https://github.com/adrienverge/yamllint):
% cat countries.yml
pyyaml
-
Cython 3.0 Released
PyYAML knew about the breakage since january 2022[0], and nothing really happened. After a year and a half with lots of alphas and betas, I don't think there is much cython could do, short of fixing PyYAML themselves.
[0]: https://github.com/yaml/pyyaml/issues/601
- Cython v3 release breaking PyYAML install well used in Python ecosystem
- Cython and pyyaml is breaking many builds
- I'm needing a hand, I do not understand some (seemingly) simple Python stuff.
-
is there any difference between using string.format() or an fstring?
They did finally change the default, in PyYAML 6, after many many bugs pointing out that their previous approach is broken (including one by yours truly), so the default is now safe.
-
Using Rust to not have to touch Yaml in k8s land
Note some parsers, most notably pyyaml are still at yaml 1.1, because 13 years is just not enough time to update it.
-
JSON is not a YAML subset
That part of the YAML 1.2 spec is in conflict with reality, though. The base of YAML 1.1 documents is large enough that a backwards-incompatible change to default behavior is for practical purposes impossible.
YAML 1.1 was released in 2005, and 1.2 in 2009 -- only four years later. But here we are, in 2022, and YAML 1.1 is still the default (in many cases, only) version supported. That's why the "Norway problem" persists -- it's not possible for the parser to know whether an un-versioned YAML document containing "a: no" should parse the same as {"a": false} or {"a": "no"}.
Python (PyYAML) doesn't support 1.2 yet: https://github.com/yaml/pyyaml/issues/116
Ruby (Psych) ditto -- I can't even find a tracking issue to enable it.
Go (go-yaml) is a mixture of YAML 1.1 and 1.2, depending on the author's preferences.
Also, as a rough guideline, you can't have a backwards-incompatible revision of a versioned spec declare that it's the new default version, because that breaks all existing users.
-
I accidentally used YAML.parse instead of JSON.parse, and it worked?
Many parsers either default to YAML pre-1.2 or do not even expose a YAML 1.2 option. PyYAML has no 1.2 option, for example. So unless Ansible is using something other than PyYAML...
Relevant (open) PR: https://github.com/yaml/pyyaml/pull/555
- AttributeError: '_io.TextIOWrapper' object has no attribute 'items'
-
Why doesn't yaml allow safe_dump for decimals?
Are you perhaps talking about decimal.Decimal? https://github.com/yaml/pyyaml/issues/255
What are some alternatives?
cue - CUE has moved to https://github.com/cue-lang/cue
confuse - painless YAML config files for Python
pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.
strictyaml - Type-safe YAML parser and validator.
Flake8 - flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code.
jsonnet - Jsonnet - The data templating language
edn - Extensible Data Notation
marshmallow - A lightweight library for converting complex objects to and from simple Python datatypes.
kubernetes - Production-Grade Container Scheduling and Management
python-strict-yaml-parsing - Examples of strict yaml parsing in python
yamlfix - A simple opinionated yaml formatter that keeps your comments!
python-frontmatter - Parse and manage posts with YAML (or other) frontmatter