eric: comparison src/eric7/Project/Project.py

-:d7ab0653bc63
+:e12589f1d408
 from eric7.Tasks.TasksFile import TasksFile
 from eric7.UI import Config
 from eric7.UI.NotificationWidget import NotificationTypes
 from .DebuggerPropertiesFile import DebuggerPropertiesFile
+from .FileCategoryRepositoryItem import FileCategoryRepositoryItem
 from .ProjectBrowserModel import ProjectBrowserModel
 from .ProjectFile import ProjectFile
 from .UserProjectFile import UserProjectFile
 "Python3": self.tr(
 "Python3 Files (*.py *.py3);;" "Python3 GUI Files (*.pyw *.pyw3);;"
 ),
 }
+self.__fileCategoriesRepository = {}
+# This dictionary will be populated by the various project browsers with
+# classes of type 'FileCategoryRepositoryItem' using the 'addFileCategory()
+# and removeFileCategory() methods.
 self.vcsMenu = None
 self.__makeProcess = None
 self.__initProjectTypes()
 self.applicationDiagram = None
 self.loadedDiagram = None
 self.__findProjectFileDialog = None
 self.processChangedProjectFiles.connect(self.__autoExecuteMake)
+def addFileCategory(self, category, categoryItem):
+"""
+Public method to add a file category to the categories repository.
+Note: The given category must not be contained in the repository already.
+@param category file category (must be unique)
+@type str
+@param categoryItem data class instance containing the category data
+@type FileCategoryRepositoryItem
+@exception TypeError raised to signal a wrong type for the category item
+"""
+if not isinstance(categoryItem, FileCategoryRepositoryItem):
+raise TypeError(
+"'categoryItem' must be an instance of 'FileCategoryRepositoryItem'."
+)
+if category in self.__fileCategoriesRepository:
+EricMessageBox.critical(
+self.ui,
+self.tr("Add File Category"),
+self.tr(
+"<p>The file category <b>{0}</b> has already been added. This"
+" attempt will be ignored.</p>"
+),
+)
+else:
+self.__fileCategoriesRepository[category] = categoryItem
+with contextlib.suppress(AttributeError):
+self.__pdata[category] = []
+def removeFileCategory(self, category):
+"""
+Public method to remove a category from the categories repository.
+Note: If the category is not contained in the repository, the request to
+remove it will be ignored silently.
+@param category file category
+@type str
+"""
+with contextlib.suppress(KeyError):
+del self.__fileCategoriesRepository[category]
 def __sourceExtensions(self, language):
 """
 Private method to get the source extensions of a programming language.
 }
 self.__pdata = {
 "DESCRIPTION": "",
 "VERSION": "",
-"SOURCES": [],
-"FORMS": [],
-"RESOURCES": [],
-"INTERFACES": [],
-"PROTOCOLS": [],
-"OTHERS": [],
-"TRANSLATIONS": [],
 "TRANSLATIONEXCEPTIONS": [],
 "TRANSLATIONPATTERN": "",
 "TRANSLATIONSBINPATH": "",
 "TRANSLATIONSOURCESTARTPATH": "",
 "MAINSCRIPT": "",
 "DOCSTRING": "",
 "TESTING_FRAMEWORK": "",
 "LICENSE": "",
 "EMBEDDED_VENV": False,
 }
-# TODO: Move these to a file categories repository populated through the
+for category in self.__fileCategoriesRepository:
-#       project browsers
+self.__pdata[category] = []
-self.__knownFileCategories = [
-"FORMS",
-"OTHERS",
-"RESOURCES",
-"SOURCES",
-"TRANSLATIONS",
-"INTERFACES",
-"PROTOCOLS",
-]
-self.__fileCategoryFilterTemplates = {
-"FORMS": self.tr("Form Files ({0})"),
-"OTHERS": self.tr("Other Files ({0})"),
-"RESOURCES": self.tr("Resource Files ({0})"),
-"SOURCES": self.tr("Source Files ({0})"),
-"TRANSLATIONS": self.tr("Translation Files ({0})"),
-"INTERFACES": self.tr("Interface Files ({0})"),
-"PROTOCOLS": self.tr("Protocol Files ({0})"),
-}
-self.__fileCategoryUserStrings = {
-"FORMS": self.tr("Form Files"),
-"OTHERS": self.tr("Other Files"),
-"RESOURCES": self.tr("Resource Files"),
-"SOURCES": self.tr("Source Files"),
-"TRANSLATIONS": self.tr("Translation Files"),
-"INTERFACES": self.tr("Interface Files"),
-"PROTOCOLS": self.tr("Protocol Files"),
-}
-self.__fileCategoryTyeStrings = {
-"FORMS": self.tr("Forms"),
-"OTHERS": self.tr("Others"),
-"RESOURCES": self.tr("Resources"),
-"SOURCES": self.tr("Sources"),
-"TRANSLATIONS": self.tr("Translations"),
-"INTERFACES": self.tr("Interfaces"),
-"PROTOCOLS": self.tr("Protocols"),
-}
-self.__fileCategoryExtensions = {
-"FORMS": ["*.ui"],
-"OTHERS": [],
-"RESOURCES": ["*.qrc"],
-"SOURCES": ["*.py", "*.pyw"],  # Python files as default
-"TRANSLATIONS": ["*.ts", "*.qm"],
-"INTERFACES": ["*.idl"],
-"PROTOCOLS": ["*.proto"],
-}
-# until here
 self.__initDebugProperties()
 self.pudata = {
 "VCSOVERRIDE": "",
 Public method to get the list of known file categories.
 @return list of known file categories
 @rtype list of str
 """
