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 functions are stored in files called modules. Before using any function in that module, the module must be included in the document with the instruction.

This creates prefixed functions, that is,. This system prevents name clashes with functions that are named the same but that come from different modules. For example, the two functions and  may coexist without problem.

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