Check code for newspaper style
Project description
Enforce Newspaper Style with Flake
Motivation
Good code reads like a newspaper. Start with the highest abstraction, go to the details. This also enables to read the code without an editor.
Quoting Robert C. Martin from his Clean Code book.
“Think of a well-written newspaper article. You read it vertically. At the top, you expect a headline that will tell you what the story is about and allows you to decided whether it is something you want to read. The first paragraph gives you a synopsis of the whole story, hiding all the details while giving you the broad-brush concepts. As you continue downward, the details increase until you have all the dates, names, quotes, claims, and other minutiae. We would like a source file to be like a newspaper article.”
In Python newspaper code should look like this.
def headline():
text()
def text(): # this needs to be defined after the usage.
...
There hasn't been an automatic way in python to check for this. So here it is.
Usage
# install the flake8 extension for newspaper style
pip3 install flake8-newspaper-style==1.2.3
# then check your code
flake8 --select=NEWS src # here it restricts flake8 to newspaper style issues
References
- Clean Code book by Robert C. Martin
- Clean Code formatting matters
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
Hashes for flake8-newspaper-style-0.2.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 566a6c9ebb3370eb5fb11a9d98219295ce1d57bba8c853165530430dd094f0e6 |
|
MD5 | 691751af794e29dbf2005187eedf3617 |
|
BLAKE2b-256 | af8dc6798dda05e6a78d2f9fbb19cdf2a882060efeeff5519a09df5b1a5a8070 |