-return self.__knownFileCategories[:]
+return list(self.__fileCategoriesRepository.keys())
 def getFileCategoryFilterString(
 self, categories=None, withOthers=False, withAll=True
 ):
 """
 @type bool (optional)
 @return file selection filter string
 @rtype str
 """
 if categories is None:
-categories = [c for c in self.__knownFileCategories if c != "OTHERS"]
+categories = [c for c in self.__fileCategoriesRepository if c != "OTHERS"]
 if withOthers:
 categories.append("OTHERS")
 patterns = collections.defaultdict(list)
 for pattern, filetype in self.__pdata["FILETYPES"].items():
-if filetype in categories and filetype in self.__knownFileCategories:
+if filetype in categories and filetype in self.__fileCategoriesRepository:
 patterns[filetype].append(pattern)
 filters = []
 for filetype in patterns:
 filters.append(
-self.__fileCategoryFilterTemplates[filetype].format(
+self.__fileCategoriesRepository[
+filetype
+].fileCategoryFilterTemplate.format(
 " ".join(sorted(patterns[filetype]))
 )
 )
 filterString = ";;".join(sorted(filters))
 if withAll:
 @param category file type category
 @type str
 @return user string for the category
 @rtype str
 """
-return self.__fileCategoryUserStrings[category]
+return self.__fileCategoriesRepository[category].fileCategoryUserString
 def getFileCategoryType(self, category):
 """
 Public method to get a user type string for the given category.
 @param category file type category
 @type str
 @return user type string for the category
 @rtype str
 """
-return self.__fileCategoryTyeStrings[category]
+return self.__fileCategoriesRepository[category].fileCategoryTyeString
 def getFileCategoryExtension(self, category, reverse=False):
 """
 Public method to get a list of default file extensions for the given category.
 @return list of default file extensions for the category
 @rtype list of str
 """
 if reverse:
 extensions = []
-for cat, ext in self.__fileCategoryExtensions.items():
+for cat, item in self.__fileCategoriesRepository.items():
 if cat != category:
-extensions += ext
+extensions += item.fileCategoryExtensions[:]
 return extensions
 else:
-return self.__fileCategoryExtensions[category][:]
+return self.__fileCategoriesRepository[category].fileCategoryExtensions[:]
 def initFileTypes(self):
 """
 Public method to initialize the filetype associations with default
 values.
 self.name = os.path.splitext(os.path.basename(fn))[0]
 # check, if the files of the project still exist in the
 # project directory
-for fileCategory in self.__knownFileCategories:
+for fileCategory in self.getFileCategories():
 self.__checkFilesExist(fileCategory)
 # get the names of subdirectories the files are stored in
-for fileCategory in [
+for fileCategory in [c for c in self.getFileCategories() if c != "OTHERS"]:
-c for c in self.__knownFileCategories if c != "OTHERS"
-]:
 for fn in self.__pdata[fileCategory]:
 dn = os.path.dirname(fn)
 if dn not in self.subdirs:
 self.subdirs.append(dn)
 """Reason: {1}</p>"""
 ).format(oldfn, str(msg)),
 )
 return False
-if any(fn in self.__pdata[category] for category in self.__knownFileCategories):
+if any(fn in self.__pdata[category] for category in self.getFileCategories()):
 self.renameFileInPdata(oldfn, newfn, isSourceFile)
 return True
 def renameFileInPdata(self, oldname, newname, isSourceFile=False):
 @return list of files starting with a common prefix (list of strings)
 """
 filelist = []
 start = self.getRelativePath(start)
 for fileCategory in [
-c for c in self.__knownFileCategories if c != "TRANSLATIONS"
+c for c in self.getFileCategories() if c != "TRANSLATIONS"
 ]:
 for entry in self.__pdata[fileCategory][:]:
 if entry.startswith(start):
 filelist.append(os.path.join(self.ppath, entry))
 return filelist
 """
 reorganized = False
 # init data store for the reorganization
 newPdata = {}
