Metadata-Version: 1.1
Name: flake8-builtins
Version: 0.3
Summary: Check for python builtins being used as variables or parameters.
Home-page: https://github.com/gforcada/flake8-builtins
Author: Gil Forcada
Author-email: gil.gnome@gmail.com
License: GPL version 2
Description: .. -*- coding: utf-8 -*-
        
        .. image:: https://travis-ci.org/gforcada/flake8-builtins.svg?branch=master
           :target: https://travis-ci.org/gforcada/flake8-builtins
        
        .. image:: https://coveralls.io/repos/gforcada/flake8-builtins/badge.svg?branch=master&service=github
           :target: https://coveralls.io/github/gforcada/flake8-builtins?branch=master
        
        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
        
        .. -*- coding: utf-8 -*-
        
        Changelog
        =========
        
        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]
        
Keywords: pep8 flake8 python
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development
