APSO - Alternative Script Organizer for Python

Tags: Extensions

last edited: 2022-09-14

Rating:

Based on an original script from Hanya, APSO will install a macro organizer dedicated to python scripts.

Description

APSO is compatible with OpenOffice

Based on an original script from Hanya, APSO is an extension that will install a macro organizer dedicated to python scripts.

Prerequisite

On some systems (like Ubuntu), the python script provider for LibreOffice is only available as a separate package (see here).

Features

• localisation (by now EN, DE, FR, IT, HU thanks to Tibor Kovács, NL thanks to Dick Groskamp, ES thanks to Francisco Gracia, JA thanks to Nogajun and PT thanks to Rafael Lima)
• embedding scripts in or extracting them from documents
• binding the extension with one's favorite code editor (thanks to another script from Hanya, see Options below)
• quick edition of embedded scripts (but only in the context of the APSO extension*)
• integrated gui debugger
• interactive python interpreter
• automatic update once installed

(* Changes will only be kept if APSO is either opened or closed after last save.)

How it works

APSO adds a new element Organize python scripts under menu Tools/Macros with default shortcut Alt+Shift+F11:

This new item or shortcut opens a dialog box that lists all python scripts and provides various actions:

The Execute  button launches the selected macro. Actions available under Menu button change according to the selection:

• create module or library if selection is a container (My Macros, Office Macros or document)
• Edit, rename, delete a module or library
• Embed module from application (My Macros or Office Macros) into current document
• Substitute an embedded module with an external file
• Export an embedded module

Helpers

APSO comes with a small library apso_utils that contains some helpers for debugging purpose during macro writing. These helpers are four functions named msgbox, xray, mri and console and can be imported by a classic import statement like from apso_utils import msgbox

Example

from apso_utils import console, msgbox, mri, xray
def testhelpers():
    # console()
    # console(BACKGROUND=0x0, FOREGROUND=0xFFFFFF)
    loc = locals()
    loc.update(globals())
    console(loc=loc)

    doc = XSCRIPTCONTEXT.getDocument()
    # xray(doc)
    msgbox(doc.Title)
    mri(doc)

Only the console macro is accessible outside an APSO instance. If someone wants to import the module apso_utils independently of APSO, he has to force that instanciation:
def entryfunc(event=None):
    ctx = XSCRIPTCONTEXT.getComponentContext()
    ctx.ServiceManager.createInstance("apso.python.script.organizer.impl")
    # now we can import apso_utils library
    from apso_utils import console
    console()

Integreted debugger

The debugger can be launched from the Apso "Menu" button when a function is selected in the main window.

Once the debugger opened, one can execute the code step by step, enter any called function, return to the caller, etc.

Break points are not supported, but you can jump ahead by double clicking any line below the current one within the same function.

You can check any caller state and scope by double clicking it in the "Stack" window (bottom left). If you have MRI or Xray installed, you can inspect any UNO variables by double clicking it in the "Scope" window (bottom right).

When you open a console window from the tool bar, the global and local scope will be automatically loaded.

If you edit the script while the debugger is running, changes will be taken in account after clicking "Restart".

The debugger uses the font name and height defined for the Basic IDE.

The debugger is still not fully localised

APSO Options

The extension option page is available under Tools -> Extension Manager -> APSO -> Options.
By default, APSO uses the system defined editor. To edit scripts with a specific editor, provide the executable full path in the "Editor" field. Some MacOS editors seem to behave differently; if you encounter any problem, please refer to this post in the French OpenOffice/LibreOffice forum.
To allow the opening at a given line and column offset when relevant, enter in the "Options" field the command line syntax corresponding to the choosen editor, using the placeholders {FILENAME}, {ROW} and {COL} (they will be replaced in due time).
Example for Emacs: +{ROW}:{COL} {FILENAME}.
Example for Sublime Text: {FILENAME}:{ROW}:{COL}.

Three advanced options are available in the Expert configuration section of LibreOffice (menu Tools -> Options -> LibreOffice -> Advanced):

• SaveLastScript, if true, keeps history of the last run script (added in 1.3.0);
• SaveTreeState, if true, keeps history of all expanded nodes on last run script (added in 1.3.0);
• UnloadChildOnCollapse, if true, collapses the requested node and all its children; if false, collapses only the requested node (added in 1.3.0);

Homepage: https://gitlab.com/jmzambon/apso

Repository: https://gitlab.com/jmzambon/apso

Release List

