Установка скиллов и плагинов OpenClaw осуществляется на ваш страх и риск. Все файлы были получены из открытых источников и предоставляются «как есть». Мы не гарантируем их корректную работу, безопасность или совместимость с вашей системой. Перед установкой настоятельно рекомендуется ознакомиться с содержимым кода и убедиться, что вы понимаете, какие изменения будут внесены в вашу систему.
В этом руководстве собраны ключевые рекомендации и лучшие практики для разработки на Python. Материал ориентирован на разработчиков, которые хотят писать более чистый, безопасный и поддерживаемый код.
Быстрый чек-лист
- Синтаксис корректен (проверка через
py_compile) - Тесты проходят успешно (
pytest) - Публичные функции имеют type hints
- В коде отсутствуют захардкоженные секреты
- Используются f-строки вместо
.format()или% - Для путей применяется
pathlib - Для работы с файлами используются контекстные менеджеры
- Нет изменяемых значений по умолчанию в аргументах функций
Принципы написания функций
Функции должны быть предсказуемыми и прозрачными. Это означает явные входные параметры, понятные возвращаемые значения и корректную обработку ошибок.
def get_user(user_id: int, include_deleted: bool = False) -> Optional[User]:
"""
Получает пользователя по идентификатору.
Args:
user_id: Уникальный идентификатор пользователя.
include_deleted: Если True — учитывать удалённых пользователей.
Returns:
Объект User или None, если пользователь не найден.
Raises:
DatabaseError: При ошибке соединения с базой данных.
"""
Такая структура делает код самодокументируемым и облегчает поддержку.
Чистота и безопасность кода
Особое внимание стоит уделять безопасности и качеству кода. Избегайте хранения секретов прямо в исходниках, следите за корректной обработкой исключений и придерживайтесь единых стандартов форматирования.
Использование современных возможностей Python — таких как f-строки и pathlib — делает код более читаемым и переносимым.
Работа с ресурсами
Любые операции ввода-вывода должны выполняться через контекстные менеджеры. Это гарантирует корректное освобождение ресурсов даже при возникновении ошибок.
with open("file.txt", "r") as f:
data = f.read()
Типизация и поддерживаемость
Type hints помогают лучше понимать код, упрощают рефакторинг и повышают качество статического анализа. Особенно важно использовать их в публичных API и библиотеках.
Распространённые ошибки
- Использование изменяемых объектов (например, списков) в качестве значений по умолчанию
- Игнорирование обработки исключений
- Смешивание различных стилей форматирования строк
- Отсутствие тестов или их неполнота
Избегая этих ошибок, можно значительно повысить надёжность и читаемость кода.
Заключение
Следование базовым практикам Python-разработки позволяет создавать качественные, масштабируемые и безопасные приложения. Даже простой чек-лист может существенно повысить уровень кода и упростить командную работу.
Файл из источника