Compare commits
51 Commits
feature/pl
...
v1.27.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8a364e2fde | ||
|
|
dc2d0991e0 | ||
|
|
e6af957131 | ||
|
|
8ac7d58693 | ||
|
|
40cab7f999 | ||
|
|
34a4f76e8b | ||
|
|
7d9c824b83 | ||
|
|
157b06871d | ||
|
|
af843b675a | ||
|
|
695fc5f1f1 | ||
|
|
632665c3e6 | ||
|
|
5658cf7f42 | ||
|
|
bdbec7dc4d | ||
|
|
9700525496 | ||
|
|
327f92e472 | ||
|
|
89b75b7c05 | ||
|
|
e49a101160 | ||
|
|
c268a82c5a | ||
|
|
2f423117c1 | ||
|
|
f58448cb21 | ||
|
|
7974d518cd | ||
|
|
8a320aaf2c | ||
|
|
c34c962691 | ||
|
|
4f1bbc33dc | ||
|
|
bb567ba395 | ||
|
|
d0392b34ca | ||
|
|
7246a0c800 | ||
|
|
9e6dfacceb | ||
|
|
11e8d8ff37 | ||
|
|
f2e2e0c366 | ||
|
|
058fef7559 | ||
|
|
f47d5318cf | ||
|
|
33ce0fa960 | ||
|
|
43744902e9 | ||
|
|
85ccd625a3 | ||
|
|
e53ea093e2 | ||
|
|
5d8ef2ea23 | ||
|
|
4515269233 | ||
|
|
66bf76a362 | ||
|
|
8f682481c7 | ||
|
|
0fff4e29e4 | ||
|
|
1b378ed5b9 | ||
|
|
a3fc64d134 | ||
|
|
ee4d163ff8 | ||
|
|
22335b294d | ||
|
|
0f9dffde23 | ||
|
|
cef0b48993 | ||
|
|
11b1f1c14e | ||
|
|
9ee8c27ac9 | ||
|
|
8eebab68ab | ||
|
|
2103bd73de |
55
.github/workflows/ci.yaml
vendored
Normal file
55
.github/workflows/ci.yaml
vendored
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
|
||||
name: CI
|
||||
|
||||
on: # yamllint disable-line rule:truthy
|
||||
push:
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
name: Linters
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v2
|
||||
- run:
|
||||
python -m pip install flake8 flake8-import-order doc8 sphinx
|
||||
rstcheck[sphinx]
|
||||
- run: python -m pip install .
|
||||
- run: flake8 .
|
||||
- run: doc8 $(git ls-files '*.rst')
|
||||
- run: rstcheck --ignore-directives automodule $(git ls-files '*.rst')
|
||||
- run: yamllint --strict $(git ls-files '*.yaml' '*.yml')
|
||||
- run: python setup.py build_sphinx
|
||||
|
||||
test:
|
||||
name: Tests
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
python-version:
|
||||
- '3.6'
|
||||
- '3.7'
|
||||
- '3.8'
|
||||
- '3.9'
|
||||
- '3.10'
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Append GitHub Actions system path
|
||||
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
|
||||
- run: pip install coveralls
|
||||
- run: pip install .
|
||||
- run: coverage run --source=yamllint -m unittest discover
|
||||
- name: Coveralls
|
||||
uses: AndreMiras/coveralls-python-action@develop
|
||||
28
.travis.yml
28
.travis.yml
@@ -1,28 +0,0 @@
|
||||
---
|
||||
dist: xenial # required for Python >= 3.7 (travis-ci/travis-ci#9069)
|
||||
language: python
|
||||
python:
|
||||
- 2.7
|
||||
- 3.5
|
||||
- 3.6
|
||||
- 3.7
|
||||
- 3.8
|
||||
- nightly
|
||||
env:
|
||||
- REMOVE_LOCALES=false
|
||||
- REMOVE_LOCALES=true
|
||||
install:
|
||||
- pip install pyyaml coveralls flake8 flake8-import-order doc8
|
||||
- if [[ $TRAVIS_PYTHON_VERSION != 2* ]]; then pip install sphinx; fi
|
||||
- pip install .
|
||||
- if [[ $REMOVE_LOCALES = "true" ]]; then sudo rm -rf /usr/lib/locale/*; fi
|
||||
script:
|
||||
- if [[ $TRAVIS_PYTHON_VERSION != nightly ]]; then flake8 .; fi
|
||||
- if [[ $TRAVIS_PYTHON_VERSION != 2* ]]; then doc8 $(git ls-files '*.rst'); fi
|
||||
- yamllint --strict $(git ls-files '*.yaml' '*.yml')
|
||||
- coverage run --source=yamllint -m unittest discover
|
||||
- if [[ $TRAVIS_PYTHON_VERSION != 2* ]]; then
|
||||
python setup.py build_sphinx;
|
||||
fi
|
||||
after_success:
|
||||
coveralls
|
||||
@@ -1,11 +1,57 @@
|
||||
Changelog
|
||||
=========
|
||||
|
||||
1.27.0 (2022-07-08)
|
||||
-------------------
|
||||
|
||||
- Add support for Python 3.10, drop Python 3.5
|
||||
- Fix GitHub Actions workflow
|
||||
- Refactor ``--format=auto`` logic
|
||||
- Update GitHub format output to use groups
|
||||
- Rule ``comments``: allow whitespace after the shebang marker
|
||||
- Multiple minor fixes in documetation
|
||||
- Configure Sphinx to make man page show up in apropos
|
||||
- Attempt to clarify configuration file location in documentation
|
||||
- Rule ``key-duplicates``: don't crash on redundant closing brackets or braces
|
||||
- Use ``rstcheck`` to lint documentation on the CI
|
||||
- Remove UTF-8 headers in Python files, since Python 2 isn't supported
|
||||
- Add various tests to increase coverage
|
||||
- Rule ``octal-values``: pre-compile regex for performance
|
||||
- Add sections for Visual Studio Code and IntelliJ in documentation
|
||||
- Rule ``new-lines``: add the ``type: platform`` config option
|
||||
- Add the new rule ``float-values``
|
||||
|
||||
1.26.3 (2021-08-21)
|
||||
-------------------
|
||||
|
||||
- Restore runtime dependency ``setuptools`` for Python < 3.8
|
||||
|
||||
1.26.2 (2021-08-03)
|
||||
-------------------
|
||||
|
||||
- Fix ``python_requires`` to comply with PEP 345 and PEP 440
|
||||
|
||||
1.26.1 (2021-04-06)
|
||||
-------------------
|
||||
|
||||
- Remove runtime dependency ``setuptools`` for Python < 3.8
|
||||
- Fix ``line_length`` to skip all hash signs starting comment
|
||||
|
||||
1.26.0 (2021-01-29)
|
||||
-------------------
|
||||
|
||||
- End support for Python 2 and Python 3.4, add support for Python 3.9
|
||||
- Add ``forbid: non-empty`` option to ``braces`` and ``brackets`` rules
|
||||
- Fix ``quoted-strings`` for explicit octal recognition
|
||||
- Add documentation for integration with Arcanist
|
||||
- Fix typos in changelog and README
|
||||
- Stop using deprecated ``python setup.py test`` in tests
|
||||
|
||||
1.25.0 (2020-09-29)
|
||||
-------------------
|
||||
|
||||
- Run tests on Travis both with and without UTF-8 locales
|
||||
- Improve documentationon with default values to rules with options
|
||||
- Improve documentation with default values to rules with options
|
||||
- Improve documentation with a Python API usage example
|
||||
- Fix documentation on ``commas`` examples
|
||||
- Packaging: move setuptools' configuration from ``setup.py`` to ``setup.cfg``
|
||||
|
||||
@@ -42,5 +42,7 @@ Pull Request Process
|
||||
|
||||
6. Write a `good commit message
|
||||
<http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
|
||||
If the pull request has multiple commits, each must be atomic (single
|
||||
irreducible change that makes sense on its own).
|
||||
|
||||
7. Then, open a pull request.
|
||||
|
||||
10
README.rst
10
README.rst
@@ -19,11 +19,7 @@ indentation, etc.
|
||||
:target: https://yamllint.readthedocs.io/en/latest/?badge=latest
|
||||
:alt: Documentation status
|
||||
|
||||
Written in Python (compatible with Python 2 & 3).
|
||||
|
||||
⚠ Python 2 upstream support stopped on January 1, 2020. yamllint will keep
|
||||
best-effort support for Python 2.7 until January 1, 2021. Passed that date,
|
||||
yamllint will drop all Python 2-related code.
|
||||
Written in Python (compatible with Python 3 only).
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
@@ -78,7 +74,7 @@ Usage
|
||||
# Output a parsable format (for syntax checking in editors like Vim, emacs...)
|
||||
yamllint -f parsable file.yaml
|
||||
|
||||
`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`_
|
||||
`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`__
|
||||
|
||||
Features
|
||||
^^^^^^^^
|
||||
@@ -136,7 +132,7 @@ Specific files can be ignored (totally or for some rules only) using a
|
||||
*.ignore-trailing-spaces.yaml
|
||||
/ascii-art/*
|
||||
|
||||
`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`_
|
||||
`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`__
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# yamllint documentation build configuration file, created by
|
||||
# sphinx-quickstart on Thu Jan 21 21:18:52 2016.
|
||||
|
||||
@@ -21,7 +20,7 @@ source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
|
||||
project = APP_NAME
|
||||
copyright = __copyright__
|
||||
copyright = __copyright__.lstrip('Copyright ')
|
||||
|
||||
version = APP_VERSION
|
||||
release = APP_VERSION
|
||||
@@ -39,7 +38,7 @@ htmlhelp_basename = 'yamllintdoc'
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'yamllint', '', [u'Adrien Vergé'], 1)
|
||||
('index', 'yamllint', 'Linter for YAML files', [u'Adrien Vergé'], 1)
|
||||
]
|
||||
|
||||
# -- Build with sphinx automodule without needing to install third-party libs
|
||||
|
||||
@@ -14,11 +14,11 @@ To use a custom configuration file, use the ``-c`` option:
|
||||
If ``-c`` is not provided, yamllint will look for a configuration file in the
|
||||
following locations (by order of preference):
|
||||
|
||||
- ``.yamllint``, ``.yamllint.yaml`` or ``.yamllint.yml`` in the current working
|
||||
directory
|
||||
- the file referenced by ``$YAMLLINT_CONFIG_FILE``, if set
|
||||
- ``$XDG_CONFIG_HOME/yamllint/config``
|
||||
- ``~/.config/yamllint/config``
|
||||
- a file named ``.yamllint``, ``.yamllint.yaml``, or ``.yamllint.yml`` in the
|
||||
current working directory
|
||||
- a filename referenced by ``$YAMLLINT_CONFIG_FILE``, if set
|
||||
- a file named ``$XDG_CONFIG_HOME/yamllint/config`` or
|
||||
``~/.config/yamllint/config``, if present
|
||||
|
||||
Finally if no config file is found, the default configuration is applied.
|
||||
|
||||
|
||||
@@ -22,9 +22,9 @@ Integration with GitHub Actions
|
||||
-------------------------------
|
||||
|
||||
yamllint auto-detects when it's running inside of `GitHub
|
||||
Actions<https://github.com/features/actions>` and automatically uses the suited
|
||||
output format to decorate code with linting errors automatically. You can also
|
||||
force the GitHub Actions output with ``yamllint --format github``.
|
||||
Actions <https://github.com/features/actions>`_ and automatically uses the suited
|
||||
output format to decorate code with linting errors. You can also force the
|
||||
GitHub Actions output with ``yamllint --format github``.
|
||||
|
||||
An example workflow using GitHub Actions:
|
||||
|
||||
@@ -51,3 +51,22 @@ An example workflow using GitHub Actions:
|
||||
|
||||
- name: Lint YAML files
|
||||
run: yamllint .
|
||||
|
||||
Integration with Arcanist
|
||||
-------------------------
|
||||
|
||||
You can configure yamllint to run on ``arc lint``. Here is an example
|
||||
``.arclint`` file that makes use of this configuration.
|
||||
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
"linters": {
|
||||
"yamllint": {
|
||||
"type": "script-and-regex",
|
||||
"script-and-regex.script": "yamllint",
|
||||
"script-and-regex.regex": "/^(?P<line>\\d+):(?P<offset>\\d+) +(?P<severity>warning|error) +(?P<message>.*) +\\((?P<name>.*)\\)$/m",
|
||||
"include": "(\\.(yml|yaml)$)"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -64,6 +64,12 @@ empty-values
|
||||
|
||||
.. automodule:: yamllint.rules.empty_values
|
||||
|
||||
float-values
|
||||
------------
|
||||
|
||||
.. automodule:: yamllint.rules.float_values
|
||||
|
||||
|
||||
hyphens
|
||||
-------
|
||||
|
||||
|
||||
@@ -33,6 +33,16 @@ Emacs
|
||||
If you are `flycheck <https://github.com/flycheck/flycheck>`_ user, you can use
|
||||
`flycheck-yamllint <https://github.com/krzysztof-magosa/flycheck-yamllint>`_ integration.
|
||||
|
||||
Visual Studio Code
|
||||
------------------
|
||||
|
||||
https://marketplace.visualstudio.com/items?itemName=fnando.linter
|
||||
|
||||
IntelliJ
|
||||
--------
|
||||
|
||||
https://plugins.jetbrains.com/plugin/15349-yamllint
|
||||
|
||||
Other text editors
|
||||
------------------
|
||||
|
||||
|
||||
11
setup.cfg
11
setup.cfg
@@ -26,14 +26,12 @@ classifiers =
|
||||
Environment :: Console
|
||||
Intended Audience :: Developers
|
||||
License :: OSI Approved :: GNU General Public License v3 (GPLv3)
|
||||
Programming Language :: Python :: 2
|
||||
Programming Language :: Python :: 2.7
|
||||
Programming Language :: Python :: 3
|
||||
Programming Language :: Python :: 3.4
|
||||
Programming Language :: Python :: 3.5
|
||||
Programming Language :: Python :: 3.6
|
||||
Programming Language :: Python :: 3.7
|
||||
Programming Language :: Python :: 3.8
|
||||
Programming Language :: Python :: 3.9
|
||||
Programming Language :: Python :: 3.10
|
||||
Topic :: Software Development
|
||||
Topic :: Software Development :: Debuggers
|
||||
Topic :: Software Development :: Quality Assurance
|
||||
@@ -48,7 +46,7 @@ project_urls =
|
||||
[options]
|
||||
packages = find:
|
||||
|
||||
python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
|
||||
python_requires = >=3.6
|
||||
|
||||
include_package_data = True
|
||||
install_requires =
|
||||
@@ -69,3 +67,6 @@ yamllint = conf/*.yaml
|
||||
[options.entry_points]
|
||||
console_scripts =
|
||||
yamllint = yamllint.cli:run
|
||||
|
||||
[coverage:run]
|
||||
relative_files = True
|
||||
|
||||
1
setup.py
1
setup.py
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -14,7 +13,9 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
import contextlib
|
||||
import os
|
||||
import shutil
|
||||
import tempfile
|
||||
import unittest
|
||||
|
||||
@@ -69,3 +70,17 @@ def build_temp_workspace(files):
|
||||
f.write(content)
|
||||
|
||||
return tempdir
|
||||
|
||||
|
||||
@contextlib.contextmanager
|
||||
def temp_workspace(files):
|
||||
"""Provide a temporary workspace that is automatically cleaned up."""
|
||||
backup_wd = os.getcwd()
|
||||
wd = build_temp_workspace(files)
|
||||
|
||||
try:
|
||||
os.chdir(wd)
|
||||
yield
|
||||
finally:
|
||||
os.chdir(backup_wd)
|
||||
shutil.rmtree(wd)
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -61,6 +60,30 @@ class ColonTestCase(RuleTestCase):
|
||||
' a: 1\n'
|
||||
'}\n', conf, problem=(2, 8))
|
||||
|
||||
conf = ('braces:\n'
|
||||
' forbid: non-empty\n')
|
||||
self.check('---\n'
|
||||
'dict:\n'
|
||||
' a: 1\n', conf)
|
||||
self.check('---\n'
|
||||
'dict: {}\n', conf)
|
||||
self.check('---\n'
|
||||
'dict: {\n'
|
||||
'}\n', conf)
|
||||
self.check('---\n'
|
||||
'dict: {\n'
|
||||
'# commented: value\n'
|
||||
'# another: value2\n'
|
||||
'}\n', conf)
|
||||
self.check('---\n'
|
||||
'dict: {a}\n', conf, problem=(2, 8))
|
||||
self.check('---\n'
|
||||
'dict: {a: 1}\n', conf, problem=(2, 8))
|
||||
self.check('---\n'
|
||||
'dict: {\n'
|
||||
' a: 1\n'
|
||||
'}\n', conf, problem=(2, 8))
|
||||
|
||||
def test_min_spaces(self):
|
||||
conf = ('braces:\n'
|
||||
' max-spaces-inside: -1\n'
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -60,6 +59,29 @@ class ColonTestCase(RuleTestCase):
|
||||
' b\n'
|
||||
']\n', conf, problem=(2, 9))
|
||||
|
||||
conf = ('brackets:\n'
|
||||
' forbid: non-empty\n')
|
||||
self.check('---\n'
|
||||
'array:\n'
|
||||
' - a\n'
|
||||
' - b\n', conf)
|
||||
self.check('---\n'
|
||||
'array: []\n', conf)
|
||||
self.check('---\n'
|
||||
'array: [\n\n'
|
||||
']\n', conf)
|
||||
self.check('---\n'
|
||||
'array: [\n'
|
||||
'# a comment\n'
|
||||
']\n', conf)
|
||||
self.check('---\n'
|
||||
'array: [a, b]\n', conf, problem=(2, 9))
|
||||
self.check('---\n'
|
||||
'array: [\n'
|
||||
' a,\n'
|
||||
' b\n'
|
||||
']\n', conf, problem=(2, 9))
|
||||
|
||||
def test_min_spaces(self):
|
||||
conf = ('brackets:\n'
|
||||
' max-spaces-inside: -1\n'
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -97,7 +96,7 @@ class CommentsTestCase(RuleTestCase):
|
||||
'#!/bin/env my-interpreter\n'
|
||||
'', conf,
|
||||
problem1=(1, 2), problem2=(3, 2), problem3=(4, 2))
|
||||
self.check('#! not a shebang\n',
|
||||
self.check('#! is a valid shebang too\n',
|
||||
conf, problem1=(1, 2))
|
||||
self.check('key: #!/not/a/shebang\n',
|
||||
conf, problem1=(1, 8))
|
||||
@@ -117,8 +116,7 @@ class CommentsTestCase(RuleTestCase):
|
||||
'#comment\n'
|
||||
'#!/bin/env my-interpreter\n', conf,
|
||||
problem2=(3, 2), problem3=(4, 2))
|
||||
self.check('#! not a shebang\n',
|
||||
conf, problem1=(1, 2))
|
||||
self.check('#! is a valid shebang too\n', conf)
|
||||
self.check('key: #!/not/a/shebang\n',
|
||||
conf, problem1=(1, 8))
|
||||
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2017 Greg Dubicki
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
120
tests/rules/test_float_values.py
Normal file
120
tests/rules/test_float_values.py
Normal file
@@ -0,0 +1,120 @@
|
||||
# Copyright (C) 2022 the yamllint contributors
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
class FloatValuesTestCase(RuleTestCase):
|
||||
rule_id = 'float-values'
|
||||
|
||||
def test_disabled(self):
|
||||
conf = 'float-values: disable\n'
|
||||
self.check('---\n'
|
||||
'- 0.0\n'
|
||||
'- .NaN\n'
|
||||
'- .INF\n'
|
||||
'- .1\n'
|
||||
'- 10e-6\n',
|
||||
conf)
|
||||
|
||||
def test_numeral_before_decimal(self):
|
||||
conf = (
|
||||
'float-values:\n'
|
||||
' require-numeral-before-decimal: true\n'
|
||||
' forbid-scientific-notation: false\n'
|
||||
' forbid-nan: false\n'
|
||||
' forbid-inf: false\n')
|
||||
self.check('---\n'
|
||||
'- 0.0\n'
|
||||
'- .1\n'
|
||||
'- \'.1\'\n'
|
||||
'- !custom_tag .2\n'
|
||||
'- &angle1 0.0\n'
|
||||
'- *angle1\n'
|
||||
'- &angle2 .3\n'
|
||||
'- *angle2\n',
|
||||
conf,
|
||||
problem1=(3, 3),
|
||||
problem2=(8, 11))
|
||||
|
||||
def test_scientific_notation(self):
|
||||
conf = (
|
||||
'float-values:\n'
|
||||
' require-numeral-before-decimal: false\n'
|
||||
' forbid-scientific-notation: true\n'
|
||||
' forbid-nan: false\n'
|
||||
' forbid-inf: false\n')
|
||||
self.check('---\n'
|
||||
'- 10e6\n'
|
||||
'- 10e-6\n'
|
||||
'- 0.00001\n'
|
||||
'- \'10e-6\'\n'
|
||||
'- !custom_tag 10e-6\n'
|
||||
'- &angle1 0.000001\n'
|
||||
'- *angle1\n'
|
||||
'- &angle2 10e-6\n'
|
||||
'- *angle2\n'
|
||||
'- &angle3 10e6\n'
|
||||
'- *angle3\n',
|
||||
conf,
|
||||
problem1=(2, 3),
|
||||
problem2=(3, 3),
|
||||
problem3=(9, 11),
|
||||
problem4=(11, 11))
|
||||
|
||||
def test_nan(self):
|
||||
conf = (
|
||||
'float-values:\n'
|
||||
' require-numeral-before-decimal: false\n'
|
||||
' forbid-scientific-notation: false\n'
|
||||
' forbid-nan: true\n'
|
||||
' forbid-inf: false\n')
|
||||
self.check('---\n'
|
||||
'- .NaN\n'
|
||||
'- .NAN\n'
|
||||
'- \'.NaN\'\n'
|
||||
'- !custom_tag .NaN\n'
|
||||
'- &angle .nan\n'
|
||||
'- *angle\n',
|
||||
conf,
|
||||
problem1=(2, 3),
|
||||
problem2=(3, 3),
|
||||
problem3=(6, 10))
|
||||
|
||||
def test_inf(self):
|
||||
conf = (
|
||||
'float-values:\n'
|
||||
' require-numeral-before-decimal: false\n'
|
||||
' forbid-scientific-notation: false\n'
|
||||
' forbid-nan: false\n'
|
||||
' forbid-inf: true\n')
|
||||
self.check('---\n'
|
||||
'- .inf\n'
|
||||
'- .INF\n'
|
||||
'- -.inf\n'
|
||||
'- -.INF\n'
|
||||
'- \'.inf\'\n'
|
||||
'- !custom_tag .inf\n'
|
||||
'- &angle .inf\n'
|
||||
'- *angle\n'
|
||||
'- &angle -.inf\n'
|
||||
'- *angle\n',
|
||||
conf,
|
||||
problem1=(2, 3),
|
||||
problem2=(3, 3),
|
||||
problem3=(4, 3),
|
||||
problem4=(5, 3),
|
||||
problem5=(8, 10),
|
||||
problem6=(10, 10))
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -87,6 +86,10 @@ class KeyDuplicatesTestCase(RuleTestCase):
|
||||
'anchor_reference:\n'
|
||||
' <<: *anchor_one\n'
|
||||
' <<: *anchor_two\n', conf)
|
||||
self.check('---\n'
|
||||
'{a:1, b:2}}\n', conf, problem=(2, 11, 'syntax'))
|
||||
self.check('---\n'
|
||||
'[a, b, c]]\n', conf, problem=(2, 10, 'syntax'))
|
||||
|
||||
def test_enabled(self):
|
||||
conf = 'key-duplicates: enable'
|
||||
@@ -165,6 +168,10 @@ class KeyDuplicatesTestCase(RuleTestCase):
|
||||
'anchor_reference:\n'
|
||||
' <<: *anchor_one\n'
|
||||
' <<: *anchor_two\n', conf)
|
||||
self.check('---\n'
|
||||
'{a:1, b:2}}\n', conf, problem=(2, 11, 'syntax'))
|
||||
self.check('---\n'
|
||||
'[a, b, c]]\n', conf, problem=(2, 10, 'syntax'))
|
||||
|
||||
def test_key_tokens_in_flow_sequences(self):
|
||||
conf = 'key-duplicates: enable'
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2017 Johannes F. Knauf
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -117,7 +116,7 @@ class KeyOrderingTestCase(RuleTestCase):
|
||||
self.addCleanup(locale.setlocale, locale.LC_ALL, (None, None))
|
||||
try:
|
||||
locale.setlocale(locale.LC_ALL, 'en_US.UTF-8')
|
||||
except locale.Error:
|
||||
except locale.Error: # pragma: no cover
|
||||
self.skipTest('locale en_US.UTF-8 not available')
|
||||
conf = ('key-ordering: enable')
|
||||
self.check('---\n'
|
||||
@@ -136,7 +135,7 @@ class KeyOrderingTestCase(RuleTestCase):
|
||||
self.addCleanup(locale.setlocale, locale.LC_ALL, (None, None))
|
||||
try:
|
||||
locale.setlocale(locale.LC_ALL, 'en_US.UTF-8')
|
||||
except locale.Error:
|
||||
except locale.Error: # pragma: no cover
|
||||
self.skipTest('locale en_US.UTF-8 not available')
|
||||
conf = ('key-ordering: enable')
|
||||
self.check('---\n'
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -14,9 +13,6 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
import sys
|
||||
import unittest
|
||||
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
@@ -119,6 +115,27 @@ class LineLengthTestCase(RuleTestCase):
|
||||
'long_line: http://localhost/very/very/long/url\n'
|
||||
'...\n', conf, problem=(2, 21))
|
||||
|
||||
conf = 'line-length: {max: 20, allow-non-breakable-words: true}'
|
||||
self.check('---\n'
|
||||
'# http://www.verylongurlurlurlurlurlurlurlurl.com\n'
|
||||
'key:\n'
|
||||
' subkey: value\n', conf)
|
||||
self.check('---\n'
|
||||
'## http://www.verylongurlurlurlurlurlurlurlurl.com\n'
|
||||
'key:\n'
|
||||
' subkey: value\n', conf)
|
||||
self.check('---\n'
|
||||
'# # http://www.verylongurlurlurlurlurlurlurlurl.com\n'
|
||||
'key:\n'
|
||||
' subkey: value\n', conf,
|
||||
problem=(2, 21))
|
||||
self.check('---\n'
|
||||
'#A http://www.verylongurlurlurlurlurlurlurlurl.com\n'
|
||||
'key:\n'
|
||||
' subkey: value\n', conf,
|
||||
problem1=(2, 2, 'comments'),
|
||||
problem2=(2, 21, 'line-length'))
|
||||
|
||||
conf = ('line-length: {max: 20, allow-non-breakable-words: true}\n'
|
||||
'trailing-spaces: disable')
|
||||
self.check('---\n'
|
||||
@@ -159,18 +176,17 @@ class LineLengthTestCase(RuleTestCase):
|
||||
' {% this line is' + 99 * ' really' + ' long %}\n',
|
||||
conf, problem=(3, 81))
|
||||
|
||||
@unittest.skipIf(sys.version_info < (3, 0), 'Python 2 not supported')
|
||||
def test_unicode(self):
|
||||
conf = 'line-length: {max: 53}'
|
||||
self.check('---\n'
|
||||
'# This is a test to check if “line-length” works nice\n'
|
||||
'with: “unicode characters” that span accross bytes! ↺\n',
|
||||
'with: “unicode characters” that span across bytes! ↺\n',
|
||||
conf)
|
||||
conf = 'line-length: {max: 52}'
|
||||
conf = 'line-length: {max: 51}'
|
||||
self.check('---\n'
|
||||
'# This is a test to check if “line-length” works nice\n'
|
||||
'with: “unicode characters” that span accross bytes! ↺\n',
|
||||
conf, problem1=(2, 53), problem2=(3, 53))
|
||||
'with: “unicode characters” that span across bytes! ↺\n',
|
||||
conf, problem1=(2, 52), problem2=(3, 52))
|
||||
|
||||
def test_with_dos_newlines(self):
|
||||
conf = ('line-length: {max: 10}\n'
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -14,6 +13,8 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from unittest import mock
|
||||
|
||||
from tests.common import RuleTestCase
|
||||
|
||||
|
||||
@@ -59,3 +60,37 @@ class NewLinesTestCase(RuleTestCase):
|
||||
self.check('\r\n', conf)
|
||||
self.check('---\ntext\n', conf, problem=(1, 4))
|
||||
self.check('---\r\ntext\r\n', conf)
|
||||
|
||||
def test_platform_type(self):
|
||||
conf = ('new-line-at-end-of-file: disable\n'
|
||||
'new-lines: {type: platform}\n')
|
||||
|
||||
self.check('', conf)
|
||||
|
||||
# mock the Linux new-line-character
|
||||
with mock.patch('yamllint.rules.new_lines.linesep', '\n'):
|
||||
self.check('\n', conf)
|
||||
self.check('\r\n', conf, problem=(1, 1))
|
||||
self.check('---\ntext\n', conf)
|
||||
self.check('---\r\ntext\r\n', conf, problem=(1, 4))
|
||||
self.check('---\r\ntext\n', conf, problem=(1, 4))
|
||||
# FIXME: the following tests currently don't work
|
||||
# because only the first line is checked for line-endings
|
||||
# see: issue #475
|
||||
# ---
|
||||
# self.check('---\ntext\r\nfoo\n', conf, problem=(2, 4))
|
||||
# self.check('---\ntext\r\n', conf, problem=(2, 4))
|
||||
|
||||
# mock the Windows new-line-character
|
||||
with mock.patch('yamllint.rules.new_lines.linesep', '\r\n'):
|
||||
self.check('\r\n', conf)
|
||||
self.check('\n', conf, problem=(1, 1))
|
||||
self.check('---\r\ntext\r\n', conf)
|
||||
self.check('---\ntext\n', conf, problem=(1, 4))
|
||||
self.check('---\ntext\r\n', conf, problem=(1, 4))
|
||||
# FIXME: the following tests currently don't work
|
||||
# because only the first line is checked for line-endings
|
||||
# see: issue #475
|
||||
# ---
|
||||
# self.check('---\r\ntext\nfoo\r\n', conf, problem=(2, 4))
|
||||
# self.check('---\r\ntext\n', conf, problem=(2, 4))
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -33,6 +32,7 @@ class OctalValuesTestCase(RuleTestCase):
|
||||
' forbid-explicit-octal: false\n'
|
||||
'new-line-at-end-of-file: disable\n'
|
||||
'document-start: disable\n')
|
||||
self.check('after-tag: !custom_tag 010', conf)
|
||||
self.check('user-city: 010', conf, problem=(1, 15))
|
||||
self.check('user-city: abc', conf)
|
||||
self.check('user-city: 010,0571', conf)
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2018 ClearScore
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -436,3 +435,21 @@ class QuotedTestCase(RuleTestCase):
|
||||
'- foo bar\n'
|
||||
'- "foo bar"\n',
|
||||
conf, problem1=(3, 3), problem2=(7, 3), problem3=(11, 3))
|
||||
|
||||
def test_octal_values(self):
|
||||
conf = 'quoted-strings: {required: true}\n'
|
||||
|
||||
self.check('---\n'
|
||||
'- 100\n'
|
||||
'- 0100\n'
|
||||
'- 0o100\n'
|
||||
'- 777\n'
|
||||
'- 0777\n'
|
||||
'- 0o777\n'
|
||||
'- 800\n'
|
||||
'- 0800\n'
|
||||
'- 0o800\n'
|
||||
'- "0800"\n'
|
||||
'- "0o800"\n',
|
||||
conf,
|
||||
problem1=(9, 3), problem2=(10, 3))
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Peter Ericson
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -14,10 +13,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
try:
|
||||
from cStringIO import StringIO
|
||||
except ImportError:
|
||||
from io import StringIO
|
||||
from io import StringIO
|
||||
import fcntl
|
||||
import locale
|
||||
import os
|
||||
@@ -27,7 +23,7 @@ import sys
|
||||
import tempfile
|
||||
import unittest
|
||||
|
||||
from tests.common import build_temp_workspace
|
||||
from tests.common import build_temp_workspace, temp_workspace
|
||||
|
||||
from yamllint import cli
|
||||
from yamllint import config
|
||||
@@ -62,7 +58,7 @@ def utf8_available():
|
||||
locale.setlocale(locale.LC_ALL, 'C.UTF-8')
|
||||
locale.setlocale(locale.LC_ALL, (None, None))
|
||||
return True
|
||||
except locale.Error:
|
||||
except locale.Error: # pragma: no cover
|
||||
return False
|
||||
|
||||
|
||||
@@ -246,19 +242,19 @@ class CommandLineTestCase(unittest.TestCase):
|
||||
cli.run(())
|
||||
self.assertNotEqual(ctx.returncode, 0)
|
||||
self.assertEqual(ctx.stdout, '')
|
||||
self.assertRegexpMatches(ctx.stderr, r'^usage')
|
||||
self.assertRegex(ctx.stderr, r'^usage')
|
||||
|
||||
with RunContext(self) as ctx:
|
||||
cli.run(('--unknown-arg', ))
|
||||
self.assertNotEqual(ctx.returncode, 0)
|
||||
self.assertEqual(ctx.stdout, '')
|
||||
self.assertRegexpMatches(ctx.stderr, r'^usage')
|
||||
self.assertRegex(ctx.stderr, r'^usage')
|
||||
|
||||
with RunContext(self) as ctx:
|
||||
cli.run(('-c', './conf.yaml', '-d', 'relaxed', 'file'))
|
||||
self.assertNotEqual(ctx.returncode, 0)
|
||||
self.assertEqual(ctx.stdout, '')
|
||||
self.assertRegexpMatches(
|
||||
self.assertRegex(
|
||||
ctx.stderr.splitlines()[-1],
|
||||
r'^yamllint: error: argument -d\/--config-data: '
|
||||
r'not allowed with argument -c\/--config-file$'
|
||||
@@ -269,21 +265,31 @@ class CommandLineTestCase(unittest.TestCase):
|
||||
cli.run(('-', 'file'))
|
||||
self.assertNotEqual(ctx.returncode, 0)
|
||||
self.assertEqual(ctx.stdout, '')
|
||||
self.assertRegexpMatches(ctx.stderr, r'^usage')
|
||||
self.assertRegex(ctx.stderr, r'^usage')
|
||||
|
||||
def test_run_with_bad_config(self):
|
||||
with RunContext(self) as ctx:
|
||||
cli.run(('-d', 'rules: {a: b}', 'file'))
|
||||
self.assertEqual(ctx.returncode, -1)
|
||||
self.assertEqual(ctx.stdout, '')
|
||||
self.assertRegexpMatches(ctx.stderr, r'^invalid config: no such rule')
|
||||
self.assertRegex(ctx.stderr, r'^invalid config: no such rule')
|
||||
|
||||
def test_run_with_empty_config(self):
|
||||
with RunContext(self) as ctx:
|
||||
cli.run(('-d', '', 'file'))
|
||||
self.assertEqual(ctx.returncode, -1)
|
||||
self.assertEqual(ctx.stdout, '')
|
||||
self.assertRegexpMatches(ctx.stderr, r'^invalid config: not a dict')
|
||||
self.assertRegex(ctx.stderr, r'^invalid config: not a dict')
|
||||
|
||||
def test_run_with_implicit_extends_config(self):
|
||||
path = os.path.join(self.wd, 'warn.yaml')
|
||||
|
||||
with RunContext(self) as ctx:
|
||||
cli.run(('-d', 'default', '-f', 'parsable', path))
|
||||
expected_out = ('%s:1:1: [warning] missing document start "---" '
|
||||
'(document-start)\n' % path)
|
||||
self.assertEqual(
|
||||
(ctx.returncode, ctx.stdout, ctx.stderr), (0, expected_out, ''))
|
||||
|
||||
def test_run_with_config_file(self):
|
||||
with open(os.path.join(self.wd, 'config'), 'w') as f:
|
||||
@@ -300,6 +306,7 @@ class CommandLineTestCase(unittest.TestCase):
|
||||
cli.run(('-c', f.name, os.path.join(self.wd, 'a.yaml')))
|
||||
self.assertEqual(ctx.returncode, 1)
|
||||
|
||||
@unittest.skipIf(os.environ.get('GITHUB_RUN_ID'), '$HOME not overridable')
|
||||
def test_run_with_user_global_config_file(self):
|
||||
home = os.path.join(self.wd, 'fake-home')
|
||||
dir = os.path.join(home, '.config', 'yamllint')
|
||||
@@ -323,6 +330,19 @@ class CommandLineTestCase(unittest.TestCase):
|
||||
cli.run((os.path.join(self.wd, 'a.yaml'), ))
|
||||
self.assertEqual(ctx.returncode, 1)
|
||||
|
||||
def test_run_with_user_xdg_config_home_in_env(self):
|
||||
self.addCleanup(os.environ.__delitem__, 'XDG_CONFIG_HOME')
|
||||
|
||||
with tempfile.TemporaryDirectory('w') as d:
|
||||
os.environ['XDG_CONFIG_HOME'] = d
|
||||
os.makedirs(os.path.join(d, 'yamllint'))
|
||||
with open(os.path.join(d, 'yamllint', 'config'), 'w') as f:
|
||||
f.write('extends: relaxed')
|
||||
with RunContext(self) as ctx:
|
||||
cli.run(('-f', 'parsable', os.path.join(self.wd, 'warn.yaml')))
|
||||
|
||||
self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr), (0, '', ''))
|
||||
|
||||
def test_run_with_user_yamllint_config_file_in_env(self):
|
||||
self.addCleanup(os.environ.__delitem__, 'YAMLLINT_CONFIG_FILE')
|
||||
|
||||
@@ -348,7 +368,7 @@ class CommandLineTestCase(unittest.TestCase):
|
||||
# as the first two runs don't use setlocale()
|
||||
try:
|
||||
locale.setlocale(locale.LC_ALL, 'en_US.UTF-8')
|
||||
except locale.Error:
|
||||
except locale.Error: # pragma: no cover
|
||||
self.skipTest('locale en_US.UTF-8 not available')
|
||||
locale.setlocale(locale.LC_ALL, (None, None))
|
||||
|
||||
@@ -386,7 +406,7 @@ class CommandLineTestCase(unittest.TestCase):
|
||||
with RunContext(self) as ctx:
|
||||
cli.run(('--version', ))
|
||||
self.assertEqual(ctx.returncode, 0)
|
||||
self.assertRegexpMatches(ctx.stdout + ctx.stderr, r'yamllint \d+\.\d+')
|
||||
self.assertRegex(ctx.stdout + ctx.stderr, r'yamllint \d+\.\d+')
|
||||
|
||||
def test_run_non_existing_file(self):
|
||||
path = os.path.join(self.wd, 'i-do-not-exist.yaml')
|
||||
@@ -395,7 +415,7 @@ class CommandLineTestCase(unittest.TestCase):
|
||||
cli.run(('-f', 'parsable', path))
|
||||
self.assertEqual(ctx.returncode, -1)
|
||||
self.assertEqual(ctx.stdout, '')
|
||||
self.assertRegexpMatches(ctx.stderr, r'No such file or directory')
|
||||
self.assertRegex(ctx.stderr, r'No such file or directory')
|
||||
|
||||
def test_run_one_problem_file(self):
|
||||
path = os.path.join(self.wd, 'a.yaml')
|
||||
@@ -549,17 +569,32 @@ class CommandLineTestCase(unittest.TestCase):
|
||||
self.assertEqual(
|
||||
(ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
|
||||
|
||||
def test_run_format_colored_warning(self):
|
||||
path = os.path.join(self.wd, 'warn.yaml')
|
||||
|
||||
with RunContext(self) as ctx:
|
||||
cli.run((path, '--format', 'colored'))
|
||||
expected_out = (
|
||||
'\033[4m%s\033[0m\n'
|
||||
' \033[2m1:1\033[0m \033[33mwarning\033[0m '
|
||||
'missing document start "---" \033[2m(document-start)\033[0m\n'
|
||||
'\n' % path)
|
||||
self.assertEqual(
|
||||
(ctx.returncode, ctx.stdout, ctx.stderr), (0, expected_out, ''))
|
||||
|
||||
def test_run_format_github(self):
|
||||
path = os.path.join(self.wd, 'a.yaml')
|
||||
|
||||
with RunContext(self) as ctx:
|
||||
cli.run((path, '--format', 'github'))
|
||||
expected_out = (
|
||||
'::error file=%s,line=2,col=4::[trailing-spaces] trailing'
|
||||
'::group::%s\n'
|
||||
'::error file=%s,line=2,col=4::2:4 [trailing-spaces] trailing'
|
||||
' spaces\n'
|
||||
'::error file=%s,line=3,col=4::[new-line-at-end-of-file] no'
|
||||
'::error file=%s,line=3,col=4::3:4 [new-line-at-end-of-file] no'
|
||||
' new line character at the end of file\n'
|
||||
% (path, path))
|
||||
'::endgroup::\n\n'
|
||||
% (path, path, path))
|
||||
self.assertEqual(
|
||||
(ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
|
||||
|
||||
@@ -573,11 +608,13 @@ class CommandLineTestCase(unittest.TestCase):
|
||||
os.environ['GITHUB_WORKFLOW'] = 'something'
|
||||
cli.run((path, ))
|
||||
expected_out = (
|
||||
'::error file=%s,line=2,col=4::[trailing-spaces] trailing'
|
||||
'::group::%s\n'
|
||||
'::error file=%s,line=2,col=4::2:4 [trailing-spaces] trailing'
|
||||
' spaces\n'
|
||||
'::error file=%s,line=3,col=4::[new-line-at-end-of-file] no'
|
||||
'::error file=%s,line=3,col=4::3:4 [new-line-at-end-of-file] no'
|
||||
' new line character at the end of file\n'
|
||||
% (path, path))
|
||||
'::endgroup::\n\n'
|
||||
% (path, path, path))
|
||||
self.assertEqual(
|
||||
(ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
|
||||
|
||||
@@ -640,3 +677,27 @@ class CommandLineTestCase(unittest.TestCase):
|
||||
'\n' % path)
|
||||
self.assertEqual(
|
||||
(ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
|
||||
|
||||
|
||||
class CommandLineConfigTestCase(unittest.TestCase):
|
||||
def test_config_file(self):
|
||||
workspace = {'a.yml': 'hello: world\n'}
|
||||
conf = ('---\n'
|
||||
'extends: relaxed\n')
|
||||
|
||||
for conf_file in ('.yamllint', '.yamllint.yml', '.yamllint.yaml'):
|
||||
with self.subTest(conf_file):
|
||||
with temp_workspace(workspace):
|
||||
with RunContext(self) as ctx:
|
||||
cli.run(('-f', 'parsable', '.'))
|
||||
|
||||
self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr),
|
||||
(0, './a.yml:1:1: [warning] missing document '
|
||||
'start "---" (document-start)\n', ''))
|
||||
|
||||
with temp_workspace({**workspace, **{conf_file: conf}}):
|
||||
with RunContext(self) as ctx:
|
||||
cli.run(('-f', 'parsable', '.'))
|
||||
|
||||
self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr),
|
||||
(0, '', ''))
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -14,10 +13,7 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
try:
|
||||
from cStringIO import StringIO
|
||||
except ImportError:
|
||||
from io import StringIO
|
||||
from io import StringIO
|
||||
import os
|
||||
import shutil
|
||||
import sys
|
||||
@@ -48,7 +44,7 @@ class SimpleConfigTestCase(unittest.TestCase):
|
||||
config.YamlLintConfig('not: valid: yaml')
|
||||
|
||||
def test_unknown_rule(self):
|
||||
with self.assertRaisesRegexp(
|
||||
with self.assertRaisesRegex(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: no such rule: "this-one-does-not-exist"'):
|
||||
config.YamlLintConfig('rules:\n'
|
||||
@@ -67,7 +63,7 @@ class SimpleConfigTestCase(unittest.TestCase):
|
||||
self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
|
||||
|
||||
def test_unknown_option(self):
|
||||
with self.assertRaisesRegexp(
|
||||
with self.assertRaisesRegex(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: unknown option "abcdef" for rule "colons"'):
|
||||
config.YamlLintConfig('rules:\n'
|
||||
@@ -105,7 +101,7 @@ class SimpleConfigTestCase(unittest.TestCase):
|
||||
self.assertEqual(c.rules['indentation']['check-multi-line-strings'],
|
||||
False)
|
||||
|
||||
with self.assertRaisesRegexp(
|
||||
with self.assertRaisesRegex(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: option "indent-sequences" of "indentation" '
|
||||
'should be in '):
|
||||
@@ -193,6 +189,41 @@ class SimpleConfigTestCase(unittest.TestCase):
|
||||
config.validate_rule_conf, Rule,
|
||||
{'multiple': ['item4']})
|
||||
|
||||
def test_invalid_rule(self):
|
||||
with self.assertRaisesRegex(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: rule "colons": should be either '
|
||||
'"enable", "disable" or a dict'):
|
||||
config.YamlLintConfig('rules:\n'
|
||||
' colons: invalid\n')
|
||||
|
||||
def test_invalid_ignore(self):
|
||||
with self.assertRaisesRegex(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: ignore should contain file patterns'):
|
||||
config.YamlLintConfig('ignore: yes\n')
|
||||
|
||||
def test_invalid_rule_ignore(self):
|
||||
with self.assertRaisesRegex(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: ignore should contain file patterns'):
|
||||
config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' ignore: yes\n')
|
||||
|
||||
def test_invalid_locale(self):
|
||||
with self.assertRaisesRegex(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: locale should be a string'):
|
||||
config.YamlLintConfig('locale: yes\n')
|
||||
|
||||
def test_invalid_yaml_files(self):
|
||||
with self.assertRaisesRegex(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: yaml-files should be a list of file '
|
||||
'patterns'):
|
||||
config.YamlLintConfig('yaml-files: yes\n')
|
||||
|
||||
|
||||
class ExtendedConfigTestCase(unittest.TestCase):
|
||||
def test_extend_on_object(self):
|
||||
@@ -337,6 +368,16 @@ class ExtendedConfigTestCase(unittest.TestCase):
|
||||
self.assertEqual(c.rules['colons']['max-spaces-before'], 0)
|
||||
self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
|
||||
|
||||
def test_extended_ignore(self):
|
||||
with tempfile.NamedTemporaryFile('w') as f:
|
||||
f.write('ignore: |\n'
|
||||
' *.template.yaml\n')
|
||||
f.flush()
|
||||
c = config.YamlLintConfig('extends: ' + f.name + '\n')
|
||||
|
||||
self.assertEqual(c.ignore.match_file('test.template.yaml'), True)
|
||||
self.assertEqual(c.ignore.match_file('test.yaml'), False)
|
||||
|
||||
|
||||
class ExtendedLibraryConfigTestCase(unittest.TestCase):
|
||||
def test_extend_config_disable_rule(self):
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -55,3 +54,13 @@ class LinterTestCase(unittest.TestCase):
|
||||
u'# الأَبْجَدِيَّة العَرَبِيَّة\n')
|
||||
linter.run(s, self.fake_config())
|
||||
linter.run(s.encode('utf-8'), self.fake_config())
|
||||
|
||||
def test_linter_problem_repr_without_rule(self):
|
||||
problem = linter.LintProblem(1, 2, 'problem')
|
||||
|
||||
self.assertEqual(str(problem), '1:2: problem')
|
||||
|
||||
def test_linter_problem_repr_with_rule(self):
|
||||
problem = linter.LintProblem(1, 2, 'problem', 'rule-id')
|
||||
|
||||
self.assertEqual(str(problem), '1:2: problem (rule-id)')
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2017 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -47,16 +46,15 @@ class ModuleTestCase(unittest.TestCase):
|
||||
subprocess.check_output([PYTHON, '-m', 'yamllint'],
|
||||
stderr=subprocess.STDOUT)
|
||||
self.assertEqual(ctx.exception.returncode, 2)
|
||||
self.assertRegexpMatches(ctx.exception.output.decode(),
|
||||
r'^usage: yamllint')
|
||||
self.assertRegex(ctx.exception.output.decode(), r'^usage: yamllint')
|
||||
|
||||
def test_run_module_on_bad_dir(self):
|
||||
with self.assertRaises(subprocess.CalledProcessError) as ctx:
|
||||
subprocess.check_output([PYTHON, '-m', 'yamllint',
|
||||
'/does/not/exist'],
|
||||
stderr=subprocess.STDOUT)
|
||||
self.assertRegexpMatches(ctx.exception.output.decode(),
|
||||
r'No such file or directory')
|
||||
self.assertRegex(ctx.exception.output.decode(),
|
||||
r'No such file or directory')
|
||||
|
||||
def test_run_module_on_file(self):
|
||||
out = subprocess.check_output(
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -22,10 +21,10 @@ indentation, etc."""
|
||||
|
||||
|
||||
APP_NAME = 'yamllint'
|
||||
APP_VERSION = '1.25.0'
|
||||
APP_VERSION = '1.27.0'
|
||||
APP_DESCRIPTION = __doc__
|
||||
|
||||
__author__ = u'Adrien Vergé'
|
||||
__copyright__ = u'Copyright 2016, Adrien Vergé'
|
||||
__copyright__ = u'Copyright 2022, Adrien Vergé'
|
||||
__license__ = 'GPLv3'
|
||||
__version__ = APP_VERSION
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -93,6 +92,10 @@ class Format(object):
|
||||
line += 'line=' + format(problem.line) + ','
|
||||
line += 'col=' + format(problem.column)
|
||||
line += '::'
|
||||
line += format(problem.line)
|
||||
line += ':'
|
||||
line += format(problem.column)
|
||||
line += ' '
|
||||
if problem.rule:
|
||||
line += '[' + problem.rule + '] '
|
||||
line += problem.desc
|
||||
@@ -103,18 +106,25 @@ def show_problems(problems, file, args_format, no_warn):
|
||||
max_level = 0
|
||||
first = True
|
||||
|
||||
if args_format == 'auto':
|
||||
if ('GITHUB_ACTIONS' in os.environ and
|
||||
'GITHUB_WORKFLOW' in os.environ):
|
||||
args_format = 'github'
|
||||
elif supports_color():
|
||||
args_format = 'colored'
|
||||
|
||||
for problem in problems:
|
||||
max_level = max(max_level, PROBLEM_LEVELS[problem.level])
|
||||
if no_warn and (problem.level != 'error'):
|
||||
continue
|
||||
if args_format == 'parsable':
|
||||
print(Format.parsable(problem, file))
|
||||
elif args_format == 'github' or (args_format == 'auto' and
|
||||
'GITHUB_ACTIONS' in os.environ and
|
||||
'GITHUB_WORKFLOW' in os.environ):
|
||||
elif args_format == 'github':
|
||||
if first:
|
||||
print('::group::%s' % file)
|
||||
first = False
|
||||
print(Format.github(problem, file))
|
||||
elif args_format == 'colored' or \
|
||||
(args_format == 'auto' and supports_color()):
|
||||
elif args_format == 'colored':
|
||||
if first:
|
||||
print('\033[4m%s\033[0m' % file)
|
||||
first = False
|
||||
@@ -125,6 +135,9 @@ def show_problems(problems, file, args_format, no_warn):
|
||||
first = False
|
||||
print(Format.standard(problem, file))
|
||||
|
||||
if not first and args_format == 'github':
|
||||
print('::endgroup::')
|
||||
|
||||
if not first and args_format != 'parsable':
|
||||
print('')
|
||||
|
||||
|
||||
@@ -19,6 +19,7 @@ rules:
|
||||
level: warning
|
||||
empty-lines: enable
|
||||
empty-values: disable
|
||||
float-values: disable
|
||||
hyphens: enable
|
||||
indentation: enable
|
||||
key-duplicates: enable
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -81,10 +80,7 @@ def get_cosmetic_problems(buffer, conf, filepath):
|
||||
self.all_rules = {r.ID for r in rules}
|
||||
|
||||
def process_comment(self, comment):
|
||||
try:
|
||||
comment = str(comment)
|
||||
except UnicodeError:
|
||||
return # this certainly wasn't a yamllint directive comment
|
||||
comment = str(comment)
|
||||
|
||||
if re.match(r'^# yamllint disable( rule:\S+)*\s*$', comment):
|
||||
items = comment[18:].rstrip().split(' ')
|
||||
@@ -110,10 +106,7 @@ def get_cosmetic_problems(buffer, conf, filepath):
|
||||
|
||||
class DisableLineDirective(DisableDirective):
|
||||
def process_comment(self, comment):
|
||||
try:
|
||||
comment = str(comment)
|
||||
except UnicodeError:
|
||||
return # this certainly wasn't a yamllint directive comment
|
||||
comment = str(comment)
|
||||
|
||||
if re.match(r'^# yamllint disable-line( rule:\S+)*\s*$', comment):
|
||||
items = comment[23:].rstrip().split(' ')
|
||||
@@ -206,15 +199,11 @@ def _run(buffer, conf, filepath):
|
||||
syntax_error.column <= problem.column):
|
||||
yield syntax_error
|
||||
|
||||
# If there is already a yamllint error at the same place, discard
|
||||
# it as it is probably redundant (and maybe it's just a 'warning',
|
||||
# Discard the problem since it is at the same place as the syntax
|
||||
# error and is probably redundant (and maybe it's just a 'warning',
|
||||
# in which case the script won't even exit with a failure status).
|
||||
if (syntax_error.line == problem.line and
|
||||
syntax_error.column == problem.column):
|
||||
syntax_error = None
|
||||
continue
|
||||
|
||||
syntax_error = None
|
||||
continue
|
||||
|
||||
yield problem
|
||||
|
||||
@@ -233,7 +222,7 @@ def run(input, conf, filepath=None):
|
||||
if conf.is_file_ignored(filepath):
|
||||
return ()
|
||||
|
||||
if isinstance(input, (type(b''), type(u''))): # compat with Python 2 & 3
|
||||
if isinstance(input, (bytes, str)):
|
||||
return _run(input, conf, filepath)
|
||||
elif hasattr(input, 'read'): # Python 2's file or Python 3's io.IOBase
|
||||
# We need to have everything in memory to parse correctly
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -33,6 +32,7 @@ from yamllint.rules import (
|
||||
new_line_at_end_of_file,
|
||||
new_lines,
|
||||
octal_values,
|
||||
float_values,
|
||||
quoted_strings,
|
||||
trailing_spaces,
|
||||
truthy,
|
||||
@@ -49,6 +49,7 @@ _RULES = {
|
||||
document_start.ID: document_start,
|
||||
empty_lines.ID: empty_lines,
|
||||
empty_values.ID: empty_values,
|
||||
float_values.ID: float_values,
|
||||
hyphens.ID: hyphens,
|
||||
indentation.ID: indentation,
|
||||
key_duplicates.ID: key_duplicates,
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -22,7 +21,8 @@ braces (``{`` and ``}``).
|
||||
|
||||
* ``forbid`` is used to forbid the use of flow mappings which are denoted by
|
||||
surrounding braces (``{`` and ``}``). Use ``true`` to forbid the use of flow
|
||||
mappings completely.
|
||||
mappings completely. Use ``non-empty`` to forbid the use of all flow
|
||||
mappings except for empty ones.
|
||||
* ``min-spaces-inside`` defines the minimal number of spaces required inside
|
||||
braces.
|
||||
* ``max-spaces-inside`` defines the maximal number of spaces allowed inside
|
||||
@@ -60,6 +60,18 @@ braces (``{`` and ``}``).
|
||||
|
||||
object: { key1: 4, key2: 8 }
|
||||
|
||||
#. With ``braces: {forbid: non-empty}``
|
||||
|
||||
the following code snippet would **PASS**:
|
||||
::
|
||||
|
||||
object: {}
|
||||
|
||||
the following code snippet would **FAIL**:
|
||||
::
|
||||
|
||||
object: { key1: 4, key2: 8 }
|
||||
|
||||
#. With ``braces: {min-spaces-inside: 0, max-spaces-inside: 0}``
|
||||
|
||||
the following code snippet would **PASS**:
|
||||
@@ -128,7 +140,7 @@ from yamllint.rules.common import spaces_after, spaces_before
|
||||
|
||||
ID = 'braces'
|
||||
TYPE = 'token'
|
||||
CONF = {'forbid': bool,
|
||||
CONF = {'forbid': (bool, 'non-empty'),
|
||||
'min-spaces-inside': int,
|
||||
'max-spaces-inside': int,
|
||||
'min-spaces-inside-empty': int,
|
||||
@@ -141,7 +153,15 @@ DEFAULT = {'forbid': False,
|
||||
|
||||
|
||||
def check(conf, token, prev, next, nextnext, context):
|
||||
if conf['forbid'] and isinstance(token, yaml.FlowMappingStartToken):
|
||||
if (conf['forbid'] is True and
|
||||
isinstance(token, yaml.FlowMappingStartToken)):
|
||||
yield LintProblem(token.start_mark.line + 1,
|
||||
token.end_mark.column + 1,
|
||||
'forbidden flow mapping')
|
||||
|
||||
elif (conf['forbid'] == 'non-empty' and
|
||||
isinstance(token, yaml.FlowMappingStartToken) and
|
||||
not isinstance(next, yaml.FlowMappingEndToken)):
|
||||
yield LintProblem(token.start_mark.line + 1,
|
||||
token.end_mark.column + 1,
|
||||
'forbidden flow mapping')
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -22,7 +21,8 @@ inside brackets (``[`` and ``]``).
|
||||
|
||||
* ``forbid`` is used to forbid the use of flow sequences which are denoted by
|
||||
surrounding brackets (``[`` and ``]``). Use ``true`` to forbid the use of
|
||||
flow sequences completely.
|
||||
flow sequences completely. Use ``non-empty`` to forbid the use of all flow
|
||||
sequences except for empty ones.
|
||||
* ``min-spaces-inside`` defines the minimal number of spaces required inside
|
||||
brackets.
|
||||
* ``max-spaces-inside`` defines the maximal number of spaces allowed inside
|
||||
@@ -61,6 +61,18 @@ inside brackets (``[`` and ``]``).
|
||||
|
||||
object: [ 1, 2, abc ]
|
||||
|
||||
#. With ``brackets: {forbid: non-empty}``
|
||||
|
||||
the following code snippet would **PASS**:
|
||||
::
|
||||
|
||||
object: []
|
||||
|
||||
the following code snippet would **FAIL**:
|
||||
::
|
||||
|
||||
object: [ 1, 2, abc ]
|
||||
|
||||
#. With ``brackets: {min-spaces-inside: 0, max-spaces-inside: 0}``
|
||||
|
||||
the following code snippet would **PASS**:
|
||||
@@ -129,7 +141,7 @@ from yamllint.rules.common import spaces_after, spaces_before
|
||||
|
||||
ID = 'brackets'
|
||||
TYPE = 'token'
|
||||
CONF = {'forbid': bool,
|
||||
CONF = {'forbid': (bool, 'non-empty'),
|
||||
'min-spaces-inside': int,
|
||||
'max-spaces-inside': int,
|
||||
'min-spaces-inside-empty': int,
|
||||
@@ -142,7 +154,15 @@ DEFAULT = {'forbid': False,
|
||||
|
||||
|
||||
def check(conf, token, prev, next, nextnext, context):
|
||||
if conf['forbid'] and isinstance(token, yaml.FlowSequenceStartToken):
|
||||
if (conf['forbid'] is True and
|
||||
isinstance(token, yaml.FlowSequenceStartToken)):
|
||||
yield LintProblem(token.start_mark.line + 1,
|
||||
token.end_mark.column + 1,
|
||||
'forbidden flow sequence')
|
||||
|
||||
elif (conf['forbid'] == 'non-empty' and
|
||||
isinstance(token, yaml.FlowSequenceStartToken) and
|
||||
not isinstance(next, yaml.FlowSequenceEndToken)):
|
||||
yield LintProblem(token.start_mark.line + 1,
|
||||
token.end_mark.column + 1,
|
||||
'forbidden flow sequence')
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -74,8 +73,6 @@ Use this rule to control the position and formatting of comments.
|
||||
"""
|
||||
|
||||
|
||||
import re
|
||||
|
||||
from yamllint.linter import LintProblem
|
||||
|
||||
|
||||
@@ -105,7 +102,7 @@ def check(conf, comment):
|
||||
if (conf['ignore-shebangs'] and
|
||||
comment.line_no == 1 and
|
||||
comment.column_no == 1 and
|
||||
re.match(r'^!\S', comment.buffer[text_start:])):
|
||||
comment.buffer[text_start] == '!'):
|
||||
return
|
||||
# We can test for both \r and \r\n just by checking first char
|
||||
# \r itself is a valid newline on some older OS.
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2017 Greg Dubicki
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
158
yamllint/rules/float_values.py
Normal file
158
yamllint/rules/float_values.py
Normal file
@@ -0,0 +1,158 @@
|
||||
# Copyright (C) 2022 the yamllint contributors
|
||||
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
"""
|
||||
Use this rule to limit the permitted values for floating-point numbers.
|
||||
YAML permits three classes of float expressions: approximation to real numbers,
|
||||
positive and negative infinity and "not a number".
|
||||
|
||||
.. rubric:: Options
|
||||
|
||||
* Use ``require-numeral-before-decimal`` to require floats to start
|
||||
with a numeral (ex ``0.0`` instead of ``.0``).
|
||||
* Use ``forbid-scientific-notation`` to forbid scientific notation.
|
||||
* Use ``forbid-nan`` to forbid NaN (not a number) values.
|
||||
* Use ``forbid-inf`` to forbid infinite values.
|
||||
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
rules:
|
||||
float-values:
|
||||
forbid-inf: false
|
||||
forbid-nan: false
|
||||
forbid-scientific-notation: false
|
||||
require-numeral-before-decimal: false
|
||||
|
||||
.. rubric:: Examples
|
||||
|
||||
#. With ``float-values: {require-numeral-before-decimal: true}``
|
||||
|
||||
the following code snippets would **PASS**:
|
||||
::
|
||||
|
||||
anemometer:
|
||||
angle: 0.0
|
||||
|
||||
the following code snippets would **FAIL**:
|
||||
::
|
||||
|
||||
anemometer:
|
||||
angle: .0
|
||||
|
||||
#. With ``float-values: {forbid-scientific-notation: true}``
|
||||
|
||||
the following code snippets would **PASS**:
|
||||
::
|
||||
|
||||
anemometer:
|
||||
angle: 0.00001
|
||||
|
||||
the following code snippets would **FAIL**:
|
||||
::
|
||||
|
||||
anemometer:
|
||||
angle: 10e-6
|
||||
|
||||
#. With ``float-values: {forbid-nan: true}``
|
||||
|
||||
the following code snippets would **FAIL**:
|
||||
::
|
||||
|
||||
anemometer:
|
||||
angle: .NaN
|
||||
|
||||
#. With ``float-values: {forbid-inf: true}``
|
||||
|
||||
the following code snippets would **FAIL**:
|
||||
::
|
||||
|
||||
anemometer:
|
||||
angle: .inf
|
||||
"""
|
||||
|
||||
import re
|
||||
|
||||
import yaml
|
||||
|
||||
from yamllint.linter import LintProblem
|
||||
|
||||
|
||||
ID = 'float-values'
|
||||
TYPE = 'token'
|
||||
CONF = {
|
||||
'require-numeral-before-decimal': bool,
|
||||
'forbid-scientific-notation': bool,
|
||||
'forbid-nan': bool,
|
||||
'forbid-inf': bool,
|
||||
}
|
||||
DEFAULT = {
|
||||
'require-numeral-before-decimal': False,
|
||||
'forbid-scientific-notation': False,
|
||||
'forbid-nan': False,
|
||||
'forbid-inf': False,
|
||||
}
|
||||
|
||||
IS_NUMERAL_BEFORE_DECIMAL_PATTERN = (
|
||||
re.compile('[-+]?(\\.[0-9]+)([eE][-+]?[0-9]+)?')
|
||||
)
|
||||
IS_SCIENTIFIC_NOTATION_PATTERN = re.compile(
|
||||
'[-+]?(\\.[0-9]+|[0-9]+(\\.[0-9]*)?)([eE][-+]?[0-9]+)'
|
||||
)
|
||||
IS_INF_PATTERN = re.compile('[-+]?(\\.inf|\\.Inf|\\.INF)')
|
||||
IS_NAN_PATTERN = re.compile('\\.nan|\\.NaN|\\.NAN')
|
||||
|
||||
|
||||
def check(conf, token, prev, next, nextnext, context):
|
||||
if prev and isinstance(prev, yaml.tokens.TagToken):
|
||||
return
|
||||
if not isinstance(token, yaml.tokens.ScalarToken):
|
||||
return
|
||||
if token.style:
|
||||
return
|
||||
val = token.value
|
||||
|
||||
if conf['forbid-nan'] and IS_NAN_PATTERN.match(val):
|
||||
yield LintProblem(
|
||||
token.start_mark.line + 1,
|
||||
token.start_mark.column + 1,
|
||||
f'forbidden not a number value "{token.value}"',
|
||||
)
|
||||
|
||||
if conf['forbid-inf'] and IS_INF_PATTERN.match(val):
|
||||
yield LintProblem(
|
||||
token.start_mark.line + 1,
|
||||
token.start_mark.column + 1,
|
||||
f'forbidden infinite value "{token.value}"',
|
||||
)
|
||||
|
||||
if conf[
|
||||
'forbid-scientific-notation'
|
||||
] and IS_SCIENTIFIC_NOTATION_PATTERN.match(val):
|
||||
yield LintProblem(
|
||||
token.start_mark.line + 1,
|
||||
token.start_mark.column + 1,
|
||||
f'forbidden scientific notation "{token.value}"',
|
||||
)
|
||||
|
||||
if conf[
|
||||
'require-numeral-before-decimal'
|
||||
] and IS_NUMERAL_BEFORE_DECIMAL_PATTERN.match(val):
|
||||
yield LintProblem(
|
||||
token.start_mark.line + 1,
|
||||
token.start_mark.column + 1,
|
||||
f'forbidden decimal missing 0 prefix "{token.value}"',
|
||||
)
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -84,7 +83,8 @@ def check(conf, token, prev, next, nextnext, context):
|
||||
elif isinstance(token, (yaml.BlockEndToken,
|
||||
yaml.FlowMappingEndToken,
|
||||
yaml.FlowSequenceEndToken)):
|
||||
context['stack'].pop()
|
||||
if len(context['stack']) > 0:
|
||||
context['stack'].pop()
|
||||
elif (isinstance(token, yaml.KeyToken) and
|
||||
isinstance(next, yaml.ScalarToken)):
|
||||
# This check is done because KeyTokens can be found inside flow
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2017 Johannes F. Knauf
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -18,8 +17,8 @@
|
||||
Use this rule to enforce alphabetical ordering of keys in mappings. The sorting
|
||||
order uses the Unicode code point number as a default. As a result, the
|
||||
ordering is case-sensitive and not accent-friendly (see examples below).
|
||||
This can be changed by setting the global ``locale`` option. This allows to
|
||||
sort case and accents properly.
|
||||
This can be changed by setting the global ``locale`` option. This allows one
|
||||
to sort case and accents properly.
|
||||
|
||||
.. rubric:: Examples
|
||||
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -17,10 +16,6 @@
|
||||
"""
|
||||
Use this rule to set a limit to lines length.
|
||||
|
||||
Note: with Python 2, the ``line-length`` rule may not work properly with
|
||||
unicode characters because of the way strings are represented in bytes. We
|
||||
recommend running yamllint with Python 3.
|
||||
|
||||
.. rubric:: Options
|
||||
|
||||
* ``max`` defines the maximal (inclusive) length of lines.
|
||||
@@ -144,7 +139,11 @@ def check(conf, line):
|
||||
start += 1
|
||||
|
||||
if start != line.end:
|
||||
if line.buffer[start] in ('#', '-'):
|
||||
if line.buffer[start] == '#':
|
||||
while line.buffer[start] == '#':
|
||||
start += 1
|
||||
start += 1
|
||||
elif line.buffer[start] == '-':
|
||||
start += 2
|
||||
|
||||
if line.buffer.find(' ', start, line.end) == -1:
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -19,8 +18,11 @@ Use this rule to force the type of new line characters.
|
||||
|
||||
.. rubric:: Options
|
||||
|
||||
* Set ``type`` to ``unix`` to use UNIX-typed new line characters (``\\n``), or
|
||||
``dos`` to use DOS-typed new line characters (``\\r\\n``).
|
||||
* Set ``type`` to ``unix`` to enforce UNIX-typed new line characters (``\\n``),
|
||||
set ``type`` to ``dos`` to enforce DOS-typed new line characters
|
||||
(``\\r\\n``), or set ``type`` to ``platform`` to infer the type from the
|
||||
system running yamllint (``\\n`` on POSIX / UNIX / Linux / Mac OS systems or
|
||||
``\\r\\n`` on DOS / Windows systems).
|
||||
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
@@ -31,24 +33,27 @@ Use this rule to force the type of new line characters.
|
||||
type: unix
|
||||
"""
|
||||
|
||||
from os import linesep
|
||||
|
||||
from yamllint.linter import LintProblem
|
||||
|
||||
|
||||
ID = 'new-lines'
|
||||
TYPE = 'line'
|
||||
CONF = {'type': ('unix', 'dos')}
|
||||
CONF = {'type': ('unix', 'dos', 'platform')}
|
||||
DEFAULT = {'type': 'unix'}
|
||||
|
||||
|
||||
def check(conf, line):
|
||||
if conf['type'] == 'unix':
|
||||
newline_char = '\n'
|
||||
elif conf['type'] == 'platform':
|
||||
newline_char = linesep
|
||||
elif conf['type'] == 'dos':
|
||||
newline_char = '\r\n'
|
||||
|
||||
if line.start == 0 and len(line.buffer) > line.end:
|
||||
if conf['type'] == 'dos':
|
||||
if (line.end + 2 > len(line.buffer) or
|
||||
line.buffer[line.end:line.end + 2] != '\r\n'):
|
||||
yield LintProblem(1, line.end - line.start + 1,
|
||||
'wrong new line character: expected \\r\\n')
|
||||
else:
|
||||
if line.buffer[line.end] == '\r':
|
||||
yield LintProblem(1, line.end - line.start + 1,
|
||||
'wrong new line character: expected \\n')
|
||||
if line.buffer[line.end:line.end + len(newline_char)] != newline_char:
|
||||
yield LintProblem(1, line.end - line.start + 1,
|
||||
'wrong new line character: expected {}'
|
||||
.format(repr(newline_char).strip('\'')))
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2017 ScienJus
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -85,9 +84,7 @@ CONF = {'forbid-implicit-octal': bool,
|
||||
DEFAULT = {'forbid-implicit-octal': True,
|
||||
'forbid-explicit-octal': True}
|
||||
|
||||
|
||||
def _is_octal_number(string):
|
||||
return re.match(r'^[0-7]+$', string) is not None
|
||||
IS_OCTAL_NUMBER_PATTERN = re.compile(r'^[0-7]+$')
|
||||
|
||||
|
||||
def check(conf, token, prev, next, nextnext, context):
|
||||
@@ -99,7 +96,7 @@ def check(conf, token, prev, next, nextnext, context):
|
||||
if not token.style:
|
||||
val = token.value
|
||||
if (val.isdigit() and len(val) > 1 and val[0] == '0' and
|
||||
_is_octal_number(val[1:])):
|
||||
IS_OCTAL_NUMBER_PATTERN.match(val[1:]) is not None):
|
||||
yield LintProblem(
|
||||
token.start_mark.line + 1, token.end_mark.column + 1,
|
||||
'forbidden implicit octal value "%s"' %
|
||||
@@ -110,7 +107,7 @@ def check(conf, token, prev, next, nextnext, context):
|
||||
if not token.style:
|
||||
val = token.value
|
||||
if (len(val) > 2 and val[:2] == '0o' and
|
||||
_is_octal_number(val[2:])):
|
||||
IS_OCTAL_NUMBER_PATTERN.match(val[2:]) is not None):
|
||||
yield LintProblem(
|
||||
token.start_mark.line + 1, token.end_mark.column + 1,
|
||||
'forbidden explicit octal value "%s"' %
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2018 ClearScore
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
@@ -144,6 +143,17 @@ def VALIDATE(conf):
|
||||
|
||||
DEFAULT_SCALAR_TAG = u'tag:yaml.org,2002:str'
|
||||
|
||||
# https://stackoverflow.com/a/36514274
|
||||
yaml.resolver.Resolver.add_implicit_resolver(
|
||||
'tag:yaml.org,2002:int',
|
||||
re.compile(r'''^(?:[-+]?0b[0-1_]+
|
||||
|[-+]?0o?[0-7_]+
|
||||
|[-+]?0[0-7_]+
|
||||
|[-+]?(?:0|[1-9][0-9_]*)
|
||||
|[-+]?0x[0-9a-fA-F_]+
|
||||
|[-+]?[1-9][0-9_]*(?::[0-5]?[0-9])+)$''', re.X),
|
||||
list('-+0123456789'))
|
||||
|
||||
|
||||
def _quote_match(quote_type, token_style):
|
||||
return ((quote_type == 'any') or
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Adrien Vergé
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 Peter Ericson
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
|
||||
Reference in New Issue
Block a user