Python: Add deprecated keyword to deprecated functions

Author: RasmusWL

python/ql/src/semmle/python/Files.qll

@@ -9,12 +9,12 @@ class File extends Container {
     }
 
     /** DEPRECATED: Use `getAbsolutePath` instead. */
-    override string getName() {
+    deprecated override string getName() {
         files(this, result, _, _, _)
     }
 
     /** DEPRECATED: Use `getAbsolutePath` instead. */
-    string getFullName() {
+    deprecated string getFullName() {
         result = getName()
     }
 
@@ -97,12 +97,12 @@ class Folder extends Container {
     }
 
     /** DEPRECATED: Use `getAbsolutePath` instead. */
-    override string getName() {
+    deprecated override string getName() {
         folders(this, result, _)
     }
 
     /** DEPRECATED: Use `getBaseName` instead. */
-    string getSimple() {
+    deprecated string getSimple() {
         folders(this, _, result)
     }
 

python/ql/src/semmle/python/Flow.qll

@@ -606,7 +606,7 @@ class SubscriptNode extends ControlFlowNode {
 
     /** DEPRECATED: Use `getObject()` instead.
      * This will be formally deprecated before the end 2018 and removed in 2019.*/
-    ControlFlowNode getValue() {
+    deprecated ControlFlowNode getValue() {
         exists(Subscript s | this.getNode() = s and s.getObject() = result.getNode() and
         result.getBasicBlock().dominates(this.getBasicBlock()))
     }

python/ql/src/semmle/python/dataflow/Configuration.qll

@@ -123,7 +123,7 @@ module TaintTracking {
         /* Old query API */
 
         /* deprecated */
-        predicate hasFlow(Source src, Sink sink) {
+        deprecated predicate hasFlow(Source src, Sink sink) {
             exists(PathSource psrc, PathSink psink |
                 this.hasFlowPath(psrc, psink) and
                 src = psrc.getNode().asCfgNode() and

python/ql/src/semmle/python/dataflow/TaintTracking.qll

@@ -132,7 +132,7 @@ abstract class TaintKind extends string {
      * This predicate is present for completeness. It is unlikely that any `TaintKind`
      * implementation will ever need to override it.
      */
-    predicate additionalFlowStepVar(EssaVariable fromvar, EssaVariable tovar) { none() }
+    deprecated predicate additionalFlowStepVar(EssaVariable fromvar, EssaVariable tovar) { none() }
 
     /** Holds if this kind of taint "taints" `expr`.
      */
@@ -143,7 +143,7 @@ abstract class TaintKind extends string {
     }
 
     /** DEPRECATED -- Use getType() instead */
-    ClassObject getClass() {
+    deprecated ClassObject getClass() {
         none()
     }
 
@@ -380,7 +380,7 @@ abstract class Sanitizer extends string {
  * Examples include flow from a request to untrusted part of that request or
  * from a socket to data from that socket.
  */
-abstract class TaintFlow extends string {
+deprecated abstract class TaintFlow extends string {
 
     bindingset[this]
     TaintFlow() { any() }

python/ql/src/semmle/python/types/FunctionObject.qll

@@ -381,52 +381,52 @@ class BuiltinFunctionObject extends BuiltinCallable {
 }
 
 /** DEPRECATED -- Use `Object::builtin("apply")` instead. */
-Object theApplyFunction() {
+deprecated Object theApplyFunction() {
     result = Object::builtin("apply")
 }
 
 /** DEPRECATED -- Use `Object::builtin("hasattr")` instead. */
-Object theHasattrFunction() {
+deprecated Object theHasattrFunction() {
     result = Object::builtin("hasattr")
 }
 
 /** DEPRECATED -- Use `Object::builtin("len")` instead. */
-Object theLenFunction() {
+deprecated Object theLenFunction() {
     result = Object::builtin("len")
 }
 
 /** DEPRECATED -- Use `Object::builtin("format")` instead. */
-Object theFormatFunction() {
+deprecated Object theFormatFunction() {
     result = Object::builtin("format")
 }
 
 /** DEPRECATED -- Use `Object::builtin("open")` instead. */
-Object theOpenFunction() {
+deprecated Object theOpenFunction() {
     result = Object::builtin("open")
 }
 
 /** DEPRECATED -- Use `Object::builtin("print")` instead. */
-Object thePrintFunction() {
+deprecated Object thePrintFunction() {
     result = Object::builtin("print")
 }
 
 /** DEPRECATED -- Use `Object::builtin("input")` instead. */
-Object theInputFunction() {
+deprecated Object theInputFunction() {
     result = Object::builtin("input")
 }
 
 /** DEPRECATED -- Use `Object::builtin("locals")` instead. */
-Object theLocalsFunction() {
+deprecated Object theLocalsFunction() {
     result = Object::builtin("locals")
 }
 
 /** DEPRECATED -- Use `Object::builtin("globals")()` instead. */
-Object theGlobalsFunction() {
+deprecated Object theGlobalsFunction() {
     result = Object::builtin("globals")
 }
 
 /** DEPRECATED -- Use `Object::builtin("sysExit()` instead. */
-Object theExitFunctionObject() {
+deprecated Object theExitFunctionObject() {
     result = ModuleObject::named("sys").attr("exit")
 }