WIP - test by Adrien

Add a section into the doc about how to develop rules' plugins.

.github/workflows/ci.yaml

@@ -1,55 +0,0 @@
----
-
-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

.travis.yml

@@ -0,0 +1,28 @@
+---
+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

CHANGELOG.rst

@@ -1,57 +1,11 @@
 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 documentation with default values to rules with options
+- Improve documentationon 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``

CONTRIBUTING.rst

@@ -42,7 +42,5 @@ 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.

README.rst

@@ -19,7 +19,11 @@ indentation, etc.
    :target: https://yamllint.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation status
 
-Written in Python (compatible with Python 3 only).
+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.
 
 Documentation
 -------------
@@ -74,7 +78,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
 ^^^^^^^^
@@ -132,7 +136,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
 -------

docs/conf.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # yamllint documentation build configuration file, created by
 # sphinx-quickstart on Thu Jan 21 21:18:52 2016.
 
@@ -20,7 +21,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 project = APP_NAME
-copyright = __copyright__.lstrip('Copyright ')
+copyright = __copyright__
 
 version = APP_VERSION
 release = APP_VERSION
@@ -38,7 +39,7 @@ htmlhelp_basename = 'yamllintdoc'
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'yamllint', 'Linter for YAML files', [u'Adrien Vergé'], 1)
+    ('index', 'yamllint', '', [u'Adrien Vergé'], 1)
 ]
 
 # -- Build with sphinx automodule without needing to install third-party libs

docs/configuration.rst

@@ -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):
 
-- a file named ``.yamllint``, ``.yamllint.yaml``, or ``.yamllint.yml`` in the
+- ``.yamllint``, ``.yamllint.yaml`` or ``.yamllint.yml`` in the current working
-  current working directory
+  directory
-- a filename referenced by ``$YAMLLINT_CONFIG_FILE``, if set
+- the file referenced by ``$YAMLLINT_CONFIG_FILE``, if set
-- a file named ``$XDG_CONFIG_HOME/yamllint/config`` or
+- ``$XDG_CONFIG_HOME/yamllint/config``
-  ``~/.config/yamllint/config``, if present
+- ``~/.config/yamllint/config``
 
 Finally if no config file is found, the default configuration is applied.
 

docs/development.rst

@@ -16,3 +16,47 @@ Basic example of running the linter from Python:
 
 .. automodule:: yamllint.linter
    :members:
+
+Develop rule plugins
+---------------------
+
+yamllint provides a plugin mechanism using setuptools (pkg_resources) to allow
+adding custom rules. So, you can extend yamllint and add rules with your own
+custom yamllint rule plugins if you developed them.
+
+Yamllint rule plugins must satisfy the followings.
+
+#. It must be a Python package installable using pip and distributed under
+   GPLv3+ same as yamllint.
+#. It must contains the entry point configuration in ``setup.cfg`` or something
+   similar packaging configuration files, to make it installed and working as a
+   yamllint plugin like below. (``<plugin_name>`` is that plugin name and
+   ``<plugin_src_dir>`` is a dir where the rule modules exist.)
+   ::
+
+     [options.entry_points]
+     yamllint.plugins.rules =
+          <plugin_name> = <plugin_src_dir>
+
+#. It must contain custom yamllint rule modules:
+
+   - Each rule module must define a couple of global variables, ID and TYPE. ID
+     must not conflicts with other rules' ID.
+   - Each rule module must define a function named 'check' to test input data
+     complies with the rule.
+   - Each rule module may have other global variables.
+
+     - CONF to define its configuration parameters and those types.
+     - DEFAULT to provide default values for each configuration parameters.
+
+#. It must define a global variable RULES_MAP to provide mappings of rule ID
+   and rule modules to yamllint like this.
+   ::
+
+     RULES_MAP = {
+         # rule ID: rule module
+         a_custom_rule.ID: a_custom_rule
+     }
+
+To develop yamllint rules, the default rules themselves in yamllint may become
+good references.

docs/integration.rst

@@ -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
+Actions<https://github.com/features/actions>` and automatically uses the suited
-output format to decorate code with linting errors. You can also force the
+output format to decorate code with linting errors automatically. You can also
-GitHub Actions output with ``yamllint --format github``.
+force the GitHub Actions output with ``yamllint --format github``.
 
 An example workflow using GitHub Actions:
 
@@ -51,22 +51,3 @@ 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)$)"
-      }
-    }
-  }

docs/rules.rst

@@ -64,12 +64,6 @@ empty-values
 
 .. automodule:: yamllint.rules.empty_values
 
-float-values
-------------
-
-.. automodule:: yamllint.rules.float_values
-
-
 hyphens
 -------
 

docs/text_editors.rst

@@ -33,16 +33,6 @@ 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
 ------------------
 

setup.cfg

@@ -26,12 +26,14 @@ 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
@@ -46,7 +48,7 @@ project_urls =
 [options]
 packages = find:
 
-python_requires = >=3.6
+python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
 
 include_package_data = True
 install_requires =
@@ -67,6 +69,3 @@ yamllint = conf/*.yaml
 [options.entry_points]
 console_scripts =
   yamllint = yamllint.cli:run
-
-[coverage:run]
-relative_files = True

setup.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/__init__.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/common.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -13,9 +14,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/>.
 
-import contextlib
 import os
-import shutil
 import tempfile
 import unittest
 
@@ -70,17 +69,3 @@ 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)

tests/plugins/example/__init__.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2020 Satoru SATOH
+#
+# 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/>.
+
+"""yamllint plugin entry point
+"""
+from __future__ import absolute_import
+
+from . import override_comments
+
+
+RULES_MAP = {
+    override_comments.ID: override_comments
+}

tests/plugins/example/override_comments.py

@@ -0,0 +1,63 @@
+#
+# Copyright (C) 2020 Satoru SATOH
+#
+# 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 override some comments' rules.
+
+.. rubric:: Options
+
+* Use ``forbid`` to control comments. Set to ``true`` to forbid comments
+  completely.
+
+.. rubric:: Examples
+
+#. With ``override-comments: {forbid: true}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    foo: 1
+
+   the following code snippet would **FAIL**:
+   ::
+
+    # baz
+    foo: 1
+
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+rules:
+  override-comments:
+    forbid: False
+
+"""
+from yamllint.linter import LintProblem
+
+
+ID = 'override-comments'
+TYPE = 'comment'
+CONF = {'forbid': bool}
+DEFAULT = {'forbid': False}
+
+
+def check(conf, comment):
+    """Check if comments are found.
+    """
+    if conf['forbid']:
+        yield LintProblem(comment.line_no, comment.column_no,
+                          'forbidden comment')

tests/plugins/yamllint_plugin_example/setup.cfg

@@ -0,0 +1,11 @@
+[metadata]
+name = yamllint_plugin_example
+version = 1.0.0
+
+[options]
+packages = find:
+install_requires = yamllint
+
+[options.entry_points]
+yamllint.plugins.rules =
+    example = yamllint_plugin_example

tests/plugins/yamllint_plugin_example/setup.py

@@ -0,0 +1,2 @@
+import setuptools
+setuptools.setup()

tests/plugins/yamllint_plugin_example/yamllint_plugin_example/__init__.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2020 Satoru SATOH
+#
+# 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/>.
+
+"""yamllint plugin entry point
+"""
+from __future__ import absolute_import
+
+from . import override_comments, random_failure
+
+
+RULES_MAP = {
+    override_comments.ID: override_comments,
+    random_failure.ID: random_failure,
+}

tests/plugins/yamllint_plugin_example/yamllint_plugin_example/override_comments.py

@@ -0,0 +1,63 @@
+#
+# Copyright (C) 2020 Satoru SATOH
+#
+# 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 override some comments' rules.
+
+.. rubric:: Options
+
+* Use ``forbid`` to control comments. Set to ``true`` to forbid comments
+  completely.
+
+.. rubric:: Examples
+
+#. With ``override-comments: {forbid: true}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    foo: 1
+
+   the following code snippet would **FAIL**:
+   ::
+
+    # baz
+    foo: 1
+
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+rules:
+  override-comments:
+    forbid: False
+
+"""
+from yamllint.linter import LintProblem
+
+
+ID = 'override-comments'
+TYPE = 'comment'
+CONF = {'forbid': bool}
+DEFAULT = {'forbid': False}
+
+
+def check(conf, comment):
+    """Check if comments are found.
+    """
+    if conf['forbid']:
+        yield LintProblem(comment.line_no, comment.column_no,
+                          'forbidden comment')

tests/plugins/yamllint_plugin_example/yamllint_plugin_example/random_failure.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2020 Adrien Vergé
+#
+# 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/>.
+
+
+import random
+
+from yamllint.linter import LintProblem
+
+
+ID = 'random-failure'
+TYPE = 'token'
+
+
+def check(conf, token, prev, next, nextnext, context):
+    if random.random() > 0.9:
+        yield LintProblem(token.start_mark.line + 1,
+                          token.start_mark.column + 1,
+                          'random failure')

tests/rules/test_braces.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -60,30 +61,6 @@ 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'

tests/rules/test_brackets.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -59,29 +60,6 @@ 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'

tests/rules/test_colons.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_commas.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_comments.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -96,7 +97,7 @@ class CommentsTestCase(RuleTestCase):
                    '#!/bin/env my-interpreter\n'
                    '', conf,
                    problem1=(1, 2), problem2=(3, 2), problem3=(4, 2))
-        self.check('#! is a valid shebang too\n',
+        self.check('#! not a shebang\n',
                    conf, problem1=(1, 2))
         self.check('key:  #!/not/a/shebang\n',
                    conf, problem1=(1, 8))
@@ -116,7 +117,8 @@ class CommentsTestCase(RuleTestCase):
                    '#comment\n'
                    '#!/bin/env my-interpreter\n', conf,
                    problem2=(3, 2), problem3=(4, 2))
-        self.check('#! is a valid shebang too\n', conf)
+        self.check('#! not a shebang\n',
+                   conf, problem1=(1, 2))
         self.check('key:  #!/not/a/shebang\n',
                    conf, problem1=(1, 8))
 

tests/rules/test_comments_indentation.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_common.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_document_end.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_document_start.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_empty_lines.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_empty_values.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2017 Greg Dubicki
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_float_values.py

@@ -1,120 +0,0 @@
-# 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))

tests/rules/test_hyphens.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_indentation.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_key_duplicates.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -86,10 +87,6 @@ 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'
@@ -168,10 +165,6 @@ 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'

tests/rules/test_key_ordering.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2017 Johannes F. Knauf
 #
 # This program is free software: you can redistribute it and/or modify
@@ -116,7 +117,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:  # pragma: no cover
+        except locale.Error:
             self.skipTest('locale en_US.UTF-8 not available')
         conf = ('key-ordering: enable')
         self.check('---\n'
@@ -135,7 +136,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:  # pragma: no cover
+        except locale.Error:
             self.skipTest('locale en_US.UTF-8 not available')
         conf = ('key-ordering: enable')
         self.check('---\n'

tests/rules/test_line_length.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -13,6 +14,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 sys
+import unittest
+
 from tests.common import RuleTestCase
 
 
@@ -115,27 +119,6 @@ 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'
@@ -176,17 +159,18 @@ 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 across bytes! ↺\n',
+                   'with: “unicode characters” that span accross bytes! ↺\n',
                    conf)
-        conf = 'line-length: {max: 51}'
+        conf = 'line-length: {max: 52}'
         self.check('---\n'
                    '# This is a test to check if “line-length” works nice\n'
-                   'with: “unicode characters” that span across bytes! ↺\n',
+                   'with: “unicode characters” that span accross bytes! ↺\n',
-                   conf, problem1=(2, 52), problem2=(3, 52))
+                   conf, problem1=(2, 53), problem2=(3, 53))
 
     def test_with_dos_newlines(self):
         conf = ('line-length: {max: 10}\n'

tests/rules/test_new_line_at_end_of_file.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_new_lines.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -13,8 +14,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/>.
 
-from unittest import mock
-
 from tests.common import RuleTestCase
 
 
@@ -60,37 +59,3 @@ 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))

tests/rules/test_octal_values.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -32,7 +33,6 @@ 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)

tests/rules/test_quoted_strings.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2018 ClearScore
 #
 # This program is free software: you can redistribute it and/or modify
@@ -435,21 +436,3 @@ 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))

tests/rules/test_trailing_spaces.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_truthy.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Peter Ericson
 #
 # This program is free software: you can redistribute it and/or modify

tests/test_cli.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -13,7 +14,10 @@
 # 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 io import StringIO
+try:
+    from cStringIO import StringIO
+except ImportError:
+    from io import StringIO
 import fcntl
 import locale
 import os
@@ -23,7 +27,7 @@ import sys
 import tempfile
 import unittest
 
-from tests.common import build_temp_workspace, temp_workspace
+from tests.common import build_temp_workspace
 
 from yamllint import cli
 from yamllint import config
@@ -58,7 +62,7 @@ def utf8_available():
         locale.setlocale(locale.LC_ALL, 'C.UTF-8')
         locale.setlocale(locale.LC_ALL, (None, None))
         return True
-    except locale.Error:  # pragma: no cover
+    except locale.Error:
         return False
 
 
@@ -242,19 +246,19 @@ class CommandLineTestCase(unittest.TestCase):
             cli.run(())
         self.assertNotEqual(ctx.returncode, 0)
         self.assertEqual(ctx.stdout, '')
-        self.assertRegex(ctx.stderr, r'^usage')
+        self.assertRegexpMatches(ctx.stderr, r'^usage')
 
         with RunContext(self) as ctx:
             cli.run(('--unknown-arg', ))
         self.assertNotEqual(ctx.returncode, 0)
         self.assertEqual(ctx.stdout, '')
-        self.assertRegex(ctx.stderr, r'^usage')
+        self.assertRegexpMatches(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.assertRegex(
+        self.assertRegexpMatches(
             ctx.stderr.splitlines()[-1],
             r'^yamllint: error: argument -d\/--config-data: '
             r'not allowed with argument -c\/--config-file$'
@@ -265,31 +269,21 @@ class CommandLineTestCase(unittest.TestCase):
             cli.run(('-', 'file'))
         self.assertNotEqual(ctx.returncode, 0)
         self.assertEqual(ctx.stdout, '')
-        self.assertRegex(ctx.stderr, r'^usage')
+        self.assertRegexpMatches(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.assertRegex(ctx.stderr, r'^invalid config: no such rule')
+        self.assertRegexpMatches(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.assertRegex(ctx.stderr, r'^invalid config: not a dict')
+        self.assertRegexpMatches(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:
@@ -306,7 +300,6 @@ 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')
@@ -330,19 +323,6 @@ 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')
 
@@ -368,7 +348,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:  # pragma: no cover
+        except locale.Error:
             self.skipTest('locale en_US.UTF-8 not available')
         locale.setlocale(locale.LC_ALL, (None, None))
 
@@ -406,7 +386,7 @@ class CommandLineTestCase(unittest.TestCase):
         with RunContext(self) as ctx:
             cli.run(('--version', ))
         self.assertEqual(ctx.returncode, 0)
-        self.assertRegex(ctx.stdout + ctx.stderr, r'yamllint \d+\.\d+')
+        self.assertRegexpMatches(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')
@@ -415,7 +395,7 @@ class CommandLineTestCase(unittest.TestCase):
             cli.run(('-f', 'parsable', path))
         self.assertEqual(ctx.returncode, -1)
         self.assertEqual(ctx.stdout, '')
-        self.assertRegex(ctx.stderr, r'No such file or directory')
+        self.assertRegexpMatches(ctx.stderr, r'No such file or directory')
 
     def test_run_one_problem_file(self):
         path = os.path.join(self.wd, 'a.yaml')
@@ -569,32 +549,17 @@ 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 = (
-            '::group::%s\n'
+            '::error file=%s,line=2,col=4::[trailing-spaces] trailing'
-            '::error file=%s,line=2,col=4::2:4 [trailing-spaces] trailing'
             ' spaces\n'
-            '::error file=%s,line=3,col=4::3:4 [new-line-at-end-of-file] no'
+            '::error file=%s,line=3,col=4::[new-line-at-end-of-file] no'
             ' new line character at the end of file\n'
-            '::endgroup::\n\n'
+            % (path, path))
-            % (path, path, path))
         self.assertEqual(
             (ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
 
@@ -608,13 +573,11 @@ class CommandLineTestCase(unittest.TestCase):
             os.environ['GITHUB_WORKFLOW'] = 'something'
             cli.run((path, ))
         expected_out = (
-            '::group::%s\n'
+            '::error file=%s,line=2,col=4::[trailing-spaces] trailing'
-            '::error file=%s,line=2,col=4::2:4 [trailing-spaces] trailing'
             ' spaces\n'
-            '::error file=%s,line=3,col=4::3:4 [new-line-at-end-of-file] no'
+            '::error file=%s,line=3,col=4::[new-line-at-end-of-file] no'
             ' new line character at the end of file\n'
-            '::endgroup::\n\n'
+            % (path, path))
-            % (path, path, path))
         self.assertEqual(
             (ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
 
@@ -677,27 +640,3 @@ 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, '', ''))

tests/test_config.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -13,7 +14,10 @@
 # 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 io import StringIO
+try:
+    from cStringIO import StringIO
+except ImportError:
+    from io import StringIO
 import os
 import shutil
 import sys
@@ -44,7 +48,7 @@ class SimpleConfigTestCase(unittest.TestCase):
             config.YamlLintConfig('not: valid: yaml')
 
     def test_unknown_rule(self):
-        with self.assertRaisesRegex(
+        with self.assertRaisesRegexp(
                 config.YamlLintConfigError,
                 'invalid config: no such rule: "this-one-does-not-exist"'):
             config.YamlLintConfig('rules:\n'
@@ -63,7 +67,7 @@ class SimpleConfigTestCase(unittest.TestCase):
         self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
 
     def test_unknown_option(self):
-        with self.assertRaisesRegex(
+        with self.assertRaisesRegexp(
                 config.YamlLintConfigError,
                 'invalid config: unknown option "abcdef" for rule "colons"'):
             config.YamlLintConfig('rules:\n'
@@ -101,7 +105,7 @@ class SimpleConfigTestCase(unittest.TestCase):
         self.assertEqual(c.rules['indentation']['check-multi-line-strings'],
                          False)
 
-        with self.assertRaisesRegex(
+        with self.assertRaisesRegexp(
                 config.YamlLintConfigError,
                 'invalid config: option "indent-sequences" of "indentation" '
                 'should be in '):
@@ -189,41 +193,6 @@ 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):
@@ -368,16 +337,6 @@ 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):

tests/test_linter.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -54,13 +55,3 @@ 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)')

tests/test_module.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2017 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -46,14 +47,15 @@ class ModuleTestCase(unittest.TestCase):
             subprocess.check_output([PYTHON, '-m', 'yamllint'],
                                     stderr=subprocess.STDOUT)
         self.assertEqual(ctx.exception.returncode, 2)
-        self.assertRegex(ctx.exception.output.decode(), r'^usage: yamllint')
+        self.assertRegexpMatches(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.assertRegex(ctx.exception.output.decode(),
+        self.assertRegexpMatches(ctx.exception.output.decode(),
                                  r'No such file or directory')
 
     def test_run_module_on_file(self):

tests/test_parser.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/test_plugins.py

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2020 Satoru SATOH
+#
+# 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/>.
+import unittest
+import warnings
+
+try:
+    from unittest import mock
+except ImportError:  # for python 2.7
+    mock = False
+
+from tests.plugins import example
+
+import yamllint.plugins
+
+
+class FakeEntryPoint(object):
+    """Fake object to mimic pkg_resources.EntryPoint.
+    """
+    RULES_MAP = example.RULES_MAP
+
+    def load(self):
+        """Fake method to return self.
+        """
+        return self
+
+
+class BrokenEntryPoint(FakeEntryPoint):
+    """Fake object to mimic load failure of pkg_resources.EntryPoint.
+    """
+    def load(self):
+        raise ImportError("This entry point should fail always!")
+
+
+class PluginFunctionsTestCase(unittest.TestCase):
+
+    def test_validate_rule_module(self):
+        fun = yamllint.plugins.validate_rule_module
+        rule_mod = example.override_comments
+
+        self.assertFalse(fun(object()))
+        self.assertTrue(fun(rule_mod))
+
+    @unittest.skipIf(not mock, "unittest.mock is not available")
+    def test_validate_rule_module_using_mock(self):
+        fun = yamllint.plugins.validate_rule_module
+        rule_mod = example.override_comments
+
+        with mock.patch.object(rule_mod, "ID", False):
+            self.assertFalse(fun(rule_mod))
+
+        with mock.patch.object(rule_mod, "TYPE", False):
+            self.assertFalse(fun(rule_mod))
+
+        with mock.patch.object(rule_mod, "check", True):
+            self.assertFalse(fun(rule_mod))
+
+    def test_load_plugin_rules_itr(self):
+        fun = yamllint.plugins.load_plugin_rules_itr
+
+        self.assertEqual(list(fun([])), [])
+        self.assertEqual(sorted(fun([FakeEntryPoint(),
+                                     FakeEntryPoint()])),
+                         sorted(FakeEntryPoint.RULES_MAP.items()))
+
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore")
+            self.assertEqual(list(fun([BrokenEntryPoint()])), [])

tests/test_rules.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2020 Satoru SATOH
+#
+# 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/>.
+import unittest
+
+try:
+    from unittest import mock
+except ImportError:  # for python 2.7
+    mock = False
+
+from tests.plugins import example
+
+import yamllint.rules
+
+
+RULE_NEVER_EXISTS = "rule_never_exists"
+PLUGIN_RULES = example.RULES_MAP
+
+
+class TestCase(unittest.TestCase):
+    """Test cases for yamllint.rules.__init__.*.
+    """
+    def test_get_default_rule(self):
+        self.assertEqual(yamllint.rules.get(yamllint.rules.braces.ID),
+                         yamllint.rules.braces)
+
+    def test_get_rule_does_not_exist(self):
+        with self.assertRaises(ValueError):
+            yamllint.rules.get(RULE_NEVER_EXISTS)
+
+
+@unittest.skipIf(not mock, "unittest.mock is not available")
+class TestCaseUsingMock(unittest.TestCase):
+    """Test cases for yamllint.rules.__init__.* using mock.
+    """
+    def test_get_default_rule_with_plugins(self):
+        with mock.patch.dict(yamllint.rules._EXTERNAL_RULES, PLUGIN_RULES):
+            self.assertEqual(yamllint.rules.get(yamllint.rules.braces.ID),
+                             yamllint.rules.braces)
+
+    def test_get_plugin_rules(self):
+        plugin_rule_id = example.override_comments.ID
+        plugin_rule_mod = example.override_comments
+
+        with mock.patch.dict(yamllint.rules._EXTERNAL_RULES, PLUGIN_RULES):
+            self.assertEqual(yamllint.rules.get(plugin_rule_id),
+                             plugin_rule_mod)
+
+    def test_get_rule_does_not_exist_with_plugins(self):
+        with mock.patch.dict(yamllint.rules._EXTERNAL_RULES, PLUGIN_RULES):
+            with self.assertRaises(ValueError):
+                yamllint.rules.get(RULE_NEVER_EXISTS)

tests/test_spec_examples.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/test_syntax_errors.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/test_yamllint_directives.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/__init__.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -21,10 +22,10 @@ indentation, etc."""
 
 
 APP_NAME = 'yamllint'
-APP_VERSION = '1.27.0'
+APP_VERSION = '1.25.0'
 APP_DESCRIPTION = __doc__
 
 __author__ = u'Adrien Vergé'
-__copyright__ = u'Copyright 2022, Adrien Vergé'
+__copyright__ = u'Copyright 2016, Adrien Vergé'
 __license__ = 'GPLv3'
 __version__ = APP_VERSION

yamllint/cli.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -92,10 +93,6 @@ 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
@@ -106,25 +103,18 @@ 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':
+        elif args_format == 'github' or (args_format == 'auto' and
-            if first:
+                                         'GITHUB_ACTIONS' in os.environ and
-                print('::group::%s' % file)
+                                         'GITHUB_WORKFLOW' in os.environ):
-                first = False
             print(Format.github(problem, file))
-        elif args_format == 'colored':
+        elif args_format == 'colored' or \
+                (args_format == 'auto' and supports_color()):
             if first:
                 print('\033[4m%s\033[0m' % file)
                 first = False
@@ -135,9 +125,6 @@ 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('')
 

yamllint/conf/default.yaml

@@ -19,7 +19,6 @@ rules:
     level: warning
   empty-lines: enable
   empty-values: disable
-  float-values: disable
   hyphens: enable
   indentation: enable
   key-duplicates: enable
@@ -30,5 +29,7 @@ rules:
   octal-values: disable
   quoted-strings: disable
   trailing-spaces: enable
+  random-failure: enable
+  override-comments: {forbid: true}
   truthy:
     level: warning

yamllint/config.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/linter.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -80,7 +81,10 @@ 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
 
             if re.match(r'^# yamllint disable( rule:\S+)*\s*$', comment):
                 items = comment[18:].rstrip().split(' ')
@@ -106,7 +110,10 @@ 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
 
             if re.match(r'^# yamllint disable-line( rule:\S+)*\s*$', comment):
                 items = comment[23:].rstrip().split(' ')
@@ -199,12 +206,16 @@ def _run(buffer, conf, filepath):
                 syntax_error.column <= problem.column):
             yield syntax_error
 
-            # Discard the problem since it is at the same place as the syntax
+            # If there is already a yamllint error at the same place, discard
-            # error and is probably redundant (and maybe it's just a 'warning',
+            # it as it 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
+
         yield problem
 
     if syntax_error:
@@ -222,7 +233,7 @@ def run(input, conf, filepath=None):
     if conf.is_file_ignored(filepath):
         return ()
 
-    if isinstance(input, (bytes, str)):
+    if isinstance(input, (type(b''), type(u''))):  # compat with Python 2 & 3
         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

yamllint/parser.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/plugins.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2020 Satoru SATOH
+#
+# 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/>.
+"""
+Plugin module utilizing setuptools (pkg_resources) to allow users to add their
+own custom lint rules.
+"""
+import warnings
+
+import pkg_resources
+
+
+PACKAGE_GROUP = "yamllint.plugins.rules"
+
+
+def validate_rule_module(rule_mod):
+    """Test if given rule module is valid.
+    """
+    return (getattr(rule_mod, "ID", False) and
+            getattr(rule_mod, "TYPE", False)
+            ) and callable(getattr(rule_mod, "check", False))
+
+
+def load_plugin_rules_itr(entry_points=None, group=PACKAGE_GROUP):
+    """Load custom lint rule plugins."""
+    if not entry_points:
+        entry_points = pkg_resources.iter_entry_points(group)
+
+    rule_ids = set()
+    for entry in entry_points:
+        try:
+            rules = entry.load()
+            for rule_id, rule_mod in rules.RULES_MAP.items():
+                if rule_id in rule_ids or not validate_rule_module(rule_mod):
+                    continue
+
+                print(rule_id, rule_mod)###
+                yield (rule_id, rule_mod)
+                rule_ids.add(rule_id)
+
+        # pkg_resources.EntryPoint.resolve may throw ImportError.
+        except (AttributeError, ImportError):
+            warnings.warn("Could not load the plugin: {}".format(entry),
+                          RuntimeWarning)
+
+
+def get_plugin_rules_map():
+    """Get a mappings of plugin rule's IDs and rules."""
+    return dict((rule_id, rule_mod)
+                for rule_id, rule_mod in load_plugin_rules_itr())

yamllint/rules/__init__.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -13,6 +14,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/>.
 
+import yamllint.plugins
 from yamllint.rules import (
     braces,
     brackets,
@@ -32,7 +34,6 @@ from yamllint.rules import (
     new_line_at_end_of_file,
     new_lines,
     octal_values,
-    float_values,
     quoted_strings,
     trailing_spaces,
     truthy,
@@ -49,7 +50,6 @@ _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,
@@ -63,9 +63,14 @@ _RULES = {
     truthy.ID: truthy,
 }
 
+_EXTERNAL_RULES = yamllint.plugins.get_plugin_rules_map()
 
-def get(id):
-    if id not in _RULES:
-        raise ValueError('no such rule: "%s"' % id)
 
-    return _RULES[id]
+def get(rule_id):
+    if rule_id in _RULES:
+        return _RULES[rule_id]
+
+    if rule_id in _EXTERNAL_RULES:
+        return _EXTERNAL_RULES[rule_id]
+
+    raise ValueError('no such rule: "%s"' % rule_id)

yamllint/rules/braces.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -21,8 +22,7 @@ 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. Use ``non-empty`` to forbid the use of all flow
+  mappings completely.
-  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,18 +60,6 @@ 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**:
@@ -140,7 +128,7 @@ from yamllint.rules.common import spaces_after, spaces_before
 
 ID = 'braces'
 TYPE = 'token'
-CONF = {'forbid': (bool, 'non-empty'),
+CONF = {'forbid': bool,
         'min-spaces-inside': int,
         'max-spaces-inside': int,
         'min-spaces-inside-empty': int,
@@ -153,15 +141,7 @@ DEFAULT = {'forbid': False,
 
 
 def check(conf, token, prev, next, nextnext, context):
-    if (conf['forbid'] is True and
+    if conf['forbid'] and isinstance(token, yaml.FlowMappingStartToken):
-            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')

yamllint/rules/brackets.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -21,8 +22,7 @@ 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. Use ``non-empty`` to forbid the use of all flow
+  flow sequences completely.
-  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,18 +61,6 @@ 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**:
@@ -141,7 +129,7 @@ from yamllint.rules.common import spaces_after, spaces_before
 
 ID = 'brackets'
 TYPE = 'token'
-CONF = {'forbid': (bool, 'non-empty'),
+CONF = {'forbid': bool,
         'min-spaces-inside': int,
         'max-spaces-inside': int,
         'min-spaces-inside-empty': int,
@@ -154,15 +142,7 @@ DEFAULT = {'forbid': False,
 
 
 def check(conf, token, prev, next, nextnext, context):
-    if (conf['forbid'] is True and
+    if conf['forbid'] and isinstance(token, yaml.FlowSequenceStartToken):
-            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')

yamllint/rules/colons.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/commas.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/comments.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -73,6 +74,8 @@ Use this rule to control the position and formatting of comments.
 """
 
 
+import re
+
 from yamllint.linter import LintProblem
 
 
@@ -102,7 +105,7 @@ def check(conf, comment):
             if (conf['ignore-shebangs'] and
                     comment.line_no == 1 and
                     comment.column_no == 1 and
-                    comment.buffer[text_start] == '!'):
+                    re.match(r'^!\S', 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.

yamllint/rules/comments_indentation.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/common.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/document_end.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/document_start.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/empty_lines.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/empty_values.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2017 Greg Dubicki
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/float_values.py

@@ -1,158 +0,0 @@
-# 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}"',
-        )

yamllint/rules/hyphens.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/indentation.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/key_duplicates.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -83,7 +84,6 @@ def check(conf, token, prev, next, nextnext, context):
     elif isinstance(token, (yaml.BlockEndToken,
                             yaml.FlowMappingEndToken,
                             yaml.FlowSequenceEndToken)):
-        if len(context['stack']) > 0:
         context['stack'].pop()
     elif (isinstance(token, yaml.KeyToken) and
           isinstance(next, yaml.ScalarToken)):

yamllint/rules/key_ordering.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2017 Johannes F. Knauf
 #
 # This program is free software: you can redistribute it and/or modify
@@ -17,8 +18,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 one
+This can be changed by setting the global ``locale`` option.  This allows to
-to sort case and accents properly.
+sort case and accents properly.
 
 .. rubric:: Examples
 

yamllint/rules/line_length.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -16,6 +17,10 @@
 """
 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.
@@ -139,11 +144,7 @@ def check(conf, line):
                 start += 1
 
             if start != line.end:
-                if line.buffer[start] == '#':
+                if line.buffer[start] in ('#', '-'):
-                    while line.buffer[start] == '#':
-                        start += 1
-                    start += 1
-                elif line.buffer[start] == '-':
                     start += 2
 
                 if line.buffer.find(' ', start, line.end) == -1:

yamllint/rules/new_line_at_end_of_file.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/new_lines.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -18,11 +19,8 @@ Use this rule to force the type of new line characters.
 
 .. rubric:: Options
 
-* Set ``type`` to ``unix`` to enforce UNIX-typed new line characters (``\\n``),
+* Set ``type`` to ``unix`` to use UNIX-typed new line characters (``\\n``), or
-  set ``type`` to ``dos`` to enforce DOS-typed new line characters
+  ``dos`` to use DOS-typed new line characters (``\\r\\n``).
-  (``\\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)
 
@@ -33,27 +31,24 @@ 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', 'platform')}
+CONF = {'type': ('unix', 'dos')}
 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 line.buffer[line.end:line.end + len(newline_char)] != newline_char:
+        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 {}'
+                                  'wrong new line character: expected \\r\\n')
-                              .format(repr(newline_char).strip('\'')))
+        else:
+            if line.buffer[line.end] == '\r':
+                yield LintProblem(1, line.end - line.start + 1,
+                                  'wrong new line character: expected \\n')

yamllint/rules/octal_values.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2017 ScienJus
 #
 # This program is free software: you can redistribute it and/or modify
@@ -84,7 +85,9 @@ CONF = {'forbid-implicit-octal': bool,
 DEFAULT = {'forbid-implicit-octal': True,
            'forbid-explicit-octal': True}
 
-IS_OCTAL_NUMBER_PATTERN = re.compile(r'^[0-7]+$')
+
+def _is_octal_number(string):
+    return re.match(r'^[0-7]+$', string) is not None
 
 
 def check(conf, token, prev, next, nextnext, context):
@@ -96,7 +99,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_PATTERN.match(val[1:]) is not None):
+                        _is_octal_number(val[1:])):
                     yield LintProblem(
                         token.start_mark.line + 1, token.end_mark.column + 1,
                         'forbidden implicit octal value "%s"' %
@@ -107,7 +110,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_PATTERN.match(val[2:]) is not None):
+                        _is_octal_number(val[2:])):
                     yield LintProblem(
                         token.start_mark.line + 1, token.end_mark.column + 1,
                         'forbidden explicit octal value "%s"' %

yamllint/rules/quoted_strings.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2018 ClearScore
 #
 # This program is free software: you can redistribute it and/or modify
@@ -143,17 +144,6 @@ 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

yamllint/rules/trailing_spaces.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/truthy.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Peter Ericson
 #
 # This program is free software: you can redistribute it and/or modify