Creating Python Scripts with ScriptForge

Diferencias entre BASIC y Python

The ScriptForge library is available both for Basic and Python. Most services, methods and properties work identically in both programming languages. However, due to differences in how each language works, ScriptForge users must be aware of some characteristics of the library when using Python:


Visit Ayuda con las macros en Python en LibreOffice for more information on Python scripting using LibreOffice.

Ejecutar secuencias Python en LibreOffice

Depending on what you intend to achieve, you may choose one of the following approaches to running Python scripts in LibreOffice:


If you plan to run scripts from inside the LibreOffice process, it is recommended to install the APSO (Alternative Script Organizer for Python) extension. However, to develop Python scripts from outside LibreOffice, you can choose your preferred Python IDE.

Ejecutar secuencias dentro del proceso de LibreOffice

Utilizar la extensión APSO

The easiest way to get started with Python scripting in LibreOffice is by installing the APSO extension. After installing it, open any LibreOffice component and go to Tools - Macros - Organize Python Scripts.

In APSO's main window go to Menu - Python Shell.


Alternatively you can open APSO using the default shortcut Alt + Shift + F11.

Now you can start typing Python commands and the shell will print the corresponding output after each line of code is executed.

To start using the ScriptForge library, you need to import the CreateScriptService method, with which you will be able to access the services provided by the library. The example below uses the Basic service to display a message box.

    from scriptforge import CreateScriptService
    bas = CreateScriptService("Basic")

To run the example above, enter each line in the Python shell, one by one, pressing the Enter key after you type each line of code.

Now you can start executing Python commands using any of the ScriptForge services. For example, the code snippet below uses the UI service to create a blank Writer document.

    ui = CreateScriptService("UI")
    doc = ui.CreateDocument("Writer")

Crear archivos de secuencia de órdenes de Python

Puede crear sus propios archivos Python y modificarlos con su editor de texto predilecto. Después, puede llamarlos desde cualquier componente de LibreOffice.

El primer paso consiste en encontrar la ubicación de las secuencias de órdenes de usuario. Para hacerlo, consulte la página de ayuda Organización y ubicación de secuencias de órdenes Python.

Now you can create a text file inside your Python user scripts folder, for instance, and start typing your scripts.

Next is a simple example that gets the numeric value from a Calc cell and increments it by 1. Simply type the following code into the file.

    from scriptforge import CreateScriptService
    doc = CreateScriptService("Calc")
    def increment_cell(args=None):
        value = doc.GetValue("A1")
        value += 1
        doc.SetValue("A1", value)
    g_exportedScripts = (increment_cell, )

This example creates the increment_cell function. Note that g_exportedScripts is a tuple that tells which functions will be displayed in LibreOffice as user scripts.

Para ejecutar esta secuencia desde un documento de Calc:

  1. Cree o abra un archivo de Calc.

  2. Enter some numeric value into cell "A1" in the current sheet.

  3. Diríjase a Herramientas ▸ Macros ▸ Ejecutar macros.

  4. Choose My Macros - sf_test in the library selector. Then choose the increment_cell function under the Macro Name list.

  5. Pulse en Run (‘Ejecutar’). Observe cómo el valor de la celda A1 aumenta en una unidad.

También puede utilizar APSO para ejecutar secuencias escritas en Python de manera semejante:

  1. Primeramente, abra APSO yendo a Herramientas ▸ Macros ▸ Organizar secuencias de Python.

  2. En la lista de macros, navegue a Mis macros ▸ sf_test ▸ increment_cell.

  3. Pulse en Ejecutar.

Ejecutar secuencias separadamente del proceso de LibreOffice

Determinar la ruta de la instalación

The first step to run scripts from a separate process is to find the folder where LibreOffice is installed. There are several ways to do that, but ScriptForge provides a quick way to identify your installation path. For that, open APSO's Python shell and type:

    from scriptforge import CreateScriptService
    fs = CreateScriptService("FileSystem")
    fs.FileNaming = "SYS"
    inst_dir = fs.InstallFolder

The output from the code above is the base directory where LibreOffice is installed. Now you need to add the "program" subfolder to the resulting path. This is the base folder from which you will run Python scripts from a separate process.

For example, suppose you get /usr/lib/libreoffice/ as the result from running the Python code above. Then you need to consider /usr/lib/libreoffice/program as the path to run your Python scripts.

Start LibreOffice with socket settings

To run Python scripts from a separate process, you need to start LibreOffice with a few additional options that specify the hostname and port through which the external process will communicate with the LibreOffice component process.

Open the your operating system's command prompt, navigate to the program folder of your LibreOffice installation directory and type:

./soffice --accept='socket,host=localhost,port=2021;urp;'

La orden anterior iniciará LibreOffice con una vía de comunicación abierta para que otros procesos puedan intercambiar mensajes con este.

Observe que el ejemplo anterior abre el centro de inicio de LibreOffice. Si quiere abrir un componente en concreto, como por ejemplo Writer, puede añadir la opción --writer a la orden, como se ejemplifica a continuación:

./soffice --writer --accept='socket,host=localhost,port=2021;urp;'

Tome nota de los parámetros host y port, los cuales en este ejemplo son localhost y 2021, respectivamente.

Ejecutar un intérprete de Python externo

Start the Python shell from within the program folder inside your LibreOffice installation path. Follow the steps above to learn how to find your installation path.

On Linux / Mac OS:

$ cd /usr/lib/libreoffice/program

$ python

En Windows:

$ cd C:\Program Files\LibreOffice\program\

$ python.exe

This will open the Python shell and now you can start typing commands that will be executed by LibreOffice. But first you need to set up the socket connection.

    from scriptforge import ScriptForge, CreateScriptService
    ScriptForge(hostname='localhost', port=2021)

The second line of code above defines the host and port settings so that the Python shell can communicate with an ongoing LibreOffice process opened with the same socket settings.

Now you can run other Python commands and they will be able to communicate with the LibreOffice process. For example:

    ui = CreateScriptService("UI")
    bas = CreateScriptService("Basic")
    doc = ui.OpenDocument("~/Documents/myFile.ods")

¡Necesitamos su ayuda!