Calling Python Scripts from Basic

Calling Python scripts from LibreOffice Basic macros is possible, and valuable features can be obtained such as:


A reasonable exposure to LibreOffice Basic and to Application Programming Interface (API) features is recommended prior to perform inter-language calls from Basic to Python, to JavaScript or any other script engine.

Retrieving Python Scripts

Python scripts can be personal, shared, or embedded in documents. In order to execute them, LibreOffice Basic needs to be provided with Python script locations. Locating interface compliant UNO objects allows the execution of Python scripts:

         Option Explicit
         Public Function GetPythonScript(macro As String, _
                 Optional location As String) As
             ''' Grab Python script object before execution
             ' Arguments:
             '    macro   : as "library/$macro" or "$macro"
             '    location: as "document", "share", "user" or ENUM(eration)
             ' Result:
             '    located UNO service'''
             If IsMissing(location) Then location = "user"
             Dim mspf As Object '
             Dim sp As Object ' compatible
             Dim uri As String
             If location="document" Then
                 sp = ThisComponent.getScriptProvider()
                 mspf = CreateUNOService("")
                 sp = mspf.createScriptProvider("")
             End If
             uri = ""& macro &"?language=Python&location="& location
             GetPythonScript = sp.getScript(uri)
         End Function ' GetPythonScript

Executing Python Scripts

La infraestructura de scripts de la Interfaz de Programación d'Aplicaciones (API) de LibreOffice tien encontu pa la execución inter-llinguax de scripts ente Python y Basic o, pal casu, otros llinguaxes de programación con sofitu. Los argumentos puen pasase atrás y alantre ente llamaes, siempre que representen primitives de tipos de datos que dambos llinguaxes reconozan, y asumiendo que la infraestructura de scripts los convierte de mou apropiáu.


workstation_name = script.invoke(Array(), Array(), Array())

opSysName = script.invoke(Array(), in_outs, Array()) ' in_out is an Array

file_len = script.invoke(Array(systemFilePath), Array(), Array())

normalizedPath = script.invoke(Array(systemFilePath), Array(), Array())

Embedded Scripts Examples

Below ComputerName, and GetFilelen routines are calling their Python counterparts, using aforementioned GetPythonScript function. Exception handling is not detailed.

         Option Explicit
         Option Compatible ' Almítense les propiedaes
         Private scr As Object '
         Private Property Get ComputerName As String
             '''Nome de la estación de trabayu'''
             scr = GetPythonScript("$computer_name", "document")
             ComputerName = scr.invoke(Array(), Array(), Array())
         End Property ' ComputerName
         Private Function GetFilelen(systemFilePath As String) As Currency
             '''Tamañu del ficheru en bytes'''
             scr = GetPythonScript("Os/$get_size", Script.ISEMBEDDED)
             GetFilelen = scr.invoke(Array(systemFilePath), Array(), Array(),)
         End Function ' GetFilelen
         Private Type _SCRIPT_LOCATION
             ISEMBEDDED As String ' document script
             ISPERSONAL As String ' user script
             ISSHARED As String ' LibreOffice macro
         End Type ' _SCRIPT_LOCATION
         Public Function Script() As Object ' Text enumeration
             Static enums As _SCRIPT_LOCATION : With enums
             If .ISEMBEDDED = "" Then
                 .ISEMBEDDED = "document" ' document script
                 .ISPERSONAL = "user" ' user scripts
                 .ISSHARED = "share" ' LibreOffice macro
             End If : End With ' enums
             Script = enums
         End Function ' Script

Two different Python modules are called. They can either be embedded in the current document, either be stored on the file system. Argument type checking is skipped for clarity:

         # -*- coding: utf-8 -*-
         from __future__ import unicode_literals
         import platform
         def computer_name() -> str:
             return platform.node()
         def OSname() -> str:
             return platform.system()

         # -*- coding: utf-8 -*-
         from __future__ import unicode_literals
         import os.path
         def get_size(systemFilePath: str) -> str:
             return str(os.path.getsize(systemFilePath))
         def normalyze(systemPath: str) -> str:
             return os.path.normpath(systemPath)

Personal or Shared Scripts Examples

The calling mechanism for personal or shared Python scripts is identical to that of embedded scripts. Library names are mapped to folders. Computing LibreOffice user profile and shared modules system file paths can be performed as detailed in Getting session information. Below OSName, HelloWorld and NormalizePath routines are calling their Python counterparts, using aforementioned GetPythonScript function. Exception handling is not detailed.

         Option Explicit
         Option Compatible ' Almítense les propiedaes
         Private scr As Object '
         Private Property Get OSName As String
             '''Platform name as "Linux", "Darwin" or "Windows"'''
             scr = GetPythonScript("$OSname", Script.ISPERSONAL)
             OSName = scr.invoke(Array(), Array(), Array()) 
         End Property ' OSName
         Private Sub HelloWorld()
             '''LibreOffice Python shared sample'''
             scr = GetPythonScript("$HelloWorldPython", Script.ISSHARED)
             scr.invoke(Array(), Array(), Array(),)
         End Sub ' HelloWorld
         Public Function NormalizePath(systemFilePath As String) As String
             '''Strip superfluous '\..' in path'''
             scr = GetPythonScript("Os/$normalyze", "user")
             NormalizePath = scr.invoke(Array(systemFilePath), Array(), Array())
         End Function ' NormalizePath

Python standard modules

LibreOffice embedded Python contains many standard libraries to benefit from. They bear a rich feature set, such as but not limited to:

Please support us!