Add support for async functions.

Author: domdfcoding

flake8_params/__init__.py

@@ -137,9 +137,13 @@ class Visitor(flake8_helper.Visitor):
 	AST node visitor for identifying mismatches between function signatures and docstring params.
 	"""
 
-	# TODO: async functions
-
 	def visit_FunctionDef(self, node: ast.FunctionDef) -> None:  # noqa: D102
+		self._visit_function(node)
+
+	def visit_AsyncFunctionDef(self, node: ast.AsyncFunctionDef) -> None:  # noqa: D102
+		self._visit_function(node)
+
+	def _visit_function(self, node: Union[ast.FunctionDef, ast.AsyncFunctionDef]) -> None:
 		if node.name == "__init__":
 			self.generic_visit(node)
 			return
@@ -198,7 +202,8 @@ def visit_ClassDef(self, node: ast.ClassDef) -> None:  # noqa: D102
 		else:
 			# No __init__; maybe it comes from a base class.
 			# TODO: check for base classes and still error if non exist
-			return None
+			self.generic_visit(node)
+			return
 
 		error = check_params(signature_args, docstring_args, decorators)
 		if not error:

repo_helper.yml

@@ -12,7 +12,7 @@ license: 'MIT'
 short_desc: "A flake8 plugin which checks for mismatches between function signatures and docstring params."
 
 use_whey: true
-min_coverage: 97
+min_coverage: 100
 sphinx_html_theme: furo
 docs_fail_on_warning: true
 enable_conda: false

tests/example_code.py

@@ -190,3 +190,100 @@ def a_command(foo):
 
 def no_docstring(foo, bar, baz):
 	pass
+
+
+async def missing_in_docstring_async(foo, bar, baz):
+	"""
+	Does something.
+
+	:param foo:
+	:param bar:
+	"""
+
+
+async def has_self_async(self, foo, bar, baz):
+	"""
+	Does something.
+
+	:param foo:
+	:param bar:
+	:param baz:
+	"""
+
+
+async def missing_in_docstring_with_self_async(self, foo, bar, baz):
+	"""
+	Does something.
+
+	:param bar:
+	:param baz:
+	"""
+
+
+async def docstring_wrong_order_async(self, foo, bar, baz):
+	"""
+	Does something.
+
+	:param bar:
+	:param foo:
+	:param baz:
+	"""
+
+
+async def missing_in_signature_async(foo, bar):
+	"""
+	Does something.
+
+	:param foo:
+	:param bar:
+	:param baz:
+	"""
+
+
+async def missing_in_signature_with_self_async(self, foo, bar):
+	"""
+	Does something.
+
+	:param foo:
+	:param bar:
+	:param baz:
+	"""
+
+
+class AsyncClass:
+	"""
+	A class.
+	"""
+
+	@classmethod
+	async def is_classmethod(cls, foo, bar, baz):
+		"""
+		Does something.
+
+		:param foo:
+		:param bar:
+		:param baz:
+		"""
+
+	@classmethod
+	async def missing_in_docstring_with_classmethod(cls, foo, bar, baz):
+		"""
+		Does something.
+
+		:param foo:
+		:param baz:
+		"""
+
+	@classmethod
+	async def missing_in_signature_with_classmethod(cls, foo, baz):
+		"""
+		Does something.
+
+		:param foo:
+		:param bar:
+		:param baz:
+		"""
+
+
+async def no_docstring_async(foo, bar, baz):
+	pass

tests/test_flake8_params_/test_plugin.txt

@@ -8,3 +8,10 @@
 90:1: PRM003 Extra parameters in docstring.
 112:0: PRM003 Extra parameters in docstring.
 125:0: PRM001 Docstring parameters in wrong order.
+195:0: PRM002 Missing parameters in docstring.
+214:0: PRM002 Missing parameters in docstring.
+223:0: PRM001 Docstring parameters in wrong order.
+233:0: PRM003 Extra parameters in docstring.
+243:0: PRM003 Extra parameters in docstring.
+269:1: PRM002 Missing parameters in docstring.
+278:1: PRM003 Extra parameters in docstring.

tox.ini

@@ -195,7 +195,7 @@ unused-arguments-ignore-variadic-names = True
 plugins = coverage_pyver_pragma
 
 [coverage:report]
-fail_under = 97
+fail_under = 100
 show_missing = True
 exclude_lines =
     raise AssertionError