Python: Rename getAnImmediateUse -> asSource

Author: asgerf

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

@@ -147,12 +147,12 @@ module API {
      * to the `escape` member of `re`, neither `x` nor any node that `x` flows to is a reference to
      * this API component.
      */
-    DataFlow::LocalSourceNode getAnImmediateUse() { Impl::use(this, result) }
+    DataFlow::LocalSourceNode asSource() { Impl::use(this, result) }
 
     /**
      * Gets a call to the function represented by this API component.
      */
-    CallNode getACall() { result = this.getReturn().getAnImmediateUse() }
+    CallNode getACall() { result = this.getReturn().asSource() }
 
     /**
      * Gets a node representing member `m` of this API component.
@@ -377,7 +377,7 @@ module API {
   class CallNode extends DataFlow::CallCfgNode {
     API::Node callee;
 
-    CallNode() { this = callee.getReturn().getAnImmediateUse() }
+    CallNode() { this = callee.getReturn().asSource() }
 
     /** Gets the API node for the `i`th parameter of this invocation. */
     pragma[nomagic]
@@ -423,7 +423,7 @@ module API {
     /** Gets the API node for the return value of this call. */
     Node getReturn() {
       result = callee.getReturn() and
-      result.getAnImmediateUse() = this
+      result.asSource() = this
     }
 
     /**

python/ql/lib/semmle/python/filters/Tests.qll

@@ -9,7 +9,7 @@ class UnitTestClass extends TestScope, Class {
       testCaseString.matches("%TestCase") and
       testCaseClass = any(API::Node mod).getMember(testCaseString)
     |
-      this.getParent() = testCaseClass.getASubclass*().getAnImmediateUse().asExpr()
+      this.getParent() = testCaseClass.getASubclass*().asSource().asExpr()
     )
   }
 }

python/ql/lib/semmle/python/frameworks/Aiohttp.qll

@@ -243,9 +243,7 @@ module AiohttpWebModel {
 
   /** A class that has a super-type which is an aiohttp.web View class. */
   class AiohttpViewClassFromSuperClass extends AiohttpViewClass {
-    AiohttpViewClassFromSuperClass() {
-      this.getParent() = View::subclassRef().getAnImmediateUse().asExpr()
-    }
+    AiohttpViewClassFromSuperClass() { this.getParent() = View::subclassRef().asSource().asExpr() }
   }
 
   /** A class that is used in a route-setup, therefore being considered an aiohttp.web View class. */

python/ql/lib/semmle/python/frameworks/Aiomysql.qll

@@ -63,7 +63,7 @@ private module Aiomysql {
   class AwaitedCursorExecuteCall extends SqlExecution::Range {
     CursorExecuteCall executeCall;
 
-    AwaitedCursorExecuteCall() { this = executeCall.getReturn().getAwaited().getAnImmediateUse() }
+    AwaitedCursorExecuteCall() { this = executeCall.getReturn().getAwaited().asSource() }
 
     override DataFlow::Node getSql() { result = executeCall.getSql() }
   }
@@ -104,7 +104,7 @@ private module Aiomysql {
   class AwaitedSAConnectionExecuteCall extends SqlExecution::Range {
     SAConnectionExecuteCall execute;
 
-    AwaitedSAConnectionExecuteCall() { this = execute.getReturn().getAwaited().getAnImmediateUse() }
+    AwaitedSAConnectionExecuteCall() { this = execute.getReturn().getAwaited().asSource() }
 
     override DataFlow::Node getSql() { result = execute.getSql() }
   }

python/ql/lib/semmle/python/frameworks/Aiopg.qll

@@ -63,7 +63,7 @@ private module Aiopg {
   class AwaitedCursorExecuteCall extends SqlExecution::Range {
     CursorExecuteCall execute;
 
-    AwaitedCursorExecuteCall() { this = execute.getReturn().getAwaited().getAnImmediateUse() }
+    AwaitedCursorExecuteCall() { this = execute.getReturn().getAwaited().asSource() }
 
     override DataFlow::Node getSql() { result = execute.getSql() }
   }
@@ -100,7 +100,7 @@ private module Aiopg {
   class AwaitedSAConnectionExecuteCall extends SqlExecution::Range {
     SAConnectionExecuteCall excute;
 
-    AwaitedSAConnectionExecuteCall() { this = excute.getReturn().getAwaited().getAnImmediateUse() }
+    AwaitedSAConnectionExecuteCall() { this = excute.getReturn().getAwaited().asSource() }
 
     override DataFlow::Node getSql() { result = excute.getSql() }
   }

python/ql/lib/semmle/python/frameworks/Asyncpg.qll

@@ -71,7 +71,7 @@ private module Asyncpg {
       CursorCreation() {
         exists(CursorConstruction c |
           sql = c.getSql() and
-          this = c.getReturn().getAwaited().getAnImmediateUse()
+          this = c.getReturn().getAwaited().asSource()
         )
         or
         exists(API::CallNode prepareCall |
@@ -86,7 +86,7 @@ private module Asyncpg {
                 .getMember("cursor")
                 .getReturn()
                 .getAwaited()
-                .getAnImmediateUse()
+                .asSource()
         )
       }
 

python/ql/lib/semmle/python/frameworks/Cryptography.qll

@@ -144,9 +144,7 @@ private module CryptographyModel {
     DataFlow::Node getCurveArg() { result in [this.getArg(0), this.getArgByName("curve")] }
 
     override int getKeySizeWithOrigin(DataFlow::Node origin) {
-      exists(API::Node n |
-        n = Ecc::predefinedCurveClass(result) and origin = n.getAnImmediateUse()
-      |
+      exists(API::Node n | n = Ecc::predefinedCurveClass(result) and origin = n.asSource() |
         this.getCurveArg() = n.getAUse()
         or
         this.getCurveArg() = n.getReturn().getAUse()

python/ql/lib/semmle/python/frameworks/Django.qll

@@ -562,7 +562,7 @@ module PrivateDjango {
 
       /** A `django.db.connection` is a PEP249 compliant DB connection. */
       class DjangoDbConnection extends PEP249::Connection::InstanceSource {
-        DjangoDbConnection() { this = connection().getAnImmediateUse() }
+        DjangoDbConnection() { this = connection().asSource() }
       }
 
       // -------------------------------------------------------------------------
@@ -869,7 +869,7 @@ module PrivateDjango {
 
           /** Gets the (AST) class of the Django model class `modelClass`. */
           Class getModelClassClass(API::Node modelClass) {
-            result.getParent() = modelClass.getAnImmediateUse().asExpr() and
+            result.getParent() = modelClass.asSource().asExpr() and
             modelClass = Model::subclassRef()
           }
 
@@ -2202,9 +2202,7 @@ module PrivateDjango {
    * thereby handling user input.
    */
   class DjangoFormClass extends Class, SelfRefMixin {
-    DjangoFormClass() {
-      this.getParent() = Django::Forms::Form::subclassRef().getAnImmediateUse().asExpr()
-    }
+    DjangoFormClass() { this.getParent() = Django::Forms::Form::subclassRef().asSource().asExpr() }
   }
 
   /**
@@ -2237,7 +2235,7 @@ module PrivateDjango {
    */
   class DjangoFormFieldClass extends Class {
     DjangoFormFieldClass() {
-      this.getParent() = Django::Forms::Field::subclassRef().getAnImmediateUse().asExpr()
+      this.getParent() = Django::Forms::Field::subclassRef().asSource().asExpr()
     }
   }
 
@@ -2340,7 +2338,7 @@ module PrivateDjango {
    */
   class DjangoViewClassFromSuperClass extends DjangoViewClass {
     DjangoViewClassFromSuperClass() {
-      this.getParent() = Django::Views::View::subclassRef().getAnImmediateUse().asExpr()
+      this.getParent() = Django::Views::View::subclassRef().asSource().asExpr()
     }
   }
 
@@ -2743,7 +2741,7 @@ module PrivateDjango {
             .getMember("utils")
             .getMember("log")
             .getMember("request_logger")
-            .getAnImmediateUse()
+            .asSource()
     }
   }
 

python/ql/lib/semmle/python/frameworks/FastApi.qll

@@ -166,7 +166,7 @@ private module FastApi {
       exists(Class cls, API::Node base |
         base = getModeledResponseClass(_).getASubclass*() and
         cls.getABase() = base.getAUse().asExpr() and
-        responseClass.getAnImmediateUse().asExpr() = cls.getParent()
+        responseClass.asSource().asExpr() = cls.getParent()
       |
         exists(Assign assign | assign = cls.getAStmt() |
           assign.getATarget().(Name).getId() = "media_type" and

python/ql/lib/semmle/python/frameworks/Flask.qll

@@ -195,7 +195,7 @@ module Flask {
 
     FlaskViewClass() {
       api_node = Views::View::subclassRef() and
-      this.getParent() = api_node.getAnImmediateUse().asExpr()
+      this.getParent() = api_node.asSource().asExpr()
     }
 
     /** Gets a function that could handle incoming requests, if any. */
@@ -220,7 +220,7 @@ module Flask {
   class FlaskMethodViewClass extends FlaskViewClass {
     FlaskMethodViewClass() {
       api_node = Views::MethodView::subclassRef() and
-      this.getParent() = api_node.getAnImmediateUse().asExpr()
+      this.getParent() = api_node.asSource().asExpr()
     }
 
     override Function getARequestHandler() {
@@ -404,7 +404,7 @@ module Flask {
 
   private class RequestAttrMultiDict extends Werkzeug::MultiDict::InstanceSource {
     RequestAttrMultiDict() {
-      this = request().getMember(["args", "values", "form", "files"]).getAnImmediateUse()
+      this = request().getMember(["args", "values", "form", "files"]).asSource()
     }
   }
 
@@ -427,14 +427,12 @@ module Flask {
 
   /** An `Headers` instance that originates from a flask request. */
   private class FlaskRequestHeadersInstances extends Werkzeug::Headers::InstanceSource {
-    FlaskRequestHeadersInstances() { this = request().getMember("headers").getAnImmediateUse() }
+    FlaskRequestHeadersInstances() { this = request().getMember("headers").asSource() }
   }
 
   /** An `Authorization` instance that originates from a flask request. */
   private class FlaskRequestAuthorizationInstances extends Werkzeug::Authorization::InstanceSource {
-    FlaskRequestAuthorizationInstances() {
-      this = request().getMember("authorization").getAnImmediateUse()
-    }
+    FlaskRequestAuthorizationInstances() { this = request().getMember("authorization").asSource() }
   }
 
   // ---------------------------------------------------------------------------
@@ -574,6 +572,6 @@ module Flask {
    * - https://flask.palletsprojects.com/en/2.0.x/logging/
    */
   private class FlaskLogger extends Stdlib::Logger::InstanceSource {
-    FlaskLogger() { this = FlaskApp::instance().getMember("logger").getAnImmediateUse() }
+    FlaskLogger() { this = FlaskApp::instance().getMember("logger").asSource() }
   }
 }