Consola Python

The Python Console is a quick way to execute commands, with access to the entire Python API, command history and auto-complete. The command prompt is typical for Python 3.x, the interpreter is loaded and is ready to accept commands at the prompt >>>.

The Python Console is a good way to explore the possibilities of Blender built-in Python. The Python Console can be used to test small bits of Python code which can then be pasted into larger scripts.

../_images/editors_python-console_default.png

Consola de Python.

Interfaz

Menús del encabezado

Menú Vista

Ampliar / Reducir

Increases/Decreases the font size of the console text.

Mover a palabra anterior Ctrl-Izquierda

Mueve el cursor al principio de la palabra anterior. Si el cursor está en medio de una palabra, el cursor se mueve al principio de la palabra actual.

Mover a palabra siguiente Ctrl-Derecha

Mueve el cursor al final de la siguiente palabra. Si el cursor está en medio de una palabra, el cursor se mueve al final de la palabra actual.

Mover a inicio de línea Inicio

Mueve el cursor al inicio de la línea actual.

Mover a fin de línea Fin

Mueve el cursor al final de la línea actual.

Menú Consola

Eliminar todo

Refreshes the console giving the view a fresh start. Note that command history is not cleared.

Eliminar línea Mayús-Intro.

Eliminará todo en la línea del símbolo del sistema.

Borrar palabra anterior Ctrl-Retroceso

Elimina todo entre el cursor y el comienzo de la palabra anterior (separado por puntos). Si el cursor está en medio de una palabra, borra todo hasta el principio de la palabra actual.

Borrar palabra siguiente Ctrl-Suprimir

Elimina todo entre el cursor y el final de la siguiente palabra. Si el cursor está en medio de una palabra, borra todo hasta el final de la palabra actual.

Copiar como script Mayús-Ctrl-C

Copies the full history buffer to the clipboard, this can be pasted into a text file to be used as a Python script.

Copiar Ctrl-C

Copy the selection.

Pegar Ctrl-V

Paste into the command line.

Insertar sangría Tab

Inserta un carácter de tabulación en el cursor.

Quitar sangría Mayús-Tab

Elimina la sangría de la selección.

Retroceder en historial Arriba

Changes the current command to previous command as they appear in the command history.

Avanzar en historial Abajo

Changes the current command to next command as they appear in the command history.

Autocompletar Tab

See Auto Completion for more information.

Vista Principal

Atajos de teclado

  • Left / Right – Cursor motion.

  • Ctrl-Left / Ctrl-Right – Cursor motion, by word.

  • Retroceso / Suprimir – Borra caracteres.

  • Ctrl-Retroceso / Ctrl-Suprimir – Borra palabras.

  • Intro – Ejecuta el comando.

  • Mayús-Intro – Agrega al historial de comandos sin ejecutar.

Uso

Alias

Algunas variables y módulos están disponibles para su comodidad:

  • C: Acceso rápido a bpy.context.

  • D: Acceso rápido a bpy.data.

  • bpy: Módulo API Python de Blender de nivel superior.

Primer vistazo al entorno de la consola

To check what is loaded into the interpreter environment, type dir() at the prompt and execute it.

../_images/editors_python-console_dir.png

Finalización Automática

Now, type bpy. and then press Tab and you will see the Console auto-complete feature in action.

../_images/editors_python-console_completion.png

You will notice that a list of submodules inside of bpy appear. These modules encapsulate all that we can do with Blender Python API and are very powerful tools.

Lets list all the contents of bpy.app module.

Notice the green output above the prompt where you enabled auto-completion. What you see is the result of auto completion listing. In the above listing all are module attributed names, but if you see any name end with (, then that is a function.

We will make use of this a lot to help our learning the API faster. Now that you got a hang of this, lets proceed to investigate some of modules in bpy.

Before Tinkering with the Modules

If you look at the 3D Viewport in the default Blender scene, you will notice three objects: Cube, Light and Camera.

  • All objects exist in a context and there can be various modes under which they are operated upon.

  • At any instance, only one object is active and there can be more than one selected object.

  • All objects are data in the blend-file.

  • There are operators/functions that create and modify these objects.

For all the scenarios listed above (not all were listed, mind you…) the bpy module provides functionality to access and modify data.

Ejemplos

bpy.context

Nota

Para que los siguientes comandos muestren el resultado adecuado, asegúrese de haber seleccionado los objetos en la Vista 3D.

../_images/editors_python-console_bpy-context.png
bpy.context.mode

Will print the current 3D Viewport mode (Object, Edit, Sculpt, etc.).

bpy.context.object or bpy.context.active_object

Will give you access to the active object in the 3D Viewport.

Change the X location to a value of 1:

bpy.context.object.location.x = 1

Move the object from previous X location by 0.5 unit:

bpy.context.object.location.x += 0.5

Change the X, Y, Z location:

bpy.context.object.location = (1, 2, 3)

Change only the X, Y components:

bpy.context.object.location.xy = (1, 2)

The data type of object’s location:

type(bpy.context.object.location)

Now that is a lot of data that you have access to:

dir(bpy.context.object.location)
bpy.context.selected_objects

Will give access to a list of all selected objects.

Type this and then press Tab:

bpy.context.selected_objects

To print out the name of first object in the list:

bpy.context.selected_objects[0]

The complex one… But this prints a list of objects not including the active object:

[obj for obj in bpy.context.selected_objects if obj != bpy.context.object]

bpy.data

bpy.data has functions and attributes that give you access to all the data in the blend-file.

You can access following data in the current blend-file: objects, meshes, materials, textures, scenes, screens, sounds, scripts, etc.

That is a lot of data.

../_images/editors_python-console_bpy-data.png

bpy.ops

The tool system is built around the concept of operators. Operators are typically executed from buttons or menus but can be called directly from Python too.

See the bpy.ops API documentation for a list of all operators.