Table of Contents

Class: Project eric3/Project/Project.py

Module implementing the project management functionality.

Signals

dirty(int)
emitted when the dirty state changes
projectSessionLoaded()
emitted after a project session file was loaded
projectLanguageAdded(string)
emitted after a new language was added
projectFormAdded(string)
emitted after a new form was added
projectSourceAdded(string)
emitted after a new source file was added
projectInterfaceAdded(string)
emitted after a new IDL file was added
newProject()
emitted after a new project was generated
pythonFile(string)
emitted after a project file was read to open the main script
projectOpened()
emitted after a project file was read
projectClosed()
emitted after a project was closed
projectOthersAdded(string)
emitted after a file or directory was added to the OTHERS project data area
Base Classes   
QObject
Methods   
__init__
_write
addDirectory
addFile
addIdlDir
addIdlFile
addLanguage
addPyDir
addPyFile
addRecursiveDirectory
addSingleDirectory
addUiDir
addUiFile
appendFile
checkDirty
checkFilesExist
closeProject
deleteFile
deleteLanguage
getActions
getMainScript
getSources
handleClearRecent
handleCodeCoverage
handleCodeMetrics
handleOpenRecent
handleProfileData
handleSearchNewFiles
handleShowRecentMenu
handleShowShowMenu
handleShowVCSMenu
handleSyntaxCheck
handleTabnanny
init
initActions
initMenu
initToolbar
initVCS
initVCSActions
isDirty
isOpen
isProjectSource
newProject
openProject
ossepToToken
othersAdded
readOldProject
readOldSession
readProject
readSession
readXMLProject
readXMLSession
removeFile
removeLanguage
saveAllScripts
saveProject
saveProjectAs
searchNewFiles
setDbgInfo
setDirty
showProperties
spaceToToken
svnBranchList
svnClearAuth
svnPropDel
svnPropList
svnPropSet
svnResolve
svnTagList
tokenToOssep
tokenToSpace
vcsCheckout
vcsCleanup
vcsCommand
vcsCommandOptions
vcsCommit
vcsDiff
vcsExport
vcsImport
vcsLog
vcsLogin
vcsLogout
vcsMerge
vcsRemove
vcsRevert
vcsStatus
vcsSwitch
vcsTag
vcsUpdate
writeOldProject
writeOldSession
writeProject
writeSession
writeXMLProject
writeXMLSession
  __init__ 
__init__ (
        self,
        parent=None,
        filename=None,
        )

Constructor

Arguments

parent
parent widget (usually the ui object) (QWidget)
filename
optional filename of a project file to open (string)
  _write 
_write (
        self,
        s,
        newline=1,
        )

Private method used to do the real write operation.

Arguments

s
string to be written to the XML file
newline
flag indicating a linebreak
  addDirectory 
addDirectory ( self,  filter )

Private method used to add all files of a directory to the project.

Arguments

filter
filter to be applied (string)
  addFile 
addFile ( self,  filter=None )

Public slot used to add a file to the project.

Arguments

filter
filter to be used by the add file dialog (string)
  addIdlDir 
addIdlDir ( self )

Public slot to add all IDL interfaces of a directory to the current project.

  addIdlFile 
addIdlFile ( self )

Public slot to add an IDL interface to the current project.

  addLanguage 
addLanguage ( self )

Public slot used to add a language to the project.

  addPyDir 
addPyDir ( self )

Public slot to add all python files of a directory to the current project.

  addPyFile 
addPyFile ( self )

Public slot to add a python file to the current project.

  addRecursiveDirectory 
addRecursiveDirectory (
        self,
        filter,
        source,
        target,
        )

Private method used to add all files of a directory tree.

The tree is rooted at source to another one rooted at target. This method decents down to the lowest subdirectory.

Arguments

filter
filter to be applied (string)
source
source directory (string)
target
target directory (string)
  addSingleDirectory 
addSingleDirectory (
        self,
        filter,
        source,
        target,
        quiet=0,
        )

Private method used to add all files of a single directory to the project.

Arguments

filter
filter to be applied (string)
source
source directory (string)
target
target directory (string)
quiet
flag indicating quiet operations (boolean)
  addUiDir 
addUiDir ( self )

Public slot to add all forms of a directory to the current project.

  addUiFile 
addUiFile ( self )

Public slot to add a form to the current project.

  appendFile 
appendFile ( self,  fn )

