logging обеспечивает доступ к встроенной функциональности для логирования; • multiprocessing позволяет запускать несколько подпроцессов из программы, обеспечивая API, которое представляет их как потоки;
class Car(object): def turn_left(self): """Поворот машины налево.
❶ .. deprecated:: 1.1 Используйте :func:`turn` вместо этого, с аргументом left (влево) """ ❷ warnings.warn("turn_left больше не используется; используйте вместо этого функцию turn с аргументом left (влево)", DeprecationWarning) self.turn(direction='left')
Я рекомендую включать в документацию проекта следующую информацию:
• проблему, которую проект решает, в двух словах;
• лицензию, под которой распространяется проект. Если он с открытым исходным кодом, стоит указать эту информацию в заголовке каждого файла с кодом, чтобы пользователи знали, что им можно делать с этим кодом;
• пример работы кода;
• инструкцию по установке;
• ссылки на сообщество, рассылки, IRC, форум и т.д.;
• ссылку на систему отслеживания ошибок;
• ссылку на исходный код для разработчиков, которые хотят разобраться в нем.
Следует также включить файл Readme.rst, объясняющий, что делает ваш проект. Этот Readme должен отображаться на странице проекта в GitHub или PyPI; оба сайта поддерживают формат reST.
