diff --git a/pyproject.toml b/pyproject.toml index 64ed1f2fe..722a03a39 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -260,21 +260,13 @@ exclude = ["tests/fixtures/**", ".git"] [tool.ruff.lint] ignore = [ + 'ANN101', # This rule is deprecated and will be removed in a future release. + 'ANN102', # This rule is deprecated and will be removed in a future release. 'ERA001', # [*] Found commented-out code 'INP001', # File `docs/_ext/regenerate_docs.py` is part of an implicit namespace package. Add an `__init__.py`. 'PLW2901', # `for` loop variable `info_name` overwritten by assignment target "RET504", # Unnecessary variable assignment before `return` statement # temporary disabled until we fix them: - 'ANN001', # Missing type annotation for function argument `output` - 'ANN002', # Missing type annotation for `*args` - 'ANN003', # Missing type annotation for `**kwargs` - 'ANN101', # Missing type annotation for `self` in method - 'ANN102', # Missing type annotation for `cls` in classmethod - 'ANN201', # Missing return type annotation for public function `notify_none` - 'ANN202', # Missing return type annotation for private function `_build_main_menu` - 'ANN204', # [*] Missing return type annotation for special method `__init__` - 'ANN205', # Missing return type annotation for staticmethod `run_single_process` - 'ANN206', # Missing return type annotation for classmethod `_missing_` 'ANN401', # Dynamically typed expressions (typing.Any) are disallowed in `cls` 'ARG001', # Unused function argument: `colno` 'ARG002', # Unused method argument: `app` diff --git a/src/ansible_navigator/action_base.py b/src/ansible_navigator/action_base.py index e7efa1f34..7a18289fc 100644 --- a/src/ansible_navigator/action_base.py +++ b/src/ansible_navigator/action_base.py @@ -33,7 +33,9 @@ class ActionBase: # pylint: disable=too-many-instance-attributes """Base class for actions.""" - def __init__(self, args: ApplicationConfiguration, name: str, logger_name: str = __name__): + def __init__( + self, args: ApplicationConfiguration, name: str, logger_name: str = __name__ + ) -> None: """Initialize the App class. :param args: The current application configuration diff --git a/src/ansible_navigator/actions/back.py b/src/ansible_navigator/actions/back.py index 1507cb182..b18acb4cf 100644 --- a/src/ansible_navigator/actions/back.py +++ b/src/ansible_navigator/actions/back.py @@ -19,7 +19,7 @@ class Action: KEGEX = r"^\^\[|\x1b|back$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:back`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/builder.py b/src/ansible_navigator/actions/builder.py index 692f29b1f..1f25a80f4 100644 --- a/src/ansible_navigator/actions/builder.py +++ b/src/ansible_navigator/actions/builder.py @@ -24,7 +24,7 @@ class Action(ActionBase): KEGEX = "^b(?:uilder)?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the action. :param args: The current application configuration diff --git a/src/ansible_navigator/actions/collections.py b/src/ansible_navigator/actions/collections.py index cc1ed1f7c..70c68a1d8 100644 --- a/src/ansible_navigator/actions/collections.py +++ b/src/ansible_navigator/actions/collections.py @@ -94,7 +94,7 @@ class Action(ActionBase): KEGEX = r"^collections(\s(?P.*))?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``collections`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/config.py b/src/ansible_navigator/actions/config.py index ac277b233..65ca59440 100644 --- a/src/ansible_navigator/actions/config.py +++ b/src/ansible_navigator/actions/config.py @@ -88,7 +88,7 @@ class Action(ActionBase): KEGEX = r"^config(\s(?P.*))?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:config`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/doc.py b/src/ansible_navigator/actions/doc.py index d12f23fbb..fb50dc346 100644 --- a/src/ansible_navigator/actions/doc.py +++ b/src/ansible_navigator/actions/doc.py @@ -35,7 +35,7 @@ class Action(ActionBase): KEGEX = r"^d(?:oc)?(\s(?P.*))?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``doc`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/exec.py b/src/ansible_navigator/actions/exec.py index ee34ec11b..666e3215e 100644 --- a/src/ansible_navigator/actions/exec.py +++ b/src/ansible_navigator/actions/exec.py @@ -74,7 +74,7 @@ class Action(ActionBase): KEGEX = "^e(?:xec)?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:exec`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/filter.py b/src/ansible_navigator/actions/filter.py index 11d29f30b..426a842ca 100644 --- a/src/ansible_navigator/actions/filter.py +++ b/src/ansible_navigator/actions/filter.py @@ -15,7 +15,7 @@ class Action: KEGEX = r"^f(ilter)?(\s(?P.*))?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:filter`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/help_doc.py b/src/ansible_navigator/actions/help_doc.py index 8100c8f23..d904cc4d6 100644 --- a/src/ansible_navigator/actions/help_doc.py +++ b/src/ansible_navigator/actions/help_doc.py @@ -16,7 +16,7 @@ class Action(ActionBase): KEGEX = r"^h(?:elp)?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:help`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/images.py b/src/ansible_navigator/actions/images.py index 660b51230..611fe8e20 100644 --- a/src/ansible_navigator/actions/images.py +++ b/src/ansible_navigator/actions/images.py @@ -59,7 +59,7 @@ class Action(ActionBase): KEGEX = r"^im(?:ages)?(\s(?P.*))?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:images`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/inventory.py b/src/ansible_navigator/actions/inventory.py index 8155d2fc8..36b400829 100644 --- a/src/ansible_navigator/actions/inventory.py +++ b/src/ansible_navigator/actions/inventory.py @@ -110,7 +110,7 @@ class Action(ActionBase): KEGEX = r"^i(?:nventory)?(\s(?P.*))?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:images`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/lint.py b/src/ansible_navigator/actions/lint.py index 2a9ac1579..0268076b3 100644 --- a/src/ansible_navigator/actions/lint.py +++ b/src/ansible_navigator/actions/lint.py @@ -183,7 +183,7 @@ class Action(ActionBase): KEGEX = r"^lint(\s(?P.*))?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the action. :param args: The current application configuration diff --git a/src/ansible_navigator/actions/log.py b/src/ansible_navigator/actions/log.py index a38a4748b..0a0422d11 100644 --- a/src/ansible_navigator/actions/log.py +++ b/src/ansible_navigator/actions/log.py @@ -15,7 +15,7 @@ class Action(ActionBase): KEGEX = r"^l(?:og)?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:log`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/open_file.py b/src/ansible_navigator/actions/open_file.py index 4fde3ae69..9ace742e5 100644 --- a/src/ansible_navigator/actions/open_file.py +++ b/src/ansible_navigator/actions/open_file.py @@ -62,7 +62,7 @@ class Action: KEGEX = r"^o(?:pen)?(\s(?P.*))?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:open`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/quit.py b/src/ansible_navigator/actions/quit.py index d5032885a..740b1971b 100644 --- a/src/ansible_navigator/actions/quit.py +++ b/src/ansible_navigator/actions/quit.py @@ -15,7 +15,7 @@ class Action: KEGEX = r"q(?:uit)?(?P!)?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:quit`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/refresh.py b/src/ansible_navigator/actions/refresh.py index 4d1e5a3a6..23bfa1e26 100644 --- a/src/ansible_navigator/actions/refresh.py +++ b/src/ansible_navigator/actions/refresh.py @@ -15,7 +15,7 @@ class Action: KEGEX = r"^KEY_F\(5\)$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the refresh action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/rerun.py b/src/ansible_navigator/actions/rerun.py index 27fab1526..121ccf053 100644 --- a/src/ansible_navigator/actions/rerun.py +++ b/src/ansible_navigator/actions/rerun.py @@ -16,7 +16,7 @@ class Action: KEGEX = r"^rr|rerun?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:rerun`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/run.py b/src/ansible_navigator/actions/run.py index 5d8b0a72a..57c1723bc 100644 --- a/src/ansible_navigator/actions/run.py +++ b/src/ansible_navigator/actions/run.py @@ -204,7 +204,7 @@ class Action(ActionBase): (\s(?P.*))?) $""" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:run`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/sample_form.py b/src/ansible_navigator/actions/sample_form.py index 3535b26c6..921821fc3 100644 --- a/src/ansible_navigator/actions/sample_form.py +++ b/src/ansible_navigator/actions/sample_form.py @@ -91,7 +91,7 @@ class Action(ActionBase): KEGEX = r"^sample_form$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:sample_form`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/sample_notification.py b/src/ansible_navigator/actions/sample_notification.py index 4e3f73594..4a9e86523 100644 --- a/src/ansible_navigator/actions/sample_notification.py +++ b/src/ansible_navigator/actions/sample_notification.py @@ -36,7 +36,7 @@ class Action(ActionBase): KEGEX = r"^sample_notification$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:sample_notification`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/sample_working.py b/src/ansible_navigator/actions/sample_working.py index 5888acaee..65448f087 100644 --- a/src/ansible_navigator/actions/sample_working.py +++ b/src/ansible_navigator/actions/sample_working.py @@ -17,7 +17,7 @@ class Action(ActionBase): KEGEX = r"^sample_working$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:sample_working`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/save.py b/src/ansible_navigator/actions/save.py index e646d9931..2d45c2f1e 100644 --- a/src/ansible_navigator/actions/save.py +++ b/src/ansible_navigator/actions/save.py @@ -15,7 +15,7 @@ class Action: KEGEX = r"^s(?:ave)?\s(?P.*)$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:save`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/select.py b/src/ansible_navigator/actions/select.py index 51f0c2eb7..8b52cdc29 100644 --- a/src/ansible_navigator/actions/select.py +++ b/src/ansible_navigator/actions/select.py @@ -19,7 +19,7 @@ class Action: KEGEX = r"^\d+$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the select action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/serialize_json.py b/src/ansible_navigator/actions/serialize_json.py index 954bd0415..fced7b5d0 100644 --- a/src/ansible_navigator/actions/serialize_json.py +++ b/src/ansible_navigator/actions/serialize_json.py @@ -16,7 +16,7 @@ class Action: KEGEX = r"^j(?:son)?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:json`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/serialize_yaml.py b/src/ansible_navigator/actions/serialize_yaml.py index f21e6e921..40fcc740f 100644 --- a/src/ansible_navigator/actions/serialize_yaml.py +++ b/src/ansible_navigator/actions/serialize_yaml.py @@ -16,7 +16,7 @@ class Action: KEGEX = r"^y(?:aml)?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:yaml`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/settings.py b/src/ansible_navigator/actions/settings.py index b51fec56a..3444a44be 100644 --- a/src/ansible_navigator/actions/settings.py +++ b/src/ansible_navigator/actions/settings.py @@ -88,7 +88,7 @@ class Action(ActionBase): KEGEX = r"^se(?:ttings)?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:settings`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/stdout.py b/src/ansible_navigator/actions/stdout.py index 534e6799c..731d17cc3 100644 --- a/src/ansible_navigator/actions/stdout.py +++ b/src/ansible_navigator/actions/stdout.py @@ -15,7 +15,7 @@ class Action(ActionBase): KEGEX = r"^st(?:dout)?$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:stdout`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/template.py b/src/ansible_navigator/actions/template.py index 3e023c9df..cdaedc849 100644 --- a/src/ansible_navigator/actions/template.py +++ b/src/ansible_navigator/actions/template.py @@ -31,7 +31,7 @@ class Action(ActionBase): KEGEX = r"^{{\s*(?P.*?)\s*}}$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the template action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/welcome.py b/src/ansible_navigator/actions/welcome.py index 576a4fba9..10ab87653 100644 --- a/src/ansible_navigator/actions/welcome.py +++ b/src/ansible_navigator/actions/welcome.py @@ -21,7 +21,7 @@ class Action(ActionBase): KEGEX = r"^welcome$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:welcome`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/actions/write_file.py b/src/ansible_navigator/actions/write_file.py index fe2868b9a..49ed99a0e 100644 --- a/src/ansible_navigator/actions/write_file.py +++ b/src/ansible_navigator/actions/write_file.py @@ -23,7 +23,7 @@ class Action: KEGEX = r"^w(?:rite)?(?P!)?\s+(?P>>)?\s*(?P.+)$" - def __init__(self, args: ApplicationConfiguration): + def __init__(self, args: ApplicationConfiguration) -> None: """Initialize the ``:write`` action. :param args: The current settings for the application diff --git a/src/ansible_navigator/configuration_subsystem/configurator.py b/src/ansible_navigator/configuration_subsystem/configurator.py index ba442b4fb..d5c6f693e 100644 --- a/src/ansible_navigator/configuration_subsystem/configurator.py +++ b/src/ansible_navigator/configuration_subsystem/configurator.py @@ -35,7 +35,7 @@ def __init__( application_configuration: ApplicationConfiguration, apply_previous_cli_entries: list[str] | C = C.NONE, skip_roll_back: bool = False, - ): + ) -> None: """Initialize the configuration variables. :param params: A list of parameters e.g. ['-x', 'value'] diff --git a/src/ansible_navigator/configuration_subsystem/parser.py b/src/ansible_navigator/configuration_subsystem/parser.py index a18cd193b..4a1e9d1b6 100644 --- a/src/ansible_navigator/configuration_subsystem/parser.py +++ b/src/ansible_navigator/configuration_subsystem/parser.py @@ -18,7 +18,7 @@ class Parser: """Build the args.""" - def __init__(self, config: ApplicationConfiguration): + def __init__(self, config: ApplicationConfiguration) -> None: """Initialize the command line interface parameter parser. :param config: The current settings for the application diff --git a/src/ansible_navigator/data/catalog_collections.py b/src/ansible_navigator/data/catalog_collections.py index 209578593..918fa9fd0 100644 --- a/src/ansible_navigator/data/catalog_collections.py +++ b/src/ansible_navigator/data/catalog_collections.py @@ -56,7 +56,7 @@ class CollectionCatalog: """A collection cataloger.""" - def __init__(self, directories: list[Path]): + def __init__(self, directories: list[Path]) -> None: """Initialize the collection cataloger. :param directories: A list of directories that may contain collections diff --git a/src/ansible_navigator/diagnostics.py b/src/ansible_navigator/diagnostics.py index 45550ed1a..0dbc484d9 100644 --- a/src/ansible_navigator/diagnostics.py +++ b/src/ansible_navigator/diagnostics.py @@ -184,7 +184,7 @@ def __init__( args: ApplicationConfiguration, messages: list[LogMessage], exit_messages: list[ExitMessage], - ): + ) -> None: """Initialize the ShowTech class. :param args: The current settings diff --git a/src/ansible_navigator/image_manager/puller.py b/src/ansible_navigator/image_manager/puller.py index ab1808c39..4fe5d3d76 100644 --- a/src/ansible_navigator/image_manager/puller.py +++ b/src/ansible_navigator/image_manager/puller.py @@ -43,7 +43,7 @@ def __init__( image: str, arguments: Constants | list[str], pull_policy: str, - ): + ) -> None: """Initialize the container image puller. :param container_engine: The name of the container engine diff --git a/src/ansible_navigator/ui_framework/colorize.py b/src/ansible_navigator/ui_framework/colorize.py index 5b3f8b4ef..555e91374 100644 --- a/src/ansible_navigator/ui_framework/colorize.py +++ b/src/ansible_navigator/ui_framework/colorize.py @@ -49,7 +49,7 @@ class ColorSchema: """A storage mechanism for the schema (theme).""" - def __init__(self, schema: dict[str, str | list[Any] | dict[Any, Any]]): + def __init__(self, schema: dict[str, str | list[Any] | dict[Any, Any]]) -> None: """Initialize the ColorSchema class. :param schema: The color scheme, theme to use @@ -91,7 +91,7 @@ def get_color_and_style(self, scope: str) -> tuple[RgbTuple | None, str | None]: class Colorize: """Functionality for coloring.""" - def __init__(self, grammar_dir: Traversable, theme_path: Traversable): + def __init__(self, grammar_dir: Traversable, theme_path: Traversable) -> None: """Initialize the colorizer. :param grammar_dir: The directory in which the grammars reside diff --git a/src/ansible_navigator/ui_framework/curses_window.py b/src/ansible_navigator/ui_framework/curses_window.py index 8ca3a04ea..1fda7915f 100644 --- a/src/ansible_navigator/ui_framework/curses_window.py +++ b/src/ansible_navigator/ui_framework/curses_window.py @@ -48,7 +48,7 @@ class CursesWindow: # pylint: disable=too-many-instance-attributes """Abstraction for a curses window.""" - def __init__(self, ui_config: UIConfig): + def __init__(self, ui_config: UIConfig) -> None: """Initialize a curses window. :param ui_config: The current user interface configuration diff --git a/src/ansible_navigator/ui_framework/menu_builder.py b/src/ansible_navigator/ui_framework/menu_builder.py index 5ccb68185..27b913e40 100644 --- a/src/ansible_navigator/ui_framework/menu_builder.py +++ b/src/ansible_navigator/ui_framework/menu_builder.py @@ -35,7 +35,7 @@ def __init__( number_colors: int, color_menu_item: Callable[..., Any], ui_config: UIConfig, - ): + ) -> None: """Initialize the menu builder. :param progress_bar_width: The width of the progress bar diff --git a/src/ansible_navigator/utils/key_value_store.py b/src/ansible_navigator/utils/key_value_store.py index 858b362a9..7b1fca2ce 100644 --- a/src/ansible_navigator/utils/key_value_store.py +++ b/src/ansible_navigator/utils/key_value_store.py @@ -31,7 +31,7 @@ class KVSValuesView(ValuesView[str]): class KeyValueStore(MutableMapping[str, str]): """An interface to use a sqlite database as a key-value store.""" - def __init__(self, filename: str | Path): + def __init__(self, filename: str | Path) -> None: """Initialize the key-value store. :param filename: The full path to the sqlite database file diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py index 8c260863e..9f4c1d2eb 100644 --- a/tests/integration/conftest.py +++ b/tests/integration/conftest.py @@ -73,7 +73,7 @@ class CliRunner: def __init__( self, request: pytest.FixtureRequest, - ): + ) -> None: """Initialize the class. :param request: The current test request.