mirror of
https://github.com/github/codeql.git
synced 2025-12-23 04:06:37 +01:00
Python: fix typos in comments
This commit is contained in:
@@ -184,7 +184,7 @@ class Import extends Import_ {
|
|||||||
* For example, for the import statement `import bar` which
|
* For example, for the import statement `import bar` which
|
||||||
* is a relative import in package "foo", this would return
|
* is a relative import in package "foo", this would return
|
||||||
* "foo.bar".
|
* "foo.bar".
|
||||||
* The import statment `from foo import bar` would return
|
* The import statement `from foo import bar` would return
|
||||||
* `foo` and `foo.bar`
|
* `foo` and `foo.bar`
|
||||||
*/
|
*/
|
||||||
string getAnImportedModuleName() {
|
string getAnImportedModuleName() {
|
||||||
|
|||||||
@@ -172,7 +172,7 @@ module ArgumentPassing {
|
|||||||
/**
|
/**
|
||||||
* Gets the node representing the argument to `call` that is passed to the parameter at
|
* Gets the node representing the argument to `call` that is passed to the parameter at
|
||||||
* (zero-based) index `paramN` in `callable`. If this is a positional argument, it must appear
|
* (zero-based) index `paramN` in `callable`. If this is a positional argument, it must appear
|
||||||
* at an index, `argN`, in `call` wich satisfies `paramN = mapping.getParamN(argN)`.
|
* at an index, `argN`, in `call` which satisfies `paramN = mapping.getParamN(argN)`.
|
||||||
*
|
*
|
||||||
* `mapping` will be the identity for function calls, but not for method- or constructor calls,
|
* `mapping` will be the identity for function calls, but not for method- or constructor calls,
|
||||||
* where the first parameter is `self` and the first positional argument is passed to the second positional parameter.
|
* where the first parameter is `self` and the first positional argument is passed to the second positional parameter.
|
||||||
|
|||||||
@@ -305,7 +305,7 @@ cached
|
|||||||
private module Cached {
|
private module Cached {
|
||||||
/**
|
/**
|
||||||
* If needed, call this predicate from `DataFlowImplSpecific.qll` in order to
|
* If needed, call this predicate from `DataFlowImplSpecific.qll` in order to
|
||||||
* force a stage-dependency on the `DataFlowImplCommon.qll` stage and therby
|
* force a stage-dependency on the `DataFlowImplCommon.qll` stage and thereby
|
||||||
* collapsing the two stages.
|
* collapsing the two stages.
|
||||||
*/
|
*/
|
||||||
cached
|
cached
|
||||||
|
|||||||
@@ -45,14 +45,14 @@ abstract class TrackableState extends string {
|
|||||||
/**
|
/**
|
||||||
* Holds if state starts at `f`.
|
* Holds if state starts at `f`.
|
||||||
* Either this predicate or `startsAt(ControlFlowNode f, Context ctx)`
|
* Either this predicate or `startsAt(ControlFlowNode f, Context ctx)`
|
||||||
* should be overriden by sub-classes.
|
* should be overridden by sub-classes.
|
||||||
*/
|
*/
|
||||||
predicate startsAt(ControlFlowNode f) { none() }
|
predicate startsAt(ControlFlowNode f) { none() }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds if state starts at `f` given context `ctx`.
|
* Holds if state starts at `f` given context `ctx`.
|
||||||
* Either this predicate or `startsAt(ControlFlowNode f)`
|
* Either this predicate or `startsAt(ControlFlowNode f)`
|
||||||
* should be overriden by sub-classes.
|
* should be overridden by sub-classes.
|
||||||
*/
|
*/
|
||||||
pragma[noinline]
|
pragma[noinline]
|
||||||
predicate startsAt(ControlFlowNode f, Context ctx) { ctx.appliesTo(f) and this.startsAt(f) }
|
predicate startsAt(ControlFlowNode f, Context ctx) { ctx.appliesTo(f) and this.startsAt(f) }
|
||||||
@@ -60,14 +60,14 @@ abstract class TrackableState extends string {
|
|||||||
/**
|
/**
|
||||||
* Holds if state ends at `f`.
|
* Holds if state ends at `f`.
|
||||||
* Either this predicate or `endsAt(ControlFlowNode f, Context ctx)`
|
* Either this predicate or `endsAt(ControlFlowNode f, Context ctx)`
|
||||||
* may be overriden by sub-classes.
|
* may be overridden by sub-classes.
|
||||||
*/
|
*/
|
||||||
predicate endsAt(ControlFlowNode f) { none() }
|
predicate endsAt(ControlFlowNode f) { none() }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds if state ends at `f` given context `ctx`.
|
* Holds if state ends at `f` given context `ctx`.
|
||||||
* Either this predicate or `endsAt(ControlFlowNode f)`
|
* Either this predicate or `endsAt(ControlFlowNode f)`
|
||||||
* may be overriden by sub-classes.
|
* may be overridden by sub-classes.
|
||||||
*/
|
*/
|
||||||
pragma[noinline]
|
pragma[noinline]
|
||||||
predicate endsAt(ControlFlowNode f, Context ctx) { ctx.appliesTo(f) and this.endsAt(f) }
|
predicate endsAt(ControlFlowNode f, Context ctx) { ctx.appliesTo(f) and this.endsAt(f) }
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ private module Aiomysql {
|
|||||||
/**
|
/**
|
||||||
* Gets a `Connection` that is created when
|
* Gets a `Connection` that is created when
|
||||||
* - the result of `aiomysql.connect()` is awaited.
|
* - the result of `aiomysql.connect()` is awaited.
|
||||||
* - the result of calling `aquire` on a `ConnectionPool` is awaited.
|
* - the result of calling `acquire` on a `ConnectionPool` is awaited.
|
||||||
* See https://aiomysql.readthedocs.io/en/stable/connection.html#connection
|
* See https://aiomysql.readthedocs.io/en/stable/connection.html#connection
|
||||||
*/
|
*/
|
||||||
API::Node connection() {
|
API::Node connection() {
|
||||||
@@ -82,7 +82,7 @@ private module Aiomysql {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets an `SAConnection` that is created when the result of calling `aquire` on an `Engine` is awaited.
|
* Gets an `SAConnection` that is created when the result of calling `acquire` on an `Engine` is awaited.
|
||||||
* See https://aiomysql.readthedocs.io/en/stable/sa.html#connection
|
* See https://aiomysql.readthedocs.io/en/stable/sa.html#connection
|
||||||
*/
|
*/
|
||||||
API::Node saConnection() { result = engine().getMember("acquire").getReturn().getAwaited() }
|
API::Node saConnection() { result = engine().getMember("acquire").getReturn().getAwaited() }
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ private module Aiopg {
|
|||||||
/**
|
/**
|
||||||
* Gets a `Connection` that is created when
|
* Gets a `Connection` that is created when
|
||||||
* - the result of `aiopg.connect()` is awaited.
|
* - the result of `aiopg.connect()` is awaited.
|
||||||
* - the result of calling `aquire` on a `ConnectionPool` is awaited.
|
* - the result of calling `acquire` on a `ConnectionPool` is awaited.
|
||||||
* See https://aiopg.readthedocs.io/en/stable/core.html#connection
|
* See https://aiopg.readthedocs.io/en/stable/core.html#connection
|
||||||
*/
|
*/
|
||||||
API::Node connection() {
|
API::Node connection() {
|
||||||
@@ -78,7 +78,7 @@ private module Aiopg {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets an `SAConnection` that is created when the result of calling `aquire` on an `Engine` is awaited.
|
* Gets an `SAConnection` that is created when the result of calling `acquire` on an `Engine` is awaited.
|
||||||
* See https://aiopg.readthedocs.io/en/stable/sa.html#connection
|
* See https://aiopg.readthedocs.io/en/stable/sa.html#connection
|
||||||
*/
|
*/
|
||||||
API::Node saConnection() { result = engine().getMember("acquire").getReturn().getAwaited() }
|
API::Node saConnection() { result = engine().getMember("acquire").getReturn().getAwaited() }
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ private module Asyncpg {
|
|||||||
/**
|
/**
|
||||||
* Gets a `Connection` that is created when
|
* Gets a `Connection` that is created when
|
||||||
* - the result of `asyncpg.connect()` is awaited.
|
* - the result of `asyncpg.connect()` is awaited.
|
||||||
* - the result of calling `aquire` on a `ConnectionPool` is awaited.
|
* - the result of calling `acquire` on a `ConnectionPool` is awaited.
|
||||||
*/
|
*/
|
||||||
API::Node connection() {
|
API::Node connection() {
|
||||||
result = API::moduleImport("asyncpg").getMember("connect").getReturn().getAwaited()
|
result = API::moduleImport("asyncpg").getMember("connect").getReturn().getAwaited()
|
||||||
@@ -69,7 +69,7 @@ private module Asyncpg {
|
|||||||
* Provides models of the `PreparedStatement` class in `asyncpg`.
|
* Provides models of the `PreparedStatement` class in `asyncpg`.
|
||||||
* `PreparedStatement`s are created when the result of calling `prepare(query)` on a connection is awaited.
|
* `PreparedStatement`s are created when the result of calling `prepare(query)` on a connection is awaited.
|
||||||
* The result of calling `prepare(query)` is a `PreparedStatementFactory` and the argument, `query` needs to
|
* The result of calling `prepare(query)` is a `PreparedStatementFactory` and the argument, `query` needs to
|
||||||
* be tracked to the place where a `PreparedStatement` is created and then futher to any executing methods.
|
* be tracked to the place where a `PreparedStatement` is created and then further to any executing methods.
|
||||||
* Hence the two type trackers.
|
* Hence the two type trackers.
|
||||||
*/
|
*/
|
||||||
module PreparedStatement {
|
module PreparedStatement {
|
||||||
|
|||||||
@@ -243,7 +243,7 @@ predicate class_method(
|
|||||||
* Holds if the literal corresponding to the control flow node `n` has class `cls`.
|
* Holds if the literal corresponding to the control flow node `n` has class `cls`.
|
||||||
*
|
*
|
||||||
* Helper predicate for `literal_instantiation`. Prevents a bad join with
|
* Helper predicate for `literal_instantiation`. Prevents a bad join with
|
||||||
* `PointsToContext::appliesTo` from occuring.
|
* `PointsToContext::appliesTo` from occurring.
|
||||||
*/
|
*/
|
||||||
pragma[nomagic]
|
pragma[nomagic]
|
||||||
private predicate literal_node_class(ControlFlowNode n, ClassObjectInternal cls) {
|
private predicate literal_node_class(ControlFlowNode n, ClassObjectInternal cls) {
|
||||||
|
|||||||
@@ -28,14 +28,14 @@ private module RegexpMatching {
|
|||||||
* but if `ignorePrefix` is true, it will only match "foo".
|
* but if `ignorePrefix` is true, it will only match "foo".
|
||||||
*/
|
*/
|
||||||
predicate test(string str, boolean ignorePrefix) {
|
predicate test(string str, boolean ignorePrefix) {
|
||||||
none() // maybe overriden in subclasses
|
none() // maybe overridden in subclasses
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Same as `test(..)`, but where the `fillsCaptureGroup` afterwards tells which capture groups were filled by the given string.
|
* Same as `test(..)`, but where the `fillsCaptureGroup` afterwards tells which capture groups were filled by the given string.
|
||||||
*/
|
*/
|
||||||
predicate testWithGroups(string str, boolean ignorePrefix) {
|
predicate testWithGroups(string str, boolean ignorePrefix) {
|
||||||
none() // maybe overriden in subclasses
|
none() // maybe overridden in subclasses
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -51,7 +51,7 @@
|
|||||||
* either a single character, a set of characters represented by a
|
* either a single character, a set of characters represented by a
|
||||||
* character class, or the set of all characters.
|
* character class, or the set of all characters.
|
||||||
* * The product automaton is constructed lazily, starting with pair states
|
* * The product automaton is constructed lazily, starting with pair states
|
||||||
* `(q, q)` where `q` is a fork, and proceding along an over-approximate
|
* `(q, q)` where `q` is a fork, and proceeding along an over-approximate
|
||||||
* step relation.
|
* step relation.
|
||||||
* * The over-approximate step relation allows transitions along pairs of
|
* * The over-approximate step relation allows transitions along pairs of
|
||||||
* abstract input symbols where the symbols have overlap in the characters they accept.
|
* abstract input symbols where the symbols have overlap in the characters they accept.
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ deprecated class ExternalStringSequenceKind extends SequenceKind {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An hierachical dictionary or list where the entire structure is externally controlled
|
* An hierarchical dictionary or list where the entire structure is externally controlled
|
||||||
* This is typically a parsed JSON object.
|
* This is typically a parsed JSON object.
|
||||||
*/
|
*/
|
||||||
deprecated class ExternalJsonKind extends TaintKind {
|
deprecated class ExternalJsonKind extends TaintKind {
|
||||||
|
|||||||
@@ -181,7 +181,7 @@ private string expectationCommentPattern() { result = "\\s*\\$((?:[^/]|/[^/])*)(
|
|||||||
/**
|
/**
|
||||||
* The possible columns in an expectation comment. The `TDefaultColumn` branch represents the first
|
* The possible columns in an expectation comment. The `TDefaultColumn` branch represents the first
|
||||||
* column in a comment. This column is not precedeeded by a name. `TNamedColumn(name)` represents a
|
* column in a comment. This column is not precedeeded by a name. `TNamedColumn(name)` represents a
|
||||||
* column containing expected results preceeded by the string `name:`.
|
* column containing expected results preceded by the string `name:`.
|
||||||
*/
|
*/
|
||||||
private newtype TColumn =
|
private newtype TColumn =
|
||||||
TDefaultColumn() or
|
TDefaultColumn() or
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
* s = SOURCE
|
* s = SOURCE
|
||||||
* SINK(s)
|
* SINK(s)
|
||||||
* ```
|
* ```
|
||||||
* `SOURCE` will be a source and the second occurance of `s` will be a sink.
|
* `SOURCE` will be a source and the second occurrence of `s` will be a sink.
|
||||||
*
|
*
|
||||||
* In order to test literals, alternative sources are defined for each type:
|
* In order to test literals, alternative sources are defined for each type:
|
||||||
*
|
*
|
||||||
|
|||||||
Reference in New Issue
Block a user