Skip to content

Commit a033338

Browse files
committed
Python: Explicitly mention lack of transitive flow in asSource/asSink
1 parent 9b27a7c commit a033338

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

python/ql/lib/semmle/python/ApiGraphs.qll

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,9 @@ module API {
121121
* obj.prop = x
122122
* foo.bar(obj);
123123
* ```
124+
*
125+
* This predicate does not include nodes transitively reaching the sink by data flow;
126+
* use `getAValueReachingSink` for that.
124127
*/
125128
DataFlow::Node asSink() { Impl::rhs(this, result) }
126129

@@ -146,6 +149,9 @@ module API {
146149
* # API::moduleImport("re").getMember("escape").getReturn().asSource()
147150
* re.escape()
148151
* ```
152+
*
153+
* This predicate does not include nodes transitively reachable by data flow;
154+
* use `getAValueReachableFromSource` for that.
149155
*/
150156
DataFlow::LocalSourceNode asSource() { Impl::use(this, result) }
151157

0 commit comments

Comments
 (0)