Docstring в Python: форматы, назначение и лучшие практики написания
Docstring (строка документации) — это специальный комментарий в коде Python, который описывает назначение функций, классов, модулей или методов. Он помогает разработчикам понять, как использовать код, не вникая в его реализацию. В этой статье мы разберем, зачем нужны докстринги, какие форматы существуют и как их правильно писать. 1. Документация кода Докстринги объясняют, что делает объект, какие параметры принимает и что возвращает. Это особенно важно в командной разработке. 2. Автогенерация документации Инструменты вроде Sphinx или pdoc преобразуют докстринги в красивую HTML-документацию...
3 года назад
Python: статические методы, методы класса и экземпляра класса
Согласно модели данных Python, язык предлагает три вида методов: статические, класса и экземпляра класса. Давайте посмотрим, что же происходит за кулисами каждого из видов методов. Понимание принципов их работы поможет в создании красивого и эффективного кода. Начнём с самого простого примера, в котором демонстрируются все три вида методов. class ToyClass: def instancemethod(self): return 'instance method called', self @classmethod def classmethod(cls): return 'class...
3519 читали · 4 года назад
Три элегантных способа перевернуть строку в Python
Строки в Python — упорядоченная последовательность символов. В Python нет встроенных методов, позволяющих перевернуть строку, «отзеркалить» ее. Но вообще это сделать можно, причем несколькими способами. Существует три способа перевернуть строку. 1. Срезы Повернуть строку можно с помощью срезов. Чтобы это сделать, мы просто создадим срез, который начинается с длины строки и заканчивается индексом 0. Делается это так: string_name[string_length::-1] # метод 1 Длиной строки можно и пренебречь: string_name[::-1] # метод 2 В этом случае подразумевается, что первый аргумент — длина строки...