Python/ru

Описание
Python - это язык программирования высокого уровня, общего назначения, который очень часто используется в больших приложениях для автоматизации некоторых задач путем создания скриптов или макросов.

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

Смотрите Введение в Python, чтобы узнать об основах языка программирования Python, затем Руководство по написанию сценариев на Python и Основы написания скриптов для FreeCAD, чтобы начать писать скрипты для FreeCAD.

Удобочитаемость
Читабельность кода Python является одним из наиболее важных аспектов этого языка. Использование четкого и последовательного стиля в сообществе Python облегчает вклад различных разработчиков, поскольку большинство опытных программистов на Python ожидают, что код будет отформатирован определенным образом и будет следовать определенным правилам. При написании кода на Python рекомендуется следовать PEP8: Руководство по стилю написания кода Python и PEP257: Соглашения о строках документов.

Эти документы представляют пояснения в более удобной для пользователя форме:
 * Как написать Красивый код на Python с помощью PEP 8
 * Документирование Кода Python: Полное Руководство.

Соглашения
В этой документации следует соблюдать некоторые соглашения для примеров Python.

Это типичная сигнатура функции


 * Аргументы с парами ключ-значение являются необязательными, значение по умолчанию указано в подписи. Это означает, что следующие вызовы эквивалентны:


 * В этом примере первый аргумент не имеет значения по умолчанию, поэтому его всегда следует включать.


 * Если аргументы заданы с явным ключом, необязательные аргументы могут быть заданы в любом порядке. Это означает, что следующие вызовы эквивалентны:


 * В рекомендациях Python подчеркивается удобочитаемость кода; в частности, круглые скобки должны сразу следовать за именем функции, а пробел должен следовать за запятой.


 * Если код необходимо разбить на несколько строк, это следует делать через запятую внутри скобок или круглых скобок; вторая строка должна быть выровнена с предыдущей.


 * Функции могут возвращать объект, который может быть использован в качестве основы для другой функции рисования.

Применение "Import"
Функции Python хранятся в файлах, называемых модулями. Перед использованием любой функции вызываемой из модуля, модуль должен быть включен в код инструкцией.

Это создает префиксы к функциям, то есть. Эта система предотвращает колизии имен между функциями, которые имеют одинаковые имена, но находятся в разных модулях. Например, две функции и  могут сосуществовать без проблем.

Полные примеры должны включать необходимый импорт и функции с префиксами.