अपने पैकेज को स्टाइलिश रखें

Python पैकेज विकसित करना

James Fulton

Climate informatics researcher

flake8 परिचय

  • स्टैंडर्ड Python स्टाइल PEP8 में वर्णित है
  • एक स्टाइल गाइड बताती है कि कोड कैसे लिखा जाए
  • बग ढूँढने के लिए pytest उपयोग होता है
  • स्टाइलिंग गलतियाँ पकड़ने के लिए flake8 उपयोग होता है
Python पैकेज विकसित करना

flake8 चलाना

स्टैटिक कोड चेकर - कोड पढ़ता है, चलाता नहीं

flake8 features.py

features.py:2:1: F401 'math' imported but unused
..

<filename>:<line number>:<charcter number>:<error code> <desciption>
Python पैकेज विकसित करना

गुणवत्तापूर्ण कोड के लिए आउटपुट का उपयोग

 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' imported but unused

4:1: E302 expected 2 blank lines, found 1

7:1: E302 expected 2 blank lines, found 0

5:4: E111 indentation is not a multiple
     of four
6:4: E111 indentation is not a multiple
     of four

9:5: F841 local variable 'mean_x' is 
     assigned to but never used
Python पैकेज विकसित करना

गुणवत्तापूर्ण कोड के लिए आउटपुट का उपयोग

 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
Python पैकेज विकसित करना

जाने-बूझकर नियम तोड़ना

quadratic.py

4. ...
5. quadratic_1 = 6 * x**2 + 2 * x + 4;
6. quadratic_2 = 12 * x**2 + 2 * x + 8
7. ...
Python पैकेज विकसित करना

जाने-बूझकर नियम तोड़ना

quadratic.py

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

flake8 quadratic.py

quadratic.py:5:14: E222 multiple spaces after operator
quadratic.py:5:35: E703 statement ends with a semicolon
Python पैकेज विकसित करना

जाने-बूझकर नियम तोड़ना

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
Python पैकेज विकसित करना

जाने-बूझकर नियम तोड़ना

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 statement ends with a semicolon
Python पैकेज विकसित करना

flake8 सेटिंग्स

कमेंट्स के बिना स्टाइल उल्लंघन इग्नोर करना

flake8 --ignore E222 quadratic.py

quadratic.py:5:35: E703 statement ends with a semicolon

flake8 --select F401,F841 features.py

2:1: F401 'math' imported but unused
9:5: F841 local variable 'mean_x' is assigned 
     to but never used
Python पैकेज विकसित करना

setup.cfg से पैकेज सेटिंग्स चुनना

सेटिंग्स सहेजने के लिए setup.cfg बनाएँ

पैकेज फाइल ट्री

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst
|-- LICENSE
|-- MANIFEST.in
`-- setup.py
Python पैकेज विकसित करना

setup.cfg से पैकेज सेटिंग्स चुनना

सेटिंग्स सहेजने के लिए setup.cfg बनाएँ

[flake8]


ignore = E302

exclude = setup.py


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

पैकेज फाइल ट्री

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst
|-- LICENSE
|-- MANIFEST.in
|-- setup.py
`-- setup.cfg
Python पैकेज विकसित करना

पूरा पैकेज

$ flake8

पैकेज फाइल ट्री

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst
|-- LICENSE
|-- MANIFEST.in
|-- setup.py
`-- setup.cfg
Python पैकेज विकसित करना

संभव हो तो कम से कम फ़िल्टरिंग करें

न्यूनतम फ़िल्टरिंग

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

अधिकतम फ़िल्टरिंग

Python पैकेज विकसित करना

अभ्यास करते हैं!

Python पैकेज विकसित करना

Preparing Video For Download...