Release Description Compatibility Operating Systems License Release notes  
v1.3.2 New translation, enchancements and bug fixes 3.4 Linux, Windows, macOS AL
[1.3.2]
- Translate APSO to Portuguese, thanks to Rafael Lima [#33]
- Add logging mode (bêta).
- Fix error when history refers to an inactive document provider.
- Code enhancements.
[1.3.1]
- [Debugger] Fix issue in selected default fixed font.
[1.3.0]
- Add context menu (issue #22).
- Add two options to keep tree state and to collapse childs on parent collapsing (issue #23).
WARNING: user upgrading from 1.2.x will have to re-enter his preferences in Apso option dialog.
- Add shortcut Ctrl+Enter (Cmd+Enter on Mac) to collapse node, alongside with left arrow (compare with Enter/right arrow).
- Add menu item icon.
- Small fixes.
Download
v1.2.8 Bug fix and small enhancement. 3.4 Linux, Windows, macOS AL
- The console() method now retuns a reference to the console object, allowing to close programmaticaly the console window by invoking its enddialog() method (issue #21).
- Fix issue #20 "LibreOffice freezes on some linux configurations".
Download
1.2.7 Minor improvements 3.4 Linux, Windows, macOS AL
Make node sorting locale aware.
Minor improvements and bug fixes
Download
1.2.6.2 Add custom content of any new module 3.4 Linux, Windows, macOS AL
The default header lines, inserted at creation of a new module, can now be customized from the option dialog.
This release also fixes a bug in the option dialog, where the "back" button had no effect, and translates to english remaining french argument names.
It also fixes a bunch of non blocking errors, with the help of Mike Kaganski.
external link
1.2.5 Add Japanese language, thanks to Nogajun contribution. 3.4 Linux, Windows, macOS AL external link
1.2.4 Add Spanish language 4.4 Linux, Windows, macOS AL
Translated by Francisco Gracia.
Thanks to him. Gracias a el.
external link
1.2.3 Clean up debugger and apso_utils code. 3.4 Linux, Windows, macOS AL
Fix a bug under OpenOffice, where splitter windows weren't
properly closed on debug window closing, causing program crash.
Other code clean up.
external link
1.2.2 Minor bug fixes. 3.4 Linux, Windows, macOS AL
Move exposed functions (by now just "console") to a dedicated folder, apart from apso_utils module (v1.2.2.0).
Change call to Mri in debugger (v1.2.2.1).
Fix two minor bugs:
- XSCRIPTCONTEXT global variable is sometime inconsistent in the console (v1.2.2.0)
- "console" function was no more available outside APSO (v1.2.2.0)
 
 
-------------------
external link
1.2.1 New integrated debugger tool and minor bug fixes in module and library naming. 3.4 Linux, Windows, macOS AL
The debugger can be launched from the Apso "Menu" button when a function is selected in the main window.
Once the debuuger opened, one can execute the code step by step, enter any called function, return to the caller, etc.
Break points are not supported, but you can jump ahead by double clicking any line below the current one within the same function.
You can check any caller state and scope by double clicking it in the "Stack" window (bottom left). If you have MRI or Xray installed, you can inspect any UNO variables by double clicking it in the "Scope" window (bottom right).
When you open a console window from the tool bar, the global and local scope will be automatically loaded.
If you edit the script while the debugger is running, changes will be taken in account after clicking "Restart".
The debugger uses the font name and height defined for the Basic IDE.
The debugger is still not fully localised

external link
1.2.0 New integrated debugger tool and minor bug fixes in module and library naming. 3.4 Linux, Windows, macOS AL
The debugger can be launched from the Apso "Menu" button when a function is selected in the main window.
Once the debuuger opened, one can execute the code step by step, enter any called function, return to the caller, etc.
Break points are not supported, but you can jump ahead by double clicking any line below the current one within the same function.
You can check any caller state and scope by double clicking it in the "Stack" window (bottom left). If you have MRI or Xray installed, you can inspect any UNO variables by double clicking it in the "Scope" window (bottom right).
When you open a console window from the tool bar, the global and local scope will be automatically loaded.
If you edit the script while the debugger is running, changes will be taken in account after clicking "Restart".
The debugger uses the font name and height defined for the Basic IDE.
The debugger is still not fully localised

external link
1.1.4 Code fixing and cleaning 3.4 Linux, Windows, macOS AL external link
1.1.2 New console tool (see Menu button).
Code clean up. 4.0 Linux, Windows, macOS AL external link
1.0.2 Bug fixes 4.0 Linux, Windows, macOS AL
Fix a bug where APSO was not able to launch from a database subdocument (base form, query wizard...).
Fix some other small bugs.
external link
1.0.0 First official release 5.0 Linux, Windows, macOS AL
See main description page for more details.
Tested on LibreOffice 5.x and OpenOffice 4.x. But should work on previous versions.
external link