Public method to append a file to the project.

Arguments

fn
filename to be added to the project (string or QString)
  checkDirty 
checkDirty ( self )

Private method to check dirty status and open a message window.

Returns

flag indicating whether this operation was successful

  checkFilesExist 
checkFilesExist ( self,  index )

Private method to check, if the files in a list exist.

The files in the indicated list are checked for existance in the filesystem. Non existant files are removed from the list and the dirty state of the project is changed accordingly.

Arguments

index
key of the list to be checked (string)
  closeProject 
closeProject ( self )

Public slot to close the current project.

  deleteFile 
deleteFile ( self,  fn )

Public slot to delete a file from the project directory.

Arguments

fn
filename to be deleted from the project

Returns

flag indicating success

  deleteLanguage 
deleteLanguage ( self,  lang )

Public slot to delete a translation from the project directory.

Arguments

lang
the language to be removed (string)

Returns

flag indicating success

  getActions 
getActions ( self )

Public method to get a list of all actions.

Returns

list of all actions (list of QAction)

  getMainScript 
getMainScript ( self,  normalized=0 )

Public method to return the main script filename.

Arguments

normalized
flag indicating a normalized filename is wanted

Returns

filename of the projects main script (string)

  getSources 
getSources ( self,  normalized=0 )

Public method to return the source script files.

Arguments

normalized
flag indicating a normalized filename is wanted

Returns

list of the projects scripts (list of string)

  handleClearRecent 
handleClearRecent ( self )

Private method to clear the recent projects menu.

  handleCodeCoverage 
handleCodeCoverage ( self )

Private slot used to show the code coverage information for the project files.

  handleCodeMetrics 
handleCodeMetrics ( self )

Private slot used to calculate some code metrics for the project files.

  handleOpenRecent 
handleOpenRecent ( self,  idx )

Private method to open a project from the list of rencently opened projects.

  handleProfileData 
handleProfileData ( self )

Private slot used to show the profiling information for the project.

  handleSearchNewFiles 
handleSearchNewFiles ( self )

Private slot used to handle the search new files action.

  handleShowRecentMenu 
handleShowRecentMenu ( self )

Private method to set up the recent projects menu.

  handleShowShowMenu 
handleShowShowMenu ( self )

Private slot called before the show menu is shown.

  handleShowVCSMenu 
handleShowVCSMenu ( self )

Private slot called before the vcs menu is shown.

  handleSyntaxCheck 
handleSyntaxCheck ( self )

Private slot used to check the project files for bad indentations.

  handleTabnanny 
handleTabnanny ( self )

Private slot used to check the project files for bad indentations.

  init 
init ( self )

Private method to initialize the project data part.

  initActions 
initActions ( self )

Public slot to initialize the project related actions.

  initMenu 
initMenu ( self )

Public slot to initialize the project menu.

Returns

the menu generated (QPopupMenu)

  initToolbar 
initToolbar ( self )

Public slot to initialize the project toolbar.

Returns

the toolbar generated (QToolBar)

  initVCS 
initVCS ( self,  vcsSystem=None )

Private method used to instantiate a vcs system.

Arguments

vcsSystem
type of VCS to be used

Returns

a reference to the vcs object

  initVCSActions 
initVCSActions ( self )

Private method to initialize the VCS actions.

  isDirty 
isDirty ( self )

Public method to return the dirty state.

Returns

dirty state (boolean)

  isOpen 
isOpen ( self )

Public method to return the opened state.

Returns

open state (boolean)

  isProjectSource 
isProjectSource ( self,  fn )

Public method used to check, if the passed in filename belongs to the project.

Arguments

fn
filename to be checked (string or QString)

Returns

flag indicating membership (boolean)

  newProject 
newProject ( self )

Public slot to built a new project.

This method displays the new project dialog and initializes the project object with the data entered. If version control support was selected, the relevant structures are initialzed as well.

  openProject 
openProject ( self,  fn=None )

Public slot to open a project.

Arguments

fn
optional filename of the project file to be read
  ossepToToken 
ossepToToken ( self,  filelist )

Private method to ensure OS independance of the project file.

This method converts the pathname separator (os.sep) to a platform neutral token (%os.sep%).

Arguments

filelist
list of filenames to convert (list of strings)

Returns

the converted filelist

  othersAdded 
othersAdded ( self,  fn )

Public slot to be called, if something was added to the OTHERS project data area.

