Python Scripts Organization /text/sbasic/python/python_locations.xhp

Python Scripts Organization and Location

%PRODUCTNAME macros are grouped in module files, modules are usually grouped in library folders, and libraries are grouped in library containers although containers can contain modules too. A library is used as a major grouping for either an entire category of macros, or for an entire application. Modules usually split functionality, such as user interaction and calculations. Individual macros are subroutines and functions. The Figure below shows an example of the hierarchical structure of macro libraries in %PRODUCTNAME. Library Container diagram Figure: Macro Library hierarchy The containers are accessible in all %PRODUCTNAME programs through the user interface. Go to Tools > Macros > Organize Macros > Python, to open the Python Macros dialog. Three library containers are shown in the Macro From list: My Macros: personal macros available for the %PRODUCTNAME user Application Macros: system macros distributed with %PRODUCTNAME for every computer user Document macros: every document can contain macro libraries available in that document for all users

Python Script Locations

Refer to Getting Session Information in order to get programmatic access to Python script locations.

Application Macros

Existing macros in this location (container) were copied by the installation program and are available to every computer user, and any open document can access macros stored the container. You need administrative rights to store or edit macros here. The %PRODUCTNAME Macros container location in the file system depends on the operating system: For Windows: {Installation}\share\Scripts\python. For Linux and macOS: {Installation}/share/Scripts/python.

My Macros

This container is accessible only by the %PRODUCTNAME user. Any open document can access macros stored the container. Macros in this location are stored in the %PRODUCTNAME user profile. The My Macros container location is in the user space and depends on the operating system: For Windows,
%APPDATA%\LibreOffice\4\user\Scripts\python. For Linux and macOS,
$HOME/.config/libreoffice/4/user/Scripts/python.

Document macros

Document macros are embedded in the document and are accessible only when the document is open.

Libraries, Modules and Macros

Python macros can be organized in libraries, modules and macros. Use the Macro Library hierarchy as a guide when creating or installing new macros in module files, new module files in library folders or new library folders in containers.