Merge pull request #16245 from github/tausbn/python-rename-StrConst-to-StringLiteral

Python: Rename `StrConst` to `StringLiteral`

Author: RasmusWL

python/ql/examples/snippets/raw_string.ql

@@ -8,6 +8,6 @@
 
 import python
 
-from StrConst s
+from StringLiteral s
 where s.getPrefix().matches("%r%")
 select s

python/ql/examples/snippets/singlequotestring.ql

@@ -9,6 +9,6 @@
 
 import python
 
-from StrConst s
+from StringLiteral s
 where s.getPrefix().charAt(_) = "'"
 select s

python/ql/lib/analysis/DefinitionTracking.qll

@@ -410,7 +410,7 @@ private predicate sets_attribute(ArgumentRefinement def, string name) {
     call = def.getDefiningNode() and
     call.getFunction().refersTo(Object::builtin("setattr")) and
     def.getInput().getAUse() = call.getArg(0) and
-    call.getArg(1).getNode().(StrConst).getText() = name
+    call.getArg(1).getNode().(StringLiteral).getText() = name
   )
 }
 

python/ql/lib/change-notes/2024-04-22-renaming-StrConst-to-StringLiteral.md

@@ -0,0 +1,5 @@
+---
+category: deprecated
+---
+
+- Renamed the `StrConst` class to `StringLiteral`, for greater consistency with other languages. The `StrConst` and `Str` classes are now deprecated and will be removed in a future release.

python/ql/lib/experimental/cryptography/modules/stdlib/HashlibModule.qll

@@ -26,10 +26,10 @@ module Hashes {
     }
 
     override string getName() {
-      result = super.normalizeName(this.asExpr().(StrConst).getText())
+      result = super.normalizeName(this.asExpr().(StringLiteral).getText())
       or
       // if not a known/static string, assume from an outside source and the algorithm is UNKNOWN
-      not this.asExpr() instanceof StrConst and result = unknownAlgorithm()
+      not this.asExpr() instanceof StringLiteral and result = unknownAlgorithm()
     }
   }
 
@@ -49,10 +49,10 @@ module Hashes {
     }
 
     override string getName() {
-      result = super.normalizeName(this.asExpr().(StrConst).getText())
+      result = super.normalizeName(this.asExpr().(StringLiteral).getText())
       or
       // if not a known/static string, assume from an outside source and the algorithm is UNKNOWN
-      not this.asExpr() instanceof StrConst and result = unknownAlgorithm()
+      not this.asExpr() instanceof StringLiteral and result = unknownAlgorithm()
     }
   }
 
@@ -88,9 +88,9 @@ module Hashes {
       // Name is a string constant or consider the name unknown
       // NOTE: we are excluding hmac.new and hmac.HMAC constructor calls so we are expecting
       //      a string or an outside configuration only
-      result = super.normalizeName(this.asExpr().(StrConst).getText())
+      result = super.normalizeName(this.asExpr().(StringLiteral).getText())
       or
-      not this.asExpr() instanceof StrConst and
+      not this.asExpr() instanceof StringLiteral and
       result = unknownAlgorithm()
     }
   }

python/ql/lib/experimental/cryptography/modules/stdlib/HmacModule.qll

@@ -62,9 +62,9 @@ module Hashes {
       then result = super.normalizeName("MD5")
       else (
         // Else get the string name, if its a string constant, or UNKNOWN if otherwise
-        result = super.normalizeName(this.asExpr().(StrConst).getText())
+        result = super.normalizeName(this.asExpr().(StringLiteral).getText())
         or
-        not this.asExpr() instanceof StrConst and result = unknownAlgorithm()
+        not this.asExpr() instanceof StringLiteral and result = unknownAlgorithm()
       )
     }
   }

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

