flake8-builtins 2.2.0__tar.gz → 2.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,6 +3,13 @@
3
3
  Changelog
4
4
  =========
5
5
 
6
+ 2.3.0 (2024-03-29)
7
+ ------------------
8
+
9
+ - Add rule for builtin module name shadowing (`A005`).
10
+ [asfaltboy]
11
+
12
+
6
13
  2.2.0 (2023-11-03)
7
14
  ------------------
8
15
 
@@ -0,0 +1,143 @@
1
+ Metadata-Version: 2.1
2
+ Name: flake8-builtins
3
+ Version: 2.3.0
4
+ Summary: Check for python builtins being used as variables or parameters
5
+ Project-URL: Homepage, https://github.com/gforcada/flake8-builtins
6
+ Project-URL: Bug Tracker, https://github.com/gforcada/flake8-builtins/issues
7
+ Project-URL: Changelog, https://github.com/gforcada/flake8-builtins/blob/main/CHANGES.rst
8
+ Author-email: Gil Forcada Codinachs <gil.gnome@gmail.com>
9
+ License-File: LICENSE
10
+ Keywords: flake8,pep8,python
11
+ Classifier: Development Status :: 5 - Production/Stable
12
+ Classifier: Environment :: Console
13
+ Classifier: Framework :: Flake8
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3 :: Only
20
+ Classifier: Programming Language :: Python :: 3.8
21
+ Classifier: Programming Language :: Python :: 3.9
22
+ Classifier: Programming Language :: Python :: 3.10
23
+ Classifier: Programming Language :: Python :: 3.11
24
+ Classifier: Programming Language :: Python :: 3.12
25
+ Classifier: Programming Language :: Python :: Implementation :: CPython
26
+ Classifier: Programming Language :: Python :: Implementation :: PyPy
27
+ Classifier: Topic :: Software Development
28
+ Classifier: Topic :: Software Development :: Quality Assurance
29
+ Requires-Python: >=3.8
30
+ Requires-Dist: flake8
31
+ Provides-Extra: test
32
+ Requires-Dist: pytest; extra == 'test'
33
+ Description-Content-Type: text/x-rst
34
+
35
+ .. -*- coding: utf-8 -*-
36
+
37
+ .. image:: https://github.com/gforcada/flake8-builtins/actions/workflows/testing.yml/badge.svg?branch=main
38
+ :target: https://github.com/gforcada/flake8-builtins/actions/workflows/testing.yml
39
+
40
+ .. image:: https://coveralls.io/repos/gforcada/flake8-builtins/badge.svg?branch=main
41
+ :target: https://coveralls.io/github/gforcada/flake8-builtins?branch=main
42
+
43
+ Flake8 Builtins plugin
44
+ ======================
45
+ Check for python builtins being used as variables or parameters.
46
+
47
+ Imagine some code like this:
48
+
49
+ .. code:: Python
50
+
51
+ def max_values(list, list2):
52
+ max = list[0]
53
+ for x in list:
54
+ if x > 0:
55
+ max = x
56
+
57
+ all_values = list()
58
+ all_values.append(max)
59
+
60
+ max = list2[0]
61
+ for x in list2:
62
+ if x > 0:
63
+ max = x
64
+ all_values.append(max)
65
+
66
+ return all_values
67
+
68
+ max_values([3, 4, 5, ], [5, 6, 7])
69
+
70
+ The last statement is not returning ``[5, 7]`` as one would expect,
71
+ instead is raising this exception::
72
+
73
+ Traceback (most recent call last):
74
+ File "test.py", line 17, in <module>
75
+ max_values([3,4,5], [4,5,6])
76
+ File "bla.py", line 6, in max_values
77
+ all_values = list()
78
+ TypeError: 'list' object is not callable
79
+
80
+ **Why?** Because ``max_value`` function's first argument is ``list`` a Python builtin.
81
+ Python allows to override them, but although could be useful in some really specific use cases,
82
+ the general approach is to **not** do that as code then can suddenly break without a clear trace.
83
+
84
+ Example
85
+ -------
86
+ Given the following code:
87
+
88
+ .. code:: Python
89
+
90
+ def my_method(object, list, dict):
91
+ max = 5
92
+ min = 3
93
+ zip = (4, 3)
94
+
95
+ The following warnings are shown (via flake8)::
96
+
97
+ test.py:1:15: A002 argument "object" is shadowing a python builtin
98
+ test.py:1:23: A002 argument "list" is shadowing a python builtin
99
+ test.py:1:29: A002 argument "dict" is shadowing a python builtin
100
+ test.py:2:5: A001 variable "max" is shadowing a python builtin
101
+ test.py:3:5: A001 variable "min" is shadowing a python builtin
102
+ test.py:4:5: A001 variable "zip" is shadowing a python builtin
103
+
104
+ Install
105
+ -------
106
+ Install with pip::
107
+
108
+ $ python -m pip install flake8-builtins
109
+
110
+ Options
111
+ -------
112
+
113
+ One can use `--builtins-ignorelist` option, or configuration option,
114
+ to ignore a custom list of builtins::
115
+
116
+ $ flake8 --builtins-ignorelist id,copyright *.py
117
+
118
+ Requirements
119
+ ------------
120
+ - Python 3.8, 3.9, 3.10, 3.11, 3.12, and pypy3
121
+ - flake8
122
+
123
+ Rules
124
+ -----
125
+
126
+ A001:
127
+ A variable is shadowing a Python builtin.
128
+
129
+ A002:
130
+ An argument is shadowing a Python builtin.
131
+
132
+ A003:
133
+ A class attribute is shadowing a Python builtin.
134
+
135
+ A004:
136
+ An import statement is shadowing a Python builtin.
137
+
138
+ A005:
139
+ A module is shadowing a Python builtin module (e.g: `logging` or `socket`)
140
+
141
+ License
142
+ -------
143
+ GPL 2.0
@@ -83,7 +83,7 @@ to ignore a custom list of builtins::
83
83
 