Arguments

fn
filename or directory name added (string or QString)
  readOldProject 
readOldProject ( self,  fn )

Public method to read in a project (.e3p) file.

Arguments

fn
filename of the project file to be read (string or QString)

Returns

flag indicating success

  readOldSession 
readOldSession (
        self,
        fn,
        quiet=0,
        )

Private method to read in the project session file (.e3s)

The data read is: - all open source filenames (fn:) - the active window (aw:) - all breakpoints (bp:) - the commandline (cl:) - the working directory (wd:) - the exception reporting flag (er:) - the list of exception types to be highlighted (ex:) - all bookmarks (bm:)

Arguments

fn
filename of the project file to be read (string or QString)
quiet
flag indicating quiet operations. If this flag is true, no errors are reported.
  readProject 
readProject ( self,  fn )

Public method to read in a project (.e3p) file.

Arguments

fn
filename of the project file to be read (string or QString)

Returns

flag indicating success

  readSession 
readSession ( self,  quiet=0 )

Private method to read in the project session file (.e3s)

Arguments

quiet
flag indicating quiet operations. If this flag is true, no errors are reported.
  readXMLProject 
readXMLProject ( self,  fn )

Public method to read the project data from an XML file.

Arguments

fn
filename of the project file to be read (string or QString)

Returns

flag indicating success

  readXMLSession 
readXMLSession (
        self,
        fn,
        quiet=0,
        )

Public method to read the project data from an XML file.

The data read is: - all open source filenames - the active window - all breakpoints - the commandline - the working directory - the exception reporting flag - the list of exception types to be highlighted - all bookmarks

Arguments

fn
filename of the project file to be read (string or QString)
quiet
flag indicating quiet operations. If this flag is true, no errors are reported.
  removeFile 
removeFile ( self,  fn )

Public slot to remove a file from the project.

The file is not deleted from the project directory.

Arguments

fn
filename to be removed from the project
  removeLanguage 
removeLanguage ( self,  lang )

Public slot to remove a translation from the project.

The translation file is not deleted from the project directory.

Arguments

lang
the language to be removed (string)
  saveAllScripts 
saveAllScripts ( self )

Public method to save all scripts belonging to the project.

Returns

flag indicating success

  saveProject 
saveProject ( self )

Public slot to save the current project.

Returns

flag indicating success

  saveProjectAs 
saveProjectAs ( self )

Public slot to save the current project to a different file.

Returns

flag indicating success

  searchNewFiles 
searchNewFiles (
        self,
        AI=1,
        onUserDemand=0,
        )

Private method to search for new files in the project directory.

If new files were found it shows a dialog listing these files and gives the user the oportunity to select the ones he wants to include. If Automatic Inclusion is enabled, the new files are automatically added to the project.

Arguments

AI
flag indicating whether the automatic inclusion should be honoured
onUserDemand
flag indicating whether this method was requested by the user via a menu action
  setDbgInfo 
setDbgInfo (
        self,
        argv,
        wd,
        excReporting,
        excList,
        )

Public method to set the debugging information.

Arguments

argv
command line arguments to be used (string or QString)
wd
working directory (string or QString)
excReporting
flag indicating the highlighting of exceptions
excList
list of exceptions to be highlighted (list of string)
  setDirty 
setDirty ( self,  b )

Private method to set the dirty state.

It emits the signal dirty(int).

Arguments

b
dirty state (boolean)
  showProperties 
showProperties ( self )

Public slot to display the properties dialog.

  spaceToToken 
spaceToToken ( self,  filelist )

Private method to ensure OS independance of the project file.

This method converts a space to a token (%20).

Arguments

filelist
list of filenames to convert (list of strings)

Returns

the converted filelist

  svnBranchList 
svnBranchList ( self )

Private slot used to list the branches of the project.

  svnClearAuth 
svnClearAuth ( self )

Private slot used to clear the stored authentication info.

  svnPropDel 
svnPropDel ( self )

Private slot used to delete a property for the project files.

  svnPropList 
svnPropList ( self )

Private slot used to list the properties of the project files.

  svnPropSet 
svnPropSet ( self )

Private slot used to set a property for the project files.

  svnResolve 
svnResolve ( self )

Private slot used to resolve conflicts of the local project.

  svnTagList 
svnTagList ( self )

Private slot used to list the tags of the project.

  tokenToOssep 
tokenToOssep ( self,  filelist )

