eric6.Plugins.VcsPlugins.vcsGit.git

Module implementing the version control systems interface to Git.

Global Attributes

Classes

Functions

Git

Class implementing the version control systems interface to Git.

Signals

committed()

emitted after the commit action has completed

Derived from

Class Attributes

Class Methods

Methods

Static Methods

Git (Constructor)

Constructor

plugin

reference to the plugin object

parent

parent widget (QWidget)

name

name of this object (string)

Git.__gitGetFileForRevision

Private method to get a file for a specific revision from the repository.

name

file name to get from the repository (string)

rev=

revision to retrieve (string)

Returns:

contents of the file (string) and an error message (string)

Git.__gitGetStashesList

Private method to get a list of stash names.

projectDir

name of the project directory (string)

Returns:

list of available stashes (list of string)

Git.__gitSubmodulesList

Private method to get the data of defined submodules.

repodir (str)

name of the directory containing the repo subdirectory

Returns:

list of dictionaries with submodule name, path, URL and branch

Return Type:

list of dict

Git.__selectSubmodulePath

Private method to select a submodule path.

repodir (str)

name of the directory containing the repo subdirectory

Returns:

tuple of selected submodule path and flag indicating a cancellation

Return Type:

tuple of (str, bool)

Git.__selectSubmodulePaths

Private method to select a list of submodule paths.

repodir (str)

name of the directory containing the repo subdirectory

Returns:

tuple of selected submodule paths and flag indicating a cancellation

Return Type:

tuple of (list of str, bool)

Git.__vcsCommit_Step2

Private slot performing the second step of the commit action.

Git._createStatusMonitorThread

Protected method to create an instance of the VCS status monitor thread.

interval

check interval for the monitor thread in seconds (integer)

project

reference to the project object (Project)

Returns:

reference to the monitor thread (QThread)

Git.clearStatusCache

Public method to clear the status cache.

Git.getPlugin

Public method to get a reference to the plugin object.

Returns:

reference to the plugin object (VcsGitPlugin)

Git.gitAddRemote

Public method to add a remote repository.

projectDir

name of the project directory (string)

Git.gitApply

Public method to apply a patch stored in a given file.

repodir

directory name of the repository (string)

patchFile

name of the patch file (string)

cached

flag indicating to apply the patch to the staging area (boolean)

reverse

flag indicating to apply the patch in reverse (boolean)

noDialog

flag indicating quiet operations (boolean)

Git.gitApplyCheckPatches

Public method to apply a list of patch files or check, if they would apply cleanly.

projectDir

directory name of the project (string)

check

flag indicating to perform a check operation (boolean)

Git.gitBisect

Public method to perform bisect commands.

projectDir

name of the project directory (string)

subcommand

name of the subcommand (string, one of 'start', 'start_extended', 'good', 'bad', 'skip' or 'reset')

Returns:

flag indicating, that the update contained an add or delete (boolean)

Raises ValueError:

raised to indicate an invalid bisect subcommand

Git.gitBisectCreateReplayFile

Public method used to create a bisect replay file for the project.

projectDir

name of the project directory (string)

Git.gitBisectEditReplayFile

Public method used to edit a bisect replay file.

projectDir

name of the project directory (string)

Git.gitBisectLogBrowser

Public method used to browse the bisect log of the project.

projectDir

name of the project directory (string)

Git.gitBisectReplay

Public method to replay a bisect session.

projectDir

name of the project directory (string)

Returns:

flag indicating, that the update contained an add or delete (boolean)

Git.gitBlame

Public method to show the output of the git blame command.

name

file name to show the annotations for (string)

Git.gitBranch

Public method used to create, delete or move a branch in the Git repository.

name

file/directory name to be branched (string)

revision

revision to set tag for (string)

branchName

name of the branch (string)

branchOp

desired branch operation (integer)

Returns:

flag indicating a performed branch action (boolean) and a flag indicating, that the branch operation contained an add or delete (boolean)

Git.gitBundle

Public method to create a bundle file.

projectDir

name of the project directory (string)

Git.gitBundleFetch

Public method to fetch a head of a bundle file into the local repository.

projectDir

name of the project directory (string)

Git.gitBundleListHeads

Public method to list the heads contained in a bundle file.

projectDir

name of the project directory (string)

Git.gitBundlePull

Public method to pull a head of a bundle file into the local repository and working area.

