Foundry.BuildManager

g Foundry.BuildManager Foundry.BuildManager Foundry.Contextual Foundry.Contextual Foundry.Service Foundry.Service Foundry.Contextual->Foundry.Service Foundry.Service->Foundry.BuildManager GObject.GInterface GObject.GInterface Json.Serializable Json.Serializable GObject.GInterface->Json.Serializable GObject.Object GObject.Object GObject.Object->Foundry.Contextual Json.Serializable->Foundry.Contextual

Subclasses:

None

Methods

Inherited:

Foundry.Service (8), Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)

Structs:

Foundry.ServiceClass (3), GObject.ObjectClass (5)

build ()

clean ()

export ()

get_busy ()

get_default_pty ()

install ()

invalidate ()

load_pipeline ()

purge ()

rebuild ()

set_default_pty (pty_fd)

stop ()

Virtual Methods

Inherited:

GObject.Object (7), Json.Serializable (5)

Properties

Inherited:

Foundry.Contextual (1)

Name

Type

Flags

Short Description

busy

bool

r

Signals

Inherited:

GObject.Object (1)

Name

Short Description

pipeline-invalidated

This signal is emitted when a loaded pipeline has become invalidated.

Fields

Inherited:

GObject.Object (1)

Class Details

class Foundry.BuildManager(**kwargs)
Bases:

Foundry.Service

Abstract:

No

Structure:

Foundry.BuildManagerClass

Manages build operations and build system integration.

Foundry.BuildManager coordinates build pipelines, manages build progress, and provides a unified interface for different build systems. It handles build configuration, execution, and integrates with device management for deployment and testing operations.

build()
Returns:

a [class`Dex`.Future] that resolves to any value or rejects with error.

Return type:

Dex.Future

clean()
Returns:

a [class`Dex`.Future] that resolves to any value or rejects with error.

Return type:

Dex.Future

export()
Returns:

a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [iface`Gio`.File] or rejects with error.

Return type:

Dex.Future

Runs the build pipeline to the export phase.

New in version 1.1.

get_busy()
Return type:

bool

If the build manager is currently busy running an operation on the active pipeline.

get_default_pty()
Return type:

int

install()
Returns:

a [class`Dex`.Future] that resolves to any value or rejects with error.

Return type:

Dex.Future

Runs the build pipeline to the install phase.

New in version 1.1.

invalidate()
load_pipeline()
Returns:

a Dex.Future that resolves to a Foundry.Pipeline

Return type:

Dex.Future

Loads the pipeline as a future.

If the pipeline is already being loaded, the future will be completed as part of that request.

If the pipeline is already loaded, the future returned will already be resolved.

Otherwise, a new request to load the pipeline is created and the future will resolve upon completion.

purge()
Returns:

a [class`Dex`.Future] that resolves to any value or rejects with error.

Return type:

Dex.Future

rebuild()
Returns:

a [class`Dex`.Future] that resolves to any value or rejects with error.

Return type:

Dex.Future

set_default_pty(pty_fd)
Parameters:

pty_fd (int) –

stop()

Stop any active builds controlled by the build manager.

Signal Details

Foundry.BuildManager.signals.pipeline_invalidated(build_manager)
Signal Name:

pipeline-invalidated

Flags:

RUN_LAST

Parameters:

build_manager (Foundry.BuildManager) – The object which received the signal

This signal is emitted when a loaded pipeline has become invalidated. Observers of pipelines may want to call [method`Foundry`.BuildManager.load_pipeline] to request a new pipeline.

Property Details

Foundry.BuildManager.props.busy
Name:

busy

Type:

bool

Default Value:

False

Flags:

READABLE