Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nhoad/flake8-unused-arguments

Flake8 plugin to warn against unused arguments in functions
https://github.com/nhoad/flake8-unused-arguments

Last synced: about 2 months ago
JSON representation

Flake8 plugin to warn against unused arguments in functions

Lists

README

        

# flake8-unused-arguments

A flake8 plugin that checks for unused function arguments.

This package adds the following warnings:

- `U100` - An unused argument.
- `U101` - An unused argument starting with an underscore

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-override-functions` - don't show warnings for overridden 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.
- `unused-arguments-ignore-nested-functions` - don't show warnings for nested
functions. Only show warnings for functions in the top level of a module, or methods
of a class in the top level of a module.
- `unused-arguments-ignore-dunder` - don't show warnings for double-underscore methods.
These methods implement or override native builtin methods which have a specific
signature. Therefore arguments must always be present. This is the case of methods
like `__new__`, `__init__`, `__getitem__`, `__setitem__`, `__reduce_ex__`,
`__enter__`, `__exit__`, etc.

## Changelog

0.0.13
- Added a new option for ignoring functions decorated with the override decorator. Thanks to Thomas M Kehrenberg for contributing this!

0.0.12
- Fixed an issue causing flake8 --help to break. Thanks to Calum Young for contributing this fix!
- Starting from this release, automated CI runs on each Github PR. Thanks again to Calum Young for contributing this work!

0.0.11
- Added a new option for ignoring functions decorated with overload.
- Added a new option for ignoring dunder methods (double-underscore) methods.

0.0.10
- Added new options for ignoring lambdas and nested functions. Thanks to João Eiras for contributing these!

0.0.9
- Check nested functions.
- Don't crash if an attribute is used in a raise statement.

0.0.8
- Whoops, report the right version when using flake8 --help.

0.0.7
- The first unused argument in a @classmethod decorated function wasn't properly detected. Thanks to Sebastian Dietrich for contributing the fix!

0.0.6
- Stub functions that have docstrings are now correctly detected as stub functions
- Functions with only a docstring are considered stub functions

0.0.5
- The positions reported are now for the arguments themselves, rather than the function

0.0.4
- Wrong project name in the readme, whoopsies

0.0.3
- treat functions that start with "raise NotImplementedError()" as stub functions

0.0.2
- fixed error in packaging

0.0.1
- initial release