Foundry.CommandLine¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`error_quark` ()
class	`new` ()
	`build_file_for_arg` (arg)
	`clear_progress` ()
	`dup_auth_provider` ()
	`get_directory` ()
	`get_environ` ()
	`get_stderr` ()
	`get_stdin` ()
	`get_stdout` ()
	`getenv` (name)
	`is_remote` ()
	`isatty` ()
	`print_list` (model, entries, format, expected_type)
	`print_object` (object, entries, format)
	`request_input` (input)
	`run` (argv)
	`set_progress` (progress)
	`set_title` (title)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Foundry.CommandLine(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Foundry.CommandLineClass

Abstract base class for command line interface implementations.

Foundry.CommandLine provides the core interface for command line operations including command parsing, execution, and communication with remote services. Concrete implementations handle different command line modes and provide unified access to Foundry functionality from the terminal.

classmethod error_quark()¶

Return type:: int

classmethod new()¶

Return type:: Foundry.CommandLine

build_file_for_arg(arg)¶

Parameters:: arg (str) –
Return type:: Gio.File

clear_progress()¶

dup_auth_provider()¶

Return type:: Foundry.AuthProvider or None

Gets an auth provider for this command line client if possible.

Currrently, this only returns an auth provider if the command line client provides a TTY.

get_directory()¶

Return type:: str

get_environ()¶

Returns:: the environment of the command line
Return type:: [str]

get_stderr()¶

Return type:: int

get_stdin()¶

Return type:: int

get_stdout()¶

Return type:: int

getenv(name)¶

Parameters:: name (str) –
Return type:: str

is_remote()¶

Return type:: bool

isatty()¶

Return type:: bool

print_list(model, entries, format, expected_type)¶

Parameters:

model (Gio.ListModel) –
entries (Foundry.ObjectSerializerEntry) –
format (Foundry.ObjectSerializerFormat) –
expected_type (GObject.GType) –

print_object(object, entries, format)¶

Parameters:

object (GObject.Object) –
entries (Foundry.ObjectSerializerEntry) –
format (Foundry.ObjectSerializerFormat) –

request_input(input)¶

Parameters:: input (Foundry.Input) – a [class`Foundry`.Input]
Returns:: a [class`Dex`.Future] that resolves to any value or rejects with error.
Return type:: Dex.Future

Queries the user for the information requested in input.

run(argv)¶

Parameters:: argv (str) –
Returns:: a Dex.Future that resolves to an int
Return type:: Dex.Future

Runs the command line.

set_progress(progress)¶

Parameters:: progress (int) –

set_title(title)¶

Parameters:: title (str) –