-for fileCategory in self.__knownFileCategories:
+for fileCategory in self.getFileCategories():
 newPdata[fileCategory] = []
 # iterate over all files checking for a reassignment
-for fileCategory in self.__knownFileCategories:
+for fileCategory in self.getFileCategories():
 for fn in self.__pdata[fileCategory][:]:
 filetype = fileCategory
 bfn = os.path.basename(fn)
 for pattern in sorted(self.__pdata["FILETYPES"].keys(), reverse=True):
 if fnmatch.fnmatch(bfn, pattern):
 ##"PROTOCOLS",
 ##"RESOURCES",
 ##"OTHERS",
 ##"TRANSLATIONS",
 ##]:
-for fileCategory in self.__knownFileCategories:
+for fileCategory in self.getFileCategories():
 self.__pdata[fileCategory] = newPdata[fileCategory][:]
 # repopulate the model
 self.__model.projectClosed(False)
 self.__model.projectOpened()
 ##"PROTOCOLS",
 ##"RESOURCES",
 ##"OTHERS",
 ##]:
 for fileCategory in [
-c for c in self.__knownFileCategories if c != "TRANSLATIONS"
+c for c in self.getFileCategories() if c != "TRANSLATIONS"
 ]:
 for entry in self.__pdata[fileCategory][:]:
 if entry.startswith(olddn):
 entry = entry.replace(olddn, newdn)
 self.appendFile(
 ##"PROTOCOLS",
 ##"RESOURCES",
 ##"OTHERS",
 ##]:
 for fileCategory in [
-c for c in self.__knownFileCategories if c != "TRANSLATIONS"
+c for c in self.getFileCategories() if c != "TRANSLATIONS"
 ]:
 for entry in self.__pdata[fileCategory][:]:
 if entry.startswith(olddn):
 if fileCategory not in typeStrings:
 typeStrings.append(fileCategory)
 for entry in self.__pdata["OTHERS"][:]:
 if entry.startswith(dn):
 self.__pdata["OTHERS"].remove(entry)
 dirty = True
 dn2 = dn if dn.endswith(os.sep) else dn + os.sep
-for fileCategory in [c for c in self.__knownFileCategories if c != "OTHERS"]:
+for fileCategory in [c for c in self.getFileCategories() if c != "OTHERS"]:
 for entry in self.__pdata[fileCategory][:]:
 if entry.startswith(dn2):
 self.__pdata[fileCategory].remove(entry)
 dirty = True
 self.__model.removeItem(dn)
 @return flag indicating, if the project contains the file (boolean)
 """
 fn = self.getRelativePath(fn)
 return any(
 fn in self.__pdata[category]
-for category in self.__knownFileCategories
+for category in self.getFileCategories()
 if category != "TRANSLATIONS"
 )
 def createNewProject(self):
 """
 @type boolean
 @return list of file names
 @rtype list of str
 @exception ValueError raised when an unsupported file type is given
 """
-if fileType not in self.__knownFileCategories:
+if fileType not in self.getFileCategories():
 raise ValueError("Given file type has incorrect value.")
 if normalized:
 return [os.path.join(self.ppath, fn) for fn in self.__pdata[fileType]]
 else:
 @rtype bool
 """
 newfn = os.path.abspath(fn)
 newfn = self.getRelativePath(newfn)
 return any(
-newfn in self.__pdata[category]
+newfn in self.__pdata[category] for category in self.getFileCategories()
-for category in self.__knownFileCategories
 )
 def isProjectFile(self, fn):
 """
 Public method used to check, if the passed in filename belongs to the
 @param fn filename to be checked (string)
 @return flag indicating membership (boolean)
 """
 return any(
 self.__checkProjectFileGroup(fn, category)
-for category in self.__knownFileCategories
+for category in self.getFileCategories()
 )
 def __checkProjectFileGroup(self, fn, group):
 """
 Private method to check, if a file is in a specific file group of the
 if fnmatch.fnmatch(bfn, pattern):
 filetype = self.__pdata["FILETYPES"][pattern]
 break
 if (
-filetype in self.__knownFileCategories
+filetype in self.getFileCategories()
 and fn not in self.__pdata[filetype]
 and (
 filetype != "TRANSLATIONS"
 or (
 filetype == "TRANSLATIONS"
 if not res:
 return  # don't overwrite
 # build the list of entries
 lst_ = []
-for key in self.__knownFileCategories:
+for key in self.getFileCategories():
 lst_.extend(self.__pdata[key])
 lst = []
 for entry in lst_:
 if os.path.isdir(self.getAbsolutePath(entry)):
 lst.extend(

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Project/Project.py

src/eric7/Project/Project.py