Private method to ensure OS independance of the project file.

This method converts the platform neutral separator token (%os.sep%) to the pathname separator (os.sep).

Arguments

filelist
list of filenames to convert (list of strings)

Returns

the converted filelist

  tokenToSpace 
tokenToSpace ( self,  filelist )

Private method to ensure OS independance of the project file.

This method converts the space token (%20) to a space.

Arguments

filelist
list of filenames to convert (list of strings)

Returns

the converted filelist

  vcsCheckout 
vcsCheckout ( self,  export=0 )

Private slot used to create a local project from the repository.

Arguments

export
flag indicating whether an export or a checkout should be performed
  vcsCleanup 
vcsCleanup ( self )

Private slot used to cleanup the local project.

  vcsCommand 
vcsCommand ( self )

Private slot used to execute an arbitrary vcs command.

  vcsCommandOptions 
vcsCommandOptions ( self )

Private slot to edit the VCS command options.

  vcsCommit 
vcsCommit ( self )

Private slot used to commit changes to the local project to the repository.

  vcsDiff 
vcsDiff ( self )

Private slot used to show the difference of the local project to the repository.

  vcsExport 
vcsExport ( self )

Private slot used to export a project from the repository.

  vcsImport 
vcsImport ( self )

Private slot used to import the local project into the repository.

NOTE: This does not make the local project a vcs controlled project. You have to checkout the project from the repository in order to accomplish that.

  vcsLog 
vcsLog ( self )

Private slot used to show the log of the local project.

  vcsLogin 
vcsLogin ( self )

Private slot used to login to a remote repository.

  vcsLogout 
vcsLogout ( self )

Private slot used to logout from a remote repository.

  vcsMerge 
vcsMerge ( self )

Private slot used to merge changes of a tag/revision into the local project.

  vcsRemove 
vcsRemove ( self )

Private slot used to remove the local project from the repository.

Depending on the parameters set in the vcs object the project may be removed from the local disk as well.

  vcsRevert 
vcsRevert ( self )

Private slot used to revert changes made to the local project.

  vcsStatus 
vcsStatus ( self )

Private slot used to show the status of the local project.

  vcsSwitch 
vcsSwitch ( self )

Private slot used to switch the local project to another tag/branch.

  vcsTag 
vcsTag ( self )

Private slot used to tag the local project in the repository.

  vcsUpdate 
vcsUpdate ( self )

Private slot used to update the local project from the repository.

  writeOldProject 
writeOldProject ( self,  fn )

Public method to save the project infos to a project file.

Arguments

fn
optional filename of the project file to be written. If fn is None, the filename stored in the project object is used. This is the save action. If fn is given, this filename is used instead of the one in the project object. This is the save as action.

Returns

flag indicating success

  writeOldSession 
writeOldSession ( self,  quiet=0 )

Private method to write the session data to a file (.e3s).

The data saved is: - all open source filenames belonging to the project (fn:) - the active window, if it belongs to the project (aw:) - all breakpoints (bp:) - the commandline (cl:) - the working directory (wd:) - the exception reporting flag (er:) - the list of exception types to be highlighted (ex:) - the bookmarks of files belonging to the project (bm:)

Arguments

quiet
flag indicating quiet operations. If this flag is true, no errors are reported.
  writeProject 
writeProject ( self,  fn=None )

Public method to save the project infos to a project file.

Arguments

fn
optional filename of the project file to be written. If fn is None, the filename stored in the project object is used. This is the save action. If fn is given, this filename is used instead of the one in the project object. This is the save as action.

Returns

flag indicating success

  writeSession 
writeSession ( self,  quiet=0 )

Private method to write the session data to a file (.e3s).

Arguments

quiet
flag indicating quiet operations. If this flag is true, no errors are reported.
  writeXMLProject 
writeXMLProject ( self,  fn=None )

Public method to write the project data to an XML file.

  writeXMLSession 
writeXMLSession ( self,  quiet=0 )

Public method to write the session data to an XML file (.e3s).

The data saved is: - all open source filenames belonging to the project - the active window, if it belongs to the project - all breakpoints - the commandline - the working directory - the exception reporting flag - the list of exception types to be highlighted - the bookmarks of files belonging to the project

Arguments

quiet
flag indicating quiet operations. If this flag is true, no errors are reported.

Table of Contents

This document was automatically generated by HappyDoc version 2.1