Ggit.BlameOptions

Fields

None

Methods

class

new ()

copy ()

free ()

get_maximum_line ()

get_minimum_line ()

get_minimum_match_characters ()

get_newest_commit ()

get_oldest_commit ()

set_maximum_line (line)

set_minimum_line (line)

set_minimum_match_characters (characters)

set_newest_commit (oid)

set_oldest_commit (oid)

Details

class Ggit.BlameOptions

Represents blame options.

classmethod new()
Returns:

a newly allocated Ggit.BlameOptions.

Return type:

Ggit.BlameOptions

Create a new, empty Ggit.BlameOptions.

copy()
Returns:

a newly allocated Ggit.BlameOptions or None.

Return type:

Ggit.BlameOptions or None

Copies self into a newly allocated Ggit.BlameOptions.

free()

Frees self.

get_maximum_line()
Returns:

the last line to consider.

Return type:

int

Get the last line in the file to consider. The default is 1.

get_minimum_line()
Returns:

the first line to consider.

Return type:

int

Get the first line in the file to consider. The default is 1.

get_minimum_match_characters()
Returns:

the minimum number of characters.

Return type:

int

Get the minimum number of characters that must be detected as moving/copying within a file for it to associate those lines with a parent commit. This is only used when any of the Ggit.BlameFlags.TRACK_COPIES_SAME_FILE flag is specified. The default value is 20.

get_newest_commit()
Returns:

a Ggit.OId or None.

Return type:

Ggit.OId or None

Get the id of the newest commit to consider in the blame. The default value of None indicates to use HEAD.

get_oldest_commit()
Returns:

a Ggit.OId or None.

Return type:

Ggit.OId or None

Get the id of the oldest commit to consider in the blame. Teh default value of None indicates to used HEAD.

set_maximum_line(line)
Parameters:

line (int) – the last line to consider.

Set the last line in the file to consider. Lines start at 1.

set_minimum_line(line)
Parameters:

line (int) – the first line to consider.

Set the first line in the file to consider. Lines start at 1.

set_minimum_match_characters(characters)
Parameters:

characters (int) – the minimum number of characters.

Set the minimum number of characters that must be detected as moving/copying within a file for it to associate those lines with a parent commit. This is only used when any of the #GGIT_BLAME_TRACK_COPIES_ flags are specified. The default value is 20.

set_newest_commit(oid)
Parameters:

oid (Ggit.OId or None) – a Ggit.OId or None.

Set the id of the newest commit to consider in the blame. Specify None to set the default value which indicates to use HEAD.

set_oldest_commit(oid)
Parameters:

oid (Ggit.OId or None) – a Ggit.OId.

Set the id of the oldest commit to consider in the blame. Specify None to set the default value which indicates to consider the first commit without a parent.