--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityContext.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityContext.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,53 +7,50 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityContext</h1> - <p> Module implementing a context class for security related checks. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#SecurityContext">SecurityContext</a></td> <td>Class implementing a context class for security related checks.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="SecurityContext" ID="SecurityContext"></a> <h2>SecurityContext</h2> - <p> Class implementing a context class for security related checks. </p> + <h3>Derived from</h3> None <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#SecurityContext.__init__">SecurityContext</a></td> <td>Constructor</td> @@ -143,16 +140,16 @@ <td>Public method to get the escaped value of the object.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="SecurityContext.__init__" ID="SecurityContext.__init__"></a> <h4>SecurityContext (Constructor)</h4> <b>SecurityContext</b>(<i>contextObject=None</i>) - <p> Constructor </p> @@ -160,6 +157,7 @@ Initialize the class with a context dictionary or an empty dictionary. </p> + <dl> <dt><i>contextObject</i> (dict)</dt> @@ -171,10 +169,10 @@ <a NAME="SecurityContext.__getLiteralValue" ID="SecurityContext.__getLiteralValue"></a> <h4>SecurityContext.__getLiteralValue</h4> <b>__getLiteralValue</b>(<i>literal</i>) - <p> Private method to turn AST literals into native Python types. </p> + <dl> <dt><i>literal</i> (ast.AST)</dt> @@ -197,11 +195,11 @@ <a NAME="SecurityContext.__repr__" ID="SecurityContext.__repr__"></a> <h4>SecurityContext.__repr__</h4> <b>__repr__</b>(<i></i>) - <p> Special method to generate representation of object for printing or interactive use. </p> + <dl> <dt>Return:</dt> <dd> @@ -217,10 +215,10 @@ <a NAME="SecurityContext.bytesVal" ID="SecurityContext.bytesVal"></a> <h4>SecurityContext.bytesVal</h4> <b>bytesVal</b>(<i></i>) - <p> Public method to get the value of a standalone bytes object. </p> + <dl> <dt>Return:</dt> <dd> @@ -236,10 +234,10 @@ <a NAME="SecurityContext.callArgs" ID="SecurityContext.callArgs"></a> <h4>SecurityContext.callArgs</h4> <b>callArgs</b>(<i></i>) - <p> Public method to get a list of function args. </p> + <dl> <dt>Return:</dt> <dd> @@ -255,10 +253,10 @@ <a NAME="SecurityContext.callArgsCount" ID="SecurityContext.callArgsCount"></a> <h4>SecurityContext.callArgsCount</h4> <b>callArgsCount</b>(<i></i>) - <p> Public method to get the number of args a function call has. </p> + <dl> <dt>Return:</dt> <dd> @@ -274,10 +272,10 @@ <a NAME="SecurityContext.callFunctionName" ID="SecurityContext.callFunctionName"></a> <h4>SecurityContext.callFunctionName</h4> <b>callFunctionName</b>(<i></i>) - <p> Public method to get the name (not FQ) of a function call. </p> + <dl> <dt>Return:</dt> <dd> @@ -293,10 +291,10 @@ <a NAME="SecurityContext.callFunctionNameQual" ID="SecurityContext.callFunctionNameQual"></a> <h4>SecurityContext.callFunctionNameQual</h4> <b>callFunctionNameQual</b>(<i></i>) - <p> Public method to get the FQ name of a function call. </p> + <dl> <dt>Return:</dt> <dd> @@ -312,10 +310,10 @@ <a NAME="SecurityContext.callKeywords" ID="SecurityContext.callKeywords"></a> <h4>SecurityContext.callKeywords</h4> <b>callKeywords</b>(<i></i>) - <p> Public method to get a dictionary of keyword parameters. </p> + <dl> <dt>Return:</dt> <dd> @@ -331,11 +329,11 @@ <a NAME="SecurityContext.checkCallArgValue" ID="SecurityContext.checkCallArgValue"></a> <h4>SecurityContext.checkCallArgValue</h4> <b>checkCallArgValue</b>(<i>argumentName, argumentValues=None</i>) - <p> Public method to check for a value of a named argument in a function call. </p> + <dl> <dt><i>argumentName</i> (str)</dt> @@ -363,11 +361,11 @@ <a NAME="SecurityContext.functionDefDefaultsQual" ID="SecurityContext.functionDefDefaultsQual"></a> <h4>SecurityContext.functionDefDefaultsQual</h4> <b>functionDefDefaultsQual</b>(<i></i>) - <p> Public method to get a list of fully qualified default values in a function def. </p> + <dl> <dt>Return:</dt> <dd> @@ -383,11 +381,11 @@ <a NAME="SecurityContext.getCallArgAtPosition" ID="SecurityContext.getCallArgAtPosition"></a> <h4>SecurityContext.getCallArgAtPosition</h4> <b>getCallArgAtPosition</b>(<i>positionNum</i>) - <p> Public method to get a positional argument at the specified position (if it exists). </p> + <dl> <dt><i>positionNum</i> (int)</dt> @@ -410,10 +408,10 @@ <a NAME="SecurityContext.getCallArgValue" ID="SecurityContext.getCallArgValue"></a> <h4>SecurityContext.getCallArgValue</h4> <b>getCallArgValue</b>(<i>argumentName</i>) - <p> Public method to get the value of a named argument in a function call. </p> + <dl> <dt><i>argumentName</i> (str)</dt> @@ -436,10 +434,10 @@ <a NAME="SecurityContext.getLinenoForCallArg" ID="SecurityContext.getLinenoForCallArg"></a> <h4>SecurityContext.getLinenoForCallArg</h4> <b>getLinenoForCallArg</b>(<i>argumentName</i>) - <p> Public method to get the line number for a specific named argument. </p> + <dl> <dt><i>argumentName</i> (str)</dt> @@ -462,10 +460,10 @@ <a NAME="SecurityContext.getOffsetForCallArg" ID="SecurityContext.getOffsetForCallArg"></a> <h4>SecurityContext.getOffsetForCallArg</h4> <b>getOffsetForCallArg</b>(<i>argumentName</i>) - <p> Public method to get the offset for a specific named argument. </p> + <dl> <dt><i>argumentName</i> (str)</dt> @@ -488,11 +486,11 @@ <a NAME="SecurityContext.isModuleBeingImported" ID="SecurityContext.isModuleBeingImported"></a> <h4>SecurityContext.isModuleBeingImported</h4> <b>isModuleBeingImported</b>(<i>module</i>) - <p> Public method to check for the given module is currently being imported. </p> + <dl> <dt><i>module</i> (str)</dt> @@ -515,11 +513,11 @@ <a NAME="SecurityContext.isModuleImportedExact" ID="SecurityContext.isModuleImportedExact"></a> <h4>SecurityContext.isModuleImportedExact</h4> <b>isModuleImportedExact</b>(<i>module</i>) - <p> Public method to check if a given module has been imported; only exact matches. </p> + <dl> <dt><i>module</i> (str)</dt> @@ -542,11 +540,11 @@ <a NAME="SecurityContext.isModuleImportedLike" ID="SecurityContext.isModuleImportedLike"></a> <h4>SecurityContext.isModuleImportedLike</h4> <b>isModuleImportedLike</b>(<i>module</i>) - <p> Public method to check if a given module has been imported; given module exists. </p> + <dl> <dt><i>module</i> (str)</dt> @@ -569,10 +567,10 @@ <a NAME="SecurityContext.node" ID="SecurityContext.node"></a> <h4>SecurityContext.node</h4> <b>node</b>(<i></i>) - <p> Public method to get the raw AST node associated with the context. </p> + <dl> <dt>Return:</dt> <dd> @@ -588,10 +586,10 @@ <a NAME="SecurityContext.statement" ID="SecurityContext.statement"></a> <h4>SecurityContext.statement</h4> <b>statement</b>(<i></i>) - <p> Public method to get the raw AST for the current statement. </p> + <dl> <dt>Return:</dt> <dd> @@ -607,10 +605,10 @@ <a NAME="SecurityContext.stringVal" ID="SecurityContext.stringVal"></a> <h4>SecurityContext.stringVal</h4> <b>stringVal</b>(<i></i>) - <p> Public method to get the value of a standalone string object. </p> + <dl> <dt>Return:</dt> <dd> @@ -626,7 +624,6 @@ <a NAME="SecurityContext.stringValAsEscapedBytes" ID="SecurityContext.stringValAsEscapedBytes"></a> <h4>SecurityContext.stringValAsEscapedBytes</h4> <b>stringValAsEscapedBytes</b>(<i></i>) - <p> Public method to get the escaped value of the object. </p> @@ -638,6 +635,7 @@ This function should be used when looking for a known sequence in a potentially badly encoded string in the code. </p> + <dl> <dt>Return:</dt> <dd> @@ -652,4 +650,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>