84
84
  Requirements
85
85
  ------------
86
- - Python 3.8, 3.9, 3.10, 3.11, and pypy3
86
+ - Python 3.8, 3.9, 3.10, 3.11, 3.12, and pypy3
87
87
  - flake8
88
88
 
89
89
  Rules
@@ -101,6 +101,9 @@ A003:
101
101
  A004:
102
102
  An import statement is shadowing a Python builtin.
103
103
 
104
+ A005:
105
+ A module is shadowing a Python builtin module (e.g: `logging` or `socket`)
106
+
104
107
  License
105
108
  -------
106
109
  GPL 2.0
@@ -1,8 +1,10 @@
1
1
  from flake8 import utils as stdin_utils
2
+ from pathlib import Path
2
3
 
3
4
  import ast
4
5
  import builtins
5
6
  import inspect
7
+ import sys
6
8
 
7
9
 
8
10
  class BuiltinsChecker:
@@ -12,6 +14,7 @@ class BuiltinsChecker:
12
14
  argument_msg = 'A002 argument "{0}" is shadowing a Python builtin'
13
15
  class_attribute_msg = 'A003 class attribute "{0}" is shadowing a Python builtin'
14
16
  import_msg = 'A004 import statement "{0}" is shadowing a Python builtin'
17
+ module_name_msg = 'A005 the module is shadowing a Python builtin module "{0}"'
15
18
 
16
19
  names = []
17
20
  ignore_list = {
@@ -20,6 +23,7 @@ class BuiltinsChecker:
20
23
  'credits',
21
24
  '_',
22
25
  }
26
+ ignored_module_names = set()
23
27
 
24
28
  def __init__(self, tree, filename):
25
29
  self.tree = tree
@@ -34,6 +38,13 @@ class BuiltinsChecker:
34
38
  comma_separated_list=True,
35
39
  help='A comma separated list of builtins to skip checking',
36
40
  )
41
+ option_manager.add_option(
42
+ '--builtins-allowed-modules',
43
+ metavar='builtins',
44
+ parse_from_config=True,
45
+ comma_separated_list=True,
46
+ help='A comma separated list of builtin module names to allow',
47
+ )
37
48
 
38
49
  @classmethod
39
50
  def parse_options(cls, options):
@@ -47,12 +58,26 @@ class BuiltinsChecker:
47
58
  if flake8_builtins:
48
59
  cls.names.update(flake8_builtins)
49
60
 
61
+ if options.builtins_allowed_modules is not None:
62
+ cls.ignored_module_names.update(options.builtins_allowed_modules)
63
+
64
+ if hasattr(sys, 'stdlib_module_names'):
65
+ # stdlib_module_names is only available in Python 3.10+
66
+ known_module_names = sys.stdlib_module_names
67
+ cls.module_names = {
68
+ m for m in known_module_names if m not in cls.ignored_module_names
69
+ }
70
+ else:
71
+ cls.module_names = set()
72
+
50
73
  def run(self):