projectDir

name of the project directory (string)

Returns:

flag indicating, that the update contained an add or delete (boolean)

Git.gitCancelMerge

Public method to cancel an uncommitted or failed merge.

name

file/directory name (string)

Returns:

flag indicating, that the cancellation contained an add or delete (boolean)

Git.gitChangeRemoteCredentials

Public method to change the user credentials of a remote repository.

projectDir (str)

name of the project directory

remoteName (str)

name of the remote repository

remoteUrl (str)

URL of the remote repository

Git.gitChangeRemoteUrl

Public method to change the URL of a remote repository.

projectDir (str)

name of the project directory

remoteName (str)

name of the remote repository

remoteUrl (str)

URL of the remote repository

Git.gitCherryPick

Public method to cherry pick commits and apply them to the current branch.

projectDir

name of the project directory (string)

commits

list of commits to be applied (list of strings)

Returns:

flag indicating that the project should be reread (boolean)

Git.gitCherryPickAbort

Public method to cancel the last copying session and return to the previous state.

projectDir

name of the project directory (string)

Returns:

flag indicating that the project should be reread (boolean)

Git.gitCherryPickContinue

Public method to continue the last copying session after conflicts were resolved.

projectDir

name of the project directory (string)

Returns:

flag indicating that the project should be reread (boolean)

Git.gitCherryPickQuit

Public method to quit the current copying operation.

projectDir

name of the project directory (string)

Returns:

flag indicating that the project should be reread (boolean)

Git.gitCommitMerge

Public method to commit a failed merge.

name

file/directory name (string)

Git.gitCopy

Public method used to copy a file/directory.

name

file/directory name to be copied (string)

project

reference to the project object

Returns:

flag indicating successful operation (boolean)

Git.gitCreateArchive

Public method to show some statistics of the local repository.

projectDir

name of the project directory (string)

Git.gitCreateIgnoreFile

Public method to create the ignore file.

name

directory name to create the ignore file in (string)

autoAdd

flag indicating to add it automatically (boolean)

Returns:

flag indicating success

Git.gitDeleteRemoteBranch

Public method to delete a branch from a remote repository.

name

file/directory name (string)

Git.gitDescribe

Public method to find the most recent tag reachable from each commit.

projectDir

name of the project directory (string)

commits

list of commits to start the search from (list of strings)

Git.gitEditConfig

Public method used to edit the repository configuration file.

projectDir

name of the project directory (string)

Git.gitEditUserConfig

Public method used to edit the user configuration file.

Git.gitExtendedDiff

Public method used to view the difference of a file/directory to the Git repository.

If name is a directory and is the project directory, all project files are saved first. If name is a file (or list of files), which is/are being edited and has unsaved modification, they can be saved or the operation may be aborted.

This method gives the chance to enter the revisions to be compared.

name

file/directory name to be diffed (string)

Git.gitFetch

Public method to fetch changes from a remote repository.

name

directory name (string)

Git.gitGetArchiveFormats

Public method to get a list of supported archive formats.

repodir

directory name of the repository (string)

Returns:

list of supported archive formats (list of strings)

Git.gitGetBranchesList

Public method to get the list of branches.

repodir

directory name of the repository (string)

withMaster

flag indicating to get 'master' as well (boolean)

allBranches

flag indicating to return all branches (boolean)

remotes

flag indicating to return remote branches only (boolean)

Returns:

list of branches (list of string)

Git.gitGetBundleHeads

Public method to get a list of heads contained in a bundle file.

repodir

directory name of the repository (string)

bundleFile

file name of a git bundle file (string)

Returns:

list of heads (list of strings)

Git.gitGetCurrentBranch

Public method used to show the current branch of the working directory.

repodir

directory name of the repository (string)

Returns:

name of the current branch (string)

Git.gitGetRemoteBranchesList

Public method to get the list of a remote repository branches.

repodir

directory name of the repository (string)

remote

remote repository name (string)

Returns:

list of remote repository branches (list of string)

Git.gitGetRemoteUrl

Public method to get the URL of a remote repository.

repodir (str)

directory name of the repository

remoteName (str)

name of the remote repository

Returns:

URL of the remote repository

Return Type:

str

Git.gitGetRemoteUrlsList

Public method to get the list of remote repos and their URLs.

repodir

directory name of the repository (string)

forFetch

