Flake8 __author__ checker
Project description
flake8-author is a Flake8 extension that checks Python modules for module-level __author__ attributes.
There is no official standard on __author__ usage. It is used largely by convention. Guido had this to say back in 2001:
Anothor source of discomfort is that there’s absolutely no standard for this kind of meta-data variables. We’ve got __version__, and I believe we once agreed on that (in 1994 or so :-). But __author__? __credits__? What next – __cute_signoff__?
This extension can therefore be configured to explicitly require or forbid __author__ attributes. By default, __author__ is considered optional.
If the __author__ attribute is allowed, its value can also be validated using a configurable regular expression pattern.
Installation
Install from PyPI using pip:
$ pip install flake8-author
The extension will be activated automatically by flake8. You can verify that it has been loaded by inspecting the flake8 --version string.
$ flake8 --version
3.8.4 (author: 1.2.0, ...) CPython 3.8.6 on Darwin
Error Codes
This extension adds three new error codes (using the A40 prefix):
A400: a module-level __author__ attribute is required
A401: __author__ attributes are not allowed
A402: __author__ attribute value does not match pattern
Configuration
Configuration values are specified in the [flake8] section of your config file or as command line arguments (e.g. --author-attribute=required).
author-attribute: “optional”, “required”, “forbidden” (default: optional)
author-pattern: __author__ validation re pattern (default: '')
Changes
1.2.0 (2020-10-12)
Drop Python 3.5 support and add version 3.8. and 3.9.
Minor documentation improvements.
1.1.4 (2017-07-29)
Minor code and packaging cleanup.
1.1.3 (2017-07-28)
Drop the setup_requires dependency on flake8.
1.1.2 (2017-01-12)
Only apply the author regular expression pattern check when a pattern has actually been configured.
1.1.1 (2016-11-06)
Fix configuration file parsing for flake8 3.0+.
1.1.0 (2016-08-15)
Support flake8 3.0.0 (required for development)
1.0.2 (2016-06-02)
Support flake8 version 2.6.0
Drop test dependency on pytest (development only)
1.0.1 (2016-05-11)
Fixed parser validation for configuration-based options
1.0.0 (2016-04-30)
Initial release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flake8-author-1.2.0.macosx-10.15-x86_64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0ac4d7b513850ce0da030c6c9d27ecfff88674acb915b84d2c95e68768b9ffd |
|
MD5 | 9dd6612c66bf96b7e20f3fd7193d60b1 |
|
BLAKE2b-256 | 33083dbfc6a022defba18612cd73e5844ca2b6c00dc4cab23c29be7a898659f4 |
Hashes for flake8_author-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef82f5adcec55239a5a93f0ba42ac202d89fb3edd247f5312ffd7396d30a26f4 |
|
MD5 | 9775b904b3a6ca641e6091e285079772 |
|
BLAKE2b-256 | 0050280e6b27260ca4c211328b6f2ba750e97858fd8bf3995c03d3c9aa2265df |