Skip to content

feat: __main__ error code #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sbrugman wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

feat: __main__ error code #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7438c10
feat: checks for __main__ and modernize
sbrugman Jan 13, 2023
1468697
test: for __main__ and refactor
sbrugman Jan 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
[![Build Status](https://ci.appveyor.com/api/projects/status/h6mucl894w6dx7d0?svg=true)](https://ci.appveyor.com/project/xuhdev/flake8-executable)

Very often, developers mess up the executable permissions and shebangs of Python files. For example,
sometimes the executable permission was accidentally granted, sometimes it is forgotten.
sometimes the executable permission was accidentally granted, sometimes it is forgotten. Moreover,
this should be consistent with [Top-level code environment][] checks.

This is a [Flake8][] plugin that ensures the executable permissions and shebangs of Python files are
correctly set. Specifically, it checks the following errors:
Expand All @@ -16,6 +17,23 @@ correctly set. Specifically, it checks the following errors:
- EXE003: Shebang is present but does not contain "python".
- EXE004: There is whitespace before shebang.
- EXE005: There are blank or comment lines before shebang.
- EXE006: Found shebang, but no \_\_name\_\_ == '\_\_main\_\_' or \_\_main\_\_.py.
- EXE007: The file is executable, but no \_\_name\_\_ == '\_\_main\_\_' or \_\_main\_\_.py.

## Error codes overview

| Shebang | Executable* | \_\_main\_\_ | Error code |
|---------|-------------|--------------|-------------------------------------|
| ✅ | ✅ | ✅ | Complete, no issues |
| ✅ | ✅ | ❌ | EXE007 |
| ✅ | ❌ | ✅ | EXE001 |
| ✅ | ❌ | ❌ | EXE001, EXE006 |
| ❌ | ✅ | ✅ | EXE002 |
| ❌ | ✅ | ❌ | EXE002, EXE007 |
| ❌ | ❌ | ✅ | Shebang and executable are optional |
| ❌ | ❌ | ❌ | No issue |

(*) Executable bit is ignored on Windows

## Installation

Expand All @@ -30,7 +48,7 @@ details, check out the [Flake8 plugin page][].

## Copyright and License

Copyright (c) 2019 Hong Xu <hong@topbug.net>
Copyright (c) 2019 Hong Xu <hong@topbug.net>, 2023 Simon Brugman

flake8-executable is free software: you can redistribute it and/or modify it under the terms of the
GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of
Expand All @@ -47,3 +65,4 @@ flake8-executable. If not, see <https://www.gnu.org/licenses/>.

[Flake8]: https://flake8.pycqa.org/
[Flake8 plugin page]: https://flake8.pycqa.org/en/latest/user/using-plugins.html
[Top-level code environment]: https://docs.python.org/3/library/__main__.html
Loading