flag indicating to get Fetch info (string)

Returns:

list of tuples of remote repo name and repo URL (list of tuple of two strings)

Git.gitGetRemotesList

Public method to get the list of remote repos.

repodir

directory name of the repository (string)

Returns:

list of remote repos (list of string)

Git.gitGetTagsList

Public method to get the list of tags.

repodir

directory name of the repository (string)

withType

flag indicating to get the tag type as well (boolean)

Returns:

list of tags (list of string) or list of tuples of tag name and flag indicating a local tag (list of tuple of string and boolean), if withType is True

Git.gitHouseKeeping

Public method to cleanup and optimize the local repository.

projectDir

name of the project directory (string)

Git.gitListTagBranch

Public method used to list the available tags or branches.

path

directory name of the project (string)

tags

flag indicating listing of branches or tags (False = branches, True = tags)

listAll

flag indicating to show all tags or branches (boolean)

merged

flag indicating to show only merged or non-merged branches (boolean)

Git.gitNormalizeURL

Public method to normalize a url for Git.

url

url string (string)

Returns:

properly normalized url for git (string)

Git.gitPruneRemote

Public method to prune stale remote-tracking branches.

projectDir

name of the project directory (string)

remoteName

name of the remote repository (string)

Git.gitPull

Public method used to pull changes from a remote Git repository.

name

directory name of the project to be pulled to (string)

Returns:

flag indicating, that the update contained an add or delete (boolean)

Git.gitPush

Public method used to push changes to a remote Git repository.

name

directory name of the project to be pushed from (string)

Git.gitReflogBrowser

Public method used to browse the reflog of the project.

projectDir

name of the project directory (string)

Git.gitRemoveRemote

Public method to remove a remote repository.

projectDir

name of the project directory (string)

remoteName

name of the remote repository (string)

Git.gitRenameRemote

Public method to rename a remote repository.

projectDir

name of the project directory (string)

remoteName

name of the remote repository (string)

Git.gitRevert

Public method used to revert changes made to a file/directory.

name

file/directory name to be reverted (string)

Returns:

flag indicating, that the update contained an add or delete (boolean)

Git.gitSbsDiff

Public method used to view the difference of a file to the Git repository side-by-side.

name

file name to be diffed (string)

extended=

flag indicating the extended variant (boolean)

revisions=

tuple of two revisions (tuple of strings)

Raises ValueError:

raised to indicate an invalid name parameter

Git.gitShortlog

Public method to show a short log suitable for inclusion in release announcements.

projectDir

name of the project directory (string)

commit

commit to start the log at (strings)

Git.gitShowBranch

Public method used to show the current branch of the working directory.

name

file/directory name (string)

Git.gitShowConfig

Public method to show the combined configuration.

projectDir

name of the project directory (string)

Git.gitShowPatchesStatistics

Public method to show statistics for a set of patch files.

projectDir

directory name of the project (string)

Git.gitShowRemote

Public method to show information about a remote repository.

projectDir

name of the project directory (string)

remoteName

name of the remote repository (string)

Git.gitShowRemotes

Public method to show available remote repositories.

projectDir

name of the project directory (string)

Git.gitStashApply

Public method to apply a stash but keep it.

projectDir

name of the project directory (string)

stashName

name of a stash (string)

Returns:

flag indicating, that the restore contained an add or delete (boolean)

Git.gitStashBranch

Public method to create a branch from a stash.

projectDir

name of the project directory (string)

stashName

name of a stash (string)

Returns:

flag indicating, that the restore contained an add or delete (boolean)

Git.gitStashBrowser

Public method used to browse the stashed changes.

projectDir

name of the project directory (string)

Git.gitStashClear

Public method to delete all stashes.

projectDir

name of the project directory (string)

Returns:

flag indicating a successful deletion (boolean)

Git.gitStashDrop

Public method to delete a stash.

projectDir

name of the project directory (string)

stashName

name of a stash (string)

Returns:

flag indicating a successful deletion (boolean)

Git.gitStashPop

Public method to apply a stash and delete it.

projectDir

name of the project directory (string)

stashName

name of a stash (string)

Returns:

flag indicating, that the restore contained an add or delete (boolean)

Git.gitStashSave

Public method to save the current changes to a new stash.

projectDir

name of the project directory (string)

Returns:

flag indicating, that the save contained an add or delete (boolean)

