Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor some constants into specific module #2451

Merged
merged 1 commit into from
Sep 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/ansiblelint/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,7 @@ def main():
"rescue",
]

# Keys that are used internally when parsing YAML/JSON files
SKIPPED_RULES_KEY = "__skipped_rules__"
LINE_NUMBER_KEY = "__line__"
FILENAME_KEY = "__file__"
8 changes: 4 additions & 4 deletions src/ansiblelint/rules/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
)
from ansiblelint.config import PROFILES, get_rule_config
from ansiblelint.config import options as default_options
from ansiblelint.constants import RULE_DOC_URL, SKIPPED_RULES_KEY
from ansiblelint.constants import LINE_NUMBER_KEY, RULE_DOC_URL, SKIPPED_RULES_KEY
from ansiblelint.errors import MatchError
from ansiblelint.file_utils import Lintable, expand_paths_vars

Expand Down Expand Up @@ -121,8 +121,8 @@ def _enrich_matcherror_with_task_details(
match.task = task
if not match.details:
match.details = "Task/Handler: " + ansiblelint.utils.task_to_str(task)
if match.linenumber < task[ansiblelint.utils.LINE_NUMBER_KEY]:
match.linenumber = task[ansiblelint.utils.LINE_NUMBER_KEY]
if match.linenumber < task[LINE_NUMBER_KEY]:
match.linenumber = task[LINE_NUMBER_KEY]

def matchlines(self, file: Lintable) -> list[MatchError]:
matches: list[MatchError] = []
Expand Down Expand Up @@ -210,7 +210,7 @@ def matchtasks(self, file: Lintable) -> list[MatchError]: # noqa: C901
message = result
match = self.create_matcherror(
message=message,
linenumber=task[ansiblelint.utils.LINE_NUMBER_KEY],
linenumber=task[LINE_NUMBER_KEY],
filename=file,
)

Expand Down
2 changes: 1 addition & 1 deletion src/ansiblelint/rules/galaxy.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
from functools import total_ordering
from typing import TYPE_CHECKING, Any

from ansiblelint.constants import LINE_NUMBER_KEY
from ansiblelint.errors import MatchError
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import LINE_NUMBER_KEY

if TYPE_CHECKING:
from typing import Optional
Expand Down
3 changes: 2 additions & 1 deletion src/ansiblelint/rules/inline_env_var.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@

from typing import TYPE_CHECKING, Any

from ansiblelint.constants import FILENAME_KEY, LINE_NUMBER_KEY
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import FILENAME_KEY, LINE_NUMBER_KEY, get_first_cmd_arg
from ansiblelint.utils import get_first_cmd_arg

if TYPE_CHECKING:
from typing import Optional
Expand Down
3 changes: 2 additions & 1 deletion src/ansiblelint/rules/jinja.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@
from ansible.parsing.yaml.objects import AnsibleUnicode
from yaml.representer import RepresenterError

from ansiblelint.constants import LINE_NUMBER_KEY
from ansiblelint.file_utils import Lintable
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.skip_utils import get_rule_skips_from_line
from ansiblelint.utils import LINE_NUMBER_KEY, parse_yaml_from_file, template
from ansiblelint.utils import parse_yaml_from_file, template
from ansiblelint.yaml_utils import nested_items_path

if TYPE_CHECKING:
Expand Down
3 changes: 1 addition & 2 deletions src/ansiblelint/rules/meta_incorrect.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

from typing import TYPE_CHECKING

from ansiblelint.constants import SKIPPED_RULES_KEY
from ansiblelint.constants import LINE_NUMBER_KEY, SKIPPED_RULES_KEY
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import LINE_NUMBER_KEY

if TYPE_CHECKING:
from typing import Any
Expand Down
2 changes: 1 addition & 1 deletion src/ansiblelint/rules/meta_video_links.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
import re
from typing import TYPE_CHECKING

from ansiblelint.constants import FILENAME_KEY, LINE_NUMBER_KEY
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import FILENAME_KEY, LINE_NUMBER_KEY

if TYPE_CHECKING:
from typing import Any
Expand Down
2 changes: 1 addition & 1 deletion src/ansiblelint/rules/name.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
import sys
from typing import TYPE_CHECKING, Any

from ansiblelint.constants import LINE_NUMBER_KEY
from ansiblelint.errors import MatchError
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import LINE_NUMBER_KEY

if TYPE_CHECKING:
from typing import Optional
Expand Down
2 changes: 1 addition & 1 deletion src/ansiblelint/rules/no_jinja_when.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

from typing import TYPE_CHECKING, Any

from ansiblelint.constants import LINE_NUMBER_KEY
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import LINE_NUMBER_KEY

if TYPE_CHECKING:
from typing import Optional
Expand Down
2 changes: 1 addition & 1 deletion src/ansiblelint/rules/no_prompting.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
import sys
from typing import TYPE_CHECKING, Any

from ansiblelint.constants import LINE_NUMBER_KEY
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import LINE_NUMBER_KEY

if TYPE_CHECKING:
from typing import Optional
Expand Down
2 changes: 1 addition & 1 deletion src/ansiblelint/rules/partial_become.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
from functools import reduce
from typing import TYPE_CHECKING, Any

from ansiblelint.constants import LINE_NUMBER_KEY
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import LINE_NUMBER_KEY

if TYPE_CHECKING:
from ansiblelint.constants import odict
Expand Down
3 changes: 2 additions & 1 deletion src/ansiblelint/rules/var_naming.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@
from ansible.parsing.yaml.objects import AnsibleUnicode

from ansiblelint.config import options
from ansiblelint.constants import LINE_NUMBER_KEY
from ansiblelint.file_utils import Lintable
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.skip_utils import get_rule_skips_from_line
from ansiblelint.utils import LINE_NUMBER_KEY, parse_yaml_from_file
from ansiblelint.utils import parse_yaml_from_file

if TYPE_CHECKING:
from ansiblelint.constants import odict
Expand Down
3 changes: 1 addition & 2 deletions src/ansiblelint/rules/yaml_rule.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@

from yamllint.linter import run as run_yamllint

from ansiblelint.constants import SKIPPED_RULES_KEY
from ansiblelint.constants import LINE_NUMBER_KEY, SKIPPED_RULES_KEY
from ansiblelint.file_utils import Lintable
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import LINE_NUMBER_KEY
from ansiblelint.yaml_utils import load_yamllint_config

if TYPE_CHECKING:
Expand Down
5 changes: 2 additions & 3 deletions src/ansiblelint/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@
from ansiblelint.app import get_app
from ansiblelint.config import options
from ansiblelint.constants import (
FILENAME_KEY,
LINE_NUMBER_KEY,
NESTED_TASK_KEYS,
PLAYBOOK_TASK_KEYWORDS,
SKIPPED_RULES_KEY,
Expand Down Expand Up @@ -132,9 +134,6 @@ def ansible_template(
raise


LINE_NUMBER_KEY = "__line__"
FILENAME_KEY = "__file__"

BLOCK_NAME_TO_ACTION_TYPE_MAP = {
"tasks": "task",
"handlers": "handler",
Expand Down