├── .appveyor.yml ├── .bandit ├── .coveragerc.in ├── .editorconfig ├── .github ├── renovate.json5 └── workflows │ └── renovate-lint.yml ├── .gitignore ├── .mypy.ini ├── .pre-commit-config.yaml ├── CONTRIBUTING.md ├── COPYING ├── COPYING.GPL ├── README.md ├── flake8_executable └── __init__.py ├── requirements-dev.txt ├── requirements ├── lint.txt └── test.txt ├── setup.cfg ├── setup.py ├── tests ├── test_flake8_executable.py └── to-be-tested │ ├── exe001_neg.py │ ├── exe001_pos.py │ ├── exe002_neg.py │ ├── exe002_pos.py │ ├── exe003_neg.py │ ├── exe003_pos.py │ ├── exe004_neg.py │ ├── exe004_pos.py │ ├── exe005_neg.py │ └── exe005_pos.py └── tox.ini /.appveyor.yml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2020 Hong Xu 2 | 3 | # This file is part of flake8-executable. 4 | 5 | # flake8-executable is free software: you can redistribute it and/or modify it 6 | # under the terms of the GNU Lesser General Public License as published by the 7 | # Free Software Foundation, either version 3 of the License, or (at your 8 | # option) any later version. 9 | 10 | # flake8-executable is distributed in the hope that it will be useful, but 11 | # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 | # FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 13 | # for more details. 14 | 15 | # You should have received a copy of the GNU Lesser General Public License 16 | # along with flake8-executable. If not, see . 17 | 18 | 19 | environment: 20 | matrix: 21 | - TOXENV: lint 22 | PYTHON_VERSION: 3.10 23 | APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu2004 24 | - TOXENV: py39 25 | PYTHON_VERSION: 3.9 26 | APPVEYOR_BUILD_WORKER_IMAGE: "Visual Studio 2019" 27 | - TOXENV: py37 28 | PYTHON_VERSION: 3.7 29 | APPVEYOR_BUILD_WORKER_IMAGE: macOS 30 | - TOXENV: py38 31 | PYTHON_VERSION: 3.8 32 | APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu2004 33 | - TOXENV: py39 34 | PYTHON_VERSION: 3.9 35 | APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu2004 36 | - TOXENV: py310 37 | PYTHON_VERSION: 3.10 38 | APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu2004 39 | - TOXENV: py311 40 | PYTHON_VERSION: 3.11 41 | APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu2004 42 | 43 | build: false 44 | 45 | install: 46 | # AppVeyor requires us to manually source a virtualenv for non-Windows tests. This line is allowed to fail (and should 47 | # fail) on Windows images. 48 | - source ~/venv${PYTHON_VERSION}/bin/activate || (exit 0) 49 | - pip install -U tox 50 | 51 | test_script: 52 | - tox -vv 53 | 54 | branches: 55 | only: 56 | - master 57 | -------------------------------------------------------------------------------- /.bandit: -------------------------------------------------------------------------------- 1 | [bandit] 2 | exclude: /.eggs,/tests,/.tox 3 | -------------------------------------------------------------------------------- /.coveragerc.in: -------------------------------------------------------------------------------- 1 | [coverage:run] 2 | source = flake8_executable 3 | 4 | [coverage:report] 5 | fail_under = 100 6 | show_missing = True 7 | exclude_lines = 8 | pragma: no cover {platform} 9 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*.py] 4 | charset = utf-8 5 | indent_style = space 6 | indent_size = 4 7 | end_of_line = lf 8 | max_line_length = 120 9 | 10 | [README.md] 11 | charset = utf-8 12 | indent_style = space 13 | indent_size = 4 14 | end_of_line = lf 15 | max_line_length = 100 -------------------------------------------------------------------------------- /.github/renovate.json5: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2020 Hong Xu 3 | 4 | This file is part of flake8-executable. 5 | 6 | flake8-executable is free software: you can redistribute it and/or modify it 7 | under the terms of the GNU Lesser General Public License as published by the 8 | Free Software Foundation, either version 3 of the License, or (at your 9 | option) any later version. 10 | 11 | flake8-executable is distributed in the hope that it will be useful, but 12 | WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 14 | for more details. 15 | 16 | You should have received a copy of the GNU Lesser General Public License 17 | along with flake8-executable. If not, see . 18 | */ 19 | 20 | { 21 | "extends": [ 22 | "config:base" 23 | ], 24 | 25 | "pip_requirements": { 26 | "fileMatch": ["requirements.*\.txt$"] 27 | }, 28 | 29 | "pre-commit": { 30 | "enabled": true 31 | }, 32 | 33 | "labels": [ 34 | "renovate" 35 | ], 36 | 37 | "dependencyDashboard": true, 38 | 39 | "schedule": [ 40 | "before 1am on Saturday" 41 | ], 42 | 43 | "packageRules": [ 44 | { 45 | "matchPackagePatterns": [ 46 | "*" 47 | ], 48 | "matchUpdateTypes": [ 49 | "patch" 50 | ], 51 | "groupName": "all non-major dependencies", 52 | "groupSlug": "all-minor-patch" 53 | } 54 | ] 55 | } 56 | -------------------------------------------------------------------------------- /.github/workflows/renovate-lint.yml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2020 Hong Xu 2 | 3 | # This file is part of flake8-executable. 4 | 5 | # flake8-executable is free software: you can redistribute it and/or modify it 6 | # under the terms of the GNU Lesser General Public License as published by the 7 | # Free Software Foundation, either version 3 of the License, or (at your 8 | # option) any later version. 9 | 10 | # flake8-executable is distributed in the hope that it will be useful, but 11 | # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 | # FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 13 | # for more details. 14 | 15 | # You should have received a copy of the GNU Lesser General Public License 16 | # along with flake8-executable. If not, see . 17 | 18 | name: 'Lint Renovate Configurations' 19 | 20 | on: 21 | push: 22 | branches: 'master' 23 | pull_request: 24 | branches: '*' 25 | 26 | jobs: 27 | test: 28 | runs-on: ubuntu-latest 29 | steps: 30 | - uses: actions/checkout@v3 31 | - uses: actions/setup-node@v3 32 | with: 33 | node-version: '16' 34 | - name: Install Dependencies 35 | run: npm install -g renovate 36 | - name: Test 37 | run: renovate-config-validator 38 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__/ 2 | .coverage 3 | .tox 4 | .eggs 5 | *.egg-info 6 | /build 7 | /dist 8 | /flake8_executable/_version.py 9 | -------------------------------------------------------------------------------- /.mypy.ini: -------------------------------------------------------------------------------- 1 | [mypy] 2 | disallow_untyped_defs = True 3 | show_error_codes = True 4 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/PyCQA/flake8 3 | rev: 6.0.0 4 | hooks: 5 | - id: flake8 6 | additional_dependencies: 7 | - flake8-executable==2.1.3 8 | - bandit==1.7.4 9 | - flake8-bugbear==21.11.29 10 | - flake8-comprehensions==3.10.1 11 | args: [ "--max-line-length", "120" ] 12 | exclude: "tests/to-be-tested/" 13 | - repo: https://github.com/pre-commit/mirrors-mypy 14 | rev: 'v0.991' 15 | hooks: 16 | - id: mypy 17 | files: ^flake8_executable 18 | exclude: "tests/" 19 | - repo: https://github.com/asottile/yesqa 20 | rev: v1.4.0 21 | hooks: 22 | - id: yesqa 23 | exclude: "tests/to-be-tested/" 24 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | To start developing, first create a virtual environment. Inside the virtual environment, install all development 2 | dependencies: 3 | 4 | pip install -U -r requirements-dev.txt 5 | 6 | Alternatively, install `tox` first. Then, let tox create the virtual environment for you: 7 | 8 | pip install -U --user tox 9 | tox -e dev 10 | . .tox/dev/bin/activate # activate the virtual environment 11 | 12 | To run lint: 13 | 14 | tox -e lint 15 | 16 | To run runtime tests: 17 | 18 | tox --skip-missing-interpreters 19 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /COPYING.GPL: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # flake8-executable 2 | 3 | [![Pyversions](https://img.shields.io/pypi/pyversions/flake8-executable.svg?style=flat-square)](https://pypi.python.org/pypi/flake8-executable) 4 | ![PyPI](https://img.shields.io/pypi/v/flake8-executable.svg) 5 | ![PyPI - Downloads](https://img.shields.io/pypi/dm/flake8-executable) 6 | [![Build Status](https://ci.appveyor.com/api/projects/status/h6mucl894w6dx7d0?svg=true)](https://ci.appveyor.com/project/xuhdev/flake8-executable) 7 | 8 | Very often, developers mess up the executable permissions and shebangs of Python files. For example, 9 | sometimes the executable permission was accidentally granted, sometimes it is forgotten. 10 | 11 | This is a [Flake8][] plugin that ensures the executable permissions and shebangs of Python files are 12 | correctly set. Specifically, it checks the following errors: 13 | 14 | - EXE001: Shebang is present but the file is not executable. 15 | - EXE002: The file is executable but no shebang is present. 16 | - EXE003: Shebang is present but does not contain "python". 17 | - EXE004: There is whitespace before shebang. 18 | - EXE005: There are blank or comment lines before shebang. 19 | 20 | ## Installation 21 | 22 | Run: 23 | 24 | pip install flake8-executable 25 | 26 | Or through `pre-commit` with the `.pre-commit-config.yaml`: 27 | 28 | ```yaml 29 | repos: 30 | - repo: https://github.com/PyCQA/flake8 31 | rev: 6.0.0 # replace with the latest flake8 release 32 | hooks: 33 | - id: flake8 34 | additional_dependencies: 35 | - flake8-executable 36 | ``` 37 | 38 | ## Usage 39 | 40 | Normally, after flake8-executable is installed, invoking flake8 will also run this plugin. For more 41 | details, check out the [Flake8 plugin page][]. 42 | 43 | ## Copyright and License 44 | 45 | Copyright (c) 2019 Hong Xu 46 | 47 | flake8-executable is free software: you can redistribute it and/or modify it under the terms of the 48 | GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of 49 | the License, or (at your option) any later version. 50 | 51 | flake8-executable is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 52 | without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 53 | GNU Lesser General Public License for more details. 54 | 55 | You should have received a copy of the GNU Lesser General Public License along with 56 | flake8-executable. If not, see . 57 | 58 | 59 | 60 | [Flake8]: https://flake8.pycqa.org/ 61 | [Flake8 plugin page]: https://flake8.pycqa.org/en/latest/user/using-plugins.html 62 | -------------------------------------------------------------------------------- /flake8_executable/__init__.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Hong Xu 2 | 3 | # This file is part of flake8-executable. 4 | 5 | # flake8-executable is free software: you can redistribute it and/or modify it 6 | # under the terms of the GNU Lesser General Public License as published by the 7 | # Free Software Foundation, either version 3 of the License, or (at your 8 | # option) any later version. 9 | 10 | # flake8-executable is distributed in the hope that it will be useful, but 11 | # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 | # FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 13 | # for more details. 14 | 15 | # You should have received a copy of the GNU Lesser General Public License 16 | # along with flake8-executable. If not, see . 17 | 18 | from abc import ABC 19 | import os 20 | import re 21 | from typing import Any, Iterable, List, Tuple, Optional, Union 22 | 23 | from ._version import version as __version__ # type: ignore 24 | 25 | __all__ = ('__version__', 26 | 'ExcutableChecker', 27 | # Error classes 28 | 'Error', 29 | 'EXE001', 30 | 'EXE002', 31 | 'EXE003', 32 | 'EXE004', 33 | 'EXE005') 34 | 35 | 36 | class Error(ABC): 37 | """Base class of all errors. 38 | 39 | :param line_number: Line number of the error. 40 | :param offset: Offset of the error. 41 | :param error_code: Error code of the error. 42 | :param message: Message of the error. 43 | :param kwargs: Ignored. This is for the convenience of inheriting and calling super().__init__(). 44 | """ 45 | 46 | def __init__(self, line_number: int, offset: int, error_code: str, message: str, **kwargs: Any) -> None: 47 | self.line_number = line_number 48 | self.offset = offset 49 | self.error_code = error_code 50 | self.message = message 51 | 52 | @staticmethod 53 | def format_flake8(line_number: int, offset: int, error_code: str, message: str) -> Tuple[int, int, str, str]: 54 | "Return a format of that Flake8 accepts." 55 | return line_number, offset, '{} {}'.format(error_code, message), '' 56 | 57 | def __call__(self) -> Tuple[int, int, str, str]: 58 | return self.__class__.format_flake8(self.line_number, self.offset, self.error_code, self.message) 59 | 60 | @classmethod 61 | def should_check(cls, **kwargs: Any) -> bool: 62 | """Whether this error should be checked. The base class currently will always return True but this can change, 63 | so you should always check the return value of this function when overriding.""" 64 | return True 65 | 66 | 67 | class EXE001(Error): 68 | def __init__(self, line_number: int, **kwargs: Any) -> None: 69 | super().__init__(line_number, 0, 'EXE001', 'Shebang is present but the file is not executable.', **kwargs) 70 | 71 | @classmethod 72 | def should_check(cls, filename: Union[os.PathLike, str], **kwargs: Any) -> bool: # type: ignore[override] 73 | # Do not check on Windows or the input is not a file in the filesystem. 74 | return (os.name != 'nt' and filename is not None and filename not in ('-', 'stdin') and 75 | super().should_check(filename=filename, **kwargs)) 76 | 77 | 78 | class EXE002(Error): 79 | def __init__(self, **kwargs: Any) -> None: 80 | super().__init__(0, 0, 'EXE002', 'The file is executable but no shebang is present.', **kwargs) 81 | 82 | @classmethod 83 | def should_check(cls, filename: Union[os.PathLike, str], **kwargs: Any) -> bool: # type: ignore[override] 84 | # Do not check on Windows or the input is not a file in the filesystem. 85 | return (os.name != 'nt' and filename is not None and filename not in ('-', 'stdin') and 86 | super().should_check(filename=filename, **kwargs)) 87 | 88 | 89 | class EXE003(Error): 90 | def __init__(self, line_number: int, shebang: str, **kwargs: Any) -> None: 91 | super().__init__(line_number, 0, 'EXE003', 'Shebang is present but does not contain "python": ' + shebang, 92 | **kwargs) 93 | 94 | 95 | class EXE004(Error): 96 | def __init__(self, line_number: int, offset: int, **kwargs: Any): 97 | super().__init__(line_number, offset, 'EXE004', 'There is whitespace before shebang.', **kwargs) 98 | 99 | 100 | class EXE005(Error): 101 | def __init__(self, line_number: int, **kwargs: Any): 102 | super().__init__(line_number, 0, 'EXE005', 'There are blank or comment lines before shebang.', **kwargs) 103 | 104 | 105 | class ExecutableChecker: 106 | name = 'flake8-executable' 107 | version = __version__ 108 | 109 | def __init__(self, 110 | tree: None = None, # This is for flake8 111 | filename: Union[os.PathLike, str] = '', 112 | lines: Optional[List[str]] = None) -> None: 113 | self.filename = filename 114 | self.lines = lines 115 | 116 | def run(self) -> Optional[Iterable[Error]]: 117 | # Get lines if its not already read 118 | if self.lines is None: 119 | with open(self.filename) as f: 120 | self.lines = f.readlines() 121 | 122 | shebang_lineno = None 123 | for i, line in enumerate(self.lines, 1): 124 | m = re.match(r'(\s*)#!', line) 125 | if m: # shebang found 126 | shebang_lineno = i 127 | shebang_line = line 128 | if m.group(1): 129 | if EXE004.should_check(): 130 | yield EXE004(line_number=shebang_lineno, offset=len(m.group(1)))() 131 | break 132 | 133 | line = line.strip() 134 | if len(line) != 0 and not line.startswith('#'): # neither blank or comment line 135 | break 136 | 137 | is_executable = os.access(self.filename, os.X_OK) 138 | if shebang_lineno is not None: 139 | if not is_executable: # pragma: no cover windows. No execution of this branch on Windows 140 | if EXE001.should_check(filename=self.filename): 141 | yield EXE001(line_number=shebang_lineno)() 142 | if 'python' not in shebang_line: 143 | if EXE003.should_check(): 144 | yield EXE003(line_number=shebang_lineno, shebang=shebang_line.strip())() 145 | if shebang_lineno > 1: 146 | if EXE005.should_check(): 147 | yield EXE005(line_number=shebang_lineno)() 148 | elif is_executable: # pragma: no cover windows. No execution of this branch on Windows 149 | # In principle, this error may also be yielded on empty 150 | # files, but flake8 seems to always skip empty files. 151 | if EXE002.should_check(filename=self.filename): 152 | yield EXE002()() 153 | -------------------------------------------------------------------------------- /requirements-dev.txt: -------------------------------------------------------------------------------- 1 | tox 2 | -r requirements/lint.txt 3 | -r requirements/test.txt 4 | -------------------------------------------------------------------------------- /requirements/lint.txt: -------------------------------------------------------------------------------- 1 | bandit==1.7.4 2 | flake8==6.0.0 3 | flake8-bugbear==21.11.29 4 | flake8-comprehensions==3.10.1 5 | mypy==0.991 6 | -------------------------------------------------------------------------------- /requirements/test.txt: -------------------------------------------------------------------------------- 1 | coverage==7.1.0 2 | pytest==7.2.1 3 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [sdist] 2 | formats=gztar 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Hong Xu 2 | 3 | # This file is part of flake8-executable. 4 | 5 | # flake8-executable is free software: you can redistribute it and/or modify it 6 | # under the terms of the GNU Lesser General Public License as published by the 7 | # Free Software Foundation, either version 3 of the License, or (at your 8 | # option) any later version. 9 | 10 | # flake8-executable is distributed in the hope that it will be useful, but 11 | # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 | # FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 13 | # for more details. 14 | 15 | # You should have received a copy of the GNU Lesser General Public License 16 | # along with flake8-executable. If not, see . 17 | 18 | import pathlib 19 | 20 | from setuptools import setup 21 | 22 | 23 | setup( 24 | name="flake8-executable", 25 | description="A Flake8 plugin for checking executable permissions and shebangs.", 26 | long_description=pathlib.Path('README.md').read_text(), 27 | long_description_content_type="text/markdown", 28 | keywords="flake8 linter qa", 29 | author="Hong Xu", 30 | author_email="hong@topbug.net", 31 | url="https://github.com/xuhdev/flake8-executable", 32 | license='LGPL v3+', 33 | packages=["flake8_executable"], 34 | data_files=[("", ["COPYING", "COPYING.GPL"])], 35 | python_requires=">=3.6", 36 | install_requires=["flake8 >= 3.0.0"], 37 | classifiers=[ 38 | "Environment :: Console", 39 | "Framework :: Flake8", 40 | "Intended Audience :: Developers", 41 | "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)", 42 | "Operating System :: OS Independent", 43 | "Programming Language :: Python", 44 | "Programming Language :: Python :: 3", 45 | "Programming Language :: Python :: 3.7", 46 | "Programming Language :: Python :: 3.8", 47 | "Programming Language :: Python :: 3.9", 48 | "Programming Language :: Python :: 3.10", 49 | "Programming Language :: Python :: 3.11", 50 | "Programming Language :: Python :: 3 :: Only", 51 | "Topic :: Software Development :: Libraries :: Python Modules", 52 | "Topic :: Software Development :: Quality Assurance", 53 | ], 54 | entry_points={ 55 | "flake8.extension": ["EXE00 = flake8_executable:ExecutableChecker"] 56 | }, 57 | use_scm_version={'write_to': 'flake8_executable/_version.py'}, 58 | setup_requires=['setuptools_scm'] 59 | ) 60 | -------------------------------------------------------------------------------- /tests/test_flake8_executable.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Hong Xu 2 | 3 | # This file is part of flake8-executable. 4 | 5 | # flake8-executable is free software: you can redistribute it and/or modify it 6 | # under the terms of the GNU Lesser General Public License as published by the 7 | # Free Software Foundation, either version 3 of the License, or (at your 8 | # option) any later version. 9 | 10 | # flake8-executable is distributed in the hope that it will be useful, but 11 | # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 | # FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 13 | # for more details. 14 | 15 | # You should have received a copy of the GNU Lesser General Public License 16 | # along with flake8-executable. If not, see . 17 | 18 | 19 | from pathlib import Path 20 | import sys 21 | 22 | import pytest 23 | 24 | from flake8_executable import ExecutableChecker, EXE001, EXE002, EXE003, EXE004, EXE005 25 | 26 | WIN32 = sys.platform.startswith("win") 27 | 28 | 29 | class TestFlake8Executable: 30 | 31 | _python_files_folder = Path(__file__).absolute().parent / 'to-be-tested' 32 | 33 | @classmethod 34 | def _get_pos_filename(cls, error_code): 35 | "Get the filename for which an error of error_code should be emitted (on POSIX, Windows might be different)." 36 | return cls._python_files_folder / (error_code + '_pos.py') 37 | 38 | @classmethod 39 | def _get_neg_filename(cls, error_code): 40 | """Get the filename for which an error of error_code should not be emitted (on POSIX, Windows might be 41 | different).""" 42 | return cls._python_files_folder / (error_code + '_neg.py') 43 | 44 | @pytest.mark.parametrize("error, error_code", [ 45 | pytest.param(EXE001(line_number=1), 'exe001', 46 | marks=pytest.mark.skipif(WIN32, reason="Windows doesn't support EXE001")), 47 | pytest.param(EXE002(), 'exe002', marks=pytest.mark.skipif(WIN32, reason="Windows doesn't support EXE002")), 48 | (EXE003(line_number=1, shebang='#!/bin/bash'), 'exe003'), 49 | (EXE004(line_number=1, offset=4), 'exe004'), 50 | (EXE005(line_number=3), 'exe005')]) 51 | def test_exe_positive(self, error, error_code): 52 | "Test cases in which an error should be reported." 53 | filename = __class__._get_pos_filename(error_code) 54 | ec = ExecutableChecker(filename=str(filename)) 55 | errors = tuple(ec.run()) 56 | assert errors == (error(),) 57 | 58 | @pytest.mark.skipif(not WIN32, reason="Windows-only test.") 59 | @pytest.mark.parametrize("error_code", [ 60 | 'exe001', 61 | 'exe002']) 62 | def test_exe_positive_others_but_negative_windows(self, error_code): 63 | "Test cases in which an error should not be reported on Windows, while they are reported on Linux." 64 | filename = __class__._get_pos_filename(error_code) 65 | ec = ExecutableChecker(filename=str(filename)) 66 | errors = tuple(ec.run()) 67 | assert not errors # errors should be empty 68 | 69 | @pytest.mark.parametrize("error_code", [ 70 | 'exe001', 71 | 'exe002', 72 | 'exe003', 73 | 'exe004', 74 | 'exe005']) 75 | def test_exe_negative(self, error_code): 76 | "Test cases in which no error should be reported." 77 | filename = __class__._get_neg_filename(error_code) 78 | ec = ExecutableChecker(filename=str(filename)) 79 | errors = tuple(ec.run()) 80 | assert not errors # errors should be empty 81 | 82 | @staticmethod 83 | def _run_checker_stdin_from_file(filename): 84 | with open(filename) as f: 85 | lines = f.readlines() 86 | ec = ExecutableChecker(filename='-', lines=lines) 87 | return tuple(ec.run()) 88 | 89 | @pytest.mark.parametrize("error, error_code", [ 90 | (EXE003(line_number=1, shebang='#!/bin/bash'), 'exe003'), 91 | (EXE004(line_number=1, offset=4), 'exe004'), 92 | (EXE005(line_number=3), 'exe005')]) 93 | def test_stdin_positive(self, error, error_code): 94 | "Test case in which an error should be reported (input is stdin)." 95 | filename = __class__._get_pos_filename(error_code) 96 | errors = __class__._run_checker_stdin_from_file(filename) 97 | assert errors == (error(),) 98 | 99 | @pytest.mark.parametrize("error_code", [ 100 | 'exe001', 101 | 'exe002', 102 | 'exe003', 103 | 'exe004', 104 | 'exe005']) 105 | def test_stdin_negative(self, error_code): 106 | "Test cases in which no error should be reported (input is stdin)." 107 | filename = __class__._get_neg_filename(error_code) 108 | errors = __class__._run_checker_stdin_from_file(filename) 109 | assert not errors # errors should be empty 110 | 111 | @pytest.mark.parametrize("error_code", [ 112 | 'exe001', 113 | 'exe002']) 114 | def test_stdin_negative_otherwise_positive(self, error_code): 115 | "Test errors that should not be emitted when the input is from stdin, even if they should be otherwise emitted." 116 | filename = __class__._get_pos_filename(error_code) 117 | errors = __class__._run_checker_stdin_from_file(filename) 118 | assert not errors # errors should be empty 119 | 120 | @pytest.mark.parametrize("filename", ['-', 'stdin']) 121 | def test_stdin_negative_empty(self, filename): 122 | "Test empty input from stdin." 123 | ec = ExecutableChecker(filename=filename, lines=[]) 124 | assert len(tuple(ec.run())) == 0 125 | 126 | def test_cli(self): 127 | "Test the flake8 CLI interface and ensure there's no crash." 128 | import flake8.main.application 129 | 130 | # The following line must not raise any exception 131 | flake8.main.application.Application().run([str(self._python_files_folder)]) 132 | 133 | 134 | if __name__ == "__main__": 135 | pytest.main([__file__]) 136 | -------------------------------------------------------------------------------- /tests/to-be-tested/exe001_neg.py: -------------------------------------------------------------------------------- 1 | if __name__ == '__main__': 2 | print('I should be executable.') 3 | -------------------------------------------------------------------------------- /tests/to-be-tested/exe001_pos.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | if __name__ == '__main__': 4 | print('I should be executable.') 5 | -------------------------------------------------------------------------------- /tests/to-be-tested/exe002_neg.py: -------------------------------------------------------------------------------- 1 | def a_lib_function(): 2 | print("I shouldn't be executable.") 3 | -------------------------------------------------------------------------------- /tests/to-be-tested/exe002_pos.py: -------------------------------------------------------------------------------- 1 | def a_lib_function(): 2 | print("I shouldn't be executable.") 3 | -------------------------------------------------------------------------------- /tests/to-be-tested/exe003_neg.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | if __name__ == '__main__': 4 | print('Wrong shebang.') 5 | -------------------------------------------------------------------------------- /tests/to-be-tested/exe003_pos.py: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | if __name__ == '__main__': 4 | print('Wrong shebang.') 5 | -------------------------------------------------------------------------------- /tests/to-be-tested/exe004_neg.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | if __name__ == '__main__': 4 | print('I do not have whitespace before shebang.') 5 | -------------------------------------------------------------------------------- /tests/to-be-tested/exe004_pos.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | if __name__ == '__main__': 4 | print('I have whitespace before shebang.') 5 | -------------------------------------------------------------------------------- /tests/to-be-tested/exe005_neg.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | if __name__ == '__main__': 4 | print('I do not have any blank or comment lines before shebang.') 5 | -------------------------------------------------------------------------------- /tests/to-be-tested/exe005_pos.py: -------------------------------------------------------------------------------- 1 | 2 | # 3 | #!/usr/bin/python3 4 | 5 | if __name__ == '__main__': 6 | print('I have blank and comment lines before shebang.') 7 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2020 Hong Xu 2 | 3 | # This file is part of flake8-executable. 4 | 5 | # flake8-executable is free software: you can redistribute it and/or modify it 6 | # under the terms of the GNU Lesser General Public License as published by the 7 | # Free Software Foundation, either version 3 of the License, or (at your 8 | # option) any later version. 9 | 10 | # flake8-executable is distributed in the hope that it will be useful, but 11 | # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 | # FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 13 | # for more details. 14 | 15 | # You should have received a copy of the GNU Lesser General Public License 16 | # along with flake8-executable. If not, see . 17 | 18 | [tox] 19 | minversion = 3.20 20 | envlist = py{37,38,39,310,311}-{linux,macos,windows} 21 | skipsdist = True 22 | 23 | [testenv] 24 | download = True 25 | usedevelop = True 26 | platform = linux: linux 27 | macos: darwin 28 | windows: win32 29 | setenv = 30 | linux: PLATFORM = linux 31 | macos: PLATFORM = macos 32 | windows: PLATFORM = windows 33 | 34 | [testenv:py{37,38,39,310,311}-{linux,macos,windows}] 35 | deps = -rrequirements/test.txt 36 | setenv = 37 | {[testenv]setenv} 38 | COVERAGE_RCFILE = {envtmpdir}/coveragerc 39 | commands_pre = 40 | {envpython} -c 'from pathlib import Path; Path(r"{env:COVERAGE_RCFILE}").write_text(Path(".coveragerc.in").read_text().format(platform="{env:PLATFORM}"))' 41 | commands = 42 | coverage run -m pytest -v 43 | coverage report 44 | 45 | [testenv:lint] 46 | deps = -rrequirements/lint.txt 47 | commands = 48 | flake8 . 49 | bandit -r . 50 | mypy flake8_executable 51 | 52 | [testenv:dev] 53 | description = development environment with all deps at {envdir} 54 | deps = -rrequirements-dev.txt 55 | commands = python -c "print(r'{envpython}')" 56 | 57 | [flake8] 58 | max-line-length = 120 59 | exclude = .eggs,.git,__pycache__,to-be-tested,.tox 60 | --------------------------------------------------------------------------------