Git.gitStashShowPatch

Public method to show the contents of a stash.

projectDir

name of the project directory (string)

stashName

name of a stash (string)

Git.gitStatistics

Public method to show some statistics of the local repository.

projectDir

name of the project directory (string)

Git.gitSubmoduleAdd

Public method to add a submodule to the project.

projectDir (str)

name of the project directory

Git.gitSubmoduleDeinit

Public method to unregister submodules.

projectDir (str)

name of the project directory

Git.gitSubmoduleInit

Public method to initialize one or all submodules.

projectDir (str)

name of the project directory

Git.gitSubmoduleList

Public method to show a list of all submodules of the project.

projectDir (str)

name of the project directory

Git.gitSubmoduleStatus

Public method to show the status of the submodules.

projectDir (str)

name of the project directory

Git.gitSubmoduleSummary

Public method to show the status of the submodules.

projectDir (str)

name of the project directory

Git.gitSubmoduleSync

Public method to synchronize submodules.

projectDir (str)

name of the project directory

Git.gitSubmoduleUpdate

Public method to update submodules.

projectDir (str)

name of the project directory

initialize (bool)

flag indicating an initialize and update operation

remote (bool)

flag indicating a fetch and update operation

Git.gitSubmoduleUpdateWithOptions

Public method to update submodules offering a dialog to select the update options.

projectDir (str)

name of the project directory

Git.gitUnstage

Public method used to unstage a file/directory.

name

file/directory name to be reverted (string)

Returns:

flag indicating, that the update contained an add or delete (boolean)

Git.gitVerify

Public method to verify the connectivity and validity of objects of the database.

projectDir

name of the project directory (string)

Git.gitVerifyBundle

Public method to verify a bundle file.

projectDir

name of the project directory (string)

Git.initCommand

Public method to initialize a command arguments list.

command

command name (string)

Returns:

list of command options (list of string)

Git.vcsAdd

Public method used to add a file/directory to the Git repository.

name

file/directory name to be added (string)

isDir

flag indicating name is a directory (boolean)

noDialog

flag indicating quiet operations

Git.vcsAddBinary

Public method used to add a file/directory in binary mode to the Git repository.

name

file/directory name to be added (string)

isDir

flag indicating name is a directory (boolean)

Git.vcsAddTree

Public method to add a directory tree rooted at path to the Git repository.

path

root directory of the tree to be added (string or list of strings))

Git.vcsAllRegisteredStates

Public method used to get the registered states of a number of files in the vcs.

Note: If a shortcut is to be taken, the code will only check, if the named directory has been scanned already. If so, it is assumed, that the states for all files have been populated by the previous run.

names

dictionary with all filenames to be checked as keys

dname

directory to check in (string)

shortcut

flag indicating a shortcut should be taken (boolean)

Returns:

the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error

Git.vcsCheckout

Public method used to check the project out of a Git repository (clone).

vcsDataDict

dictionary of data required for the checkout

projectDir

project directory to create (string)

noDialog

flag indicating quiet operations

Returns:

flag indicating an execution without errors (boolean)

Git.vcsCleanup

Public method used to cleanup the working directory.

name

directory name to be cleaned up (string)

Git.vcsCommandLine

Public method used to execute arbitrary Git commands.

name

directory name of the working directory (string)

Git.vcsCommit

Public method used to make the change of a file/directory permanent in the Git repository.

name

file/directory name to be committed (string or list of strings)

message

message for this operation (string)

noDialog

flag indicating quiet operations (boolean)

commitAll

flag indicating to commit all local changes (boolean)

amend

flag indicating to amend the HEAD commit (boolean)

Git.vcsConvertProject

Public method to convert an uncontrolled project to a version controlled project.

vcsDataDict (dict)

dictionary of data required for the conversion

project (Project)

reference to the project object

addAll (bool)

flag indicating to add all files to the repository

Git.vcsDiff

Public method used to view the difference of a file/directory to the Git repository.

If name is a directory and is the project directory, all project files are saved first. If name is a file (or list of files), which is/are being edited and has unsaved modification, they can be saved or the operation may be aborted.

name

file/directory name to be diffed (string)

Git.vcsExists

Public method used to test for the presence of the git executable.

Returns:

flag indicating the existance (boolean) and an error message (string)

Git.vcsExport

Public method used to export a directory from the Git repository.

