Module importer_user_ext_script

Function: importer_user_ext_script

importer_user_ext_script(ext_name)

A context manager that manages adding ImporterUserExtScript to the sys.meta_path.

This context manager ensures that the resource is properly acquired and released.

The importer will only search in the python/scripts folder of the extension.

Args:

ext_name (str): The name of the extension that contains the module to be imported.

Returns:

None:

Note:

The extension module must be in registered in LibreOffice as a user extension.

Example:

In this example the context manager is used to import a module from a Calc document.

from __future__ import annotations
from pathlib import Path
from ooodev.calc import CalcDoc
from ooodev.loader import Lo
from ooodev.uno_helper.importer import importer_user_ext_script


def main():
    _ = Lo.load_office(connector=Lo.ConnectPipe())
    doc = None
    try:
        doc = CalcDoc.create_doc()

        with importer_user_ext_script("apso"):
            import tools

        print("Done")

    except Exception as e:
        print(f"Error: {e}")

    finally:
        if doc:
            doc.close()
        Lo.close_office()


if __name__ == "__main__":
    main()

In this example, a ImporterUserExtScript instance is automatically managed, ensuring proper cleanup.

class ImporterUserExtScript

class ooodev.uno_helper.importer.ImporterUserExtScript(ext_name)

Bases: ImporterFile

Parameters:

ext_name (str) –

__init__(ext_name)

Initializes the ImporterUserExtScript instance. :type ext_name: str :param ext_name: The name of the extension module to be imported. :type ext_name: str

Raises:

ImportError – If the module specified by ext_name is not found.

Parameters:

ext_name (str) –

find_spec(fullname, path, target=None)

Return type:

ModuleSpec | None

Parameters:

• fullname (str) –

• path (Sequence[str] | None) –

• target (types.ModuleType | None) –