51
74
  tree = self.tree
52
75
 
53
76
  if self.filename == 'stdin':
54
77
  lines = stdin_utils.stdin_get_value()
55
78
  tree = ast.parse(lines)
79
+ else:
80
+ yield from self.check_module_name(self.filename)
56
81
 
57
82
  for statement in ast.walk(tree):
58
83
  for child in ast.iter_child_nodes(statement):
@@ -234,13 +259,26 @@ class BuiltinsChecker:
234
259
  if statement.name in self.names:
235
260
  yield self.error(statement, variable=statement.name)
236
261
 
237
- def error(self, statement, variable, message=None):
262
+ def error(self, statement=None, variable=None, message=None):
238
263
  if not message:
239
264
  message = self.assign_msg
240
265
 
266
+ # lineno and col_offset must be integers
241
267
  return (
242
- statement.lineno,
243
- statement.col_offset,
268
+ statement.lineno if statement else 0,
269
+ statement.col_offset if statement else 0,
244
270
  message.format(variable),
245
271
  type(self),
246
272
  )
273
+
274
+ def check_module_name(self, filename: str):
275
+ if not self.module_names:
276
+ return
277
+ path = Path(filename)
278
+ module_name = path.name.removesuffix('.py')
279
+ if module_name in self.module_names:
280
+ yield self.error(
281
+ None,
282
+ module_name,
283
+ message=self.module_name_msg,
284
+ )
@@ -4,13 +4,12 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "flake8-builtins"
7
- version = "2.2.0"
7
+ version = "2.3.0"
8
8
  authors = [
9
9
  { name="Gil Forcada Codinachs", email="gil.gnome@gmail.com" },
10
10
  ]
11
11
  description = "Check for python builtins being used as variables or parameters"
12
12
  keywords = ["pep8", "flake8", "python", ]
13
- license = {file = "LICENSE"}
14
13
  readme = "README.rst"
15
14
  requires-python = ">=3.8"
16
15
  classifiers = [
@@ -10,15 +10,25 @@ import textwrap
10
10
  class FakeOptions:
11
11
  builtins_ignorelist = []
12
12
  builtins = None
13
+ builtins_allowed_modules = None
13
14
 
14
- def __init__(self, ignore_list='', builtins=None):
15
+ def __init__(self, ignore_list='', builtins=None, builtins_allowed_modules=None):
15
16
  if ignore_list:
16
17
  self.builtins_ignorelist = ignore_list
17
18
  if builtins:
18
19
  self.builtins = builtins
19
-
20
-
21
- def check_code(source, expected_codes=None, ignore_list=None, builtins=None):
20
+ if builtins_allowed_modules:
21
+ self.builtins_allowed_modules = builtins_allowed_modules
22
+
23
+
24
+ def check_code(
25
+ source,
26
+ expected_codes=None,
27
+ ignore_list=None,
28
+ builtins=None,
29
+ builtins_allowed_modules=None,
30
+ filename='/home/script.py',
31
+ ):
22
32
  """Check if the given source code generates the given flake8 errors
23
33
 
24
34
  If `expected_codes` is a string is converted to a list,
@@ -37,8 +47,14 @@ def check_code(source, expected_codes=None, ignore_list=None, builtins=None):
37
47
  if ignore_list is None:
38
48
  ignore_list = []
39
49
  tree = ast.parse(textwrap.dedent(source))
40
- checker = BuiltinsChecker(tree, '/home/script.py')
41
- checker.parse_options(FakeOptions(ignore_list=ignore_list, builtins=builtins))
50
+ checker = BuiltinsChecker(tree, filename)
51
+ checker.parse_options(
52
+ FakeOptions(
53
+ ignore_list=ignore_list,
54
+ builtins=builtins,
55
+ builtins_allowed_modules=builtins_allowed_modules,
56
+ )
57
+ )
42
58
  return_statements = list(checker.run())
43
59
 
44
60
  assert len(return_statements) == len(expected_codes)
@@ -463,12 +479,36 @@ def test_async_with_nothing():
463
479
  def test_stdin(stdin_get_value):
464
480
  source = 'max = 4'
465
481
  stdin_get_value.return_value = source
466
- checker = BuiltinsChecker('', 'stdin')
467
- checker.parse_options(FakeOptions())
468
- ret = list(checker.run())
469
- assert len(ret) == 1
482
+ check_code('', expected_codes='A001', filename='stdin')
470
483
 
471
484
 
472
485
  def test_tuple_unpacking():
473
486
  source = 'a, *(b, c) = 1, 2, 3'
474
487
  check_code(source)
488
+
489
+
490
+ @pytest.mark.skipif(
491
+ sys.version_info < (3, 10),
492
+ reason='Skip A005, module testing is only supported in Python 3.10 and above',
493
+ )
494
+ def test_module_name():
495
+ source = ''
496
+ check_code(source, expected_codes='A005', filename='./temp/logging.py')
497
+
498
+
499
+ @pytest.mark.skipif(
500
+ sys.version_info < (3, 10),
501
+ reason='Skip A005, module testing is only supported in Python 3.10 and above',
502
+ )
503
+ def test_module_name_ignore_module():
504
+ source = ''
505
+ check_code(
506
+ source,
507
+ filename='./temp/logging.py',
508
+ builtins_allowed_modules=['logging'],
509
+ )
510
+
511
+
512
+ def test_module_name_not_builtin():
513
+ source = ''
514
+ check_code(source, filename='log_config')
@@ -44,6 +44,7 @@ description = get a test coverage report
44
44
  use_develop = true
45
45
  skip_install = false
46
46
  deps =
47
+ pytest-cov
47
48
  coverage
48
49
  commands =
49
50
  pytest run_tests.py --cov --cov-report term-missing
@@ -1,479 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: flake8-builtins
3
- Version: 2.2.0
4
- Summary: Check for python builtins being used as variables or parameters
5
- Project-URL: Homepage, https://github.com/gforcada/flake8-builtins
6
- Project-URL: Bug Tracker, https://github.com/gforcada/flake8-builtins/issues
7
- Project-URL: Changelog, https://github.com/gforcada/flake8-builtins/blob/main/CHANGES.rst
8
- Author-email: Gil Forcada Codinachs <gil.gnome@gmail.com>
9
- License: GNU GENERAL PUBLIC LICENSE
10
- Version 2, June 1991
11
-
12
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
13
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
14
- Everyone is permitted to copy and distribute verbatim copies
15
- of this license document, but changing it is not allowed.
16
-
17
- Preamble
18
-
19
- The licenses for most software are designed to take away your
20
- freedom to share and change it. By contrast, the GNU General Public
21
- License is intended to guarantee your freedom to share and change free
22
- software--to make sure the software is free for all its users. This
23
- General Public License applies to most of the Free Software
24
- Foundation's software and to any other program whose authors commit to
25
- using it. (Some other Free Software Foundation software is covered by
26
- the GNU Lesser General Public License instead.) You can apply it to
27
- your programs, too.
28
-
29
- When we speak of free software, we are referring to freedom, not
30
- price. Our General Public Licenses are designed to make sure that you
31
- have the freedom to distribute copies of free software (and charge for
32
- this service if you wish), that you receive source code or can get it
33
- if you want it, that you can change the software or use pieces of it
34
- in new free programs; and that you know you can do these things.
35
-
36
- To protect your rights, we need to make restrictions that forbid
37
- anyone to deny you these rights or to ask you to surrender the rights.
38
- These restrictions translate to certain responsibilities for you if you
39
- distribute copies of the software, or if you modify it.
40
-
41
- For example, if you distribute copies of such a program, whether
42
- gratis or for a fee, you must give the recipients all the rights that
43
- you have. You must make sure that they, too, receive or can get the
44
- source code. And you must show them these terms so they know their
45
- rights.
46
-
47
- We protect your rights with two steps: (1) copyright the software, and
48
- (2) offer you this license which gives you legal permission to copy,
49
- distribute and/or modify the software.
50
-
51
- Also, for each author's protection and ours, we want to make certain
52
- that everyone understands that there is no warranty for this free
53
- software. If the software is modified by someone else and passed on, we
54
- want its recipients to know that what they have is not the original, so
55
- that any problems introduced by others will not reflect on the original
56
- authors' reputations.
57
-
58
- Finally, any free program is threatened constantly by software
59
- patents. We wish to avoid the danger that redistributors of a free
60
- program will individually obtain patent licenses, in effect making the
61
- program proprietary. To prevent this, we have made it clear that any
62
- patent must be licensed for everyone's free use or not licensed at all.
63
-
64
- The precise terms and conditions for copying, distribution and
65
- modification follow.
66
-
67
- GNU GENERAL PUBLIC LICENSE
68
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
69
-
70
- 0. This License applies to any program or other work which contains
71
- a notice placed by the copyright holder saying it may be distributed
72
- under the terms of this General Public License. The "Program", below,
73
- refers to any such program or work, and a "work based on the Program"
74
- means either the Program or any derivative work under copyright law:
75
- that is to say, a work containing the Program or a portion of it,
76
- either verbatim or with modifications and/or translated into another
77
- language. (Hereinafter, translation is included without limitation in
78
- the term "modification".) Each licensee is addressed as "you".
79
-
80
- Activities other than copying, distribution and modification are not
81
- covered by this License; they are outside its scope. The act of
82
- running the Program is not restricted, and the output from the Program
83
- is covered only if its contents constitute a work based on the
84
- Program (independent of having been made by running the Program).
85
- Whether that is true depends on what the Program does.
86
-
87
- 1. You may copy and distribute verbatim copies of the Program's
88
- source code as you receive it, in any medium, provided that you
89
- conspicuously and appropriately publish on each copy an appropriate
90
- copyright notice and disclaimer of warranty; keep intact all the
91
- notices that refer to this License and to the absence of any warranty;
92
- and give any other recipients of the Program a copy of this License
93
- along with the Program.
94
-
95
- You may charge a fee for the physical act of transferring a copy, and
96
- you may at your option offer warranty protection in exchange for a fee.
97
-
98
- 2. You may modify your copy or copies of the Program or any portion
99
- of it, thus forming a work based on the Program, and copy and
100
- distribute such modifications or work under the terms of Section 1
101
- above, provided that you also meet all of these conditions:
102
-
103
- a) You must cause the modified files to carry prominent notices
104
- stating that you changed the files and the date of any change.
105
-
106
- b) You must cause any work that you distribute or publish, that in
107
- whole or in part contains or is derived from the Program or any
108
- part thereof, to be licensed as a whole at no charge to all third
109
- parties under the terms of this License.
110
-
111
- c) If the modified program normally reads commands interactively
112
- when run, you must cause it, when started running for such
113
- interactive use in the most ordinary way, to print or display an
114
- announcement including an appropriate copyright notice and a
115
- notice that there is no warranty (or else, saying that you provide
116
- a warranty) and that users may redistribute the program under
117
- these conditions, and telling the user how to view a copy of this
118
- License. (Exception: if the Program itself is interactive but
119
- does not normally print such an announcement, your work based on
120
- the Program is not required to print an announcement.)
121
-
122
- These requirements apply to the modified work as a whole. If
123
- identifiable sections of that work are not derived from the Program,
124
- and can be reasonably considered independent and separate works in
125
- themselves, then this License, and its terms, do not apply to those
126
- sections when you distribute them as separate works. But when you
127
- distribute the same sections as part of a whole which is a work based
128
- on the Program, the distribution of the whole must be on the terms of
129
- this License, whose permissions for other licensees extend to the
130
- entire whole, and thus to each and every part regardless of who wrote it.
131
-
132
- Thus, it is not the intent of this section to claim rights or contest
133
- your rights to work written entirely by you; rather, the intent is to
134
- exercise the right to control the distribution of derivative or
135
- collective works based on the Program.
136
-
137
- In addition, mere aggregation of another work not based on the Program
138
- with the Program (or with a work based on the Program) on a volume of
139
- a storage or distribution medium does not bring the other work under
140
- the scope of this License.
141
-
142
- 3. You may copy and distribute the Program (or a work based on it,
143
- under Section 2) in object code or executable form under the terms of
144
- Sections 1 and 2 above provided that you also do one of the following:
145
-
146
- a) Accompany it with the complete corresponding machine-readable
147
- source code, which must be distributed under the terms of Sections
148
- 1 and 2 above on a medium customarily used for software interchange; or,
149
-
150
- b) Accompany it with a written offer, valid for at least three
151
- years, to give any third party, for a charge no more than your
152
- cost of physically performing source distribution, a complete
153
- machine-readable copy of the corresponding source code, to be
154
- distributed under the terms of Sections 1 and 2 above on a medium
155
- customarily used for software interchange; or,
156
-
157
- c) Accompany it with the information you received as to the offer
158
- to distribute corresponding source code. (This alternative is
159
- allowed only for noncommercial distribution and only if you
160
- received the program in object code or executable form with such
161
- an offer, in accord with Subsection b above.)
162
-
163
- The source code for a work means the preferred form of the work for
164
- making modifications to it. For an executable work, complete source
165
- code means all the source code for all modules it contains, plus any
166
- associated interface definition files, plus the scripts used to
167
- control compilation and installation of the executable. However, as a
168
- special exception, the source code distributed need not include
169
- anything that is normally distributed (in either source or binary
170
- form) with the major components (compiler, kernel, and so on) of the
171
- operating system on which the executable runs, unless that component
172
- itself accompanies the executable.
173
-
174
- If distribution of executable or object code is made by offering
175
- access to copy from a designated place, then offering equivalent
176
- access to copy the source code from the same place counts as
177
- distribution of the source code, even though third parties are not
178
- compelled to copy the source along with the object code.
179
-
180
- 4. You may not copy, modify, sublicense, or distribute the Program
181
- except as expressly provided under this License. Any attempt
182
- otherwise to copy, modify, sublicense or distribute the Program is
183
- void, and will automatically terminate your rights under this License.
184
- However, parties who have received copies, or rights, from you under
185
- this License will not have their licenses terminated so long as such
186
- parties remain in full compliance.
187
-
188
- 5. You are not required to accept this License, since you have not
189
- signed it. However, nothing else grants you permission to modify or
190
- distribute the Program or its derivative works. These actions are
191
- prohibited by law if you do not accept this License. Therefore, by
192
- modifying or distributing the Program (or any work based on the
193
- Program), you indicate your acceptance of this License to do so, and
194
- all its terms and conditions for copying, distributing or modifying
195
- the Program or works based on it.
196
-
197
- 6. Each time you redistribute the Program (or any work based on the
198
- Program), the recipient automatically receives a license from the
199
- original licensor to copy, distribute or modify the Program subject to
200
- these terms and conditions. You may not impose any further
201
- restrictions on the recipients' exercise of the rights granted herein.
202
- You are not responsible for enforcing compliance by third parties to
203
- this License.
204
-
205
- 7. If, as a consequence of a court judgment or allegation of patent
206
- infringement or for any other reason (not limited to patent issues),
207
- conditions are imposed on you (whether by court order, agreement or
208
- otherwise) that contradict the conditions of this License, they do not
209
- excuse you from the conditions of this License. If you cannot
210
- distribute so as to satisfy simultaneously your obligations under this
211
- License and any other pertinent obligations, then as a consequence you
212
- may not distribute the Program at all. For example, if a patent
213
- license would not permit royalty-free redistribution of the Program by
214
- all those who receive copies directly or indirectly through you, then
215
- the only way you could satisfy both it and this License would be to
216
- refrain entirely from distribution of the Program.
217
-
218
- If any portion of this section is held invalid or unenforceable under
219
- any particular circumstance, the balance of the section is intended to
220
- apply and the section as a whole is intended to apply in other
221
- circumstances.
222
-
223
- It is not the purpose of this section to induce you to infringe any
224
- patents or other property right claims or to contest validity of any
225
- such claims; this section has the sole purpose of protecting the
226
- integrity of the free software distribution system, which is
227
- implemented by public license practices. Many people have made
228
- generous contributions to the wide range of software distributed
229
- through that system in reliance on consistent application of that
230
- system; it is up to the author/donor to decide if he or she is willing
231
- to distribute software through any other system and a licensee cannot
232
- impose that choice.
233
-
234
- This section is intended to make thoroughly clear what is believed to
235
- be a consequence of the rest of this License.
236
-
237
- 8. If the distribution and/or use of the Program is restricted in
238
- certain countries either by patents or by copyrighted interfaces, the
239
- original copyright holder who places the Program under this License
240
- may add an explicit geographical distribution limitation excluding
241
- those countries, so that distribution is permitted only in or among
242
- countries not thus excluded. In such case, this License incorporates
243
- the limitation as if written in the body of this License.
244
-
245
- 9. The Free Software Foundation may publish revised and/or new versions
246
- of the General Public License from time to time. Such new versions will
247
- be similar in spirit to the present version, but may differ in detail to
248
- address new problems or concerns.
249
-
250
- Each version is given a distinguishing version number. If the Program
251
- specifies a version number of this License which applies to it and "any
252
- later version", you have the option of following the terms and conditions
253
- either of that version or of any later version published by the Free
254
- Software Foundation. If the Program does not specify a version number of
255
- this License, you may choose any version ever published by the Free Software
256
- Foundation.
257
-
258
- 10. If you wish to incorporate parts of the Program into other free
259
- programs whose distribution conditions are different, write to the author
260
- to ask for permission. For software which is copyrighted by the Free
261
- Software Foundation, write to the Free Software Foundation; we sometimes
262
- make exceptions for this. Our decision will be guided by the two goals
263
- of preserving the free status of all derivatives of our free software and
264
- of promoting the sharing and reuse of software generally.
265
-
266
- NO WARRANTY
267
-
268
- 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
269
- FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
270
- OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
271
- PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
272
- OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
273
- MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
274
- TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
275
- PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
276
- REPAIR OR CORRECTION.
277
-
278
- 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
279
- WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
280
- REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
281
- INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
282
- OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
283
- TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
284
- YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
285
- PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
286
- POSSIBILITY OF SUCH DAMAGES.
287
-
288
- END OF TERMS AND CONDITIONS
289
-
290
- How to Apply These Terms to Your New Programs
291
-
292
- If you develop a new program, and you want it to be of the greatest
293
- possible use to the public, the best way to achieve this is to make it
294
- free software which everyone can redistribute and change under these terms.
295
-
296
- To do so, attach the following notices to the program. It is safest
297
- to attach them to the start of each source file to most effectively
298
- convey the exclusion of warranty; and each file should have at least
299
- the "copyright" line and a pointer to where the full notice is found.
300
-
301
- <one line to give the program's name and a brief idea of what it does.>
302
- Copyright (C) <year> <name of author>
303
-
304
- This program is free software; you can redistribute it and/or modify
305
- it under the terms of the GNU General Public License as published by
306
- the Free Software Foundation; either version 2 of the License, or
307
- (at your option) any later version.
308
-
309
- This program is distributed in the hope that it will be useful,
310
- but WITHOUT ANY WARRANTY; without even the implied warranty of
311
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
312
- GNU General Public License for more details.
313
-
314
- You should have received a copy of the GNU General Public License along
315
- with this program; if not, write to the Free Software Foundation, Inc.,
316
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
317
-
318
- Also add information on how to contact you by electronic and paper mail.
319
-
320
- If the program is interactive, make it output a short notice like this
321
- when it starts in an interactive mode:
322
-
323
- Gnomovision version 69, Copyright (C) year name of author
324
- Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
325
- This is free software, and you are welcome to redistribute it
326
- under certain conditions; type `show c' for details.
327
-
328
- The hypothetical commands `show w' and `show c' should show the appropriate
329
- parts of the General Public License. Of course, the commands you use may
330
- be called something other than `show w' and `show c'; they could even be
331
- mouse-clicks or menu items--whatever suits your program.
332
-
333
- You should also get your employer (if you work as a programmer) or your
334
- school, if any, to sign a "copyright disclaimer" for the program, if
335
- necessary. Here is a sample; alter the names:
336
-
337
- Yoyodyne, Inc., hereby disclaims all copyright interest in the program
338
- `Gnomovision' (which makes passes at compilers) written by James Hacker.
339
-
340
- <signature of Ty Coon>, 1 April 1989
341
- Ty Coon, President of Vice
342
-
343
- This General Public License does not permit incorporating your program into
344
- proprietary programs. If your program is a subroutine library, you may
345
- consider it more useful to permit linking proprietary applications with the
346
- library. If this is what you want to do, use the GNU Lesser General
347
- Public License instead of this License.
348
- License-File: LICENSE
349
- Keywords: flake8,pep8,python
350
- Classifier: Development Status :: 5 - Production/Stable
351
- Classifier: Environment :: Console
352
- Classifier: Framework :: Flake8
353
- Classifier: Intended Audience :: Developers
354
- Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
355
- Classifier: Operating System :: OS Independent
356
- Classifier: Programming Language :: Python
357
- Classifier: Programming Language :: Python :: 3
358
- Classifier: Programming Language :: Python :: 3 :: Only
359
- Classifier: Programming Language :: Python :: 3.8
360
- Classifier: Programming Language :: Python :: 3.9
361
- Classifier: Programming Language :: Python :: 3.10
362
- Classifier: Programming Language :: Python :: 3.11
363
- Classifier: Programming Language :: Python :: 3.12
364
- Classifier: Programming Language :: Python :: Implementation :: CPython
365
- Classifier: Programming Language :: Python :: Implementation :: PyPy
366
- Classifier: Topic :: Software Development
367
- Classifier: Topic :: Software Development :: Quality Assurance
368
- Requires-Python: >=3.8
369
- Requires-Dist: flake8
370
- Provides-Extra: test
371
- Requires-Dist: pytest; extra == 'test'
372
- Description-Content-Type: text/x-rst
373
-
374
- .. -*- coding: utf-8 -*-
375
-
376
- .. image:: https://github.com/gforcada/flake8-builtins/actions/workflows/testing.yml/badge.svg?branch=main
377
- :target: https://github.com/gforcada/flake8-builtins/actions/workflows/testing.yml
378
-
379
- .. image:: https://coveralls.io/repos/gforcada/flake8-builtins/badge.svg?branch=main
380
- :target: https://coveralls.io/github/gforcada/flake8-builtins?branch=main
381
-
382
- Flake8 Builtins plugin
383
- ======================
384
- Check for python builtins being used as variables or parameters.
385
-
386
- Imagine some code like this:
387
-
388
- .. code:: Python
389
-
390
- def max_values(list, list2):
391
- max = list[0]
392
- for x in list:
393
- if x > 0:
394
- max = x
395
-
396
- all_values = list()
397
- all_values.append(max)
398
-
399
- max = list2[0]
400
- for x in list2:
401
- if x > 0:
402
- max = x
403
- all_values.append(max)
404
-
405
- return all_values
406
-
407
- max_values([3, 4, 5, ], [5, 6, 7])
408
-
409
- The last statement is not returning ``[5, 7]`` as one would expect,
410
- instead is raising this exception::
411
-
412
- Traceback (most recent call last):
413
- File "test.py", line 17, in <module>
414
- max_values([3,4,5], [4,5,6])
415
- File "bla.py", line 6, in max_values
416
- all_values = list()
417
- TypeError: 'list' object is not callable
418
-
419
- **Why?** Because ``max_value`` function's first argument is ``list`` a Python builtin.
420
- Python allows to override them, but although could be useful in some really specific use cases,
421
- the general approach is to **not** do that as code then can suddenly break without a clear trace.
422
-
423
- Example
424
- -------
425
- Given the following code:
426
-
427
- .. code:: Python
428
-
429
- def my_method(object, list, dict):
430
- max = 5
431
- min = 3
432
- zip = (4, 3)
433
-
434
- The following warnings are shown (via flake8)::
435
-
436
- test.py:1:15: A002 argument "object" is shadowing a python builtin
437
- test.py:1:23: A002 argument "list" is shadowing a python builtin
438
- test.py:1:29: A002 argument "dict" is shadowing a python builtin
439
- test.py:2:5: A001 variable "max" is shadowing a python builtin
440
- test.py:3:5: A001 variable "min" is shadowing a python builtin
441
- test.py:4:5: A001 variable "zip" is shadowing a python builtin
442
-
443
- Install
444
- -------
445
- Install with pip::
446
-
447
- $ python -m pip install flake8-builtins
448
-
449
- Options
450
- -------
451
-
452
- One can use `--builtins-ignorelist` option, or configuration option,
453
- to ignore a custom list of builtins::
454
-
455
- $ flake8 --builtins-ignorelist id,copyright *.py
456
-
457
- Requirements
458
- ------------
459
- - Python 3.8, 3.9, 3.10, 3.11, and pypy3
460
- - flake8
461
-
462
- Rules
463
- -----
464
-
465
- A001:
466
- A variable is shadowing a Python builtin.
467
-
468
- A002:
469
- An argument is shadowing a Python builtin.
470
-
471
- A003:
472
- A class attribute is shadowing a Python builtin.
473
-
474
- A004:
475
- An import statement is shadowing a Python builtin.
476
-
477
- License
478
- -------
479
- GPL 2.0
@@ -1,9 +0,0 @@
1
- [zest.releaser]
2
- create-wheel = yes
3
-
4
- [check-manifest]
5
- ignore =
6
- .installed.cfg
7
-
8
- [isort]
9
- profile = black
File without changes
File without changes