Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions python.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,31 @@
* Используем двойные кавычки для строк (`"string"`), не используем одинарные (`'string'`).
* Добавляем аннотации типов.
* В случае длинных перечислений элементов коллекций или аргументов, после последнего аргумента добавляется запятая (для однородного автоформатирования).
* Докстринги всегда оформляем многострочно — см. раздел [Докстринги](#докстринги).

Ниже приведены инструкции по настройке автоформатирования и code coverage из консоли. Для настройки интеграции с VSCode воспользуйтесь [инструкцией](https://docs.google.com/document/d/19gT4BH6MO-XXyqqzTOoz-jhY0ITbeGKDOZ8FbV_J1tc).


## Докстринги

Докстринг всегда многострочный, независимо от длины текста:
* после открывающих `"""` на той же строке ничего не пишем — текст начинается со следующей строки;
* закрывающие `"""` стоят на отдельной строке.

```python
# Плохо
def crc16(data: bytes) -> int:
"""Return the CRC-16/Modbus of *data* as a 16-bit int."""

# Хорошо
def crc16(data: bytes) -> int:
"""
Return the CRC-16/Modbus of *data* as a 16-bit int.
"""
```

Текущий набор инструментов (black/isort/pylint) это правило не проверяет — соблюдается на ревью.

## Автоматическая проверка кода

Для автоформатирования кода используется [black](https://github.com/psf/black) и [isort](https://github.com/PyCQA/isort).
Expand Down