eric4.VCS.vcsPySvn.subversion

Module implementing the version control systems interface to Subversion.

Classes

Subversion Class implementing the version control systems interface to Subversion.

Functions

None


Subversion

Class implementing the version control systems interface to Subversion.

Derived from

VersionControl

Methods

Subversion Constructor
getClient Public method to create and initialize the pysvn client object.
vcsAdd Public method used to add a file/directory to the Subversion repository.
vcsAddBinary Public method used to add a file/directory in binary mode to the Subversion repository.
vcsAddTree Public method to add a directory tree rooted at path to the Subversion repository.
vcsAllRegisteredStates Public method used to get the registered states of a number of files in the vcs.
vcsCheckout Public method used to check the project out of the Subversion repository.
vcsCommit Public method used to make the change of a file/directory permanent in the Subversion repository.
vcsConvertProject Public method to convert an uncontrolled project to a version controlled project.
vcsDiff Public method used to view the difference of a file/directory to the Subversion repository.
vcsExists Public method used to test for the presence of the svn executable.
vcsExport Public method used to export a directory from the Subversion repository.
vcsGetProjectBrowserHelper Public method to instanciate a helper object for the different project browsers.
vcsGetProjectHelper Public method to instanciate a helper object for the project.
vcsImport Public method used to import the project into the Subversion repository.
vcsInit Public method used to initialize the subversion repository.
vcsLog Public method used to view the log of a file/directory from the Subversion repository.
vcsMerge Public method used to merge a URL/revision into the local project.
vcsRegisteredState Public method used to get the registered state of a file in the vcs.
vcsRemove Public method used to remove a file/directory from the Subversion repository.
vcsRevert Public method used to revert changes made to a file/directory.
vcsShutdown Public method used to shutdown the Subversion interface.
vcsStatus Public method used to view the status of files/directories in the Subversion repository.
vcsSwitch Public method used to switch a directory to a different tag/branch.
vcsTag Public method used to set the tag of a file/directory in the Subversion repository.
vcsUpdate Public method used to update a file/directory with the Subversion repository.

Subversion (Constructor)

Subversion(parent=None, name=None)

Constructor

parent
parent widget (QWidget)
name
name of this object (string or QString)

Subversion.getClient

getClient()

Public method to create and initialize the pysvn client object.

Returns:
the pysvn client object (pysvn.Client)

Subversion.vcsAdd

vcsAdd(name, isDir = False)

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

name
file/directory name to be added (string)
isDir
flag indicating name is a directory (boolean)

Subversion.vcsAddBinary

vcsAddBinary(name, isDir = False)

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

name
file/directory name to be added (string)
isDir
flag indicating name is a directory (boolean)

Subversion.vcsAddTree

vcsAddTree(path)

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

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

Subversion.vcsAllRegisteredStates

vcsAllRegisteredStates(names, dname, shortcut = True)

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 has 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

Subversion.vcsCheckout

vcsCheckout(vcsDataDict, projectDir, noDialog = False)

Public method used to check the project out of the Subversion repository.

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)

Subversion.vcsCommit

vcsCommit(name, message, noDialog = False, parent = None)

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

name
file/directory name to be committed (string or list of strings)
message
message for this operation (string)
noDialog
flag indicating quiet operations
parent
reference to the parent object of the commit dialog (QWidget)
Returns:
flag indicating an execution without errors (boolean)

Subversion.vcsConvertProject

vcsConvertProject(vcsDataDict, project)

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

vcsDataDict
dictionary of data required for the conversion
project
reference to the project object

Subversion.vcsDiff

vcsDiff(name)

Public method used to view the difference of a file/directory to the Subversion 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)

Subversion.vcsExists

vcsExists()

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

Returns:
flag indicating the existance (boolean)

Subversion.vcsExport

vcsExport(vcsDataDict, projectDir)

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

vcsDataDict
dictionary of data required for the checkout
projectDir
project directory to create (string)
Returns:
flag indicating an execution without errors (boolean)

Subversion.vcsGetProjectBrowserHelper

vcsGetProjectBrowserHelper(browser, project, isTranslationsBrowser = False)

Public method to instanciate 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

Subversion.vcsGetProjectHelper

vcsGetProjectHelper(project)

Public method to instanciate a helper object for the project.

project
reference to the project object
Returns:
the project helper object

Subversion.vcsImport

vcsImport(vcsDataDict, projectDir, noDialog = False)

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

vcsDataDict
dictionary of data required for the import
projectDir
project directory (string)
noDialog
flag indicating quiet operations
Returns:
flag indicating an execution without errors (boolean) and a flag indicating the version controll status (boolean)

Subversion.vcsInit

vcsInit(vcsDir, noDialog = False)

Public method used to initialize the subversion repository.

The subversion repository has to be initialized from outside eric4 because the respective command always works locally. Therefore we always return TRUE without doing anything.

vcsDir
name of the VCS directory (string)
noDialog
flag indicating quiet operations (boolean)
Returns:
always TRUE

Subversion.vcsLog

vcsLog(name)

Public method used to view the log of a file/directory from the Subversion repository.

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

Subversion.vcsMerge

vcsMerge(name)

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

name
file/directory name to be merged (string)

Subversion.vcsRegisteredState

vcsRegisteredState(name)

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

name
filename to check (string or QString)
Returns:
a combination of canBeCommited and canBeAdded

Subversion.vcsRemove

vcsRemove(name, project=0)

Public method used to remove a file/directory from the Subversion 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)
Returns:
flag indicating successfull operation (boolean)

Subversion.vcsRevert

vcsRevert(name)

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

name
file/directory name to be reverted (string)

Subversion.vcsShutdown

vcsShutdown()

Public method used to shutdown the Subversion interface.

Subversion.vcsStatus

vcsStatus(name)

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

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

Subversion.vcsSwitch

vcsSwitch(name)

Public method used to switch a directory to a different tag/branch.

name
directory name to be switched (string)

Subversion.vcsTag

vcsTag(name)

Public method used to set the tag of a file/directory in the Subversion repository.

name
file/directory name to be tagged (string)

Subversion.vcsUpdate

vcsUpdate(name)

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

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

Up