Skip to content

pytauri_wheel.lib

PyTauri precompiled wheels.

Usage

pytauri-wheel provides precompiled pytauri.EXT_MOD for pytauri, which means you can normally use the pytauri API, except for the following APIs provided by pytauri-wheel:

Functions:

Name Description
builder_factory

A factory function for creating a pytauri.Builder instance.
context_factory

Generate a Context based on tauri.conf.json, capabilities/ and etc in the src_tauri_dir directory.

__all__ module-attribute 

__all__ = ['builder_factory', 'context_factory']

builder_factory 

builder_factory(*, opener: bool = True, clipboard_manager: bool = True, dialog: bool = True, fs: bool = True) -> Builder

A factory function for creating a pytauri.Builder instance.

This is a type-hinted wrapper function for pytauri.builder_factory.

Parameters:

Name Type Description Default

opener

bool

Whether to enable the plugin opener

 True

clipboard_manager

bool

Whether to enable the plugin clipboard-manager

 True

dialog

bool

Whether to enable the plugin dialog

 True

fs

bool

Whether to enable the plugin fs

 True
Source code in python/pytauri-wheel/python/pytauri_wheel/lib.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def builder_factory(
    *,
    opener: bool = True,
    clipboard_manager: bool = True,
    dialog: bool = True,
    fs: bool = True,
) -> Builder:
    """A factory function for creating a [pytauri.Builder][] instance.

    This is a type-hinted wrapper function for [pytauri.builder_factory][].

    Args:
        opener: Whether to enable the plugin `opener`
        clipboard_manager: Whether to enable the plugin `clipboard-manager`
        dialog: Whether to enable the plugin `dialog`
        fs: Whether to enable the plugin `fs`
    """
    return pytauri_builder_factory(
        opener=opener, clipboard_manager=clipboard_manager, dialog=dialog, fs=fs
    )

context_factory 

context_factory(src_tauri_dir: Path, /, *, tauri_config: Optional[str] = None) -> Context

Generate a Context based on tauri.conf.json, capabilities/ and etc in the src_tauri_dir directory.

This type-hinted wrapper function for pytauri.context_factory.

Parameters:

Name Type Description Default

src_tauri_dir

Path

The absolute path of the pytauri project directory. In a typical Tauri project, it exists as the src-tauri directory; in the pytauri-wheel project, you only need to provide a similar file layout to src-tauri: 

src-tauri/
    __init__.py
    tauri.conf.json
    capabilities/
    ...

required

tauri_config

Optional[str]

The config JSON string to be merged with tauri.conf.json, equivalent to the --config of tauri-cli. See: https://tauri.app/develop/configuration-files/#extending-the-configuration.

 None
Source code in python/pytauri-wheel/python/pytauri_wheel/lib.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def context_factory(
    src_tauri_dir: Path, /, *, tauri_config: Optional[str] = None
) -> Context:
    """Generate a `Context` based on `tauri.conf.json`, `capabilities/` and etc in the `src_tauri_dir` directory.

    This type-hinted wrapper function for [pytauri.context_factory][].

    Args:
        src_tauri_dir: The **absolute** path of the pytauri project directory.
            In a typical Tauri project, it exists as the `src-tauri` directory;
            in the `pytauri-wheel` project, you only need to provide a similar file layout to `src-tauri`:
                ```text
                src-tauri/
                    __init__.py
                    tauri.conf.json
                    capabilities/
                    ...
                ```
        tauri_config: The config JSON string to be merged with `tauri.conf.json`, equivalent to the `--config` of `tauri-cli`.
            See: <https://tauri.app/develop/configuration-files/#extending-the-configuration>.
    """
    if not src_tauri_dir.is_absolute():
        raise ValueError("`src_tauri_dir` must be an absolute path.")

    return pytauri_context_factory(src_tauri_dir, tauri_config=tauri_config)