Paketinizi şık tutma

Python Paketleri Geliştirme

James Fulton

Climate informatics researcher

flake8’e giriş

Standart Python stili PEP8 ile tanımlanır
Bir stil kılavuzu kodun düzenini belirler
Hataları bulmak için pytest kullanılır
Stil hatalarını bulmak için flake8 kullanılır

flake8 çalıştırma

Statik kod denetleyici — kodu okur, çalıştırmaz

flake8 features.py

features.py:2:1: F401 'math' içe aktarıldı ama kullanılmadı
..

<dosya adı>:<satır no>:<karakter no>:<hata kodu> <açıklama>

Çıktıyı kaliteli kod için kullanma

 1. import numpy as np
 2. import math
 3.
 4. def mean(x):
 5.    """Calculate the mean"""
 6.    return np.mean(x)
 7. def std(x):
 8.     """Calculate the standard deviation"""
 9.     mean_x = mean(x)
10.     std = mean((x-mean(x))**2)
11.     return std
12.

flake8 features.py

2:1: F401 'math' içe aktarıldı ama kullanılmadı

4:1: E302 2 boş satır bekleniyordu, 1 bulundu

7:1: E302 2 boş satır bekleniyordu, 0 bulundu

5:4: E111 girinti dört katın katı değil
6:4: E111 girinti dört katın katı değil

9:5: F841 yerel değişken 'mean_x' atandı, 
     ancak hiç kullanılmadı

Çıktıyı kaliteli kod için kullanma

 1. import numpy as np
 2.
 3.
 4. def mean(x):
 5.     """Calculate the mean"""
 6.     return np.mean(x)
 7. 
 8. 
 9. def std(x):
10.     """Calculate the standard deviation"""
11.     mean_x = mean(x)
12.     std = mean((x - mean_x)**2)
13.     return std
14.

flake8 features.py

Kuralları bilerek çiğneme

quadratic.py

4. ...
5. quadratic_1 = 6 * x**2 + 2 * x + 4;
6. quadratic_2 = 12 * x**2 + 2 * x + 8
7. ...

Kuralları bilerek çiğneme

quadratic.py

4. ...
5. quadratic_1 =  6 * x**2 + 2 * x + 4;\n6. quadratic_2 = 12 * x**2 + 2 * x + 8
7. ...


flake8 quadratic.py


quadratic.py:5:14: E222 işlemciden sonra birden çok boşluk
quadratic.py:5:35: E703 ifade noktalı virgülle bitiyor

Kuralları bilerek çiğneme

quadratic.py

4. ...
5. quadratic_1 =  6 * x**2 + 2 * x + 4; # noqa
6. quadratic_2 = 12 * x**2 + 2 * x + 8
7. ...

flake8 quadratic.py

Kuralları bilerek çiğneme

quadratic.py

4. ...
5. quadratic_1 =  6 * x**2 + 2 * x + 4; # noqa: E222
6. quadratic_2 = 12 * x**2 + 2 * x + 8
7. ...

flake8 quadratic.py

quadratic.py:5:35: E703 ifade noktalı virgülle bitiyor

flake8 ayarları

Yorum kullanmadan stil ihlallerini yok sayma

flake8 --ignore E222 quadratic.py

quadratic.py:5:35: E703 ifade noktalı virgülle bitiyor

flake8 --select F401,F841 features.py

2:1: F401 'math' içe aktarıldı ama kullanılmadı
9:5: F841 yerel değişken 'mean_x' atandı, 
     ancak hiç kullanılmadı

setup.cfg ile paket ayarlarını seçme

Ayarları saklamak için bir setup.cfg oluşturun

Paket dosya ağacı

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst
|-- LICENSE
|-- MANIFEST.in
`-- setup.py

setup.cfg ile paket ayarlarını seçme

Ayarları saklamak için bir setup.cfg oluşturun

[flake8]


ignore = E302

exclude = setup.py


per-file-ignores =
  example_package/example_package.py: E222

Paket dosya ağacı

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst
|-- LICENSE
|-- MANIFEST.in
|-- setup.py
`-- setup.cfg

Tüm paket

$ flake8

Paket dosya ağacı

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst
|-- LICENSE
|-- MANIFEST.in
|-- setup.py
`-- setup.cfg

Mümkün olan en az filtrelemeyi kullanın

En az filtreleme

# noqa : <code>
# noqa
setup.py → per-file-ignores
setup.cfg → exclude, ignore

En çok filtreleme

Ayo berlatih!

Python Paketleri Geliştirme