--- a/src/eric7/Plugins/PluginVcsGit.py Wed Jul 13 11:16:20 2022 +0200
+++ b/src/eric7/Plugins/PluginVcsGit.py Wed Jul 13 14:55:47 2022 +0200
@@ -33,9 +33,7 @@
className = "VcsGitPlugin"
packageName = "__core__"
shortDescription = "Implements the Git version control interface."
-longDescription = (
- """This plugin provides the Git version control interface."""
-)
+longDescription = """This plugin provides the Git version control interface."""
pyqtApi = 2
# End-Of-Header
@@ -45,41 +43,40 @@
def exeDisplayData():
"""
Public method to support the display of some executable info.
-
+
@return dictionary containing the data to query the presence of
the executable
"""
- exe = 'git'
+ exe = "git"
if Utilities.isWindowsPlatform():
- exe += '.exe'
-
+ exe += ".exe"
+
data = {
"programEntry": True,
- "header": QCoreApplication.translate(
- "VcsGitPlugin", "Version Control - Git"),
+ "header": QCoreApplication.translate("VcsGitPlugin", "Version Control - Git"),
"exe": exe,
- "versionCommand": 'version',
- "versionStartsWith": 'git',
+ "versionCommand": "version",
+ "versionStartsWith": "git",
"versionPosition": 2,
"version": "",
"versionCleanup": None,
}
-
+
return data
def getVcsSystemIndicator():
"""
Public function to get the indicators for this version control system.
-
+
@return dictionary with indicator as key and a tuple with the vcs name
(string) and vcs display string (string)
"""
global pluginTypename
data = {}
- exe = 'git'
+ exe = "git"
if Utilities.isWindowsPlatform():
- exe += '.exe'
+ exe += ".exe"
if Utilities.isinpath(exe):
data[".git"] = (pluginTypename, displayString())
data["_git"] = (pluginTypename, displayString())
@@ -89,14 +86,14 @@
def displayString():
"""
Public function to get the display string.
-
+
@return display string (string)
"""
- exe = 'git'
+ exe = "git"
if Utilities.isWindowsPlatform():
- exe += '.exe'
+ exe += ".exe"
if Utilities.isinpath(exe):
- return QCoreApplication.translate('VcsGitPlugin', 'Git')
+ return QCoreApplication.translate("VcsGitPlugin", "Git")
else:
return ""
@@ -107,33 +104,34 @@
def createConfigurationPage(configDlg):
"""
Module function to create the configuration page.
-
+
@param configDlg reference to the configuration dialog (QDialog)
@return reference to the configuration page
"""
global gitCfgPluginObject
- from VcsPlugins.vcsGit.ConfigurationPage.GitPage import (
- GitPage
- )
+ from VcsPlugins.vcsGit.ConfigurationPage.GitPage import GitPage
+
if gitCfgPluginObject is None:
gitCfgPluginObject = VcsGitPlugin(None)
page = GitPage(gitCfgPluginObject)
return page
-
+
def getConfigData():
"""
Module function returning data as required by the configuration dialog.
-
+
@return dictionary with key "zzz_gitPage" containing the relevant
data
"""
return {
- "zzz_gitPage":
- [QCoreApplication.translate("VcsGitPlugin", "Git"),
- os.path.join("VcsPlugins", "vcsGit", "icons",
- "preferences-git.svg"),
- createConfigurationPage, "vcsPage", None],
+ "zzz_gitPage": [
+ QCoreApplication.translate("VcsGitPlugin", "Git"),
+ os.path.join("VcsPlugins", "vcsGit", "icons", "preferences-git.svg"),
+ createConfigurationPage,
+ "vcsPage",
+ None,
+ ],
}
@@ -141,8 +139,7 @@
"""
Module function to prepare for an uninstallation.
"""
- if not ericApp().getObject("PluginManager").isPluginLoaded(
- "PluginVcsGit"):
+ if not ericApp().getObject("PluginManager").isPluginLoaded("PluginVcsGit"):
Preferences.getSettings().remove("Git")
@@ -152,25 +149,25 @@
"""
for key in ["RepositoryUrlHistory"]:
VcsGitPlugin.setPreferences(key, [])
-
+
class VcsGitPlugin(QObject):
"""
Class implementing the Git version control plugin.
"""
+
GitDefaults = {
- "StopLogOnCopy": True, # used in log browser
- "ShowAuthorColumns": True, # used in log browser
- "ShowCommitterColumns": True, # used in log browser
- "ShowCommitIdColumn": True, # used in log browser
- "ShowBranchesColumn": True, # used in log browser
- "ShowTagsColumn": True, # used in log browser
- "FindCopiesHarder": False, # used in log browser
+ "StopLogOnCopy": True, # used in log browser
+ "ShowAuthorColumns": True, # used in log browser
+ "ShowCommitterColumns": True, # used in log browser
+ "ShowCommitIdColumn": True, # used in log browser
+ "ShowBranchesColumn": True, # used in log browser
+ "ShowTagsColumn": True, # used in log browser
+ "FindCopiesHarder": False, # used in log browser
"LogLimit": 20,
"LogSubjectColumnWidth": 30,
"LogBrowserGeometry": QByteArray(),
- "LogBrowserSplitterStates": [QByteArray(), QByteArray(),
- QByteArray()],
+ "LogBrowserSplitterStates": [QByteArray(), QByteArray(), QByteArray()],
# mainSplitter, detailsSplitter, diffSplitter
"StatusDialogGeometry": QByteArray(),
"StatusDialogSplitterStates": [QByteArray(), QByteArray()],
@@ -181,28 +178,30 @@
"AggressiveGC": True,
"RepositoryUrlHistory": [],
}
-
+
def __init__(self, ui):
"""
Constructor
-
+
@param ui reference to the user interface object (UI.UserInterface)
"""
super().__init__(ui)
self.__ui = ui
-
+
from VcsPlugins.vcsGit.ProjectHelper import GitProjectHelper
+
self.__projectHelperObject = GitProjectHelper(None, None)
with contextlib.suppress(KeyError):
ericApp().registerPluginObject(
- pluginTypename, self.__projectHelperObject, pluginType)
-
+ pluginTypename, self.__projectHelperObject, pluginType
+ )
+
readShortcuts(pluginName=pluginTypename)
-
+
def getProjectHelper(self):
"""
Public method to get a reference to the project helper object.
-
+
@return reference to the project helper object
"""
return self.__projectHelperObject
@@ -210,68 +209,77 @@
def initToolbar(self, ui, toolbarManager):
"""
Public slot to initialize the VCS toolbar.
-
+
@param ui reference to the main window (UserInterface)
@param toolbarManager reference to a toolbar manager object
(EricToolBarManager)
"""
if self.__projectHelperObject:
self.__projectHelperObject.initToolbar(ui, toolbarManager)
-
+
def activate(self):
"""
Public method to activate this plugin.
-
+
@return tuple of reference to instantiated viewmanager and
activation status (boolean)
"""
from VcsPlugins.vcsGit.git import Git
+
self.__object = Git(self, self.__ui)
-
+
tb = self.__ui.getToolbar("vcs")[1]
tb.setVisible(False)
tb.setEnabled(False)
-
+
tb = self.__ui.getToolbar("git")[1]
tb.setVisible(Preferences.getVCS("ShowVcsToolbar"))
tb.setEnabled(True)
-
+
return self.__object, True
-
+
def deactivate(self):
"""
Public method to deactivate this plugin.
"""
self.__object = None
-
+
tb = self.__ui.getToolbar("git")[1]
tb.setVisible(False)
tb.setEnabled(False)
-
+
tb = self.__ui.getToolbar("vcs")[1]
tb.setVisible(Preferences.getVCS("ShowVcsToolbar"))
tb.setEnabled(True)
-
+
@classmethod
def getPreferences(cls, key):
"""
Class method to retrieve the various settings.
-
+
@param key the key of the value to get
@return the requested setting
"""
- if key in ["StopLogOnCopy", "ShowReflogInfo", "ShowAuthorColumns",
- "ShowCommitterColumns", "ShowCommitIdColumn",
- "ShowBranchesColumn", "ShowTagsColumn", "FindCopiesHarder",
- "AggressiveGC"]:
- return Preferences.toBool(Preferences.getSettings().value(
- "Git/" + key, cls.GitDefaults[key]))
+ if key in [
+ "StopLogOnCopy",
+ "ShowReflogInfo",
+ "ShowAuthorColumns",
+ "ShowCommitterColumns",
+ "ShowCommitIdColumn",
+ "ShowBranchesColumn",
+ "ShowTagsColumn",
+ "FindCopiesHarder",
+ "AggressiveGC",
+ ]:
+ return Preferences.toBool(
+ Preferences.getSettings().value("Git/" + key, cls.GitDefaults[key])
+ )
elif key in ["LogLimit", "CommitIdLength", "LogSubjectColumnWidth"]:
- return int(Preferences.getSettings().value(
- "Git/" + key, cls.GitDefaults[key]))
+ return int(
+ Preferences.getSettings().value("Git/" + key, cls.GitDefaults[key])
+ )
elif key in ["Commits", "RepositoryUrlHistory"]:
- return Preferences.toList(Preferences.getSettings().value(
- "Git/" + key))
+ return Preferences.toList(Preferences.getSettings().value("Git/" + key))
elif key in ["LogBrowserGeometry", "StatusDialogGeometry"]:
v = Preferences.getSettings().value("Git/" + key)
if v is not None:
@@ -285,14 +293,13 @@
else:
return cls.GitDefaults[key]
else:
- return Preferences.getSettings().value(
- "Git/" + key, cls.GitDefaults[key])
-
+ return Preferences.getSettings().value("Git/" + key, cls.GitDefaults[key])
+
@classmethod
def setPreferences(cls, key, value):
"""
Class method to store the various settings.
-
+
@param key the key of the setting to be set
@param value the value to be set
"""
@@ -301,25 +308,27 @@
def getConfigPath(self):
"""
Public method to get the filename of the config file.
-
+
@return filename of the config file (string)
"""
return getConfigPath()
-
+
def prepareUninstall(self):
"""
Public method to prepare for an uninstallation.
"""
ericApp().unregisterPluginObject(pluginTypename)
-
+
def prepareUnload(self):
"""
Public method to prepare for an unload.
"""
if self.__projectHelperObject:
self.__projectHelperObject.removeToolbar(
- self.__ui, ericApp().getObject("ToolbarManager"))
+ self.__ui, ericApp().getObject("ToolbarManager")
+ )
ericApp().unregisterPluginObject(pluginTypename)
+
#
# eflag: noqa = M801
