Организация исходного файла Python

Question

Я начинаю новый проект на Python и хочу как можно точнее следовать стандартным соглашениям. Я читал, что операторы import должны стоять на первом месте, например. Но я не нашел никаких соглашений для таких вещей, как размещение всех определений функций до или после всех определений классов. Есть ли какие-либо соглашения для таких вещей? Или все обычно просто организуют такие вещи, как определения функций и классов в любом порядке?

Answer 1

PEP8 - это руководство по стилю Python: http://www.python.org/dev/peps/pep-0008/

Импорт идет вверху файла, хотя импорт на уровне метода разрешен.

Нет определенного порядка для классов и функций. Используйте то, что имеет смысл.

Answer 2

Нет, соглашения об организации функций и классов отсутствуют. Тем не менее, есть несколько основных рекомендаций, которые сделают ваш источник лучше и понятнее для читателей:

• Документ. Что бы вы ни делали, убедитесь, что использование (и в некоторых случаях реализация) классов и функций описано на простом английском языке
• Сгруппируйте вещи, которые похожи друг на друга. Две функции, которые выполняют похожие функции? Положите их вместе.
• Используйте здравый смысл. Если класс расширяет другой, базовый класс должен стоять первым. Если функция берет экземпляр класса, который вы определили, убедитесь, что определение класса идет первым.

Примеры того, как это сделать, приведены не далее, чем в стандартной библиотеке Python. Исходные файлы из некоторых модулей должны дать вам представление о том, как организован исходный код в Python.