Mercurial Repositories > eric / changeset
changeset
Corrected some code style issues and regenerated the source docu.
Sun, 16 Aug 2015 15:34:40 +0200
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Sun, 16 Aug 2015 15:34:40 +0200
- changeset 4370
- 54dbb658f9e6
- parent 4369
- 4ef6ecc62a9d
- child 4371
- e09838aa0a9f
Corrected some code style issues and regenerated the source docu.
--- a/DebugClients/Python/DebugClientBase.py Sun Aug 16 15:02:46 2015 +0200 +++ b/DebugClients/Python/DebugClientBase.py Sun Aug 16 15:34:40 2015 +0200 @@ -1184,7 +1184,7 @@ @param signalNumber number of the signal to be handled @type int - @param stack frame current stack frame + @param stackFrame current stack frame @type frame object """ if signalNumber == signal.SIGABRT:
--- a/DebugClients/Python3/DebugClientBase.py Sun Aug 16 15:02:46 2015 +0200 +++ b/DebugClients/Python3/DebugClientBase.py Sun Aug 16 15:34:40 2015 +0200 @@ -1195,7 +1195,7 @@ @param signalNumber number of the signal to be handled @type int - @param stack frame current stack frame + @param stackFrame current stack frame @type frame object """ if signalNumber == signal.SIGABRT:
--- a/Debugger/DebugUI.py Sun Aug 16 15:02:46 2015 +0200 +++ b/Debugger/DebugUI.py Sun Aug 16 15:34:40 2015 +0200 @@ -1211,10 +1211,10 @@ QApplication.processEvents() self.viewmanager.setFileLine(filename, lineNo, True) E5MessageBox.critical( - self.ui, Program, + self.ui, Program, self.tr("""<p>The program generate the signal "{0}".<br/>""" """File: <b>{1}</b>, Line: <b>{2}</b></p>""").format( - message, filename, lineNo)) + message, filename, lineNo)) def __clientGone(self, unplanned): """
--- a/Documentation/Help/source.qhp Sun Aug 16 15:02:46 2015 +0200 +++ b/Documentation/Help/source.qhp Sun Aug 16 15:34:40 2015 +0200 @@ -5093,9 +5093,9 @@ <keyword name="FirefoxImporter.open" id="FirefoxImporter.open" ref="eric6.Helpviewer.Bookmarks.BookmarksImporters.FirefoxImporter.html#FirefoxImporter.open" /> <keyword name="FirefoxImporter.setPath" id="FirefoxImporter.setPath" ref="eric6.Helpviewer.Bookmarks.BookmarksImporters.FirefoxImporter.html#FirefoxImporter.setPath" /> <keyword name="FlashCookie" id="FlashCookie" ref="eric6.Helpviewer.FlashCookieManager.FlashCookie.html#FlashCookie" /> + <keyword name="FlashCookie (Constructor)" id="FlashCookie (Constructor)" ref="eric6.Helpviewer.FlashCookieManager.FlashCookie.html#FlashCookie.__init__" /> <keyword name="FlashCookie (Module)" id="FlashCookie (Module)" ref="eric6.Helpviewer.FlashCookieManager.FlashCookie.html" /> <keyword name="FlashCookie.__eq__" id="FlashCookie.__eq__" ref="eric6.Helpviewer.FlashCookieManager.FlashCookie.html#FlashCookie.__eq__" /> - <keyword name="FlashCookie.__init" id="FlashCookie.__init" ref="eric6.Helpviewer.FlashCookieManager.FlashCookie.html#FlashCookie.__init" /> <keyword name="FlashCookieManager" id="FlashCookieManager" ref="eric6.Helpviewer.FlashCookieManager.FlashCookieManager.html#FlashCookieManager" /> <keyword name="FlashCookieManager (Constructor)" id="FlashCookieManager (Constructor)" ref="eric6.Helpviewer.FlashCookieManager.FlashCookieManager.html#FlashCookieManager.__init__" /> <keyword name="FlashCookieManager (Module)" id="FlashCookieManager (Module)" ref="eric6.Helpviewer.FlashCookieManager.FlashCookieManager.html" />
--- a/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html Sun Aug 16 15:02:46 2015 +0200 +++ b/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html Sun Aug 16 15:34:40 2015 +0200 @@ -431,9 +431,9 @@ <dt><i>signalNumber</i> (int)</dt> <dd> number of the signal to be handled -</dd><dt><i>stack</i> (frame object)</dt> +</dd><dt><i>stackFrame</i> (frame object)</dt> <dd> -frame current stack frame +current stack frame </dd> </dl><a NAME="DebugClientBase.__unhandled_exception" ID="DebugClientBase.__unhandled_exception"></a> <h4>DebugClientBase.__unhandled_exception</h4>
--- a/Documentation/Source/eric6.DebugClients.Python3.DebugClientBase.html Sun Aug 16 15:02:46 2015 +0200 +++ b/Documentation/Source/eric6.DebugClients.Python3.DebugClientBase.html Sun Aug 16 15:34:40 2015 +0200 @@ -446,9 +446,9 @@ <dt><i>signalNumber</i> (int)</dt> <dd> number of the signal to be handled -</dd><dt><i>stack</i> (frame object)</dt> +</dd><dt><i>stackFrame</i> (frame object)</dt> <dd> -frame current stack frame +current stack frame </dd> </dl><a NAME="DebugClientBase.__unhandled_exception" ID="DebugClientBase.__unhandled_exception"></a> <h4>DebugClientBase.__unhandled_exception</h4>
--- a/Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookie.html Sun Aug 16 15:02:46 2015 +0200 +++ b/Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookie.html Sun Aug 16 15:34:40 2015 +0200 @@ -57,18 +57,23 @@ <h3>Methods</h3> <table> <tr> +<td><a href="#FlashCookie.__init__">FlashCookie</a></td> +<td>Constructor</td> +</tr><tr> <td><a href="#FlashCookie.__eq__">__eq__</a></td> <td>Special method to compare to another Flash cookie.</td> -</tr><tr> -<td><a href="#FlashCookie.__init">__init</a></td> -<td>Constructor</td> </tr> </table> <h3>Static Methods</h3> <table> <tr><td>None</td></tr> </table> -<a NAME="FlashCookie.__eq__" ID="FlashCookie.__eq__"></a> +<a NAME="FlashCookie.__init__" ID="FlashCookie.__init__"></a> +<h4>FlashCookie (Constructor)</h4> +<b>FlashCookie</b>(<i></i>) +<p> + Constructor +</p><a NAME="FlashCookie.__eq__" ID="FlashCookie.__eq__"></a> <h4>FlashCookie.__eq__</h4> <b>__eq__</b>(<i>other</i>) <p> @@ -88,12 +93,7 @@ <dd> bool </dd> -</dl><a NAME="FlashCookie.__init" ID="FlashCookie.__init"></a> -<h4>FlashCookie.__init</h4> -<b>__init</b>(<i></i>) -<p> - Constructor -</p> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookieManager.html Sun Aug 16 15:02:46 2015 +0200 +++ b/Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookieManager.html Sun Aug 16 15:34:40 2015 +0200 @@ -180,6 +180,16 @@ <dd> Flash cookie to be tested </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a blacklisted cookie +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> </dl><a NAME="FlashCookieManager.__isWhitelisted" ID="FlashCookieManager.__isWhitelisted"></a> <h4>FlashCookieManager.__isWhitelisted</h4> <b>__isWhitelisted</b>(<i>cookie</i>) @@ -190,6 +200,16 @@ <dd> Flash cookie to be tested </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a whitelisted cookie +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> </dl><a NAME="FlashCookieManager.__loadFlashCookies" ID="FlashCookieManager.__loadFlashCookies"></a> <h4>FlashCookieManager.__loadFlashCookies</h4> <b>__loadFlashCookies</b>(<i></i>)
--- a/Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookieManagerDialog.html Sun Aug 16 15:02:46 2015 +0200 +++ b/Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookieManagerDialog.html Sun Aug 16 15:34:40 2015 +0200 @@ -140,12 +140,22 @@ <b>__addBlacklist</b>(<i>origin</i>) <p> Private method to add a cookie origin to the blacklist. -</p><a NAME="FlashCookieManagerDialog.__addWhitelist" ID="FlashCookieManagerDialog.__addWhitelist"></a> +</p><dl> +<dt><i>origin</i> (str)</dt> +<dd> +origin to be added to the list +</dd> +</dl><a NAME="FlashCookieManagerDialog.__addWhitelist" ID="FlashCookieManagerDialog.__addWhitelist"></a> <h4>FlashCookieManagerDialog.__addWhitelist</h4> <b>__addWhitelist</b>(<i>origin</i>) <p> Private method to add a cookie origin to the whitelist. -</p><a NAME="FlashCookieManagerDialog.__cookiesListContextMenuRequested" ID="FlashCookieManagerDialog.__cookiesListContextMenuRequested"></a> +</p><dl> +<dt><i>origin</i> (str)</dt> +<dd> +origin to be added to the list +</dd> +</dl><a NAME="FlashCookieManagerDialog.__cookiesListContextMenuRequested" ID="FlashCookieManagerDialog.__cookiesListContextMenuRequested"></a> <h4>FlashCookieManagerDialog.__cookiesListContextMenuRequested</h4> <b>__cookiesListContextMenuRequested</b>(<i>pos</i>) <p>
--- a/Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookieNotification.html Sun Aug 16 15:02:46 2015 +0200 +++ b/Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookieNotification.html Sun Aug 16 15:34:40 2015 +0200 @@ -74,9 +74,9 @@ <dt><i>view</i> (QWebView)</dt> <dd> reference to the web view -</dd><dt><i>reference</i> (FlashCookieManager)</dt> +</dd><dt><i>manager</i> (FlashCookieManager)</dt> <dd> -to the Flash cookie manager object +reference to the Flash cookie manager object </dd><dt><i>noCookies</i> (int)</dt> <dd> number of newly detected Flash cookies
--- a/Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookieReader.html Sun Aug 16 15:02:46 2015 +0200 +++ b/Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookieReader.html Sun Aug 16 15:34:40 2015 +0200 @@ -134,6 +134,12 @@ <dd> reference to the dictionary to insert the result into </dd> +</dl><dl> +<dt>Raises <b>FlashCookieReaderError</b>:</dt> +<dd> +raised when an issue with the cookie + file is found +</dd> </dl><a NAME="FlashCookieReader.__parseBoolean" ID="FlashCookieReader.__parseBoolean"></a> <h4>FlashCookieReader.__parseBoolean</h4> <b>__parseBoolean</b>(<i>variableName, parent</i>) @@ -199,6 +205,12 @@ <dd> reference to the dictionary to insert the result into </dd> +</dl><dl> +<dt>Raises <b>FlashCookieReaderError</b>:</dt> +<dd> +raised when an issue with the cookie + file is found +</dd> </dl><a NAME="FlashCookieReader.__parseOcc" ID="FlashCookieReader.__parseOcc"></a> <h4>FlashCookieReader.__parseOcc</h4> <b>__parseOcc</b>(<i>variableName, parent</i>) @@ -212,6 +224,12 @@ <dd> reference to the dictionary to insert the result into </dd> +</dl><dl> +<dt>Raises <b>FlashCookieReaderError</b>:</dt> +<dd> +raised when an issue with the cookie + file is found +</dd> </dl><a NAME="FlashCookieReader.__parseOjm" ID="FlashCookieReader.__parseOjm"></a> <h4>FlashCookieReader.__parseOjm</h4> <b>__parseOjm</b>(<i>variableName, parent</i>)
--- a/Helpviewer/FlashCookieManager/FlashCookie.py Sun Aug 16 15:02:46 2015 +0200 +++ b/Helpviewer/FlashCookieManager/FlashCookie.py Sun Aug 16 15:34:40 2015 +0200 @@ -16,7 +16,7 @@ """ Class implementing the Flash cookie. """ - def __init(self): + def __init__(self): """ Constructor """
--- a/Helpviewer/FlashCookieManager/FlashCookieManager.py Sun Aug 16 15:02:46 2015 +0200 +++ b/Helpviewer/FlashCookieManager/FlashCookieManager.py Sun Aug 16 15:34:40 2015 +0200 @@ -116,6 +116,8 @@ @param cookie Flash cookie to be tested @type FlashCookie + @return flag indicating a blacklisted cookie + @rtype bool """ return cookie.origin in Preferences.getHelp("FlashCookiesBlacklist") @@ -125,6 +127,8 @@ @param cookie Flash cookie to be tested @type FlashCookie + @return flag indicating a whitelisted cookie + @rtype bool """ return cookie.origin in Preferences.getHelp("FlashCookiesWhitelist") @@ -198,7 +202,7 @@ newCookie = True for oldCookie in oldFlashCookies: if (oldCookie.path + oldCookie.name == - cookie.path + cookie.name): + cookie.path + cookie.name): newCookie = False break @@ -327,10 +331,10 @@ if "/" in origin: origin = origin.split("/", 1)[1] elif path.startswith( - self.flashPlayerDataPath() + + self.flashPlayerDataPath() + "/macromedia.com/support/flashplayer/sys/"): origin = origin.replace( - self.flashPlayerDataPath() + + self.flashPlayerDataPath() + "/macromedia.com/support/flashplayer/sys/", "") if origin == "settings.sol": return self.tr("!default")
--- a/Helpviewer/FlashCookieManager/FlashCookieManagerDialog.py Sun Aug 16 15:02:46 2015 +0200 +++ b/Helpviewer/FlashCookieManager/FlashCookieManagerDialog.py Sun Aug 16 15:34:40 2015 +0200 @@ -84,6 +84,9 @@ def __addWhitelist(self, origin): """ Private method to add a cookie origin to the whitelist. + + @param origin origin to be added to the list + @type str """ if not origin: return @@ -125,6 +128,9 @@ def __addBlacklist(self, origin): """ Private method to add a cookie origin to the blacklist. + + @param origin origin to be added to the list + @type str """ if not origin: return @@ -351,7 +357,7 @@ suffix = "" if cookie.path.startswith( - self.__manager.flashPlayerDataPath() + + self.__manager.flashPlayerDataPath() + "/macromedia.com/support/flashplayer/sys"): suffix = self.tr(" (settings)")
--- a/Helpviewer/FlashCookieManager/FlashCookieNotification.py Sun Aug 16 15:02:46 2015 +0200 +++ b/Helpviewer/FlashCookieManager/FlashCookieNotification.py Sun Aug 16 15:34:40 2015 +0200 @@ -28,7 +28,7 @@ @param view reference to the web view @type QWebView - @param reference to the Flash cookie manager object + @param manager reference to the Flash cookie manager object @type FlashCookieManager @param noCookies number of newly detected Flash cookies @type int
--- a/Helpviewer/FlashCookieManager/FlashCookieReader.py Sun Aug 16 15:02:46 2015 +0200 +++ b/Helpviewer/FlashCookieManager/FlashCookieReader.py Sun Aug 16 15:34:40 2015 +0200 @@ -110,7 +110,7 @@ "Flash cookie data lengths don't match\n" " file length: {0}\n" " data length: {1}" - .format(lenSolData - 6, lenData)) + .format(lenSolData - 6, lenData)) sDataType = self.__data.read(4).decode("utf-8") # 'TCSO' if sDataType != "TCSO": raise FlashCookieReaderError( @@ -175,7 +175,7 @@ elif b == b"\x7F\xF8\x00\x00\x00\x00\x00\x00": value = "NaN" else: - value, = struct.unpack(">d", b) # double, big-endian + value, = struct.unpack(">d", b) # double, big-endian value = str(value) parent[variableName] = ("number", value) @@ -245,7 +245,7 @@ @param parent reference to the dictionary to insert the result into @type dict """ - lenCData, = struct.unpack(">L", self.__data.read(4)) + lenCData, = struct.unpack(">L", self.__data.read(4)) # unsigned long, big-endian cData = self.__data.read(lenCData) value = cData.decode("utf-8") @@ -292,6 +292,8 @@ @type str @param parent reference to the dictionary to insert the result into @type dict + @exception FlashCookieReaderError raised when an issue with the cookie + file is found """ value = {} parent[variableName] = ("object", value) @@ -338,6 +340,8 @@ @type str @param parent reference to the dictionary to insert the result into @type dict + @exception FlashCookieReaderError raised when an issue with the cookie + file is found """ arrayLength, = struct.unpack(">L", self.__data.read(4)) # unsigned long, big-endian @@ -387,6 +391,8 @@ @type str @param parent reference to the dictionary to insert the result into @type dict + @exception FlashCookieReaderError raised when an issue with the cookie + file is found """ lenCname = struct.unpack(">H", self.__data.read(2)) # unsigned short, big-endian @@ -456,12 +462,12 @@ resultStr = self.toString(indent + 1, value) if resultStr: strArr.append("{0}{1}:\n{2}" - .format(indentStr, variableName, resultStr)) + .format(indentStr, variableName, resultStr)) else: strArr.append("{0}{1}:" - .format(indentStr, variableName)) + .format(indentStr, variableName)) else: strArr.append("{0}{1}: {2}" - .format(indentStr, variableName, value)) + .format(indentStr, variableName, value)) return "\n".join(strArr)
--- a/Preferences/ConfigurationDialog.py Sun Aug 16 15:02:46 2015 +0200 +++ b/Preferences/ConfigurationDialog.py Sun Aug 16 15:34:40 2015 +0200 @@ -59,7 +59,7 @@ """ return self.__pageName -# TODO: add page for Flash Cookie Manager + class ConfigurationWidget(QWidget): """ Class implementing a dialog for the configuration of eric6.
