CodeQL 文档
CodeQL 资源

Python 代码的基本查询

了解如何使用 CodeQL 扩展在 Visual Studio Code 中编写和运行简单的 CodeQL 查询。

有关安装 Visual Studio Code 版 CodeQL 扩展的信息，请参阅“安装 Visual Studio Code 版 CodeQL”。

关于查询

我们将运行的查询对代码进行基本搜索，查找冗余的 if 语句，这些语句仅包含 pass 语句。例如，类似以下代码：

if error: pass

查找 CodeQL 数据库以进行实验

在开始为 Python 代码编写查询之前，您需要一个 CodeQL 数据库来运行这些查询。最简单的方法是直接从 GitHub.com 下载使用 Python 的存储库的数据库。

  1. 在 Visual Studio Code 中，单击左侧边栏中的 **QL** 图标 CodeQL 扩展的图标。 以显示 CodeQL 扩展。
  2. 单击 CodeQL 扩展顶部的 **从 GitHub 获取** 或 GitHub 徽标 CodeQL 扩展选项的图标，用于从 GitHub 下载 CodeQL 数据库。 以打开一个输入字段。
  3. 将存储库的 URL 复制到该字段中，然后按键盘上的 **Enter** 键。例如，https://github.com/saltstack/salt。
  4. 可选：如果存储库有多个可用的 CodeQL 数据库，请选择 python 以下载从 Python 代码创建的数据库。

有关数据库下载进度的信息将显示在 Visual Studio Code 右下角。下载完成后，数据库将显示在 CodeQL 扩展的 **数据库** 部分中，旁边有一个复选标记（见下图）。

运行快速查询

Visual Studio Code 版 CodeQL 扩展向命令面板添加了几个 **CodeQL:** 命令，包括 **快速查询**，您可以使用它在没有任何设置的情况下运行查询。

  1. 在 Visual Studio Code 的命令面板中，选择 **CodeQL: 快速查询**。

  2. 片刻之后，将打开一个新的选项卡 *quick-query.ql*，以便您为当前选定的 CodeQL 数据库（此处为 python 数据库）编写查询。如果系统提示您将工作区重新加载为多文件夹工作区以允许快速查询，请接受或使用入门工作流创建新的工作区。

    image-quick-query

  1. 在快速查询选项卡中，删除 select "" 并将以下查询粘贴到导入语句 import python 下面。

    from If ifstmt, Stmt pass
where pass = ifstmt.getStmt(0) and
  pass instanceof Pass
select ifstmt, "This 'if' statement is redundant."

  1. 将查询保存在其默认位置（工作区下名为“快速查询”的临时目录，位于 GitHub.vscode-codeql/quick-queries 中）。

  2. 右键单击查询选项卡，然后选择 **CodeQL: 在选定数据库上运行查询**。（或者，从命令面板运行该命令。）

    查询将需要几分钟才能返回结果。查询完成后，结果将显示在 CodeQL 查询结果视图中，位于主编辑器视图旁边。

    查询结果列在两列中，分别对应于查询 select 子句中的表达式。第一列对应于表达式 ifstmt，并链接到项目源代码中 ifstmt 出现的位置。第二列是警报消息。

../../_images/basic-python-query-results-1.png

如果找到任何匹配的代码，请单击 ifstmt 列中的链接以打开该文件并突出显示匹配的 if 语句。

../../_images/basic-python-query-results-2.png

注意

如果您想将实验性查询移到更永久的位置，则需要移动整个 Quick Queries 目录。该目录是一个 CodeQL 包，包含一个 qlpack.yml 文件，该文件将内容定义为针对 Python CodeQL 数据库的查询。有关 CodeQL 包的更多信息，请参阅“管理 CodeQL 查询包和库包”。

关于查询结构

在初始 import 语句之后，这个简单的查询包含三个部分，它们与 SQL 查询的 FROM、WHERE 和 SELECT 部分的功能类似。

查询部分 目的 详细信息
import python 导入 Python 的标准 CodeQL 库。 每个查询都以一个或多个 import 语句开头。
from If ifstmt, Stmt pass 定义查询的变量。声明的格式为：<type> <variable name>

我们使用

  • 一个 If 变量来表示 if 语句
  • 一个 Stmt 变量来表示语句
where pass = ifstmt.getStmt(0) and pass instanceof Pass 定义对变量的条件。

pass = ifstmt.getStmt(0)：pass 是 if 语句中的第一个语句。

pass instanceof Pass：pass 必须是 pass 语句。

换句话说，if 语句中包含的第一个语句是 pass 语句。
select ifstmt, "This 'if' statement is redundant."

定义为每个匹配项报告的内容。

select 语句用于查找不良编码实践实例的查询始终采用以下形式：select <program element>, "<alert message>"

 使用一个字符串报告生成的 if 语句，该字符串解释了问题。

扩展查询

查询编写本质上是一个迭代过程。您编写一个简单的查询，然后在运行它时，您会发现以前没有考虑到的示例，或者发现改进的机会。

删除误报结果

浏览基本查询的结果表明，它可以改进。在结果中，您可能会发现一些 if 语句的示例，这些语句具有 else 分支，其中 pass 语句确实起作用。例如

if cond():
  pass
else:
  do_something()

在这种情况下，将具有 pass 语句的 if 语句识别为冗余是一个误报。解决此问题的方案之一是修改查询，以忽略 pass 语句，如果 if 语句具有 else 分支。

要排除具有 else 分支的 if 语句

  1. 将 where 子句扩展为包括以下附加条件

    and not exists(ifstmt.getOrelse())

    现在，where 子句为

    where pass = ifstmt.getStmt(0) and
  pass instanceof Pass and
  not exists(ifstmt.getOrelse())

  2. 重新运行查询。

    现在结果更少了，因为不再包含具有 else 分支的 if 语句。

  • ©GitHub, Inc.
  • 条款
  • 隐私