Ответ 1

#!/usr/bin/env python
# coding: utf-8
"""
    package.module
    ~~~~~~~~~~~~~

    A description which can be long and explain the complete
    functionality of this module even with indented code examples.
    Class/Function however should not be documented here.

    :copyright: year by my name, see AUTHORS for more details
    :license: license_name, see LICENSE for more details
"""

Модуль может содержать или не содержать функцию main, чтобы не быть частью шаблона.

Ответ 2

Часто рекомендуется устанавливать

#coding=<coding>

во второй строке. Как

#coding=utf8

Например. Это альтернатива подробному

# -*- coding: <encoding name> -*-

Подробнее см. PEP-263.

Изменить для полного ответа: зависит от ситуации. Если его для какого-то внутреннего проекта проще, лучше. Но у меня почти всегда есть

def main():
    #code
    pass

if __name__=="__main__":
    main()

Если я намереваюсь опубликовать код, я добавляю правильную документацию и условия лицензирования, а также указанную директиву кодирования.

Shebang (#!/usr/bin/env python) необходим только для файла, который должен быть исполняемым.

Ответ 3

Еще лучше, вот предлагаемая макета пакета доктором Титусом Брауном:

http://github.com/ctb/SomePackage

Ответ 4

Возвращение чего-то тоже является лучшей практикой (здесь с названными args):

...
import sys

def main(args):
    return 0

if __name__=='__main__':
    sys.exit(main(sys.argv))

Но это становится более сложным, чем простой "мир привет".

Ответ 5

Модули не исполняются, поэтому они не должны иметь shebang.

Докстры отлично.

Кодирование полезно.

Метаданные, такие как автор, авторское право, версия и лицензия, как лучше всего хранятся в setup.py как часть метаданных упаковки. Использование атрибутов модуля __(metadata)__ является устаревшей практикой, поскольку оно предшествует времени, когда Python имел метаданные упаковки. Если код имеет достаточно эфемерную природу, чтобы не гарантировать упаковку, то это не означает, что вам понадобятся какие-либо метаданные.

Дополнительные функции, такие как test() или __main__ hack, я не использую почти так, чтобы гарантировать включение в шаблон модуля.

Итак, нужен только один шаблон:

# -*- coding: ascii -*-
"""
"""

Приятный и простой.

Ответ 6

Я бы сказал, что самое лучшее - это самое простое, чем удовлетворить ваши требования. Чем больше данных вы помещаете в "скелет", тем более устарелые или бессмысленные или ошибочные данные вы можете получить там.

• Часть if __name__=='__main__': не нужна в модуле, который является всего лишь модулем. Тесты могут быть частью модуля, но даже тогда их можно было бы называть внешними. Вызов модуля напрямую часто является неудобным (или невозможным, например, когда используется относительный импорт).
• Интерпретатор Python обычно скажет, когда нужна информация о кодировании, а не каждый кусочный код нуждается в символах без ascii.

Разумным минимальным IMHO является докшлинка в начале модуля. Другие части, упомянутые в вашем вопросе и другие ответы, также часто полезны, но никоим образом не являются обязательными.

Ответ 7

В зависимости от характера программы вы можете рассмотреть возможность выбора лицензии и поместить ее в начало файла.

Ответ 8

Как насчет:

...
import sys

def main(*args):
    return 0

if __name__=='__main__':
    sys.exit(main(*sys.argv[1:]))

Затем, конечно, вы изменяете основной скелет, чтобы отражать фактические параметры программы (после имени файла):

def main(arg1, arg2, *args):
    ...

(Удивленный, мы не можем использовать Markdown в комментариях...)