Context English Guadeloupean Creole, French (gcf)
main0000.xhp
tit
help.text
Python Scripts
main0000.xhp
bm_id491543348147708
help.text
<bookmark_value>macros;Python scripts</bookmark_value> <bookmark_value>Python;macros</bookmark_value> <bookmark_value>scripts;Python</bookmark_value>
main0000.xhp
hd_id3154232
help.text
<variable id="pythonscriptshelp"><link href="text/sbasic/python/main0000.xhp" name="mainpython">%PRODUCTNAME Python Scripts Help</link></variable>
main0000.xhp
par_id3153894
help.text
%PRODUCTNAME provides an Application Programming Interface (API) that allows controlling the $[officename] components with different programming languages by using the $[officename] Software Development Kit (SDK). For more information about the $[officename] API and the Software Development Kit, visit <link href="https://api.libreoffice.org/" name="api.libreoffice.org">https://api.libreoffice.org</link>
main0000.xhp
par_id3147226
help.text
This help section explains the most common Python script functions for %PRODUCTNAME. For more in-depth information please refer to the <link href="https://wiki.documentfoundation.org/Macros/Python_Design_Guide" name="wiki.documentfoundation.org PYTHON Guide">Designing & Developing Python Applications</link> on the Wiki.
main0000.xhp
hd_id3146957
help.text
Working with Python Scripts in %PRODUCTNAME
main0000.xhp
N0102
help.text
You can execute Python scripts choosing <menuitem>Tools - Macros - Run Macro</menuitem>. Editing scripts can be done with your preferred text editor. Python scripts are present in various locations detailed hereafter. You can refer to Programming examples for macros illustrating how to run the Python interactive console from %PRODUCTNAME.
main0000.xhp
par_id131568902936659
help.text
The %PRODUCTNAME scripting framework for Python is optional on some GNU/Linux distributions. If it is installed, selecting <menuitem>Tools - Macros - Run Macro</menuitem> and checking <literal>%PRODUCTNAME Macros</literal> for the presence of <literal>HelloWorld – HelloWorldPython</literal> macro is sufficient. If absent, please refer to your distribution documentation in order to install the %PRODUCTNAME scripting framework for Python.
python_2_basic.xhp
tit
help.text
Python to Basic
python_2_basic.xhp
N0330
help.text
<bookmark_value>Python;Calling Basic</bookmark_value> <bookmark_value>ParamArray</bookmark_value>
python_2_basic.xhp
N0331
help.text
<variable id="py2ba_h1"><link href="text/sbasic/python/python_2_basic.xhp" name="Calling Basic macros from Python">Calling Basic Macros from Python</link></variable>
python_2_basic.xhp
N0332
help.text
You can call %PRODUCTNAME Basic macros from Python scripts, and notable features can be obtained in return such as:
python_2_basic.xhp
N0333
help.text
Simple logging facilities out of <literal>Access2Base</literal> library Trace console,
python_2_basic.xhp
N0334
help.text
<literal>InputBox</literal> and <literal>MsgBox</literal> screen I/O functions based on Basic to ease Python development,
python_2_basic.xhp
N0335
help.text
<literal>Xray</literal> calls interrupting Python script execution to help inspect variables.
python_2_basic.xhp
N0336
help.text
The %PRODUCTNAME Application Programming Interface (API) Scripting Framework supports inter-language script execution between Python and Basic, or other supported programming languages for that matter. Arguments can be passed back and forth across calls, provided that they represent primitive data types that both languages recognize, and assuming that the Scripting Framework converts them appropriately.
python_2_basic.xhp
N0337
help.text
It is recommended to have knowledge of Python standard modules and %PRODUCTNAME API features prior to perform inter-language calls from Python to Basic, JavaScript or any other script engine.
python_2_basic.xhp
N0338
help.text
When running Python scripts from an Integrated Development Environment (IDE), the %PRODUCTNAME-embedded Basic engine may be absent. Avoid Python-to-%PRODUCTNAME Basic calls in such contexts. However Python environment and Universal Networks Objects (UNO) are fully available. Refer to <link href="text/sbasic/python/python_ide.xhp" name="Setting Up an Integrated IDE for Python">Setting Up an Integrated IDE for Python</link> for more information.
python_2_basic.xhp
N0339
help.text
Retrieving %PRODUCTNAME Basic Scripts
python_2_basic.xhp
N0340
help.text
%PRODUCTNAME Basic macros can be personal, shared, or embedded in documents. In order to execute them, Python run time needs to be provided with Basic macro locations. Implementing the <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1script_1_1provider_1_1XScript.html" name="XScriptProvider interface">com.sun.star.script.provider.XScriptProvider</link> interface allows the retrieval of executable scripts: