Check for python builtins being used as variables or parameters.
Project description
Flake8 Builtins plugin
Check for python builtins being used as variables or parameters.
Imagine some code like this:
def max_values(list, list2):
max = list[0]
for x in list:
if x > 0:
max = x
all_values = list()
all_values.append(max)
max = list2[0]
for x in list2:
if x > 0:
max = x
all_values.append(max)
return all_values
max_values([3, 4, 5, ], [5, 6, 7])
The last statement is not returning [5, 7] as one would expect, instead is raising this exception:
Traceback (most recent call last):
File "test.py", line 17, in <module>
max_values([3,4,5], [4,5,6])
File "bla.py", line 6, in max_values
all_values = list()
TypeError: 'list' object is not callable
Why? Because max_value function’s first argument is list a Python builtin. Python allows to override them, but although could be useful in some really specific use cases, the general approach is to not do that as code then can suddenly break without a clear trace.
Example
Given the following code:
def my_method(object, list, dict):
max = 5
min = 3
zip = (4, 3)
The following warnings are shown (via flake8):
test.py:1:15: B002 "object" is used as an argument and thus shadows a python builtin, consider renaming the argument test.py:1:23: B002 "list" is used as an argument and thus shadows a python builtin, consider renaming the argument test.py:1:29: B002 "dict" is used as an argument and thus shadows a python builtin, consider renaming the argument test.py:2:5: B001 "max" is a python builtin and is being shadowed, consider renaming the variable test.py:3:5: B001 "min" is a python builtin and is being shadowed, consider renaming the variable test.py:4:5: B001 "zip" is a python builtin and is being shadowed, consider renaming the variable
Install
Install with pip:
$ pip install flake8-builtins
Requirements
Python 2.7, 3.3, 3.4
flake8
License
GPL 2.0
Changelog
0.2 (2016-03-30)
Whitelist some builtins. [gforcada]
0.1 (2016-03-04)
Initial release [gforcada]
Add buildout and other stuff. [gforcada]
Add actual code. [gforcada]
Drop support for python 3.3, only python 2.7 and python 3.4 are tested. [gforcada]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flake8_builtins-0.2-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b8a407ba5722e54ef783cf009a6aeb204f695b18a51eed29e65e0f32b55e441c |
|
| MD5 | 8fe014b50df12ec465eb593dccfe63f0 |
|
| BLAKE2b-256 | c376960e80c88280844b5dd55b2e23b088de17676f7829ef28f020de685fff2b |
