types-unopy 2.0.0

Type annotations for LibreOffice API

This project allow typings for the full LibreOffice API

WHY

Working with LibreOffice API in a modern code editor such as Visual Studio Code there is not type support for LibreOffice API This project solves that Issue.

VERSION

This package is for Version 2024.2 + of LibreOffice API.

From one version of LibreOffice to the next, generally speaking, the API does not changed much. Because this is the case it is very likely this current version of LibreOffice API Typings will work fine with other versions of LibreOffice. This a typing package so not much can go wrong in other versions.

Installation

PIP

types-unopy on PyPI

$ pip install types-unopy

CONDA

types-unopy on Anaconda

$ conda install -c conda-forge types-unopy

Related

Types-ScriptForge leverages types-unopy. By installing Types-ScriptForge into your project you will also automatically install types-unopy.

USAGE

Not all object in LibreOffice API can be directly imported.

Any UNO object that is a service cannot be imported at runtime.

For instance if you need to import SheetCellRange so it can be used as type the following will fail at runtime.

>>> from com.sun.star.sheet import SheetCellRange
ImportError: No module named 'com' (or 'com.sun.star.sheet.SheetCellRange' is unknown)

The solution is to use TYPE_CHECKING.

>>> from __future__ import annotations
>>> from typing import TYPE_CHECKING
>>> if TYPE_CHECKING:
...     from com.sun.star.sheet import SheetCellRange
...

Anything imported in the TYPE_CHECKING block will not be available at runtime. For this reason types inside the TYPE_CHECKING must be wrapped in quotes OR from __future__ import annotations must be the first line of the module.

Example of wrapping type in quotes.

def do_work(range: 'SheetCellRange') -> None: ...

Known Issues

Enums

There is no enum classes in API only enum members.

To access the enum members they must be imported directly.

For example to import com.sun.star.beans.PropertyState.DIRECT_VALUE

If you need the behavior of regular Enum Classes consider using ooouno

>>> from com.sun.star.beans import PropertyState
ImportError: No module named 'com' (or 'com.sun.star.beans.PropertyState' is unknown
>>>
>>> from com.sun.star.beans.PropertyState import DIRECT_VALUE
>>> DIRECT_VALUE.value
'DIRECT_VALUE'
>>>
>>> type(DIRECT_VALUE)
<class 'uno.Enum'>

Demo

Special Cases

ImportError

By default an ImportError is raised when importing form com.sun.star at runtime. This is by design as the import error triggers uno to search LibreOffice API for actual import; Otherwise, com.sun.star is seen a namespace import and uno is ignored.

In some cases the ImportError may need to be suppressed.

Suppressing ImportError is accomplished by adding "ooouno_ignore_import_error" to environment and setting it to "True"

>>> import os
>>> os.environ["ooouno_ignore_import_error"] = "True" # must be string

When building with Sphinx and autodoc it may be necessary to exclude uno related imports. This can be accomplished using the autodoc_mock_imports option.

# docs conf.py
autodoc_mock_imports = ['uno', 'unohelper', 'com']

For a reference see ooo-dev-tools conf.py.

Enum Protocols

As mentioned above there are no enum classes in API only enum members.

For this reason this package implements protocols for enums.

from com.sun.star.beans.PropertyState import DIRECT_VALUE
# DIRECT_VALUE is a type of PropertyStateProto

The implemented protocol for PropertyState is as follows:

class PropertyStateProto(Protocol):
    """Protocol for PropertyState"""

    @property
    def typeName(self) -> Literal["com.sun.star.beans.PropertyState"]:
        ...
    value: Any
    AMBIGUOUS_VALUE: PropertyStateProto
    DEFAULT_VALUE: PropertyStateProto
    DIRECT_VALUE: PropertyStateProto

Implemented methods such as com.sun.star.beans.PropertyState.XPropertyState.getPropertyState() return a protocol, in this case PropertyStateProto.

If you need to import a protocol for type hinting in your project then it will need to be guarded.

Type Guarding Protocol

Since typing.TYPE_CHECKING is always False at runtime we can use it.

There are two way to handle importing a protocol class. The first way is by importing annotations

from __future__ import annotations
import uno
from com.sun.star.sheet.SolverConstraintOperator import SolverConstraintOperatorProto
# ...

def solve_operation(value: int, x: SolverConstraintOperatorProto) -> int:
    ...

Note when using annotations the cast to protocol must be wrapped in a string.

from typing import cast
from com.sun.star.sheet.SolverConstraintOperator import SolverConstraintOperatorProto
from ooo.dyn.sheet.solver_constraint_operator import SolverConstraintOperator
# ...

# SolverConstraintOperatorProto must be wrapped in a string
# if it has not been assigned to object at runtime.
solve_operation(
    11, cast("SolverConstraintOperatorProto", SolverConstraintOperator.BINARY)
)

The other way is to assign the protocol class as an object at runtime.

from typing import TYPE_CHECKING
import uno
from com.sun.star.sheet.SolverConstraintOperator import SolverConstraintOperatorProto

if TYPE_CHECKING:
    # While writing code we have the advantages of protocol
    from com.sun.star.sheet.SolverConstraintOperator import SolverConstraintOperatorProto
else:
    # code is executing. Now protocol is an object and basically ignored
    SolverConstraintOperatorProto = object

Related Projects

• OOO Development Tools

• ooouno

• ScriptForge Typings

• Access2base Typings

• LibreOffice Python UNO Examples

• LibreOffice UNO Typings

• LibreOffice Developer Search

• OOO UNO TEMPLATE