Foundry.VcsBlame

g Foundry.VcsBlame Foundry.VcsBlame GObject.Object GObject.Object GObject.Object->Foundry.VcsBlame

Subclasses:

Foundry.GitBlame

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

dup_file ()

get_n_lines ()

query_line (line)

update (bytes)

Virtual Methods

Inherited:

GObject.Object (7)

do_get_n_lines ()

do_query_line (line)

do_update (bytes)

Properties

Name

Type

Flags

Short Description

file

Foundry.VcsFile

r/w/co

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent_instance

GObject.Object

r

Class Details

class Foundry.VcsBlame(**kwargs)
Bases:

GObject.Object

Abstract:

Yes

Structure:

Foundry.VcsBlameClass

dup_file()
Returns:

a [class`Foundry`.VcsFile]

Return type:

Foundry.VcsFile

Gets the underlying file being blamed

get_n_lines()
Returns:

A value < GObject.G_MAXUINT

Return type:

int

Gets the number of lines contained in the blame.

query_line(line)
Parameters:

line (int) – the line number, starting from 0

Returns:

a [class`Foundry`.VcsSignature] or None if there is no commit related to the changes on line.

Return type:

Foundry.VcsSignature or None

Queries the signature of the commit that modified line.

update(bytes)
Parameters:

bytes (GLib.Bytes or None) – data for the blame or None to reset to file defaults

Returns:

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

Return type:

Dex.Future

Update the blame using the contents in bytes.

If bytes is None then the underlying file contents will be used as if no modifications were provided.

do_get_n_lines() virtual
Returns:

A value < GObject.G_MAXUINT

Return type:

int

Gets the number of lines contained in the blame.

do_query_line(line) virtual
Parameters:

line (int) – the line number, starting from 0

Returns:

a [class`Foundry`.VcsSignature] or None if there is no commit related to the changes on line.

Return type:

Foundry.VcsSignature or None

Queries the signature of the commit that modified line.

do_update(bytes) virtual
Parameters:

bytes (GLib.Bytes or None) – data for the blame or None to reset to file defaults

Returns:

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

Return type:

Dex.Future

Update the blame using the contents in bytes.

If bytes is None then the underlying file contents will be used as if no modifications were provided.

Property Details

Foundry.VcsBlame.props.file
Name:

file

Type:

Foundry.VcsFile

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY