Add an option to include functions decorated with @overload.

Fixes nhoad#10.

Author: nhoad

README.md

@@ -9,6 +9,7 @@ This package adds the following warnings:
 
 Configuration options also exist:
  - `unused-arguments-ignore-abstract-functions` - don't show warnings for abstract functions.
+ - `unused-arguments-ignore-overload-functions` - don't show warnings for overload functions.
  - `unused-arguments-ignore-stub-functions` - don't show warnings for empty functions.
  - `unused-arguments-ignore-variadic-names` - don't show warnings for unused *args and **kwargs.
  - `unused-arguments-ignore-lambdas` - don't show warnings for all lambdas.
@@ -23,6 +24,9 @@ Configuration options also exist:
 
 ## Changelog
 
+0.0.11
+ - Added a new option for ignoring functions decorated with overload.
+
 0.0.10
  - Added new options for ignoring lambdas and nested functions. Thanks to João Eiras for contributing these!
 

flake8_unused_arguments.py

@@ -15,6 +15,7 @@ class Plugin:
     version = "0.0.10"
 
     ignore_abstract = False
+    ignore_overload = False
     ignore_stubs = False
     ignore_variadic_names = False
     ignore_lambdas = False
@@ -35,6 +36,15 @@ def add_options(cls, option_manager: flake8.options.manager.OptionManager) -> No
             help="If provided, then unused arguments for functions decorated with abstractmethod will be ignored.",
         )
 
+        option_manager.add_option(
+            "--unused-arguments-ignore-overload-functions",
+            action="store_true",
+            parse_from_config=True,
+            default=cls.ignore_overload,
+            dest="unused_arguments_ignore_overload_functions",
+            help="If provided, then unused arguments for functions decorated with overload will be ignored.",
+        )
+
         option_manager.add_option(
             "--unused-arguments-ignore-stub-functions",
             action="store_true",
@@ -89,6 +99,7 @@ def add_options(cls, option_manager: flake8.options.manager.OptionManager) -> No
     @classmethod
     def parse_options(cls, options: optparse.Values) -> None:
         cls.ignore_abstract = options.unused_arguments_ignore_abstract_functions
+        cls.ignore_overload = options.unused_arguments_ignore_overload_functions
         cls.ignore_stubs = options.unused_arguments_ignore_stub_functions
         cls.ignore_variadic_names = options.unused_arguments_ignore_variadic_names
         cls.ignore_lambdas = options.unused_arguments_ignore_lambdas
@@ -101,7 +112,12 @@ def run(self) -> Iterable[LintResult]:
 
         for function in finder.functions:
             decorator_names = set(get_decorator_names(function))
-            # ignore abtractmethods, it's not a surprise when they're empty
+
+            # ignore overload functions, it's not a surprise when they're empty
+            if self.ignore_overload and "overload" in decorator_names:
+                continue
+
+            # ignore abstractmethods, it's not a surprise when they're empty
             if self.ignore_abstract and "abstractmethod" in decorator_names:
                 continue
 

test_unused_arguments.py

@@ -178,6 +178,24 @@ def foo(a):
         ),
         (
             """
+    @overload
+    def foo(a):
+        pass
+    """,
+            {"ignore_overload": False},
+            [(3, 8, "U100 Unused argument 'a'", "unused argument")],
+        ),
+        (
+            """
+    @overload
+    def foo(a):
+        pass
+    """,
+            {"ignore_overload": True},
+            [],
+        ),
+        (
+            """
     def foo(a):
         pass
     """,