Konwencje i PEP 8

Zasady inżynierii oprogramowania w Pythonie

Adam Spannbauer

Machine Learning Engineer at Eastman

Czym są konwencje?

Bump pięściami

Kłaniająca się osoba

Uścisk dłoni

Logo Pythona

Wprowadzenie do PEP 8

PEP 8

„Kod jest czytany znacznie częściej, niż jest pisany"

Naruszanie PEP 8

#define our data
my_dict ={
    'a'  : 10,
'b': 3,
    'c'  :   4,
             'd': 7}
#import needed package
import numpy as np
#helper function
def DictToArray(d):
    """Convert dictionary values to numpy array"""
    #extract values and convert
              x=np.array(d.values())
              return x
print(DictToArray(my_dict))

array([10,  4,  3,  7])

Przestrzeganie PEP 8

# Import needed package
import numpy as np

# Define our data
my_dict = {'a': 10, 'b': 3, 'c': 4, 'd': 7}


# Helper function
def dict_to_array(d):
    """Convert dictionary values to numpy array"""
    # Extract values and convert
    x = np.array(d.values())
    return x


print(dict_to_array(my_dict))

array([10,  4,  3,  7])

Narzędzia PEP 8

PEP 8 w PyCharm

Pakiet pycodestyle

Używanie pycodestyle

datacamp@server:~$ pip install pycodestyle
datacamp@server:~$ pycodestyle dict_to_array.py

dict_to_array.py:5:9: E203 whitespace before ':'
dict_to_array.py:6:14: E131 continuation line unaligned for hanging indent
dict_to_array.py:8:1: E265 block comment should start with '# '
dict_to_array.py:9:1: E402 module level import not at top of file
dict_to_array.py:11:1: E302 expected 2 blank lines, found 0
dict_to_array.py:13:15: E111 indentation is not a multiple of four

Wynik działania pycodestyle

Wynik błędów pycodestyle

Ćwiczenia

Zasady inżynierii oprogramowania w Pythonie