@@ -257,7 +257,7 @@ module API {
      */
     Node getSubscript(string key) {
       exists(API::Node index | result = this.getSubscriptAt(index) |
-        key = index.getAValueReachingSink().asExpr().(PY::StrConst).getText()
+        key = index.getAValueReachingSink().asExpr().(PY::StringLiteral).getText()
       )
     }
 

python/ql/lib/semmle/python/Concepts.qll

@@ -855,7 +855,7 @@ module Http {
 
         /** Gets the URL pattern for this route, if it can be statically determined. */
         string getUrlPattern() {
-          exists(StrConst str |
+          exists(StringLiteral str |
             this.getUrlPatternArg().getALocalSource() = DataFlow::exprNode(str) and
             result = str.getText()
           )
@@ -983,7 +983,7 @@ module Http {
 
         /** Gets the mimetype of this HTTP response, if it can be statically determined. */
         string getMimetype() {
-          exists(StrConst str |
+          exists(StringLiteral str |
             this.getMimetypeOrContentTypeArg().getALocalSource() = DataFlow::exprNode(str) and
             result = str.getText().splitAt(";", 0)
           )

python/ql/lib/semmle/python/Exprs.qll

@@ -236,7 +236,7 @@ class Call extends Call_ {
   string getANamedArgumentName() {
     result = this.getAKeyword().getArg()
     or
-    result = this.getKwargs().(Dict).getAKey().(StrConst).getText()
+    result = this.getKwargs().(Dict).getAKey().(StringLiteral).getText()
   }
 
   /** Gets the positional argument count of this call, provided there is no more than one tuple (*) argument. */
@@ -299,7 +299,7 @@ class Repr extends Repr_ {
  * A bytes constant, such as `b'ascii'`. Note that unadorned string constants such as
  * `"hello"` are treated as Bytes for Python2, but Unicode for Python3.
  */
-class Bytes extends StrConst {
+class Bytes extends StringLiteral {
   /* syntax: b"hello" */
   Bytes() { not this.isUnicode() }
 
@@ -446,7 +446,7 @@ class NegativeIntegerLiteral extends ImmutableLiteral, UnaryExpr {
  * A unicode string expression, such as `u"\u20ac"`. Note that unadorned string constants such as
  * "hello" are treated as Bytes for Python2, but Unicode for Python3.
  */
-class Unicode extends StrConst {
+class Unicode extends StringLiteral {
   /* syntax: "hello" */
   Unicode() { this.isUnicode() }
 
@@ -599,7 +599,7 @@ class Slice extends Slice_ {
 /**
  * Returns all string prefixes in the database that are explicitly marked as Unicode strings.
  *
- * Helper predicate for `StrConst::isUnicode`.
+ * Helper predicate for `StringLiteral::isUnicode`.
  */
 pragma[nomagic]
 private string unicode_prefix() {
@@ -610,20 +610,27 @@ private string unicode_prefix() {
 /**
  * Returns all string prefixes in the database that are _not_ explicitly marked as bytestrings.
  *
- * Helper predicate for `StrConst::isUnicode`.
+ * Helper predicate for `StringLiteral::isUnicode`.
  */
 pragma[nomagic]
 private string non_byte_prefix() {
   result = any(Str_ s).getPrefix() and
   not result.charAt(_) in ["b", "B"]
 }
 
-/** A string constant. This is a placeholder class -- use `StrConst` instead. */
-class Str = StrConst;
+/** DEPRECATED. Use `StringLiteral` instead. */
+deprecated class Str = StringLiteral;
+
+/** DEPRECATED. Use `StringLiteral` instead. */
+deprecated class StrConst = StringLiteral;
 
 /** A string constant. */
-class StrConst extends Str_, ImmutableLiteral {
+class StringLiteral extends Str_, ImmutableLiteral {
   /* syntax: "hello" */
+  /**
+   * Holds if this string is a unicode string, either by default (e.g. if Python 3), or with an
+   * explicit prefix.
+   */
   predicate isUnicode() {
     this.getPrefix() = unicode_prefix()
     or
@@ -652,6 +659,8 @@ class StrConst extends Str_, ImmutableLiteral {
   }
 
   override Object getLiteralObject() { none() }
+
+  override string toString() { result = "StringLiteral" }
 }
 
 private predicate name_consts(Name_ n, string id) {

python/ql/lib/semmle/python/Files.qll

@@ -93,7 +93,7 @@ class File extends Container, Impl::File {
       exists(Stmt s | s.getLocation().getFile() = this)
       or
       // The file contains the usual `if __name__ == '__main__':` construction
-      exists(If i, Name name, StrConst main, Cmpop op |
+      exists(If i, Name name, StringLiteral main, Cmpop op |
         i.getScope().(Module).getFile() = this and
         op instanceof Eq and
         i.getTest().(Compare).compares(name, op, main) and
@@ -123,7 +123,7 @@ private predicate occupied_line(File f, int n) {
   exists(Location l | l.getFile() = f |
     l.getStartLine() = n
     or
-    exists(StrConst s | s.getLocation() = l | n in [l.getStartLine() .. l.getEndLine()])
+    exists(StringLiteral s | s.getLocation() = l | n in [l.getStartLine() .. l.getEndLine()])
   )
 }