├── .flake8 ├── .github └── workflows │ └── testing.yml ├── .gitignore ├── .pre-commit-config.yaml ├── CHANGES.rst ├── LICENSE ├── MANIFEST.in ├── README.rst ├── flake8_pep3101.py ├── pyproject.toml ├── run_tests.py └── tox.ini /.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | doctests = 1 3 | ignore = 4 | # black takes care of line length 5 | E501, 6 | # black takes care of where to break lines 7 | W503, 8 | # black takes care of spaces within slicing (list[:]) 9 | E203, 10 | # black takes care of spaces after commas 11 | E231, 12 | # as one has to use self.XX it should not be a problem 13 | A003, 14 | -------------------------------------------------------------------------------- /.github/workflows/testing.yml: -------------------------------------------------------------------------------- 1 | name: Testing 2 | on: 3 | push: 4 | branches: [main] 5 | pull_request: 6 | branches: [main] 7 | env: 8 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 9 | jobs: 10 | test: 11 | name: Testing on 12 | runs-on: "ubuntu-latest" 13 | strategy: 14 | matrix: 15 | python-version: ["3.12", "3.11", "3.10", 3.9, 3.8, pypy-3.9] 16 | steps: 17 | - uses: actions/checkout@v4 18 | - name: Set up Python 19 | uses: actions/setup-python@v4 20 | with: 21 | python-version: ${{ matrix.python-version }} 22 | - name: Cache packages 23 | uses: actions/cache@v3 24 | with: 25 | path: ~/.cache/pip 26 | key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('tox.ini') }} 27 | restore-keys: | 28 | ${{ runner.os }}-pip-${{ matrix.python-version }}- 29 | - name: Install dependencies 30 | run: python -m pip install tox 31 | - name: Test 32 | run: tox -e test 33 | 34 | lint: 35 | name: Lint code 36 | runs-on: "ubuntu-latest" 37 | strategy: 38 | matrix: 39 | python-version: [3.8] 40 | steps: 41 | - uses: actions/checkout@v4 42 | - name: Set up Python 43 | uses: actions/setup-python@v4 44 | with: 45 | python-version: ${{ matrix.python-version }} 46 | - name: Cache packages 47 | uses: actions/cache@v3 48 | with: 49 | path: | 50 | ~/.cache/pre-commit 51 | ~/.cache/pip 52 | key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('tox.ini') }} 53 | restore-keys: | 54 | ${{ runner.os }}-pip-${{ matrix.python-version }}- 55 | - name: Install dependencies 56 | run: python -m pip install tox 57 | - name: Run linting 58 | run: tox -e lint 59 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.egg-info 2 | *.pyc 3 | 4 | .cache 5 | .coverage 6 | .installed.cfg 7 | .hypothesis 8 | bin 9 | develop-eggs 10 | include 11 | lib 12 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | ci: 2 | autofix_prs: false 3 | autoupdate_schedule: monthly 4 | 5 | repos: 6 | - repo: https://github.com/asottile/pyupgrade 7 | rev: v3.14.0 8 | hooks: 9 | - id: pyupgrade 10 | args: [--py38-plus] 11 | - repo: https://github.com/pycqa/isort 12 | rev: 5.12.0 13 | hooks: 14 | - id: isort 15 | - repo: https://github.com/psf/black 16 | rev: 23.9.1 17 | hooks: 18 | - id: black 19 | - repo: https://github.com/PyCQA/flake8 20 | rev: 6.1.0 21 | hooks: 22 | - id: flake8 23 | additional_dependencies: 24 | - flake8-bugbear 25 | - flake8-builtins 26 | - flake8-comprehensions 27 | - flake8-debugger 28 | - flake8-deprecated 29 | - flake8-isort 30 | - flake8-print 31 | - flake8-quotes 32 | 33 | - repo: https://github.com/codespell-project/codespell 34 | rev: v2.2.6 35 | hooks: 36 | - id: codespell 37 | additional_dependencies: 38 | - tomli 39 | - repo: https://github.com/mgedmin/check-manifest 40 | rev: "0.49" 41 | hooks: 42 | - id: check-manifest 43 | - repo: https://github.com/regebro/pyroma 44 | rev: "4.2" 45 | hooks: 46 | - id: pyroma 47 | - repo: https://github.com/mgedmin/check-python-versions 48 | rev: "0.21.3" 49 | hooks: 50 | - id: check-python-versions 51 | -------------------------------------------------------------------------------- /CHANGES.rst: -------------------------------------------------------------------------------- 1 | .. -*- coding: utf-8 -*- 2 | 3 | Changelog 4 | ========= 5 | 6 | 2.1.1 (unreleased) 7 | ------------------ 8 | 9 | - Nothing changed yet. 10 | 11 | 12 | 2.1.0 (2023-11-03) 13 | ------------------ 14 | 15 | - Drop python 3.7 support. 16 | [gforcada] 17 | 18 | - Test against python 3.12. 19 | [gforcada] 20 | 21 | - Use `pyproject.toml` rather than `setup.py`. 22 | [gforcada] 23 | 24 | - Switch from `setuptools` to `hatchling`. 25 | [gforcada] 26 | 27 | - Switch to `main` branch. 28 | [gforcada] 29 | 30 | - Use `tox` and `pre-commit` to ease project maintenance. 31 | [gforcada] 32 | 33 | 2.0.0 (2022-10-08) 34 | ------------------ 35 | 36 | - Update dependencies. [gforcada] 37 | 38 | - Test the code on GitHub actions. [gforcada] 39 | 40 | - Drop python 2.7 and only support python 3.7+. [gforcada] 41 | 42 | - Use linters and formatters to keep code sane and beautiful. [gforcada] 43 | 44 | - Simplify the amount of code to write a test. [gforcada] 45 | 46 | 1.3.0 (2019-12-15) 47 | ------------------ 48 | 49 | - Warn about `"string %i" % 33` which was previously ignored. 50 | Reported by @unformatt. 51 | [gforcada] 52 | 53 | 54 | 1.2.1 (2018-04-05) 55 | ------------------ 56 | 57 | - Fix text on the error message. 58 | [icemac] 59 | 60 | 1.2 (2017-12-12) 61 | ---------------- 62 | 63 | - Handle when there are numbers in either side of the modulo operator. 64 | [gforcada] 65 | 66 | 1.1 (2017-05-12) 67 | ---------------- 68 | 69 | - Handle variable formatting (i.e. ``my_string_variable % ('one', 'two', )``). 70 | [gforcada] 71 | 72 | - Test againsta Python 3.6. 73 | [gforcada] 74 | 75 | - Release universal wheels as well. 76 | [gforcada] 77 | 78 | 1.0 (2016-11-27) 79 | ---------------- 80 | - Remove tox and use plain travis matrix to test. 81 | [gforcada] 82 | 83 | - Test on python 2.7, python 3.5, pypy and pypy3. 84 | [gforcada] 85 | 86 | - Require flake8 3.0. 87 | [gforcada] 88 | 89 | - Use ast to analyze the code. 90 | The regular expression used so far was mostly a hit or miss, 91 | with each corner case making it even more difficult to read. 92 | The new checker with ast is simple, elegant and so much easy to read. 93 | [gforcada] 94 | 95 | 0.6 (2016-10-29) 96 | ---------------- 97 | - Handle edge case when a single or double quoted string 98 | has another pair of quotes inside ('lala "lu" la') with 99 | some % symbol inside as well. 100 | [gforcada] 101 | 102 | 0.5 (2016-10-26) 103 | ---------------- 104 | - Add all possible string formatters. 105 | [gforcada] 106 | 107 | - Fix extension to work with flake8 > 3.0. 108 | [gforcada] 109 | 110 | - Fix crash when the % symbol was the last character of a line. 111 | [gforcada] 112 | 113 | 0.4 (2016-07-03) 114 | ---------------- 115 | - Rename pep8 to pycodestyle. 116 | [alefteris] 117 | 118 | - Add support for python 3.5. 119 | [alefteris] 120 | 121 | - Add flake8 pypi classifier. 122 | [alefteris] 123 | 124 | - Drop python 3.3 and 3.4 support (only testing it probably works just fine). 125 | [gforcada] 126 | 127 | - Fix travis and coveralls to work properly with python 3.5. 128 | [gforcada] 129 | 130 | 0.3 (2016-03-05) 131 | ---------------- 132 | - Allow stdin processing, this way text editor can pass input to flake8. 133 | [mjacksonw] 134 | 135 | 0.2 (2015-09-16) 136 | ---------------- 137 | - 0.1 was a brown bag release. 138 | [gforcada] 139 | 140 | 0.1 (2015-09-16) 141 | ---------------- 142 | - Initial release 143 | [gforcada] 144 | 145 | - Create the flake8 plugin per se. 146 | [gforcada] 147 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include MANIFEST.in 2 | include LICENSE 3 | include setup.cfg 4 | include *.rst 5 | include *.py 6 | include *requirements.txt 7 | 8 | exclude .installed.cfg 9 | exclude .coveragerc 10 | exclude *.pyc 11 | exclude *.in 12 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | .. -*- coding: utf-8 -*- 2 | 3 | .. image:: https://github.com/gforcada/flake8-pep3101/actions/workflows/testing.yml/badge.svg?branch=main 4 | :target: https://github.com/gforcada/flake8-pep3101/actions/workflows/testing.yml 5 | 6 | .. image:: https://coveralls.io/repos/gforcada/flake8-pep3101/badge.svg?branch=main 7 | :target: https://coveralls.io/github/gforcada/flake8-pep3101?branch=main 8 | 9 | Flake8 PEP 3101 plugin 10 | ====================== 11 | Python has three string formatting options: 12 | 13 | - the old percent operator 14 | - the ``.format()`` string method 15 | - `f-strings`_ (only since python 3.6+) 16 | 17 | Although f-strings are more ergonomic, there a certain scenarios where the 18 | ``.format()`` method is still the only viable option. 19 | 20 | See `pyformat website`_ for examples of the percent operator vs the ``format()`` method. 21 | 22 | For a more format definition see the `PEP 3101`_. 23 | 24 | This plugin is based on a python checker that was in `plone.recipe.codeanalysis`_. 25 | 26 | Install 27 | ------- 28 | Install with pip:: 29 | 30 | $ pip install flake8-pep3101 31 | 32 | Requirements 33 | ------------ 34 | - Python 3.8, 3.9, 3.10, 3.11 and pypy3 35 | - flake8 36 | 37 | Extras 38 | ------ 39 | If you want to check whether your new style formatting are correctly defined, 40 | check `flake8-string-format`_ plugin. 41 | 42 | License 43 | ------- 44 | GPL 2.0 45 | 46 | .. _`pyformat website`: https://pyformat.info 47 | .. _`PEP 3101`: https://www.python.org/dev/peps/pep-3101 48 | .. _`f-strings`: https://peps.python.org/pep-0498/ 49 | .. _`flake8-string-format`: https://pypi.python.org/pypi/flake8-string-format 50 | .. _`plone.recipe.codeanalysis`: https://pypi.python.org/pypi/plone.recipe.codeanalysis 51 | -------------------------------------------------------------------------------- /flake8_pep3101.py: -------------------------------------------------------------------------------- 1 | from flake8 import utils as stdin_utils 2 | 3 | import ast 4 | 5 | 6 | class Flake8Pep3101: 7 | name = 'flake8_pep3101' 8 | version = '1.2.1' 9 | message = 'S001 found modulo formatter' 10 | 11 | def __init__(self, tree, filename): 12 | self.filename = filename 13 | self.tree = tree 14 | 15 | def run(self): 16 | tree = self.tree 17 | 18 | if self.filename == 'stdin': 19 | lines = stdin_utils.stdin_get_value() 20 | tree = ast.parse(lines) 21 | 22 | for stmt in ast.walk(tree): 23 | if self._is_module_operation(stmt): 24 | if self._is_left_hand_number(stmt): 25 | continue 26 | if self._is_modulo_variable_and_number(stmt): 27 | continue 28 | 29 | if isinstance(stmt.left, (ast.Str, ast.Name)): 30 | yield ( 31 | stmt.lineno, 32 | stmt.col_offset, 33 | self.message, 34 | type(self), 35 | ) 36 | 37 | @staticmethod 38 | def _is_module_operation(stmt): 39 | return isinstance(stmt, ast.BinOp) and isinstance(stmt.op, ast.Mod) 40 | 41 | @staticmethod 42 | def _is_left_hand_number(stmt): 43 | """Check if it is a case of `44 % SOMETHING`.""" 44 | return isinstance(stmt.left, ast.Num) 45 | 46 | @staticmethod 47 | def _is_modulo_variable_and_number(stmt): 48 | """Check if it is a case of `var % 44`.""" 49 | return isinstance(stmt.right, ast.Num) and isinstance(stmt.left, ast.Name) 50 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["hatchling"] 3 | build-backend = "hatchling.build" 4 | 5 | [project] 6 | name = "flake8-pep3101" 7 | version = "2.1.1.dev0" 8 | authors = [ 9 | { name="Gil Forcada Codinachs", email="gil.gnome@gmail.com" }, 10 | ] 11 | description = "Checks for old string formatting" 12 | keywords = ["pep8", "flake8", "python", "pycodestyle", "string formatting"] 13 | license = {file = "LICENSE"} 14 | readme = "README.rst" 15 | requires-python = ">=3.8" 16 | classifiers = [ 17 | "Development Status :: 5 - Production/Stable", 18 | "Environment :: Console", 19 | "Framework :: Flake8", 20 | "Intended Audience :: Developers", 21 | "License :: OSI Approved :: GNU General Public License v2 (GPLv2)", 22 | "Operating System :: OS Independent", 23 | "Programming Language :: Python", 24 | "Programming Language :: Python :: 3", 25 | "Programming Language :: Python :: 3 :: Only", 26 | "Programming Language :: Python :: 3.8", 27 | "Programming Language :: Python :: 3.9", 28 | "Programming Language :: Python :: 3.10", 29 | "Programming Language :: Python :: 3.11", 30 | "Programming Language :: Python :: 3.12", 31 | "Programming Language :: Python :: Implementation :: CPython", 32 | "Programming Language :: Python :: Implementation :: PyPy", 33 | "Topic :: Software Development", 34 | "Topic :: Software Development :: Quality Assurance", 35 | ] 36 | dependencies = ["flake8"] 37 | 38 | [project.urls] 39 | "Homepage" = "https://github.com/gforcada/flake8-pep3101" 40 | "Bug Tracker" = "https://github.com/gforcada/flake8-pep3101/issues" 41 | "Changelog" = "https://github.com/gforcada/flake8-pep3101/blob/main/CHANGES.rst" 42 | 43 | [project.optional-dependencies] 44 | test = ["pytest"] 45 | 46 | [project.entry-points."flake8.extension"] 47 | S001 = "flake8_pep3101:Flake8Pep3101" 48 | 49 | [tool.isort] 50 | profile = "plone" 51 | 52 | [tool.black] 53 | target-version = ["py38"] 54 | skip-string-normalization = true 55 | 56 | [tool.check-manifest] 57 | ignore = [ 58 | ".vscode/*", 59 | "venv/*", 60 | ] 61 | -------------------------------------------------------------------------------- /run_tests.py: -------------------------------------------------------------------------------- 1 | from flake8_pep3101 import Flake8Pep3101 2 | from unittest import mock 3 | 4 | import ast 5 | import textwrap 6 | import unittest 7 | 8 | 9 | class NewTestFlake8Pep3101(unittest.TestCase): 10 | def check_code(self, source, expected_codes=None): 11 | """Check if the given source code generates the given flake8 errors 12 | 13 | If `expected_codes` is a string is converted to a list, 14 | if it is not given, then it is expected to **not** generate any error. 15 | """ 16 | if isinstance(expected_codes, str): 17 | expected_codes = [expected_codes] 18 | elif expected_codes is None: 19 | expected_codes = [] 20 | tree = ast.parse(textwrap.dedent(source)) 21 | checker = Flake8Pep3101(tree, '/home/script.py') 22 | return_statements = list(checker.run()) 23 | 24 | self.assertEqual( 25 | len(return_statements), len(expected_codes), f'Got {return_statements}' 26 | ) 27 | 28 | for item, code in zip(return_statements, expected_codes): 29 | self.assertTrue( 30 | item[2].startswith(f'{code} '), 31 | f'Actually got {item[2]} rather than {code}', 32 | ) 33 | 34 | @mock.patch('flake8.utils.stdin_get_value') 35 | def test_stdin(self, stdin_get_value): 36 | source = 'a = "hello %s" % ("world")' 37 | stdin_get_value.return_value = source 38 | checker = Flake8Pep3101('', 'stdin') 39 | ret = list(checker.run()) 40 | self.assertEqual( 41 | len(ret), 42 | 1, 43 | ) 44 | 45 | def test_no_old_formatter(self): 46 | source = 'b = 3' 47 | self.check_code(source) 48 | 49 | def test_new_formatter(self): 50 | source = 'print("hello {0:s}".format("world"))' 51 | self.check_code(source) 52 | 53 | def test_error(self): 54 | source = 'print("hello %s" % ("world"))' 55 | self.check_code(source, 'S001') 56 | 57 | def test_line_number(self): 58 | source = """ 59 | a = 2 60 | open = 4 61 | msg = "hello %s" % ("world") 62 | """ 63 | tree = ast.parse(textwrap.dedent(source)) 64 | checker = Flake8Pep3101(tree, '/home/script.py') 65 | ret = list(checker.run()) 66 | self.assertEqual(ret[0][0], 4) 67 | 68 | def test_offset(self): 69 | source = """ 70 | def bla(): 71 | msg = "hello %s" % ("world") 72 | """ 73 | tree = ast.parse(textwrap.dedent(source)) 74 | checker = Flake8Pep3101(tree, '/home/script.py') 75 | ret = list(checker.run()) 76 | self.assertEqual(ret[0][1], 10) 77 | 78 | def test_s_formatter(self): 79 | source = 'print("hello %s" % (\'lo\'))' 80 | self.check_code(source, 'S001') 81 | 82 | def test_multiline_formatter(self): 83 | source = """ 84 | print("hello %s" 85 | % ('world') 86 | ) 87 | """ 88 | self.check_code(source, 'S001') 89 | 90 | def test_multiline_aligned_formatter(self): 91 | source = """ 92 | print("hello %s" 93 | % ('world') 94 | ) 95 | """ 96 | self.check_code(source, 'S001') 97 | 98 | def test_logging_module(self): 99 | source = """ 100 | import logging 101 | logger = logging.getLogger() 102 | logger.info("%s world", "hello") 103 | """ 104 | self.check_code(source) 105 | 106 | def test_multiple_strings(self): 107 | source = '"""""""1" if "%" else "2"' 108 | self.check_code(source) 109 | 110 | def test_multiple_single_quotes_strings(self): 111 | source = "'''''''1' if '%' else '2'" 112 | self.check_code(source) 113 | 114 | def test_multiple_strings_with_old_formatting(self): 115 | """Check that multiple quoting is handled properly. 116 | 117 | In this case correctly detecting it. 118 | """ 119 | source = '"""""""1" if "%" else "2%s" % "x"' 120 | self.check_code(source, 'S001') 121 | 122 | def test_percent_on_string(self): 123 | """Check that multiple quoting is handled properly. 124 | 125 | In this case no string substitution is happening. 126 | 127 | Found in plone.app.drafts.tests 128 | """ 129 | 130 | source = 'a = \'"%2B%2Badd%2B%2BMyDocument"\'' 131 | self.check_code(source) 132 | 133 | def test_percent_as_last_character_on_line(self): 134 | """Check that a percent symbol as the last character on a line is 135 | handled properly. 136 | """ 137 | source = """ 138 | a = 'my string %s %s' \ 139 | % \ 140 | ('3', '4', ) 141 | """ 142 | self.check_code(source, 'S001') 143 | 144 | def test_variable(self): 145 | source = """ 146 | a = 'my string %s %s' 147 | a % ('3', '4', ) 148 | """ 149 | self.check_code(source, 'S001') 150 | 151 | def test_right_hand_number_modulo(self): 152 | source = """ 153 | var = 40 154 | if var % 50 == 0: 155 | print(var) 156 | """ 157 | self.check_code(source) 158 | 159 | def test_left_hand_number_modulo(self): 160 | source = """ 161 | var = 40 162 | if 50 % var == 0: 163 | print(var) 164 | """ 165 | self.check_code(source) 166 | 167 | def test_right_hand_string_left_hand_number(self): 168 | source = 'print("asd %s" % 1)' 169 | self.check_code(source, 'S001') 170 | 171 | def test_right_hand_string_left_hand_variable(self): 172 | source = """ 173 | a = 44 174 | print("asd %s" % a) 175 | """ 176 | self.check_code(source, 'S001') 177 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | min_version = 4.4.0 3 | envlist = 4 | format 5 | lint 6 | coverage 7 | py38 8 | py39 9 | py310 10 | py311 11 | py312 12 | pypy3 13 | 14 | [testenv:test] 15 | description = run the distribution tests 16 | use_develop = true 17 | skip_install = false 18 | constrain_package_deps = true 19 | commands = 20 | pytest run_tests.py 21 | extras = 22 | test 23 | 24 | [testenv:format] 25 | description = automatically reformat code 26 | skip_install = true 27 | deps = 28 | pre-commit 29 | commands = 30 | pre-commit run -a pyupgrade 31 | pre-commit run -a isort 32 | pre-commit run -a black 33 | 34 | [testenv:lint] 35 | description = run linters that will help improve the code style 36 | skip_install = true 37 | deps = 38 | pre-commit 39 | commands = 40 | pre-commit run -a 41 | 42 | [testenv:coverage] 43 | description = get a test coverage report 44 | use_develop = true 45 | skip_install = false 46 | deps = 47 | coverage 48 | commands = 49 | pytest run_tests.py --cov --cov-report term-missing 50 | extras = 51 | test 52 | --------------------------------------------------------------------------------