Files
.github
api-server
client
config
curriculum
docs
guide
arabic
chinese
english
3d
accessibility
agile
algorithms
android-development
angular
angularjs
apache
aspnet
bash
blender
blockchain
bootstrap
bsd-os
bulma
c
canvas
certifications
chef
clojure
cloud-development
computational-genomics
computer-hardware
computer-science
containers
cplusplus
csharp
css
d3
data-science-tools
design-patterns
designer-tools
developer-ethics
developer-tools
devops
docker
documentation
drupal
electron
elixir
elm
erlang
fsharp
game-development
gatsbyjs
git
go
groovy
haskell
haxe
hibernate
html
ionic
java
javascript
joomla
jquery
julia
kotlin
laravel
linux
logic
machine-learning
mathematics
meta
miscellaneous
mobile-app-development
mongodb
natural-language-processing
neovim
network-engineering
nginx
nodejs
optical-alignment
php
product-design
progressive-web-apps
puppet
python
abs-function
all-iterable
anaconda
any-iterable
args-variable
basic-operators
bool-function
boolean-operations
built-in-constants
calling-functions
class
code-blocks-and-indentation
commenting-code
comparisons
complex-numbers
containers
converting-integer-to-string-in-python
creating-guis-in-python3
data-structures
decorators
defaultdict
defining-functions
difference-between-is-and-equal-equal-operators
docstring
enumerate
escape-sequences
exception-and-error-handling
files-and-io
for-loop-statements
from-x-import-y
frozenset
functions
generators
hex-functions
how-to-convert-strings-into-integers-in-python
idobject
if-elif-else-statements
import-statements
input-functions
installing-and-using-python-3
is-there-a-way-to-substring-a-string-in-python
iterators
itertools
keywords
lambda-expressions
learn-about-python-sets
len-function
list-deque
lists
max-function
min-function
more-built-in-types
mutability-and-variable-assignments
name-binding-and-aliasing-functions
nested-functions
numeric-operations
numeric-types
object-oriented-programming
ord-function
parenthesis-for-boolean-operations
powxy
python-2-vs-python-3
python-coding-standards
index.md
python-f-strings
python-resources
range-function
raspberry-pi-basics
rest-api-with-falcon
return-statement
sequence-types
set-types
setting-up-python-web-framework-django-and-flask
share-file-using-python-simple-http-server
sleep-how-can-i-make-a-time-delay-in-python
slicestartstopstep
string-methods
ternary-operator
truth-value-testing
using-pip
using-python-for-web-development
variable-names-and-binding
virtual-environments
web-frameworks-and-what-they-do-for-you
what-is-python-used-for
while-loop-statements
zip-function
index.md
r
raspberry-pi
react
react-native
redux
rest-api
robotics
rt-os
ruby
rust
sass
security
semantic-ui
software-engineering
sql
ssh
svg
svn
swift
terminal-commandline
tomcat
tools
typescript
typography
user-experience-design
user-experience-research
vagrant
vim
virtualbox
visual-design
voice
vue
vue-cli
web-augmented-reality
web-components
web-performance
web-virtual-reality
wordpress
working-in-tech
xml
portuguese
russian
spanish
mock-guide
tools
.editorconfig
.eslintignore
.eslintrc
.gitattributes
.gitignore
.node-inspectorrc
.prettierrc
.snyk
.travis.yml
.vcmrc
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
README(french).md
README-IT
README.md
docker-compose-shared.yml
docker-compose.yml
lerna.json
netlify.toml
package-lock.json
package.json
sample.env
freeCodeCamp/guide/english/python/python-coding-standards/index.md

28 lines
1.4 KiB
Markdown
Raw Normal View History

2018-10-12 15:37:13 -04:00
---
title: Coding standards
---
### Outline
* Why coding standards?
* Intro to PEP 8
* Commands
### Why coding standards?
The global python community is rapidly growing, and almost everyone uses python. This is where readability of code and uniform standards matter. *Anyone on the planet should be able to read your code and understand what it does*. There are a lot of aspects to understanding other's code, for example comments about what a function does, logically dividing tasks among modules and functions, good variable names, etc.
2018-10-12 15:37:13 -04:00
### Intro to PEP 8
We love sticking to conventions. The python user community has come up with a set of standards, which are now taken as convention. PEP stands for Python Enhancement Proposal. Any industry level code that you write is run through the PEP 8 checker. It is therefore a good practice to start writing docstrings for your classes and functions, and naming variables in lower case with appropriate underscores. It may be worthwhile to have a look at these standards before you begin coding.
2018-10-12 15:37:13 -04:00
[Here is the exhaustive link](https://www.python.org/dev/peps/pep-0008/ "PEP 8 standards")
### Commands
Here's how you check if your python code meets he standards.
```console
:~$ pip install pep8
:~$ pep8 --first myCode.py
```
This will give all those lines which violate the standards, along with a short description of the fixes.