Difference between revisions of "Python"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Insert tables.)
Line 46: Line 46:
 
To learn to run Python on Windows, visit [[Using Python on Windows| this link]] for more detailed information.
 
To learn to run Python on Windows, visit [[Using Python on Windows| this link]] for more detailed information.
  
=== Getting Started ===
+
{| align="center" cellspacing="0" cellpadding="0" style="border: 0px solid rgb(102, 102, 102);"
 +
|- valign="top"
 +
| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(155, 192, 245) rgb(155, 192, 245) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">Getting Started</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
 
*[[Python/Python_Language_Binding|Python Language Binding]]
 
*[[Python/Python_Language_Binding|Python Language Binding]]
*[[Python/Transfer_from_Basic_to_Python|Transfer from Basic to Python]]
 
 
*[[Python/Python_Loader|Python Loader]]
 
*[[Python/Python_Loader|Python Loader]]
 
*[[Using Python on Windows]] - New to Python? Learn how to use python on Windows
 
*[[Using Python on Windows]] - New to Python? Learn how to use python on Windows
Line 54: Line 55:
 
* [[pyUNO bridge]] - Official page of the PyUNO bridge at the [http://udk.openoffice.org/ UDK site] - ([http://www.fatcow.com/edu/mathtex-be/ ''Belorussian translation''])
 
* [[pyUNO bridge]] - Official page of the PyUNO bridge at the [http://udk.openoffice.org/ UDK site] - ([http://www.fatcow.com/edu/mathtex-be/ ''Belorussian translation''])
 
* [[Python as a macro language]] in OpenOffice.org 2.x - How to use the Python scripting framework
 
* [[Python as a macro language]] in OpenOffice.org 2.x - How to use the Python scripting framework
 +
* [[Python/Transfer_from_Basic_to_Python|Transfer from Basic to Python]]
 
* [http://lucasmanual.com/mywiki/OpenOffice PyUNO Manual] Lukasz created a pyUNO manual. '''new'''
 
* [http://lucasmanual.com/mywiki/OpenOffice PyUNO Manual] Lukasz created a pyUNO manual. '''new'''
 
* [[SQLAlquemyPyUNO|SQLAlchemy and PyUNO]] connecting OpenOffice to any database
 
* [[SQLAlquemyPyUNO|SQLAlchemy and PyUNO]] connecting OpenOffice to any database
Line 63: Line 65:
 
* Enhanced [http://www.oooforum.org/forum/viewtopic.phtml?p=257496#257496 Capitalized.py] script by ''The gray Cardinal'' at OOoforum.
 
* Enhanced [http://www.oooforum.org/forum/viewtopic.phtml?p=257496#257496 Capitalized.py] script by ''The gray Cardinal'' at OOoforum.
  
=== PyUNO Modules ===
+
| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(155, 192, 245) rgb(155, 192, 245) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">PYUNO Modules</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
 
*[[Danny's Python Modules]] - Collection guide from DannyB's modules.
 
*[[Danny's Python Modules]] - Collection guide from DannyB's modules.
 
*[[PrinttoWriter.py]] - This makes it easy and convenient to print a bunch of text into a Writer document.
 
*[[PrinttoWriter.py]] - This makes it easy and convenient to print a bunch of text into a Writer document.
Line 75: Line 77:
 
*[[Zotero_Plugin |Zotero Plugin]] - The Zotero plugin provides citation and bibliographic table insertion and editing functions for Writer documents.
 
*[[Zotero_Plugin |Zotero Plugin]] - The Zotero plugin provides citation and bibliographic table insertion and editing functions for Writer documents.
 
*[http://oosheet.hacklab.com.br/ OOSheet] - High level python library to develop spreadsheet macros without the complexity of Uno. Focuses on spreadsheets, but may be useful for other documents.
 
*[http://oosheet.hacklab.com.br/ OOSheet] - High level python library to develop spreadsheet macros without the complexity of Uno. Focuses on spreadsheets, but may be useful for other documents.
 +
|}
  
 
=== Hacking Around ===
 
=== Hacking Around ===

Revision as of 19:36, 26 August 2013

OOo Extensions project

Please view the wiki usage guidelines
before contributing.

Categories:

Pages:

Extensions on the main site

Extensions in other languages:
ES - FR - IT - JA - NL - OC -

PyUNO Logo Pyuno logo a.jpg

Python and OpenOffice.org

OpenOffice.org 3.1 ships with the Python scripting language, version 2.6.1. Older OpenOffice.org ships with Python version 2.3.4. This Python distribution comes with the Uno module, which connects the UNO API to the python scripting language. To run this version of Python on Linux, you can go directly to the OpenOffice.org PATH. And as one would expect with any distribution of Python, OOo-Python can be run from the command line as well.

If you already have a separate Python 2.6 installation, you can import the uno module (the Python-UNO bridge) to it using these instructions.

If you already have a different version of Python installed on Windows, you can also access the UNO API using the COM bridge instead of the Python bridge. Requires the add-on pywin32 module so Python can talk to COM. Note that while the UNO API is uniform, the implementation by the two bridges is slightly different, so the syntax required by each is also sometimes different.

Where is the IDE ?

OpenOffice.org's IDE doesn't support Python, so development has to be done from another editor that does. Any volunteer for a binding is welcomed. Here is a nice blog post about using VIM a common Unix/Linux text editor configured in a way that acts like an IDE. Windows users can use Gvim and MacVim for OSX users.

Tips & Tricks

Here is some useful information about using python in OOo.

Debug output

If you launch a python script, any error will silently break the execution, making your extension hard to debug. To change this behaviour, one can change the LogLevel .

Have a look in /path/to/ooo/program/pythonscript.py and replace LogLevel.use = LogLevel.NONE with LogLevel.use = LogLevel.DEBUG .

There are also currently-undocumented environment variables that tell the pyUno bridge to log every call. Set the environment variable export PYUNO_LOGLEVEL=ARGS . The output may be a little hard to read, but helpful nonetheless.

Note that his applies only to Linux. For Windows, you need some more switches, and the output gets written to files (there is no stdout on windows :-( ).

There are still some error messages that won't appear in these logs; this will improve in the near future (cws pyunofixes4). Once the cws is integrated, I will document these switches on the official pyuno site.

Thanks to Joerg Budischewski .

Python specific information for Extension creation

To create extensions for python, it is important that you have enough familiarity with the UNO components, as well as with packaging your code for easy distribution through the OpenOffice.org package manager. Please check the tutorials to learn how to component-ize your code, and how to deploy remote scripting through a service implementation.

To learn to run Python on Windows, visit this link for more detailed information.

Getting Started
PYUNO Modules
  • Danny's Python Modules - Collection guide from DannyB's modules.
  • PrinttoWriter.py - This makes it easy and convenient to print a bunch of text into a Writer document.
  • Developing Calc Functions in Python - Learn how Python can be used to script your spreadsheets
  • Generating a Spreadsheet through Python - Automatically generate new spreadsheets
  • Python container components
  • PyUNOServer - The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc
  • calcParser - calcParser is a small parser using the native SAX utilities within the OpenOffice.org python
  • OoConfig - OoConfig is a Python extension that seeks to provide a configuration editing facility similar to Mozilla's about:config
  • OOoRISExport.py - Exports the bibliographic database in RIS format. Also RISImport.py
  • Zotero Plugin - The Zotero plugin provides citation and bibliographic table insertion and editing functions for Writer documents.
  • OOSheet - High level python library to develop spreadsheet macros without the complexity of Uno. Focuses on spreadsheets, but may be useful for other documents.

Hacking Around

Python rules OOo (by B. Bois)

Python rules OOo :-)
Views
Personal tools
Navigation
Print/export
Tools