OLD | NEW |
1 # flake8-abp | 1 # flake8-eyeo |
2 | 2 |
3 A [flake8](https://flake8.readthedocs.io) extension that checks for compliance | 3 A [flake8](https://flake8.readthedocs.io) extension that checks for compliance |
4 with the [Adblock Plus coding style guide](https://adblockplus.org/coding-style#
python) | 4 with the |
5 and some bad practices which flake8 doesn't handle by default. | 5 [Adblock Plus coding style guide](https://adblockplus.org/coding-style#python) |
| 6 which is used for all eyeo projects, and some bad practices which flake8 doesn't |
| 7 handle by default. |
6 | 8 |
7 | 9 |
8 ## Installation | 10 ## Installation |
9 | 11 |
10 Run `python setup.py install`. | 12 Run `python setup.py install`. |
11 | 13 |
12 | 14 |
13 ## Usage | 15 ## Usage |
14 | 16 |
15 Just run `flake8` (you have to install it seperately) on your source files. | 17 Just run `flake8` (you have to install it seperately) on your source files. |
16 After installation the `flake8-abp` extension is active by default. | 18 After installation the `flake8-eyeo` extension is active by default. |
17 | 19 |
18 | 20 |
19 ## Warnings | 21 ## Warnings |
20 | 22 |
21 ### Readability and consistency | 23 ### Readability and consistency |
22 | 24 |
23 * `A101`: Loop over a tuple or set literal; use lists for data that have order | 25 * `A101`: Loop over a tuple or set literal; use lists for data that have order |
24 * `A102`: Membership check on a tuple or list literal; use a set here | 26 * `A102`: Membership check on a tuple or list literal; use a set here |
25 * `A103`: Yoda condition | 27 * `A103`: Yoda condition |
26 * `A104`: `map()` or `filter()` called with lambda function | 28 * `A104`: `map()` or `filter()` called with lambda function |
(...skipping 19 matching lines...) Expand all Loading... |
46 * `A205`: Superfluos empty block | 48 * `A205`: Superfluos empty block |
47 * `A206`: Extraneous `else` statement after block is left | 49 * `A206`: Extraneous `else` statement after block is left |
48 * `A207`: Duplicate key in dict or set | 50 * `A207`: Duplicate key in dict or set |
49 | 51 |
50 | 52 |
51 ### Error-prone practices | 53 ### Error-prone practices |
52 | 54 |
53 * `A301`: Discouraged APIs | 55 * `A301`: Discouraged APIs |
54 * `A302`: Redefinition of built-in name | 56 * `A302`: Redefinition of built-in name |
55 * `A303`: Non-default source file encoding | 57 * `A303`: Non-default source file encoding |
OLD | NEW |