<!DOCTYPE html>
<html lang="es" dir="ltr">
<head>
<base href="../../../../">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Python: programar con Python</title>
<link rel="shortcut icon" href="media/navigation/favicon.ico">
<link type="text/css" href="normalize.css" rel="Stylesheet">
<link type="text/css" href="prism.css" rel="Stylesheet">
<link type="text/css" href="default.css" rel="Stylesheet">
<script type="text/javascript" src="polyfills.js"></script><script type="text/javascript" src="languages.js"></script><script type="text/javascript" src="es/langnames.js"></script><script type="text/javascript" src="flexsearch.debug.js"></script><script type="text/javascript" src="prism.js"></script><script type="text/javascript" src="help2.js" defer></script><script type="text/javascript" src="a11y-toggle.js" defer></script><script type="text/javascript" src="paginathing.js" defer></script><script type="text/javascript" src="es/bookmarks.js" defer></script><script type="text/javascript" src="es/contents.js" defer></script><script type="text/javascript" src="help.js" defer></script><meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body>
<header id="TopLeftHeader"><a class="symbol" href="es/text/shared/05/new_help.html"><div></div></a><a class="logo" href="es/text/shared/05/new_help.html"><p dir="auto">Ayuda de LibreOffice 25.2</p></a><div class="dropdowns"><div class="modules">
<button type="button" data-a11y-toggle="modules-nav" id="modules" aria-haspopup="true" aria-expanded="false" aria-controls="modules-nav">Módulo</button><nav id="modules-nav" hidden=""></nav>
</div></div></header><aside class="leftside"><input id="accordion-1" name="accordion-menu" type="checkbox"><label for="accordion-1" dir="auto">Contenido</label><div id="Contents" class="contents-treeview"></div></aside><div id="SearchFrame"><div id="Bookmarks">
<input id="search-bar" type="search" class="search" placeholder="Buscar en los marcadores del módulo elegido" dir="auto"><div class="nav-container" tabindex="0"><nav class="index" dir="auto"></nav></div>
</div></div>
<div id="DisplayArea" itemprop="softwareHelp" itemscope="true" itemtype="http://schema.org/SoftwareApplication">
<noscript><div id="WarnJS"><h1 dir="auto">Active JavaScript en el navegador para mostrar las páginas de ayuda de LibreOffice.</h1></div></noscript>
<a id="N0218"></a> <meta itemprop="keywords" content="Python,Programming"> <meta itemprop="keywords" content="XSCRIPTCONTEXT,Python"> <meta itemprop="keywords" content="XSCRIPTCONTEXT,getComponentContext"> <meta itemprop="keywords" content="XSCRIPTCONTEXT,getDesktop"> <meta itemprop="keywords" content="XSCRIPTCONTEXT,getDocument"> <meta itemprop="keywords" content="uno.py,getComponentContext"> <meta itemprop="keywords" content="uno.py,getDesktop"> <meta itemprop="keywords" content="uno.py,getDocument">
<a id="pythonprogramming"></a>
<h1 id="hd_id691546462755220" dir="auto">
<a id="pythonprogrammingheading"></a>Programar con secuencias de órdenes en Python</h1>
<p id="N0220" class="paragraph" dir="auto">A Python macro is a function within a .py file, identified as a module. Unlike LibreOffice Basic and its dozen of <a target="_top" href="es/text/sbasic/shared/uno_objects.html">UNO objects functions or services</a>, Python macros use the <span class="literal">XSCRIPTCONTEXT</span> UNO single object, shared with JavaScript and BeanShell. The <span class="literal">g_exportedScripts</span> global tuple explicitly lists selectable macros from a module. Python modules hold autonomous code logic, and are independent from one another.</p>
<h2 id="N0221" dir="auto">Variable global XSCRIPTCONTEXT</h2>
<p id="N0222" class="paragraph" dir="auto">Genuine Basic UNO facilities can be inferred from <span class="literal">XSCRIPTCONTEXT</span> global variable. Refer to LibreOffice API for a complete <a target="_blank" href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1script_1_1provider_1_1XScriptContext.html">description of XSCRIPTCONTEXT</a>. <span class="literal">XSCRIPTCONTEXT</span> methods summarize as:</p>
<table border="1" class="" cellpadding="0" cellspacing="0">
<tr>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="N0224" class="tableheadintable" dir="auto">Métodos</p>
</th>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="N0225" class="tableheadintable" dir="auto">Descripción</p>
</th>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="N0226" class="tableheadintable" dir="auto">Correlacionado en Basic con</p>
</th>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0227" class="tablecontentintable" dir="auto">getDocument()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0228" class="tablecontentintable" dir="auto">La referencia del documento en el que puede funcionar la macro.</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0229" class="tablecontentintable" dir="auto">ThisComponent</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0230" class="tablecontentintable" dir="auto">getDesktop()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0231" class="tablecontentintable" dir="auto">La referencia del escritorio en la que puede funcionar la macro.</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0232" class="tablecontentintable" dir="auto">StarDesktop</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0233" class="tablecontentintable" dir="auto">getComponentContext()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0234" class="tablecontentintable" dir="auto">El contexto del componente que la macro puede utilizar para crear otros componentes UNO.</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0235" class="tablecontentintable" dir="auto">GetDefaultContext</p>
</td>
</tr>
</table>
<br>
<p id="N0237" class="paragraph" dir="auto"><span class="emph">HelloWorld</span> y <span class="emph">Capitalise</span> instaladas en las macros compartidas, ilustra las macros relacionadas con UNO, haciendo uso de la variable global<span class="literal">XSCRIPTCONTEXT</span>.</p>
<div class="tip">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/tip.svg" alt="tip" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="N0238" dir="auto">La salida estándar de Python no está disponible cuando se ejecutan macros de Python desde el menú <span class="menuitem">Herramientas ▸ Macros ▸ Ejecutar macro</span>. Consulte <span class="emph">Entrada/salida de y hacia la pantalla</span> para obtener más información.</p></div>
</div>
<br>
<h2 id="N0239" dir="auto">Importación de módulos</h2>
<div class="warning">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/warning.svg" alt="warning" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="N0240" dir="auto"><span class="literal">XSCRIPTCONTEXT</span> no se proporciona a los módulos importados.</p></div>
</div>
<br>
<a id="PythonFileSystemImport"></a>
<p id="N0241" class="paragraph" dir="auto">LibreOffice Basic libraries contain classes, routines and variables, Python modules contain classes, functions and variables. Common pieces of reusable Python or UNO features must be stored in <a target="_top" href="es/text/sbasic/python/python_locations.html">My macros</a> within <span class="literal">(User Profile)/Scripts/python/pythonpath</span>. Python libraries help organize modules in order to prevent module name collisions. Import <span class="literal">uno.py</span> inside shared modules.</p>
<a id="uno"></a>
<p id="N0242" class="paragraph" dir="auto">Genuine BASIC UNO facilities can be inferred using <span class="literal">uno.py</span> module. Use <a target="_top" href="es/text/sbasic/python/python_shell.html">Python interactive shell</a> to get a complete module description using <span class="literal">dir()</span> and <span class="literal">help()</span> Python commands.</p>
<a id="bm_id391659034206678"></a> <meta itemprop="keywords" content="uno.py"> <meta itemprop="keywords" content="uno.py,absolutize"> <meta itemprop="keywords" content="uno.py,createUnoStruct"> <meta itemprop="keywords" content="uno.py,fileUrlToSystemPath"> <meta itemprop="keywords" content="uno.py,getClass"> <meta itemprop="keywords" content="uno.py,getComponentContext"> <meta itemprop="keywords" content="uno.py,Enum"> <meta itemprop="keywords" content="uno.py,getConstantByName"> <meta itemprop="keywords" content="uno.py,isInterface"> <meta itemprop="keywords" content="uno.py,systemPathToFileUrl">
<table border="1" class="" cellpadding="0" cellspacing="0">
<tr>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="N0244" class="tableheadintable" dir="auto">Funciones</p>
</th>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="N0245" class="tableheadintable" dir="auto">Descripción</p>
</th>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="N0246" class="tableheadintable" dir="auto">Correlacionado en Basic con</p>
</th>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0247" class="tablecontentintable" dir="auto">absolutize()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0248" class="tablecontentintable" dir="auto">Devuelve un URL de archivo absoluto a partir de los URL proporcionados.</p>
</td>
<td rowspan="" colspan="" dir="auto">
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0250" class="tablecontentintable" dir="auto">createUnoStruct()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0251" class="tablecontentintable" dir="auto">Crea una estructura UNO o excepción dada por typeName.</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0252" class="tablecontentintable" dir="auto">CreateUNOStruct()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0253" class="tablecontentintable" dir="auto">fileUrlToSystemPath()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0254" class="tablecontentintable" dir="auto">Devuelve una ruta del sistema.</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0255" class="tablecontentintable" dir="auto">ConvertFromURL()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0256" class="tablecontentintable" dir="auto">getClass()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0257" class="tablecontentintable" dir="auto">Devuelve la clase de una excepción, una estructura o una interfaz de UNO concreta.</p>
</td>
<td rowspan="" colspan="" dir="auto">
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0259" class="tablecontentintable" dir="auto">getComponentContext()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0260" class="tablecontentintable" dir="auto">Devuelve el contexto del componente de UNO utilizado para iniciar el entorno de ejecución de Python.</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0261" class="tablecontentintable" dir="auto">GetDefaultContext()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0262" class="tablecontentintable" dir="auto">Enum()</p>
<p id="N0263" class="tablecontentintable" dir="auto">getConstantByName()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0264" class="tablecontentintable" dir="auto">Busca el valor de una constante de IDL dando su nombre explícito.</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0265" class="tablecontentintable" dir="auto">Ver grupos constantes de API</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0266" class="tablecontentintable" dir="auto">isInterface()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0267" class="tablecontentintable" dir="auto">Devuelve Verdadero, cuando el objeto es una clase de una interfaz UNO</p>
</td>
<td rowspan="" colspan="" dir="auto">
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0269" class="tablecontentintable" dir="auto">systemPathToFileUrl()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0270" class="tablecontentintable" dir="auto">Devuelve un URL de archivo para la ruta del sistema proporcionada.</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0271" class="tablecontentintable" dir="auto">ConvertToURL()</p>
</td>
</tr>
</table>
<br>
<p id="N0272" class="paragraph" dir="auto">Las secuencias de órdenes preinstaladas <span class="emph">LibreLogo</span>, <span class="emph">NamedRanges</span>, <span class="emph">SetCellColor</span> y <span class="emph">TableSample</span> usan el módulo <span class="literal">uno.py</span>.</p>
<h2 id="N0273" dir="auto">Más ejemplos Python-Basic</h2>
<table border="1" class="" cellpadding="0" cellspacing="0">
<tr>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="N0275" class="tableheadintable" dir="auto">UNO en Python</p>
</th>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="N0276" class="tableheadintable" dir="auto">Funcionalidades básicas de UNO</p>
</th>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0277" class="tablecontentintable" dir="auto">ctx = uno.getComponentContext()</p>
<p id="N0278" class="tablecontentintable" dir="auto">smgr = ctx.getServiceManager()</p>
<p id="N0279" class="tablecontentintable" dir="auto">obj = smgr.createInstanceWithContext( .. , ctx)</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0280" class="tablecontentintable" dir="auto">CreateUnoService()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0284" class="tablecontentintable" dir="auto">See <a target="_top" href="es/text/sbasic/python/python_dialogs.html">Opening a Dialog</a></p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0285" class="tablecontentintable" dir="auto">CreateUnoDialog()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0286" class="tablecontentintable" dir="auto">See <a target="_top" href="es/text/sbasic/python/python_listener.html">Creating a Listener</a></p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0287" class="tablecontentintable" dir="auto">CreateUnoListener()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0288" class="tablecontentintable" dir="auto">Ver tipos de datos UNO</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0289" class="tablecontentintable" dir="auto">CreateUnoValue()</p>
<p id="N0290" class="tablecontentintable" dir="auto">CreateObject()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="par_id511723497344246" class="tablecontentintable" dir="auto">Usar operadores de comparación «==» o «!=»</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N1244" class="tablecontentintable" dir="auto">EqualUnoObjects()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0281" class="tablecontentintable" dir="auto">ctx = uno.getComponentContext()</p>
<p id="N0282" class="tablecontentintable" dir="auto">smgr = ctx.getServiceManager()</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0283" class="tablecontentintable" dir="auto">GetProcessServiceManager()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0292" class="tablecontentintable" dir="auto">def hasUnoInterfaces(obj, *interfaces):</p>
<p id="N0293" class="tablecontentintable" dir="auto">return set(interfaces).issubset(t.typeName for t in obj.Types)</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0294" class="tablecontentintable" dir="auto">HasUnoInterfaces()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0296" class="tablecontentintable" dir="auto">IsUnoStruct()</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N0297" class="tablecontentintable" dir="auto">ctx = uno.getComponentContext()</p>
<p id="N0298" class="tablecontentintable" dir="auto">smgr = ctx.getServiceManager()</p>
<p id="N0299" class="tablecontentintable" dir="auto">DESK = 'com.sun.star.frame.Desktop'</p>
<p id="N0300" class="tablecontentintable" dir="auto">desktop = smgr.createInstanceWithContext(DESK , ctx)</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N0301" class="tablecontentintable" dir="auto">StarDesktop</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="N2298" class="tablecontentintable" dir="auto">desktop = smgr.createInstanceWithContext(DESK , ctx)</p>
<p id="N1299" class="tablecontentintable" dir="auto">doc = desktop.CurrentComponent</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="N1301" class="tablecontentintable" dir="auto">ThisComponent</p>
</td>
</tr>
</table>
<br>
<h2 id="N1297" dir="auto">Importing an embedded Module</h2>
<a id="PythonEmbeddedImport"></a>
<p id="N1298" class="paragraph" dir="auto">Similarly to LibreOffice Basic that supports browsing and dynamic loading of libraries, Python libraries can be explored and imported on demand. For more information on library containers, visit <a target="_blank" href="https://api.libreoffice.org/">LibreOffice Application Programming Interface</a> (API) or download <a target="_blank" href="https://www.libreoffice.org/download/download/">LibreOffice Software Development Kit</a> (SDK).</p>
<p id="N3299" class="paragraph" dir="auto">Importing a Python document embedded module is illustrated below, exception handling is not detailed:</p>
<div class="pycode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-python line-numbers">
import uno, sys, zipimport
def load_library(library_name: str, module_name=None):
""" carga de biblioteca e importación de módulo
Adaptado de «Bibliothèque de fonctions» de Hubert Lambert
en https://forum.openoffice.org/fr/forum/viewtopic.php?p=286213"""
doc = XSCRIPTCONTEXT.getDocument() # documento actual
url = uno.fileUrlToSystemPath( \
'{}/{}'.format(doc.URL, 'Scripts/python'+library_name)) # ConvertToURL()
if not url in sys.path: # adición de ruta, si es necesario
sys.path.insert(0, url) # el doclib tiene prioridad
if module_name: # se importa si se solicita
return zipimport.zipimporter(url).load_module(module_name)
def import_embedded_python():
ui = load_library("my_gui",'screen_io') # agrega <lib> ruta + import <module>
ui.MsgBox(sys.modules.keys())
g_exportedScripts = (import_embedded_python,) # Public macros
</code></pre></div>
<a id="relatedtopics"></a><div class="relatedtopics">
<p class="related" itemprop="mentions" dir="auto"><a id="related"></a><span class="emph">Temas relacionados</span></p>
<div class="relatedbody" itemprop="mentions">
<p id="N0321" class="paragraph" dir="auto"><a target="_top" href="es/text/sbasic/shared/uno_objects.html">Objetos, funciones y servicios de UNO en Basic</a></p>
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/python/python_import.html">Importar módulos de Python</a></p></div>
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/python/python_screen.html">Entrada y salida de y hacia la pantalla</a></p></div>
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/python/main0000.html">Ayuda con las macros en Python en LibreOffice</a></p></div>
</div>
</div>
</div>
<div id="DonationFrame"></div>
<footer><h2 style="text-align: center;"><a href="https://books.libreoffice.org" target="_blank">Libros de LibreOffice</a></h2>
<div class="noteicon" dir="auto" style="display:flex;justify-content:center;flex-wrap:wrap;row-gap:15px;">
<img src="media/navigation/libo-writer.svg" alt="Writer Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-calc.svg" alt="Calc Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-impress.svg" alt="Impress Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-draw.svg" alt="Draw Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-base.svg" alt="Base Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-math.svg" alt="Math Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-symbol-black.svg" alt="Getting Started Icon" style="width:60px;height:60px;">
</div>
<div id="DEBUG" class="debug">
<h3 class="bug">Help content debug info:</h3>
<p dir="auto">This page is: <a href="https://opengrok.libreoffice.org/xref/help/source/text/sbasic/python/python_programming.xhp" target="_blank">/text/sbasic/python/python_programming.xhp</a></p>
<p dir="auto">Title is: Python: programar con Python</p>
<p id="bm_module" dir="auto"></p>
<p id="bm_system" dir="auto"></p>
<p id="bm_HID" dir="auto"></p>
</div></footer>
</body>
</html>