Foundry.VcsCommit¶

Subclasses:: Foundry.GitCommit

Methods¶

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

	`dup_author` ()
	`dup_committer` ()
	`dup_id` ()
	`dup_title` ()
	`get_n_parents` ()
	`load_delta` (relative_path)
	`load_parent` (index)
	`load_tree` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_dup_author` ()
	`do_dup_committer` ()
	`do_dup_id` ()
	`do_dup_title` ()
	`do_get_n_parents` ()
	`do_load_delta` (relative_path)
	`do_load_parent` (index)
	`do_load_tree` ()

Properties¶

Name	Type	Flags
`author`	`Foundry.VcsSignature`	r
`committer`	`Foundry.VcsSignature`	r
`id`	`str`	r
`title`	`str`	r

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Foundry.VcsCommit(**kwargs)¶

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

dup_author()¶

Return type:: Foundry.VcsSignature or None

dup_committer()¶

Return type:: Foundry.VcsSignature or None

dup_id()¶

Return type:: str or None

dup_title()¶

Return type:: str or None

get_n_parents()¶

Return type:: int

Counts the number of parents of the commit

load_delta(relative_path)¶

Parameters:: relative_path (str) – the relative path of the file to get the delta for
Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.VcsDelta] or rejects with error
Return type:: Dex.Future

Loads the delta for a single file comparing this commit to its parent. This extracts the changes for relative_path from the commit’s parent commit.

load_parent(index)¶

Parameters:: index (int) – the index of the parent
Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.VcsCommit] or rejects with error
Return type:: Dex.Future

load_tree()¶

Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.VcsTree] or rejects with error
Return type:: Dex.Future

do_dup_author() virtual¶

Return type:: Foundry.VcsSignature or None

do_dup_committer() virtual¶

Return type:: Foundry.VcsSignature or None

do_dup_id() virtual¶

Return type:: str or None

do_dup_title() virtual¶

Return type:: str or None

do_get_n_parents() virtual¶

Return type:: int

Counts the number of parents of the commit

do_load_delta(relative_path) virtual¶

Parameters:: relative_path (str) – the relative path of the file to get the delta for
Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.VcsDelta] or rejects with error
Return type:: Dex.Future

Loads the delta for a single file comparing this commit to its parent. This extracts the changes for relative_path from the commit’s parent commit.

do_load_parent(index) virtual¶

Parameters:: index (int) – the index of the parent
Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.VcsCommit] or rejects with error
Return type:: Dex.Future

do_load_tree() virtual¶

Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.VcsTree] or rejects with error
Return type:: Dex.Future

Property Details¶

Foundry.VcsCommit.props.author¶

Name:: author
Type:: Foundry.VcsSignature
Default Value:: None
Flags:: READABLE

Foundry.VcsCommit.props.committer¶

Name:: committer
Type:: Foundry.VcsSignature
Default Value:: None
Flags:: READABLE

Foundry.VcsCommit.props.id¶

Name:: id
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.VcsCommit.props.title¶

Name:: title
Type:: str
Default Value:: None
Flags:: READABLE