Skip to content

_build_module

Surface module for brms._build() context (internal tooling).

This module is intended to be imported safely in the main process (no top-level rpy2 imports). Heavy work should be performed in the worker when these functions are called via ModuleProxy.

Only names listed in all will be exposed by the _build() context proxy.

Attributes

__all__ = ['BuildModule'] module-attribute

Classes

BuildModule

Source code in brmspy/brms/_build_module.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
class BuildModule:
    @staticmethod
    def is_package_installed(name: str) -> bool:
        from brmspy._runtime._r_packages import is_package_installed

        return is_package_installed(name)

    @staticmethod
    def collect_runtime_metadata() -> dict:
        """
        Collect comprehensive R environment metadata for runtime bundle.

        Executed in worker.
        """
        from brmspy._build._metadata import collect_runtime_metadata as _collect

        return _collect()

    @staticmethod
    def stage_runtime_tree(
        base_dir: Path, metadata: dict, runtime_version: str
    ) -> Path:
        """
        Stage runtime tree structure for packing.

        Executed in worker.
        """
        from brmspy._build._stage import stage_runtime_tree as _stage

        return _stage(base_dir, metadata, runtime_version)

    @staticmethod
    def pack_runtime(runtime_root: Path, out_dir: Path, runtime_version: str) -> Path:
        """
        Pack staged runtime into distributable archive.

        Executed in worker.
        """
        from brmspy._build._pack import pack_runtime as _pack

        return _pack(runtime_root, out_dir, runtime_version)

Functions

is_package_installed(name) staticmethod
Source code in brmspy/brms/_build_module.py 
20
21
22
23
24
@staticmethod
def is_package_installed(name: str) -> bool:
    from brmspy._runtime._r_packages import is_package_installed

    return is_package_installed(name)
collect_runtime_metadata() staticmethod

Collect comprehensive R environment metadata for runtime bundle.

Executed in worker.

Source code in brmspy/brms/_build_module.py 
26
27
28
29
30
31
32
33
34
35
@staticmethod
def collect_runtime_metadata() -> dict:
    """
    Collect comprehensive R environment metadata for runtime bundle.

    Executed in worker.
    """
    from brmspy._build._metadata import collect_runtime_metadata as _collect

    return _collect()
stage_runtime_tree(base_dir, metadata, runtime_version) staticmethod

Stage runtime tree structure for packing.

Executed in worker.

Source code in brmspy/brms/_build_module.py 
37
38
39
40
41
42
43
44
45
46
47
48
@staticmethod
def stage_runtime_tree(
    base_dir: Path, metadata: dict, runtime_version: str
) -> Path:
    """
    Stage runtime tree structure for packing.

    Executed in worker.
    """
    from brmspy._build._stage import stage_runtime_tree as _stage

    return _stage(base_dir, metadata, runtime_version)
pack_runtime(runtime_root, out_dir, runtime_version) staticmethod

Pack staged runtime into distributable archive.

Executed in worker.

Source code in brmspy/brms/_build_module.py 
50
51
52
53
54
55
56
57
58
59
@staticmethod
def pack_runtime(runtime_root: Path, out_dir: Path, runtime_version: str) -> Path:
    """
    Pack staged runtime into distributable archive.

    Executed in worker.
    """
    from brmspy._build._pack import pack_runtime as _pack

    return _pack(runtime_root, out_dir, runtime_version)