Общие принципы написания кода на Python
-
-
1. Простой скрипт (один файл)
Если у вас небольшая утилита или программа, которая делает одну задачу, часто весь код пишут в одном файле с расширением .py. Такой файл становится модулем. Внутри могут быть:
- функции и классы;
- константы и настройки;
- собственные исключения;
- импорты других модулей;
- строка документации (docstring);
- аннотации типов;
- «точка входа» — блок if __name__ == "__main__":, который выполняется только при прямом запуске файла, а не при импорте.
Пример:
-
# utils.py
def greet(name: str) -> str:
"""Возвращает приветствие."""
return f"Hello, {name}!"
if __name__ == "__main__":
print(greet("World"))
-
2. Проект с несколькими модулями
Когда задача разрастается, код разбивают на несколько файлов. Каждый такой файл — это модуль.
Пример структуры проекта:my_project/
├── main.py # Точка входа
├── utils/
│ ├── __init__.py
│ ├── helpers.py
│ └── constants.py
├── models/
│ ├── __init__.py
│ └── database.py
├── tests/
│ └── test_utils.py
└── config.py # Конфигурационные параметры
Здесь utils и models — это пакеты.
Чтобы Python распознал папку как пакет, в ней должен находиться специальный файл __init__.py (он может быть пустым, а может содержать инициализационный код — например, импорт часто используемых функций на уровень пакета).
Несколько общих принципов
- Модульность — ключ к поддерживаемости. Разбивайте код на логические части.
- Разделение ответственности. Каждый файл (модуль) должен решать одну задачу.
- Документируйте. Используйте docstrings, комментарии, аннотации типов.
- Избегайте глобального кода. Код, который должен выполняться только при прямом запуске, выносите в блоки if __name__ == "__main__":.
Нюанс: это расширение лучше всего работает в файлах, где используется единый стиль отступов (только табы или только пробелы). При смешении (табы и пробелы вместе) могут возникнуть проблемы
Окружить с помощью
Если вы работаете в Visual Studio Code, установите расширение htmltagwrap. После этого:
- Выделите текст.
- Нажмите Alt + W (на Mac — Option + W).
- Введите название тега — <p>