--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityUtils.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityUtils.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,28 +7,25 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityUtils</h1> - <p> Module implementing utility functions used by the security checks. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#InvalidModulePathError">InvalidModulePathError</a></td> <td>Class defining an exception for invalid module paths.</td> </tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#_get">_get</a></td> <td></td> @@ -82,37 +79,38 @@ <td>Function to split a namespace path into a head and tail.</td> </tr> </table> + <hr /> <hr /> <a NAME="InvalidModulePathError" ID="InvalidModulePathError"></a> <h2>InvalidModulePathError</h2> - <p> Class defining an exception for invalid module paths. </p> + <h3>Derived from</h3> Exception <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>None</td></tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -126,7 +124,6 @@ <a NAME="concatString" ID="concatString"></a> <h2>concatString</h2> <b>concatString</b>(<i>node, stop=None</i>) - <p> Function to build a string from an ast.BinOp chain. </p> @@ -135,6 +132,7 @@ wrapped in ast.BinOp nodes. Something like "a" + "b" + "c" or "a %s" % val etc. The provided node can be any participant in the BinOp chain. </p> + <dl> <dt><i>node</i> (ast.BinOp or ast.Constant)</dt> @@ -165,10 +163,10 @@ <a NAME="deepgetattr" ID="deepgetattr"></a> <h2>deepgetattr</h2> <b>deepgetattr</b>(<i>obj, attr</i>) - <p> Function to recurs through an attribute chain to get the ultimate value. </p> + <dl> <dt><i>obj</i> (ast.Name or ast.Attribute)</dt> @@ -198,7 +196,6 @@ <a NAME="escapedBytesRepresentation" ID="escapedBytesRepresentation"></a> <h2>escapedBytesRepresentation</h2> <b>escapedBytesRepresentation</b>(<i>b</i>) - <p> Function to escape bytes for comparison with other strings. </p> @@ -211,6 +208,7 @@ This is safe to do for the whole range 0..255 and result matches unicode_escape on a unicode string. </p> + <dl> <dt><i>b</i> (bytes)</dt> @@ -236,7 +234,6 @@ <a NAME="getAttrQualName" ID="getAttrQualName"></a> <h2>getAttrQualName</h2> <b>getAttrQualName</b>(<i>node, aliases</i>) - <p> Function to get a the full name for the attribute node. </p> @@ -249,6 +246,7 @@ empty string. If this encounters something more complex, such as foo.mylist[0](a,b) we just return empty string. </p> + <dl> <dt><i>node</i> (ast.Attribute)</dt> @@ -278,10 +276,10 @@ <a NAME="getCallName" ID="getCallName"></a> <h2>getCallName</h2> <b>getCallName</b>(<i>node, aliases</i>) - <p> Function to extract the call name from an ast.Call node. </p> + <dl> <dt><i>node</i> (ast.Call)</dt> @@ -311,7 +309,6 @@ <a NAME="getCalledName" ID="getCalledName"></a> <h2>getCalledName</h2> <b>getCalledName</b>(<i>node</i>) - <p> Function to get the function name from an ast.Call node. </p> @@ -320,6 +317,7 @@ wrapping a function call: thing.call() vs call(). This helper will grab the unqualified call name correctly in either case. </p> + <dl> <dt><i>node</i> (ast.Call)</dt> @@ -345,7 +343,6 @@ <a NAME="getModuleQualnameFromPath" ID="getModuleQualnameFromPath"></a> <h2>getModuleQualnameFromPath</h2> <b>getModuleQualnameFromPath</b>(<i>path</i>) - <p> Function to get the module's qualified name by analysis of the path. @@ -361,6 +358,7 @@ part of the module name. Move left to the subsequent directory components until a directory is found without __init__.py. </p> + <dl> <dt><i>path</i> (str)</dt> @@ -393,10 +391,10 @@ <a NAME="getQualAttr" ID="getQualAttr"></a> <h2>getQualAttr</h2> <b>getQualAttr</b>(<i>node, aliases</i>) - <p> Function to extract the qualified name from an ast.Attribute node. </p> + <dl> <dt><i>node</i> (ast.Attribute)</dt> @@ -426,10 +424,10 @@ <a NAME="linerange" ID="linerange"></a> <h2>linerange</h2> <b>linerange</b>(<i>node</i>) - <p> Function to get line number range from a node. </p> + <dl> <dt><i>node</i> (ast.AST)</dt> @@ -455,11 +453,11 @@ <a NAME="linerange_fix" ID="linerange_fix"></a> <h2>linerange_fix</h2> <b>linerange_fix</b>(<i>node</i>) - <p> Function to get a line number range working around a known Python bug with multi-line strings. </p> + <dl> <dt><i>node</i> (ast.AST)</dt> @@ -485,10 +483,10 @@ <a NAME="namespacePathJoin" ID="namespacePathJoin"></a> <h2>namespacePathJoin</h2> <b>namespacePathJoin</b>(<i>namespace, name</i>) - <p> Function to extend a given namespace path. </p> + <dl> <dt><i>namespace</i> (str)</dt> @@ -518,7 +516,6 @@ <a NAME="namespacePathSplit" ID="namespacePathSplit"></a> <h2>namespacePathSplit</h2> <b>namespacePathSplit</b>(<i>path</i>) - <p> Function to split a namespace path into a head and tail. </p> @@ -527,6 +524,7 @@ be everything leading up to that in the path. This is similar to os.path.split. </p> + <dl> <dt><i>path</i> (str)</dt> @@ -548,4 +546,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>