hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-17 01:03:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Apply review suggestions - remove methodOfClass, fix qhelp typo; additionally add some more doc comments

Browse Source
This commit is contained in:
Joe Farebrother
2025-05-27 13:35:13 +01:00
parent c070d04231
commit f3a5608b06
2 changed files with 7 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
python/ql/src/Functions/IterReturnsNonSelf.qhelp
View File

@@ -3,7 +3,7 @@
"qhelp.dtd">
<qhelp>
<overview>
<p>Iterator classes (classes defining a <code>__next__</code> method) should have an <code>__iter__</code> that returns the iterator itself.
<p>Iterator classes (classes defining a <code>__next__</code> method) should have an <code>__iter__</code> method that returns the iterator itself.
This ensures that the object is also an iterable; and behaves as expected when used anywhere an iterator or iterable is expected, such as in <code>for</code> loops.
</p>

17
python/ql/src/Functions/IterReturnsNonSelf.ql
View File

@@ -14,16 +14,11 @@
import python
import semmle.python.ApiGraphs
/** Holds if `f` is a method of the class `c`. */
private predicate methodOfClass(Function f, Class c) {
exists(FunctionDef d | d.getDefinedFunction() = f and d.getScope() = c)
}
/** Gets the __iter__ method of `c`. */
Function iterMethod(Class c) { methodOfClass(result, c) and result.getName() = "__iter__" }
Function iterMethod(Class c) { result = c.getAMethod() and result.getName() = "__iter__" }
/** Gets the `__next__` method of `c`. */
Function nextMethod(Class c) { methodOfClass(result, c) and result.getName() = "__next__" }
Function nextMethod(Class c) { result = c.getAMethod() and result.getName() = "__next__" }
/** Holds if `var` is a variable referring to the `self` parameter of `f`. */
predicate isSelfVar(Function f, Name var) { var.getVariable() = f.getArg(0).(Name).getVariable() }
@@ -48,8 +43,6 @@ predicate returnsNonSelf(Function f) {
exists(f.getFallthroughNode())
or
exists(Return r | r.getScope() = f and not isGoodReturn(f, r.getValue()))
or
exists(Return r | r.getScope() = f and not exists(r.getValue()))
}
/** Holds if `iter` and `next` methods are wrappers around some field. */
@@ -70,7 +63,8 @@ predicate iterWrapperMethods(Function iter, Function next) {
)
}
DataFlow::CallCfgNode iterCall(DataFlow::Node arg) {
/** Gets a call to `iter(arg)`, `arg.__iter__()`, or `arg` itself (which we assume may already be an iterator). */
private DataFlow::CallCfgNode iterCall(DataFlow::Node arg) {
result.(DataFlow::MethodCallNode).calls(arg, "__iter__")
or
result = API::builtin("iter").getACall() and
@@ -80,7 +74,8 @@ DataFlow::CallCfgNode iterCall(DataFlow::Node arg) {
result = arg // assume the wrapping field is already an iterator
}
DataFlow::CallCfgNode nextCall(DataFlow::Node arg) {
/** Gets a call to `next(arg)` or `arg.__next__()`. */
private DataFlow::CallCfgNode nextCall(DataFlow::Node arg) {
result.(DataFlow::MethodCallNode).calls(arg, "__next__")
or
result = API::builtin("next").getACall() and