Skip to main content

Check for python builtins being used as variables or parameters.

Project description

https://travis-ci.org/gforcada/flake8-builtins.svg?branch=master https://coveralls.io/repos/gforcada/flake8-builtins/badge.svg?branch=master&service=github

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: A002 "object" is used as an argument and thus shadows a python builtin, consider renaming the argument
test.py:1:23: A002 "list" is used as an argument and thus shadows a python builtin, consider renaming the argument
test.py:1:29: A002 "dict" is used as an argument and thus shadows a python builtin, consider renaming the argument
test.py:2:5: A001 "max" is a python builtin and is being shadowed, consider renaming the variable
test.py:3:5: A001 "min" is a python builtin and is being shadowed, consider renaming the variable
test.py:4:5: A001 "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.5, 3.6

  • flake8

License

GPL 2.0

Changelog

1.5.2 (2020-03-16)

  • Add DictComp, SetComp, and GeneratorExpr support. [sobolevn]

1.5.1 (2020-03-16)

  • Adds kwonly and posonly args support. [sobolevn]

1.5.0 (2020-03-14)

  • Add python3.8 support. [sobolevn]

  • Add AnnAssign support. [soboelvn]

  • Add NamedExpr or := support. [sobolevn]

1.4.2 (2019-12-18)

  • Fix tuple parsing. [memery-imb]

1.4.1 (2018-05-11)

  • Fix regression in 1.4.0 and interaction with flake8-bugbear. [dirk-thomas]

1.4.0 (2018-05-03)

  • Make code more robust by not assuming that a node is an ast.Name but actually checking it. [gforcada]

  • Handle ast.Starred as well (i.e. a, *int = range(4)) [gforcada]

  • Handle lists as well, i.e. [a, int] = 3, 4 [gforcada]

1.3.1 (2018-04-30)

1.3.0 (2018-04-13)

1.2.3 (2018-04-10)

1.2.2 (2018-04-03)

1.2.1 (2018-04-01)

  • re-relase 1.2 from master branch. [gforcada]

1.2 (2018-04-01)

  • Fix error message in for loops. [gforcada]

  • Inspect the following places for possible builtins being shadowed:

    • with open(‘/tmp/bla.txt’) as int

    • except ValueError as int

    • [int for int in range(4)]

    • from zope.component import provide as int

    • import zope.component as int

    • class int(object)

    • def int()

    • async def int()

    • async for int in range(4)

    • async with open(‘/tmp/bla.txt’) as int

    [gforcada]

1.1.1 (2018-03-20)

  • Variables assigned in a for loop can be not only a Tuple, but a Tuple inside a Tuple. [dopplershift]

1.1.0 (2018-03-17)

  • Update more trove classifiers. [gforcada]

  • Inspect variables assigned in a for loop as well. Thanks to sobolevn for reporting it! [gforcada]

1.0.post0 (2017-12-02)

  • Update README. [DmytroLitvinov]

  • Update trove classifiers. [dirn]

1.0 (2017-08-19)

  • Use requirements.txt to pin dependencies. [gforcada]

  • Fix tests with newer flake8 version. [gforcada]

  • BREAKING CHANGE: error codes have been changed from B00X to A00X to not clash with flake8-bugbear, see https://github.com/gforcada/flake8-builtins/issues/7 [gforcada]

0.4 (2017-05-29)

  • Use a different code for class attributes. [karamanolev]

0.3.1.post0 (2017-05-27)

  • Release universal wheels, not only python 2 wheels. [gforcada]

  • Update trove classifiers. [gforcada]

0.3.1 (2017-05-27)

  • Fix stdin handling. [sangiovanni]

0.3 (2017-05-15)

  • Handle stdin, which is the way flake8 gets integrated into editors. [gforcada]

  • Test against Python 2.7, 3.5, 3.6 and pypy. [gforcada]

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]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8-builtins-1.5.2.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

flake8_builtins-1.5.2-py2.py3-none-any.whl (13.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file flake8-builtins-1.5.2.tar.gz.

File metadata

  • Download URL: flake8-builtins-1.5.2.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for flake8-builtins-1.5.2.tar.gz
Algorithm Hash digest
SHA256 fe7be13fe51bfb06bdae6096c6488e328c822c3aa080e24b91b77116a4fbb8b0
MD5 22ade09660c287e87971b20cd1a4f8d3
BLAKE2b-256 303ed4da21c8eed7ddb1515e239e2d8eebbc5b54c4eaf32f291445239b3abd48

See more details on using hashes here.

File details

Details for the file flake8_builtins-1.5.2-py2.py3-none-any.whl.

File metadata

  • Download URL: flake8_builtins-1.5.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for flake8_builtins-1.5.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a0296d23da92a6f2494243b9f2039bfdb73f34aba20054c1b70b2a60c84745bb
MD5 c679caa1323dc7393f8a5f2569225954
BLAKE2b-256 39b20302c76e17bae9ac6772cdcc973320a3f3ce9aab54914707390b179cdc21

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page