Ggit.Rebase

g GObject.Object GObject.Object Ggit.ObjectFactoryBase Ggit.ObjectFactoryBase GObject.Object->Ggit.ObjectFactoryBase Ggit.Native Ggit.Native Ggit.Rebase Ggit.Rebase Ggit.Native->Ggit.Rebase Ggit.ObjectFactoryBase->Ggit.Native

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

abort ()

commit (author, committer, message)

finish (signature)

get_operation_by_index (idx)

get_operation_entry_count ()

get_operation_index ()

next ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

Ggit.Native (1)

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Ggit.Rebase(**kwargs)
Bases:

Ggit.Native

Abstract:

No

Structure:

Ggit.RebaseClass

Represents a rebase object.

abort()
Raises:

GLib.Error

Aborts a rebase that is currently in progress, resetting the repository and working directory to their state before rebase began.

commit(author, committer, message)
Parameters:
Raises:

GLib.Error

Returns:

a Ggit.OId of the newly created commit or None.

Return type:

Ggit.OId or None

Commits the current patch. You must have resolved any conflicts that were introduced during the patch application from the Ggit.Rebase.next() invocation.

finish(signature)
Parameters:

signature (Ggit.Signature or None) – the identity that is finishing the rebase or None.

Raises:

GLib.Error

Finishes a rebase that is currently in progress once all patches have been applied.

get_operation_by_index(idx)
Parameters:

idx (int) – The index of the rebase operation to retrieve.

Returns:

The rebase operation or None if idx was out of bounds.

Return type:

Ggit.RebaseOperation or None

Gets the rebase operation specified by idx.

get_operation_entry_count()
Returns:

the count of rebase operations that are to be applied.

Return type:

int

Gets the count of rebase operations that are to be applied.

get_operation_index()
Returns:

The index of the rebase operation currently being applied.

Return type:

int

Gets the index of the rebase operation that is currently being applied. If the first operation has not yet been applied (because you have called Ggit.Repository.rebase_init() but not yet Ggit.Rebase.next()) then this returns GGIT_REBASE_NO_OPERATION.

next()
Raises:

GLib.Error

Returns:

the rebase operation that is to be performed next or None.

Return type:

Ggit.RebaseOperation or None

Performs the next rebase operation and returns the information about it. If the operation is one that applies a patch (which is any operation except Ggit.RebaseOperationType.EXEC) then the patch will be applied and the index and working directory will be updated with the changes. If there are conflicts, you will need to address those before committing the changes.