Made yamllint a direct dependency (#1881)

ansible · Feb 13, 2022 · 36e1b1e · 36e1b1e
1 parent 464fd99
commit 36e1b1e
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 34 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -125,33 +125,34 @@ repos:
     - tenacity
     - typing_extensions
     - wcmatch
+    - yamllint
 - # keep at bottom as these are slower
   repo: local
   hooks:
   - id: pip-compile
     name: pip-compile
-    entry: python3.9 -m piptools compile -q --no-annotate --output-file=constraints.txt setup.cfg --extra test --extra yamllint --strip-extras
+    entry: python3.9 -m piptools compile -q --no-annotate --output-file=constraints.txt setup.cfg --extra test --strip-extras
     language: system
     files: ^(setup\.cfg|=constraints\.txt)$
     pass_filenames: false
     stages: [manual]
   - id: pip-compile-docs
     name: pip-compile-docs
-    entry: python3.9 -m piptools compile -q --no-annotate --output-file=docs/requirements.txt --extra yamllint --strip-extras docs/requirements.in setup.cfg
+    entry: python3.9 -m piptools compile -q --no-annotate --output-file=docs/requirements.txt --strip-extras docs/requirements.in setup.cfg
     language: system
     files: ^(docs\/requirements\.(txt|in)|)$
     pass_filenames: false
     stages: [manual]
   - id: pip-compile-upgrade
     name: pip-compile-upgrade
-    entry: python3.9 -m piptools compile -q --upgrade --no-annotate --output-file=constraints.txt setup.cfg --extra test --extra yamllint --strip-extras
+    entry: python3.9 -m piptools compile -q --upgrade --no-annotate --output-file=constraints.txt setup.cfg --extra test --strip-extras
     language: system
     files: ^(setup\.cfg|=constraints\.txt)$
     pass_filenames: false
     stages: [manual]
   - id: pip-compile-docs-upgrade
     name: pip-compile-docs-upgrade
-    entry: python3.9 -m piptools compile -q --upgrade --no-annotate  --extra yamllint --output-file=docs/requirements.txt --strip-extras docs/requirements.in setup.cfg
+    entry: python3.9 -m piptools compile -q --upgrade --no-annotate --output-file=docs/requirements.txt --strip-extras docs/requirements.in setup.cfg
     language: system
     files: ^(docs\/requirements\.(txt|in)|)$
     pass_filenames: false

diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -17,4 +17,4 @@
         # if you want to use only the base ansible version for linting,
         # replace 'community' extra with 'core' or just mention the exact
         # version of Ansible you want to install as a dependency.
-        - .[community,yamllint]
+        - .[community]
diff --git a/constraints.txt b/constraints.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with python 3.9
 # To update, run:
 #
-#    pip-compile --extra=test --extra=yamllint --no-annotate --output-file=constraints.txt --strip-extras setup.cfg
+#    pip-compile --extra=test --no-annotate --output-file=constraints.txt --strip-extras setup.cfg
 #
 attrs==21.4.0
 bracex==2.2.1

diff --git a/docs/installing.rst b/docs/installing.rst
@@ -43,15 +43,14 @@ using ``--user`` or fixing potential conflicts if not using virtualenvs.
 
 .. code-block:: bash
 
-    # Assuming you already installed Ansible and you also want the optional
-    # yamllint support:
-    pip3 install "ansible-lint[yamllint]"
+    # Assuming you already installed Ansible
+    pip3 install "ansible-lint"
 
     # If you want to install and use the latest Ansible (w/o community collections)
-    pip3 install "ansible-lint[core,yamllint]"
+    pip3 install "ansible-lint[core]"
 
     # If you want to install and use the latest Ansible with community collections
-    pip3 install "ansible-lint[community,yamllint]"
+    pip3 install "ansible-lint[community]"
 
     # If you want to install an older version of Ansible 2.9
     pip3 install ansible-lint "ansible>=2.9,<2.10"

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with python 3.9
 # To update, run:
 #
-#    pip-compile --extra=yamllint --no-annotate --output-file=docs/requirements.txt --strip-extras docs/requirements.in setup.cfg
+#    pip-compile --no-annotate --output-file=docs/requirements.txt --strip-extras docs/requirements.in setup.cfg
 #
 alabaster==0.7.12
 ansible-core==2.12.2

diff --git a/setup.cfg b/setup.cfg
@@ -78,6 +78,7 @@ install_requires =
   tenacity
   typing-extensions; python_version < "3.8"
   wcmatch>=7.0  # MIT
+  yamllint >= 1.25.0  # GPLv3
 
 [options.entry_points]
 console_scripts =
@@ -97,9 +98,6 @@ core =
 ; Disabled due to https://github.com/pypa/twine/issues/726
 ; devel =
 ;   ansible-core @ git+https://github.com/ansible/ansible.git  # GPLv3+
-# yamllint must remain optional
-yamllint =
-  yamllint >= 1.25.0  # GPLv3
 test =
   coverage >= 6.2, < 6.3 # 6.3 dropped py37 support
   tomli >= 1.2.3, < 2.0.0  # 2.0.0 dropped py37 support (needed by coverage))

diff --git a/src/ansiblelint/rules/YamllintRule.py b/src/ansiblelint/rules/YamllintRule.py
@@ -3,7 +3,9 @@
 import sys
 from typing import TYPE_CHECKING, List
 
-from ansiblelint.config import options
+from yamllint.config import YamlLintConfig
+from yamllint.linter import run as run_yamllint
+
 from ansiblelint.file_utils import Lintable
 from ansiblelint.rules import AnsibleLintRule
 from ansiblelint.skip_utils import get_rule_skips_from_line
@@ -13,18 +15,6 @@
 
 _logger = logging.getLogger(__name__)
 
-# yamllint is a soft-dependency (not installed by default)
-try:
-    from yamllint.config import YamlLintConfig
-    from yamllint.linter import run as run_yamllint
-except ImportError:
-    # missing library is ignored unless yaml is exclitely added to enable_list
-    if "yaml" in options.enable_list:
-        raise RuntimeError(
-            "Failed to load yamllint library and ansible-linted was configured to require it."
-        )
-
-
 YAMLLINT_CONFIG = """
 extends: default
 rules:
@@ -48,10 +38,6 @@
 Specific tag identifiers that are printed at the end of rule name,
 like 'trailing-spaces' or 'indentation' can also be be skipped, allowing
 you to have a more fine control.
-
-By default this rule is not used when yamllint library is missing. If you want
-to make its absence a runtime failure, please add 'yaml' to 'enable_list'
-inside the configuration file.
 """
 
 

diff --git a/tox.ini b/tox.ini
@@ -16,7 +16,7 @@ description =
   devel: ansible devel branch
   core: ansible-core 2.11+
 deps =
-  --editable .[yamllint,test]
+  --editable .[test]
   core: ansible-core
   py: ansible-core>=2.11
   devel: ansible-core @ git+https://github.com/ansible/ansible.git  # GPLv3+
@@ -104,7 +104,7 @@ commands =
 description = Builds docs
 basepython = python3
 deps =
-  --editable .[yamllint]
+  --editable .
   -r{toxinidir}/docs/requirements.in
 setenv =
   PIP_CONSTRAINT = {toxinidir}/docs/requirements.txt