Почему лучшие практики написания кода на Python?

Путь к достижению хороших результатов анализа полон исследований, экспериментов и тестирования различных подходов. В этом путешествии мы пишем много кодов, на которые мы и другие ссылаемся, работая в команде. Если ваш код недостаточно чистый, другим (и вам тоже) будет сложно понять, повторно использовать или модифицировать ваш код.

Если вы напишете аккуратный и чистый код, вы будете благодарны себе и другим.

В этом блоге вы познакомитесь с передовыми методами написания аккуратного и чистого кода на Python.

Существуют отраслевые стандарты, такие как PEP8 для программирования на Python. PEP означает предложение по улучшению Python. Рассмотрим эти стандарты более подробно:

Лучшие практики написания кода на Python

1. Соглашение об именах переменных

Установка интуитивно понятных имен переменных очень полезна для любого, кто понимает, «что» мы пытаемся сделать.

Часто мы создаем переменные, используя одиночные символы, такие как i, j, k — это не самоочевидные переменные, и их следует избегать.

Примечание. Никогда не используйте однобуквенные имена l, o или I, поскольку они могут быть ошибочно приняты за «1» и «0» в зависимости от гарнитуры.

o = 2 # This may look like you're trying to reassign 2 to zero

Плохая практика

Мы можем использовать подчеркивание «_» для создания имен переменных, состоящих из нескольких слов, как показано ниже:

Рекомендации

Примечание. Прекратите использовать df для определения фреймов данных, вместо этого используйте более интуитивно понятные имена.

2. Комментарии в функции

Комментарии являются одним из наиболее важных аспектов, позволяющих сделать наш код удобочитаемым и простым для понимания.

Есть 2 типа комментариев:

  1. Встроенный комментарий: комментарии, которые находятся в той же строке, что и наш код. «#» используется для установки встроенных комментариев.
a = 10 # Single line comment

2. Блочный комментарий. Многострочные комментарии называются блочными комментариями.

""" Example of Multi-line comment 
    Line 2 of a multiline comment
"""

Плохая практика

Рекомендации

3. Отступ

Отступы — это мощная функция, облегчающая чтение и выполнение кода. Отступ задается с использованием 4 пробелов/табуляции на уровень отступа.

Некоторые синтаксисы требуют, чтобы код имел отступ по умолчанию. Например, содержимое тела определения функции:

def function(var_one):
    print(var_one)

Мы можем использовать отступы для создания чистых и легко читаемых многострочных составляющих функций (таких как аргументы, переменные и т. д.).

Плохая практика

Рекомендации

Табы или пробелы для отступов? Предпочтительнее использовать пробелы. Вкладки следует использовать исключительно для того, чтобы оставаться согласованным с кодом, который уже имеет отступы с помощью табуляции. Python запрещает смешивать табуляции и пробелы для отступов.

4. Максимальная длина строки

Согласно PEP8, рекомендуется ограничить длину всех строк до 79 символов. 80–100 символов в целом тоже нормально.

Для кодов в скобках или квадратных скобках Python по умолчанию предполагает продолжение строки, в то время как в других случаях мы можем использовать «\».

Плохая практика

Рекомендации

5. Импорт по отдельным строкам

Рекомендуется импортировать новый пакет в отдельной строке.

Плохая практика

import sys, os, pandas

Рекомендации

import os
import sys
import pandas

6. Рекомендации по размещению

Расстояние также влияет на общую удобочитаемость для пользователя. Ниже приведена наилучшая практика в отношении интервалов:

Всегда окружайте следующие бинарные операторы одним пробелом с обеих сторон: присваивание (=), расширенное присваивание (+=, -=, и т. д.), сравнения (==, <, >, !=, <>, <=, >=, in, not in, is , is not), логические значения (and, or, not).

Плохая практика

i=i+1
submitted +=1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)

Рекомендации

i = i + 1
submitted += 1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)

Использованная литература:

  1. https://gist.github.com/sloria/7001839
  2. https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google

Спасибо!

Вам также могут понравиться следующие истории:



10 операций Python для 70% вашего анализа данных
Повседневная работа Data Scientist включает в себя множество задач, таких как предварительная обработка данных, анализ данных, машинное… medium.com





10-шаговый подход к каждому анализу данных!
Добавление структуры к вашему анализу данных!medium.com