types-unopy 0.2.0

Type annotations for LibreOffice API

This project allow typings for the full LibreOffice API

WHY

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

VERSION

This package is for Version 7.3 of LibreOffice API.

Installation

PIP

types-unopy PyPI

$ pip install 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.

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 typing import TYPE_CHECKING
>>> if TYPE_CHECKING:
...     from com.sun.star.sheet import SheetCellRange
...
# anything inside of TYPE_CHECKING block is ignore at runtime.

Known Issues

Enums

There is no enum classes in API only enum members.

To acces the enum members they must be imported directly.

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

If you need the behaviour 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'>