In FreeCAD, Python code can be used to create various elements programmatically, without needing to click on the graphical user interface. Additionally, many tools and workbenches of FreeCAD are programmed in Python.
Readability of Python code is one of the most important aspects of this language. Using a clear and consistent style within the Python community facilitates contributions by different developers, as most experienced Python programmers expect the code to be formatted in a certain way and to follow certain rules. When writing Python code, it is advisable to follow PEP8: Style Guide for Python Code and PEP257: Docstring Conventions.
These documents present explanations in a more user-friendly way:
In this documentation, some conventions for Python examples should be followed.
This is a typical function signature
Wire = makeWire(pointslist, closed=False, placement=None, face=None, support=None)
- Arguments with key-value pairs are optional, with the default value indicated in the signature. This means that the following calls are equivalent:
Wire = makeWire(pointslist, False, None, None, None) Wire = makeWire(pointslist, False, None, None) Wire = makeWire(pointslist, False, None) Wire = makeWire(pointslist, False) Wire = makeWire(pointslist)
- In this example the first argument doesn't have a default value so it should always be included.
- When the arguments are given with the explicit key, the optional arguments can be given in any order. This means that the following calls are equivalent:
Wire = makeWire(pointslist, closed=False, placement=None, face=None) Wire = makeWire(pointslist, closed=False, face=None, placement=None) Wire = makeWire(pointslist, placement=None, closed=False, face=None) Wire = makeWire(pointslist, support=None, closed=False, placement=None, face=None)
- Python's guidelines stress readability of code; in particular, parentheses should immediately follow the function name, and a space should follow a comma.
p1 = Vector(0, 0, 0) p2 = Vector(1, 1, 0) p3 = Vector(2, 0, 0) Wire = makeWire([p1, p2, p3], closed=True)
- If code needs to be broken over several lines, this should be done at a comma inside brackets or parentheses; the second line should be aligned with the previous one.
a_list = [1, 2, 3, 2, 4, 5] Wire = makeWire(pointslist, False, None, None, None)
- Functions may return an object that can be used as the base of another drawing function.
Wire = makeWire(pointslist, closed=True, face=True) Window = makeWindow(Wire, name="Big window")
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
This creates prefixed functions, that is,
module.function(). This system prevents name clashes with functions that are named the same but that come from different modules.
For example, the two functions
myModule.makeWindow() may coexist without problem.
Full examples should include the necessary imports and the prefixed functions.
import FreeCAD, Draft p1 = FreeCAD.Vector(0, 0, 0) p2 = FreeCAD.Vector(1, 1, 0) p3 = FreeCAD.Vector(2, 0, 0) Wire = Draft.makeWire([p1, p2, p3], closed=True)
import FreeCAD, Draft, Arch p1 = FreeCAD.Vector(0, 0, 0) p2 = FreeCAD.Vector(1, 0, 0) p3 = FreeCAD.Vector(1, 1, 0) p4 = FreeCAD.Vector(0, 2, 0) pointslist = [p1, p2, p3, p4] Wire = Draft.makeWire(pointslist, closed=True, face=True) Structure = Arch.makeStructure(Wire, name="Big pillar")