Sat, 26 Nov 2016 15:35:12 +0100
Added public methods for acces to sveral parts of the pdata structure of the Project class.
--- a/APIs/Python3/eric6.api Fri Nov 25 19:06:40 2016 +0100 +++ b/APIs/Python3/eric6.api Sat Nov 26 15:35:12 2016 +0100 @@ -6832,8 +6832,12 @@ eric6.Project.Project.Project.getModel?4() eric6.Project.Project.Project.getMostRecent?4() eric6.Project.Project.Project.getProgrammingLanguages?4() +eric6.Project.Project.Project.getProjectAuthor?4() +eric6.Project.Project.Project.getProjectAuthorEmail?4() +eric6.Project.Project.Project.getProjectDescription?4() eric6.Project.Project.Project.getProjectDictionaries?4() eric6.Project.Project.Project.getProjectFile?4() +eric6.Project.Project.Project.getProjectFiles?4(fileType, normalized=False) eric6.Project.Project.Project.getProjectLanguage?4() eric6.Project.Project.Project.getProjectManagementDir?4() eric6.Project.Project.Project.getProjectName?4() @@ -6841,6 +6845,7 @@ eric6.Project.Project.Project.getProjectSpellLanguage?4() eric6.Project.Project.Project.getProjectType?4() eric6.Project.Project.Project.getProjectTypes?4(progLanguage="") +eric6.Project.Project.Project.getProjectVersion?4() eric6.Project.Project.Project.getRelativePath?4(path) eric6.Project.Project.Project.getRelativeUniversalPath?4(path) eric6.Project.Project.Project.getSources?4(normalized=False)
--- a/Documentation/Help/source.qhp Fri Nov 25 19:06:40 2016 +0100 +++ b/Documentation/Help/source.qhp Sat Nov 26 15:35:12 2016 +0100 @@ -10898,8 +10898,12 @@ <keyword name="Project.getModel" id="Project.getModel" ref="eric6.Project.Project.html#Project.getModel" /> <keyword name="Project.getMostRecent" id="Project.getMostRecent" ref="eric6.Project.Project.html#Project.getMostRecent" /> <keyword name="Project.getProgrammingLanguages" id="Project.getProgrammingLanguages" ref="eric6.Project.Project.html#Project.getProgrammingLanguages" /> + <keyword name="Project.getProjectAuthor" id="Project.getProjectAuthor" ref="eric6.Project.Project.html#Project.getProjectAuthor" /> + <keyword name="Project.getProjectAuthorEmail" id="Project.getProjectAuthorEmail" ref="eric6.Project.Project.html#Project.getProjectAuthorEmail" /> + <keyword name="Project.getProjectDescription" id="Project.getProjectDescription" ref="eric6.Project.Project.html#Project.getProjectDescription" /> <keyword name="Project.getProjectDictionaries" id="Project.getProjectDictionaries" ref="eric6.Project.Project.html#Project.getProjectDictionaries" /> <keyword name="Project.getProjectFile" id="Project.getProjectFile" ref="eric6.Project.Project.html#Project.getProjectFile" /> + <keyword name="Project.getProjectFiles" id="Project.getProjectFiles" ref="eric6.Project.Project.html#Project.getProjectFiles" /> <keyword name="Project.getProjectLanguage" id="Project.getProjectLanguage" ref="eric6.Project.Project.html#Project.getProjectLanguage" /> <keyword name="Project.getProjectManagementDir" id="Project.getProjectManagementDir" ref="eric6.Project.Project.html#Project.getProjectManagementDir" /> <keyword name="Project.getProjectName" id="Project.getProjectName" ref="eric6.Project.Project.html#Project.getProjectName" /> @@ -10907,6 +10911,7 @@ <keyword name="Project.getProjectSpellLanguage" id="Project.getProjectSpellLanguage" ref="eric6.Project.Project.html#Project.getProjectSpellLanguage" /> <keyword name="Project.getProjectType" id="Project.getProjectType" ref="eric6.Project.Project.html#Project.getProjectType" /> <keyword name="Project.getProjectTypes" id="Project.getProjectTypes" ref="eric6.Project.Project.html#Project.getProjectTypes" /> + <keyword name="Project.getProjectVersion" id="Project.getProjectVersion" ref="eric6.Project.Project.html#Project.getProjectVersion" /> <keyword name="Project.getRelativePath" id="Project.getRelativePath" ref="eric6.Project.Project.html#Project.getRelativePath" /> <keyword name="Project.getRelativeUniversalPath" id="Project.getRelativeUniversalPath" ref="eric6.Project.Project.html#Project.getRelativeUniversalPath" /> <keyword name="Project.getSources" id="Project.getSources" ref="eric6.Project.Project.html#Project.getSources" />
--- a/Documentation/Source/eric6.Project.Project.html Fri Nov 25 19:06:40 2016 +0100 +++ b/Documentation/Source/eric6.Project.Project.html Sat Nov 26 15:35:12 2016 +0100 @@ -488,12 +488,24 @@ <td><a href="#Project.getProgrammingLanguages">getProgrammingLanguages</a></td> <td>Public method to get the programming languages supported by project.</td> </tr><tr> +<td><a href="#Project.getProjectAuthor">getProjectAuthor</a></td> +<td>Public method to get the author of the project.</td> +</tr><tr> +<td><a href="#Project.getProjectAuthorEmail">getProjectAuthorEmail</a></td> +<td>Public method to get the email address of the project author.</td> +</tr><tr> +<td><a href="#Project.getProjectDescription">getProjectDescription</a></td> +<td>Public method to get the description of the project.</td> +</tr><tr> <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td> <td>Public method to get the names of the project specific dictionaries.</td> </tr><tr> <td><a href="#Project.getProjectFile">getProjectFile</a></td> <td>Public method to get the path of the project file.</td> </tr><tr> +<td><a href="#Project.getProjectFiles">getProjectFiles</a></td> +<td>Public method to get the file entries of the given type.</td> +</tr><tr> <td><a href="#Project.getProjectLanguage">getProjectLanguage</a></td> <td>Public method to get the project's programming language.</td> </tr><tr> @@ -515,6 +527,9 @@ <td><a href="#Project.getProjectTypes">getProjectTypes</a></td> <td>Public method to get the list of supported project types.</td> </tr><tr> +<td><a href="#Project.getProjectVersion">getProjectVersion</a></td> +<td>Public mehod to get the version number of the project.</td> +</tr><tr> <td><a href="#Project.getRelativePath">getRelativePath</a></td> <td>Public method to convert a file path to a project relative file path.</td> </tr><tr> @@ -1675,6 +1690,51 @@ <dd> list of supported programming languages (list of string) </dd> +</dl><a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a> +<h4>Project.getProjectAuthor</h4> +<b>getProjectAuthor</b>(<i></i>) +<p> + Public method to get the author of the project. +</p><dl> +<dt>Returns:</dt> +<dd> +author name +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl><a NAME="Project.getProjectAuthorEmail" ID="Project.getProjectAuthorEmail"></a> +<h4>Project.getProjectAuthorEmail</h4> +<b>getProjectAuthorEmail</b>(<i></i>) +<p> + Public method to get the email address of the project author. +</p><dl> +<dt>Returns:</dt> +<dd> +project author email +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl><a NAME="Project.getProjectDescription" ID="Project.getProjectDescription"></a> +<h4>Project.getProjectDescription</h4> +<b>getProjectDescription</b>(<i></i>) +<p> + Public method to get the description of the project. +</p><dl> +<dt>Returns:</dt> +<dd> +project description +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> </dl><a NAME="Project.getProjectDictionaries" ID="Project.getProjectDictionaries"></a> <h4>Project.getProjectDictionaries</h4> <b>getProjectDictionaries</b>(<i></i>) @@ -1696,6 +1756,30 @@ <dd> path of the project file (string) </dd> +</dl><a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a> +<h4>Project.getProjectFiles</h4> +<b>getProjectFiles</b>(<i>fileType, normalized=False</i>) +<p> + Public method to get the file entries of the given type. +</p><dl> +<dt><i>fileType</i> (str)</dt> +<dd> +project file type (one of SOURCES, FORMS, RESOURCES, + INTERFACES, OTHERS, TRANSLATIONS) +</dd><dt><i>normalized</i> (boolean)</dt> +<dd> +flag indicating normalized file names are wanted +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of file names +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> </dl><a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a> <h4>Project.getProjectLanguage</h4> <b>getProjectLanguage</b>(<i></i>) @@ -1774,6 +1858,21 @@ <dd> reference to the dictionary of project types. </dd> +</dl><a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a> +<h4>Project.getProjectVersion</h4> +<b>getProjectVersion</b>(<i></i>) +<p> + Public mehod to get the version number of the project. +</p><dl> +<dt>Returns:</dt> +<dd> +version number +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> </dl><a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a> <h4>Project.getRelativePath</h4> <b>getRelativePath</b>(<i>path</i>)
--- a/Project/Project.py Fri Nov 25 19:06:40 2016 +0100 +++ b/Project/Project.py Sat Nov 26 15:35:12 2016 +0100 @@ -3081,11 +3081,29 @@ (boolean) @return list of the projects scripts (list of string) """ + return self.getProjectFiles("SOURCES", normalized=normalized) + + def getProjectFiles(self, fileType, normalized=False): + """ + Public method to get the file entries of the given type. + + @param fileType project file type (one of SOURCES, FORMS, RESOURCES, + INTERFACES, OTHERS, TRANSLATIONS) + @type str + @param normalized flag indicating normalized file names are wanted + @type boolean + @return list of file names + @rtype list of str + """ + if fileType not in ["SOURCES", "FORMS", "RESOURCES", "INTERFACES", + "OTHERS", "TRANSLATIONS"]: + raise ValueError("Given file type has incorrect value.") + if normalized: return [os.path.join(self.ppath, fn) for fn in - self.pdata["SOURCES"]] + self.pdata[fileType]] else: - return self.pdata["SOURCES"] + return self.pdata[fileType] def getProjectType(self): """ @@ -3355,6 +3373,42 @@ @return flag indicating the usage of system eol (boolean) """ return self.pdata["EOL"] == 0 + + def getProjectVersion(self): + """ + Public mehod to get the version number of the project. + + @return version number + @rtype str + """ + return self.pdate["VERSION"] + + def getProjectAuthor(self): + """ + Public method to get the author of the project. + + @return author name + @rtype str + """ + return self.pdata["AUTHOR"] + + def getProjectAuthorEmail(self): + """ + Public method to get the email address of the project author. + + @return project author email + @rtype str + """ + return self.pdata["EMAIL"] + + def getProjectDescription(self): + """ + Public method to get the description of the project. + + @return project description + @rtype str + """ + return self.pdata["DESCRIPTION"] def isProjectFile(self, fn): """