Python: Add qldocs

yoff · yoff · commit d6e9b351e51b · 2020-10-23T16:39:38.000+02:00
diff --git a/python/ql/src/experimental/semmle/python/frameworks/Stdlib.qll b/python/ql/src/experimental/semmle/python/frameworks/Stdlib.qll
@@ -739,6 +739,10 @@ private class ExecStatement extends CodeExecution::Range {
   override DataFlow::Node getCode() { result = this }
 }
 
+/**
+ * A call to the builtin `open` function.
+ * See https://docs.python.org/3/library/functions.html#open
+ */
 private class OpenCall extends FileSystemAccess::Range, DataFlow::CfgNode {
   override CallNode node;
 
@@ -749,6 +753,10 @@ private class OpenCall extends FileSystemAccess::Range, DataFlow::CfgNode {
   }
 }
 
+/**
+ * A call to the `startswith` method on a string.
+ * See https://docs.python.org/3.9/library/stdtypes.html#str.startswith
+ */
 private class StartswithCall extends Path::SafeAccessCheck::Range {
   StartswithCall() { this.(CallNode).getFunction().(AttrNode).getName() = "startswith" }
 

Original file line number	Diff line number	Diff line change
`@@ -739,6 +739,10 @@ private class ExecStatement extends CodeExecution::Range {`
`739`	`739`	`override DataFlow::Node getCode() { result = this }`
`740`	`740`	`}`
`741`	`741`
	`742`	`+/**`
	`743`	+ * A call to the builtin `open` function.
	`744`	`+ * See https://docs.python.org/3/library/functions.html#open`
	`745`	`+ */`
`742`	`746`	`private class OpenCall extends FileSystemAccess::Range, DataFlow::CfgNode {`
`743`	`747`	`override CallNode node;`
`744`	`748`
`@@ -749,6 +753,10 @@ private class OpenCall extends FileSystemAccess::Range, DataFlow::CfgNode {`
`749`	`753`	`}`
`750`	`754`	`}`
`751`	`755`
	`756`	`+/**`
	`757`	+ * A call to the `startswith` method on a string.
	`758`	`+ * See https://docs.python.org/3.9/library/stdtypes.html#str.startswith`
	`759`	`+ */`
`752`	`760`	`private class StartswithCall extends Path::SafeAccessCheck::Range {`
`753`	`761`	`StartswithCall() { this.(CallNode).getFunction().(AttrNode).getName() = "startswith" }`
`754`	`762`