vcsDataDict

dictionary of data required for the checkout

projectDir

project directory to create (string)

Returns:

flag indicating an execution without errors (boolean)

Git.vcsGetProjectBrowserHelper

Public method to instantiate a helper object for the different project browsers.

browser

reference to the project browser object

project

reference to the project object

isTranslationsBrowser

flag indicating, the helper is requested for the translations browser (this needs some special treatment)

Returns:

the project browser helper object

Git.vcsGetProjectHelper

Public method to instantiate a helper object for the project.

project

reference to the project object

Returns:

the project helper object

Git.vcsImport

Public method used to import the project into the Git repository.

vcsDataDict (dict)

dictionary of data required for the import

projectDir (str)

project directory (string)

noDialog (bool)

flag indicating quiet operations

addAll (bool)

flag indicating to add all files to the repository

Returns:

tuple containing a flag indicating an execution without errors and a flag indicating the version controll status

Return Type:

tuple of (bool, bool)

Git.vcsInit

Public method used to initialize the Git repository.

The initialization is done, when a project is converted into a Git controlled project. Therefore we always return TRUE without doing anything.

vcsDir

name of the VCS directory (string)

noDialog

flag indicating quiet operations (boolean)

Returns:

always TRUE

Git.vcsInitConfig

Public method to initialize the VCS configuration.

This method ensures, that an ignore file exists.

project

reference to the project (Project)

Git.vcsLogBrowser

Public method used to browse the log of a file/directory from the Git repository.

name

file/directory name to show the log of (string)

isFile=

flag indicating log for a file is to be shown (boolean)

Git.vcsMerge

Public method used to merge a URL/revision into the local project.

name

file/directory name to be merged (string)

Git.vcsMove

Public method used to move a file/directory.

name

file/directory name to be moved (string)

project

reference to the project object

target

new name of the file/directory (string)

noDialog

flag indicating quiet operations

Returns:

flag indicating successful operation (boolean)

Git.vcsName

Public method returning the name of the vcs.

Returns:

always 'Git' (string)

Git.vcsNewProjectOptionsDialog

Public method to get a dialog to enter repository info for getting a new project.

parent

parent widget (QWidget)

Returns:

reference to the instantiated options dialog (GitNewProjectOptionsDialog)

Git.vcsOptionsDialog

Public method to get a dialog to enter repository info.

project

reference to the project object

archive

name of the project in the repository (string)

editable

flag indicating that the project name is editable (boolean)

parent

parent widget (QWidget)

Returns:

reference to the instantiated options dialog (GitOptionsDialog)

Git.vcsRegisteredState

Public method used to get the registered state of a file in the vcs.

name

filename to check (string)

Returns:

a combination of canBeCommited and canBeAdded

Git.vcsRemove

Public method used to remove a file/directory from the Git repository.

The default operation is to remove the local copy as well.

name

file/directory name to be removed (string or list of strings))

project

flag indicating deletion of a project tree (boolean) (not needed)

noDialog

flag indicating quiet operations (boolean)

stageOnly

flag indicating to just remove the file from the staging area (boolean)

Returns:

flag indicating successful operation (boolean)

Git.vcsRepositoryInfos

Public method to retrieve information about the repository.

ppath

local path to get the repository infos (string)

Returns:

string with ready formated info for display (string)

Git.vcsShutdown

Public method used to shutdown the Git interface.

Git.vcsStatus

Public method used to view the status of files/directories in the Git repository.

name

file/directory name(s) to show the status of (string or list of strings)

Git.vcsSupportCommandOptions

Public method to signal the support of user settable command options.

Returns:

flag indicating the support of user settable command options (boolean)

Git.vcsSwitch

Public method used to switch a working directory to a different revision.

name

directory name to be switched (string)

Returns:

flag indicating, that the switch contained an add or delete (boolean)

Git.vcsTag

Public method used to set/remove a tag in the Git repository.

name

file/directory name to determine the repo root from (string)

revision

revision to set tag for (string)

tagName

name of the tag (string)

Returns:

flag indicating a performed tag action (boolean)

Git.vcsUpdate

Public method used to update a file/directory with the Git repository.

name

file/directory name to be updated (string or list of strings)

noDialog

flag indicating quiet operations (boolean)

revision=

revision to update to (string)

Returns:

flag indicating, that the update contained an add or delete (boolean)