Visual Studio Code でプログラムをフォーマットするにはどうすればよいですか?この記事では、VSCode の書式設定方法を理解し、習得するための手順を段階的に説明します。皆様のお役に立てれば幸いです。
#Visual Studio Code のすべての言語は、自動フォーマッタの 1 つを使用してフォーマットでき、Python 拡張機能はリンターもサポートしています。 [推奨学習: 「vscode 入門チュートリアル 」]
リンターとフォーマッタは異なるタスクを実行します:
Python 拡張機能は、さまざまなジョブを実行する多くのサードパーティ リンターをサポートしています。たとえば、Bandit はセキュリティ脆弱性用の linter、 および Flake8 はスタイル ガイド準拠のための linter です。
Python 拡張機能には、コードおよび使用するライブラリからインターフェイス (メソッド、関数、クラス) をロードして分析を実行する 言語サーバー ツール も付属しています。
このチュートリアルの執筆時点では、Visual Studio Code 上の Python 用の最新かつ最高の言語サーバー拡張機能は Pylance です。
Pylance のセットアップ
Pylance は、Visual Studio Code の Python と連携して、より詳細な言語サポートとコードの Python イントロスペクションを提供する拡張機能です。 Pylance は、オートコンプリート、自動モジュール インポート、より優れたコード ナビゲーション、型チェックなどを提供します。
Pylance を入手するには、サイドバーの *拡張機能* メニューに移動し、Pylance
( ms-python.vscode-pylance
) を検索します。
注: Pylance は Python 拡張機能にバンドルされているため、すでにインストールされている可能性があります。
Pylance をインストールした後、拡張機能を最大限に活用するには、ユーザー設定 で 2 つのデフォルト構成設定を変更する必要がある場合があります。
最初に変更する設定は型チェック モードです。これを使用して、実行される型チェック分析のレベルを指定できます。
"python.analysis.typeCheckingMode": "basic"
デフォルトでは、型チェック モードは ## に設定されています。 #"オフ"###。 その他のオプションは、
または "strict"
です。 "basic"
を使用して、型チェックとは独立したルールと基本的な型チェックのルールを実行します。モードが "strict"
に設定されている場合、最も高いエラー重大度を持つすべての型チェック ルールが実行されます。この "basic"
を設定して、厳密と無効化の間のバランスを取るようにします。 もう 1 つのデフォルト設定は
です。デフォルトでは、Pylance は現在開いているファイルのみをチェックします。この設定を workspace
に変更すると、ワークスペース内のすべての Python ファイルがチェックされ、Explorer
ビューにエラーと警告のリストが表示されます:
利用可能な RAM がある場合にのみ、
python.analysis.diagnosticMode を "workspace"
に設定してください。より多くのリソースが消費されるためです。 Pylance は、メソッドや関数のパラメーターとして使用される型と戻り値の型に関する情報を持っている場合に最も効果的です。
外部ライブラリの場合、Pylance は
typeshedを使用して戻り値の型とパラメーターの型を推論します。 Pylance は、pandas、Matplotlib、scikit-learn、NumPy などの最も人気のあるデータ サイエンス ライブラリの一部に型スタブとインテリジェンスも提供します。 Pandas を使用している場合、Pylance は、一般的な関数とパターンの情報と例を提供します。
タイプシェッドに型スタブがないライブラリの場合、Pylance は、種類を推測するのが最善です。それは何ですか。それ以外の場合は、独自のタイプ スタブを追加できます。
保存時にフォーマットと lint を設定する 格式化文档是将格式应用于 VS Code 中的任何文档的操作。对于Python扩展,这个动作执行 在 中配置格式化程序后 随着格式化程序的执行,您还可以按字母顺序组织导入语句,并通过将标准库模块、外部模块和包导入分成具有以下配置的组: 与格式化不同,linting 特定于 Python 扩展。要启用 linting,请通过 要在保存文件时运行启用的 linter,请将以下设置添加到 您可能会发现启用多个 linter 很有帮助。请记住,Pylance 已经提供了您可以从 pylint 获得的许多见解,因此您可能不需要同时启用 pylint和Pylance。相比之下,Flake8 提供了 Pylance 没有涵盖的风格反馈,因此您可以将这两者结合使用。 Python 提供了大量工具来测试您的代码。VS Code 的 Python 扩展支持最流行的测试框架, 配置测试集成 要启用对 Python 的测试支持,请 此向导将配置选项添加到 您可以 如果您有更复杂的 pytest 设置,请将它们 执行测试 为测试运行器配置测试框架和参数后,您可以通过 测试发现完成后,每个测试用例都将有一个内联选项来执行或调试该用例: 失败的测试将被标记为有错误。您可以在Python 测试日志面板中以及通过将鼠标悬停在代码中失败的测试用例上来查看测试运行器的失败: 如果您经常运行测试,则可以使用testing explorer改善 VS Code 中的测试体验。 要启用测试面板,请右键单击侧栏并确保选中测试。测试面板显示了 Python 扩展发现的所有测试,并为您提供了许多功能: 您可以直观地表示测试套件分组以及哪些测试失败。您还可以使用菜单按钮运行和调试测试。 VS Code 的测试系统功能强大,但默认情况下禁用了许多功能以使其成为轻量级编辑器。除了测试之外,您可能还希望从 VS Code 内部定期运行其他任务。这就是任务系统的用武之地。 Visual Studio Code 支持 Go、Rust 和 C++ 等编译语言,以及 Python 和 Ruby 等解释型语言。VS Code 有一个灵活的系统来执行用户定义的配置任务,比如构建和编译代码。 Python 代码通常不需要提前编译,因为 Python 解释器会为您做这件事。相反,您可以使用任务系统来预先配置您将在命令行中运行的任务,例如: VS Code 任务是可以使用命令面板按需运行的命令或可执行文件。有两个内置的默认任务: 在构建任务 该测试任务 请注意,您可以将任务用于可能通过命令行执行的任何内容。您不仅限于构建和测试活动。 使用任务编译轮子 如果您有一个 任务在 在这个例子中有几件事情需要注意,所以你将逐行查看最重要的配置: 要执行默认构建任务,您可以 您不仅限于构建脚本。任务系统是 Django 和 Flask 管理命令的一个很好的解决方案。 使用 Django 任务 您是否正在使用 Django 应用程序,并且想要 要运行此任务,请使用 您可以复制此代码段并将其粘贴到您定期运行的任何 Django 命令中,例如 链接任务 如果您有多个应按顺序运行的任务或一个任务依赖于另一个任务,则可以在 扩展上的 在默认构建任务中,您可以添加一个属性 下次运行此任务时,它将首先运行所有相关任务。 如果您有此任务所依赖的多个任务并且它们可以并行运行,请添加 使用任务运行 Tox 现在您将探索tox,这是一个旨在自动化和标准化 Python 测试的工具。Visual Studio Code 的 Python 扩展不附带 tox 集成。相反,您可以使用任务系统将 tox 设置为默认测试任务。 **提示:**如果你希望迅速与TOX开始,然后安装 这将提示您完成创建tox 配置文件的步骤。 要使用您的 tox 配置自动运行 tox,请将以下任务添加到 您可以使用 如果您有几个任务并且需要经常运行它们,那么是时候探索一个很棒的扩展了,它在 UI 中添加了一些用于运行配置任务的快捷方式。 使用任务资源管理器扩展 该任务浏览器扩展( 单击任何任务旁边的箭头以执行它,如果您更改了任务的配置,请单击顶部的刷新图标。 Visual Studio Code 的 Python 扩展捆绑了一个强大的调试器,支持本地和远程调试。 运行和调试简单 Python 脚本的最简单方法是转到运行 → 开始调试菜单并从选择中选择Python 文件。这将使用配置的 Python 解释器执行当前文件。 您可以通过单击行号左侧的装订线在代码中的任何位置设置断点。当代码执行时遇到断点时,代码将暂停并等待指令: 调试器添加了一个控件菜单:Continue、Step Over、Step Into、Step Out、Restart和Stop Execution: 在左侧面板上,您可以执行常见的调试操作,例如探索局部和全局变量以及 Python 的调用堆栈。您还可以设置手表,您将在下一节中了解更多信息。 设置手表 监视是在调试会话之间持续存在的表达式。当您停止执行并再次开始调试时,您将保留上次会话的所有监视。 您可以将变量添加到关注从面板变量通过右键单击一个变量,然后选择面板添加到关注。 您还可以通过单击*+图标将任何 Python 表达式添加到监视*列表。表达式可以包含: 每当遇到断点时,您都会实时获得每个表达式的当前结果。当您逐步调试会话时,VS Code 还将更新每个手表的值: 您可以使用左侧的箭头扩展字典和对象等复杂类型。 到目前为止,您已经看到了单个 Python 文件的调试器,但许多 Python 应用程序都是模块或需要特殊命令才能启动。 配置启动文件 VS Code 有一个用于启动配置文件的配置文件 **注意:**要查看即将进行的配置的预期结果,您需要设置一个有效的FastAPI 项目,并在您使用的 Python 环境中安装异步Web 服务器uvicorn。 作为在 VS Code 中使用启动配置文件的示例,您将探索如何使用 ASGI 服务器 相反,您可以在以下位置设置等效的启动配置 在这里,您将 添加此配置后,您应该会在“*运行和调试”*面板下找到准备启动的新启动配置: 当您按F5或从顶部菜单中选择Run → Start Debugging时,您配置为首次启动配置的任何内容都将运行。 如果 VS Code 没有自动为你选择正确的 Python 环境,那么你也可以在你的 您可以将 Python 解释器的路径添加为名称为 的新条目 VS Code 支持三种远程开发配置文件: 容器 通过 SSH 的远程主机 适用于 Linux 的 Windows 子系统 (WSL) 所有三个选项都由远程开发扩展包 ( 使用容器进行远程开发 您需要在您的机器上安装 Docker 运行时才能对容器进行远程调试。如果您还没有安装 Docker,可以从Docker 网站下载它。 Docker 运行后,转到左侧导航菜单上的远程资源管理器选项卡。将Remote Explorer下拉菜单更改为Containers,您将看到一个带有面板的视图: 如果您有全新的 Docker 安装,则不会填充这些面板。 如果您已经安装并运行了 Docker 映像,则可能会填充三个面板: **Containers:**一个导航面板,用于显示此工作区中的开发容器或一些快速启动步骤的链接 **容器的名称(如果正在运行):**正在运行的容器的属性和卷安装 **DevVolumes:**可以编辑和挂载以修改代码的开发卷列表 例如,如果您按照 VS Code 的容器教程 中概述的步骤安装了试用开发容器:Python,则您的 VS Code远程资源管理器选项卡将在前面提到的面板中显示正在运行的容器的名称: 使用这些面板可以快速管理您的项目所依赖的任何 Docker 容器。 通常,运行远程容器扩展的主要方式有以下三种: 附加到现有的运行容器以进行快速更改 创建 运行 如果您计划在容器和 VS Code 中进行大量工作,那么花费额外的时间来创建开发容器将是值得的。 **注意:**您可以通过阅读官方 VS Code 文档来更详细地了解如何创建开发容器。 开始使用开发容器的一种快速方法是从当前工作区创建它: 选择 Python 3,然后选择所需的 Python 版本。 接受默认的 Node.js 建议版本。 然后 VS Code 将移植您现有的工作区并 开发容器有两个必需的文件: .devcontainer/devcontainer.json,它指定了所有 VS Code 要求,例如需要哪些扩展以及要使用哪些设置 Dockerfile, 指定哪些命令将构建环境 在默认设置中, 您将使用里面的默认值 如果您的应用程序需要来自 PyPI 的其他包,请更改 如果您正在开发提供网络服务的应用程序(如 Web 应用程序),您还可以添加端口转发选项。有关完整的选项列表,您可以查看 在对 通过这样做,您将使用对配置和 除了用于远程调试的远程开发扩展包的扩展功能之外,还有一个用于 VS Code 的 Docker 扩展。您将在本教程结束时介绍此扩展并找到更多功能。 使用 SSH 进行远程开发 通过 这是两个主机的示例配置: 保存配置文件后,远程资源管理器选项卡将在SSH 目标下拉选项下列出这些 SSH 主机: 要连接到该服务器,请单击“新窗口中的连接到主机”,这是任何主机右侧的图标。这将打开一个带有远程主机的新 VS Code 窗口。 连接后,单击资源管理器视图下的打开文件夹。VS Code 将显示一个特殊的文件夹导航菜单,显示远程主机上的可用文件夹。导航到您的代码所在的文件夹,您可以在该目录下启动一个新的工作区: 在这个远程工作区中,您可以编辑和保存远程服务器上的任何文件。如果您需要运行任何其他命令,“*终端”*选项卡会自动设置为远程主机的 SSH 终端。 使用 WSL 进行远程开发 适用于 Linux 的 Windows 子系统或WSL是 Microsoft Windows 的一个组件,它使用户能够在其 Windows 操作系统上运行任意数量的 Linux 发行版,而无需单独的虚拟机管理程序。 VS Code 支持 WSL 作为远程目标,因此您可以在 WSL 下为 Windows 运行 VS Code 并为 Linux 开发。 在 VS Code 中使用 WSL 首先需要安装 WSL。安装 WSL 后,您需要至少有一个可用的发行版。 在最新版本的 Windows 10 上安装 WSL 的最简单方法是打开命令提示符并运行: 该 在计算机上成功设置 WSL 后,您还需要为 VS Code安装Remote - WSL ( 如果您已经在 WSL 中有代码,请 如果您的代码已在 Windows 中签出,请 远程资源管理器将记住您配置的 WSL 目标,并让您从远程资源管理器视图中的WSL 目标下拉菜单中快速重新打开它们: 如果您想要一个可重现的环境,请考虑创建一个 VS Code 非常适合使用 Python 进行应用程序开发和 Web 开发。它还具有一组强大的扩展和工具,用于处理数据科学项目。 到目前为止,您主要介绍了 VS Code 的 Python 扩展。还有Jupyter Notebooks 扩展,它将 IPython 内核和笔记本编辑器集成到 VS Code 中。 安装 Jupyter Notebook 扩展 要在 VS Code 上开始使用 Jupyter Notebooks,您需要Jupyter 扩展 ( 注意: Jupyter Notebooks 支持现在与 Python 扩展捆绑在一起,所以如果您已经安装了它,请不要感到惊讶。 Jupyter Notebooks 支持 Python 的数据科学库通常需要用 C 和 C++ 编写的编译模块。 在 VS Code 中开始使用 Jupyter Notebook 在本例中,您将打开一系列关于波变换的 Jupyter Notebooks 。下载 repo 的 **注意:**本节的其余部分使用 在 VS Code 中,您可以使用任何现有 创建 安装依赖项后, 此选择会将您的 VS Code 设置为使用您 **注意:**如果 选择后,在 VS Code 中打开笔记本并单击右侧的选择内核按钮或 选择新 选择内核后,您可以运行任何或所有单元格并查看 VS Code 中显示的操作输出: 笔记本执行后,Jupyter 扩展将在Jupyter: Variables视图中提供任何中间变量,例如列表、NumPy 数组和 Pandas DataFrames: 您可以通过单击笔记本顶部的“*变量”*按钮或运行 对于更复杂的变量,选择图标以在数据查看器中打开数据。 使用数据查看器 Jupyter 扩展带有一个数据查看器,用于查看和过滤 2D 数组,例如列表、NumPy データ ビューアにアクセスするには、[データ ビューアで変数を表示] をクリックして、変数ビューで複雑な変数を展開します。このオプションは、複雑な変数を表す行の左側に表示されるアイコンで表されます。 データ ビューアは、大規模なデータ セットのインライン フィルタリングとページングをサポートします。 Matplotlib で大規模なデータセットをプロットする場合、Jupyter 拡張機能は SVG レンダリングの代わりに Matplotlib ウィジェットをサポートします。 Rainbow CSV 拡張機能の使用 CSV または TSV を使用してデータを入力している場合は、Rainbow CSV ( #各列は色付けされており、不足しているカンマをすぐに見つけることができます。コマンド パレットから **注:** この拡張機能を試すためのサンプル CSV ファイルを探している場合は、ニュージーランド政府の公式統計ページからダウンロードする CSV ファイルを選択できます。 Rainbow CSV 拡張機能には、Rainbow Query Language (RBQL) クエリ ツールも付属しており、CSV データに RBQL クエリを記述して、フィルタリングされたデータセットを作成できます。 コマンド パネルで このチュートリアルでは、VS Code 用のいくつかの便利な拡張機能をインストールしました。便利な拡張機能がたくさんあります。このチュートリアルの最後の部分では、これまで説明していない、試してみたい追加の拡張機能について学びます。 VS Code マーケットプレイスには何千もの拡張機能があります。拡張機能の選択には、言語サポート、テーマ、スペルチェック、さらにはミニゲームに至るまで、あらゆるものが含まれます。 このチュートリアルではこれまで、Visual Studio Code での Python 開発をより強力にする多数の拡張機能を紹介してきました。最後の 4 つの拡張機能はオプションですが、作業を容易にすることができます。 コード スペル チェッカー コード スペル チェッカー ( コード スペル チェッカー拡張機能は、スペル エラーの疑いがあるものを強調表示します。辞書内のスペルを修正したり、ユーザーまたはワークスペースの辞書に単語を追加したりできます。 ワークスペース ディクショナリはワークスペース フォルダーに配置されるため、Git にチェックインできます。ユーザー辞書はすべてのプロジェクトにわたって一定のままです。よく使うキーワードやフレーズがたくさんある場合は、ユーザー辞書に追加できます。 Docker Docker 拡張機能 ( Docker 拡張機能は、前に紹介した Remote - Containers 拡張機能を超えています。イメージ、ネットワーク、コンテナー レジストリ、ボリューム、コンテナーを管理するための UI を提供します。 Thunder クライアント Thunder クライアント ( Thunder クライアントでは、HTTP リクエストを作成して API に送信し、ヘッダーを操作し、テキスト、XML、および JSON のペイロードを設定できます。 # #Thunder Client は、VS Code で直接使用できるため、Postman やcurl に代わる優れた代替手段であり、REST API のテストおよび開発時にアプリケーション間の切り替えを回避できます。 VS Code Pets VS Code Pets ( ペットをカスタマイズしたり、ペットの環境をカスタマイズしたり、一緒にゲームをしたりできます。 **注:**このチュートリアルの作成者として、これは素晴らしい拡張機能だと言いますが、私が作成したため偏見があるかもしれません。 これは市場の拡大のほんの一部です。何千もの追加の言語サポート、UI の改善、さらには Spotify の統合もまだ見つかっていません。 Visual Studio Code の Python ツールは急速に進化しており、チームはバグ修正や新機能を含む更新プログラムを毎月リリースしています。環境を最新かつ最適な状態に保つために、新しい更新プログラムを必ずインストールしてください。 このチュートリアルでは、Visual Studio Code、Python、Jupyter の拡張機能、および追加の拡張機能のいくつかの高度な機能の概要を説明しました。 次の方法を学びました: #この知識を利用して、VS Code のパワー ユーザーになるための軌道に乗せることができます。 これらの拡張機能のいくつかを使用して、次のプロジェクトに取り組むときにテストしてください。 VS Code の一部の機能が他の機能よりも役立つ場合があります。いくつかのカスタマイズと拡張機能を理解したら、VS Code ドキュメントでさらに詳細を探したり、独自の拡張機能を作成したりすることさえできるかもしれません。 VSCode の詳細については、vscode チュートリアル をご覧ください。 ! 以上がVSCode でプログラムをフォーマットする方法を段階的に説明します。の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。"python.formatting.provider"
,其可设置为任何支持自动格式化的:"autopep8"
,"black"
或"yapf"
。settings.json
,您可以将格式化程序设置为在保存文件时自动运行。在 VS Code 配置中,您可以将编辑器设置配置为仅适用于某些文件类型,方法是将它们放在一个"[<file_type>]"
组中:...
"[python]": {
"editor.formatOnSave": true,
},
"[python]": {
...
"editor.codeActionsOnSave": {"source.organizeImports": true},
},
Python: Select Linter
在命令面板上运行来选择一个 linter 。您还可以在设置中启用一个或多个 linter。例如,要启用 Bandit 和 Pylint linters,请编辑您的settings.json
:...
"python.linting.enabled": true,
"python.linting.banditEnabled": true,
"python.linting.pylintEnabled": true,
settings.json
:...
"python.linting.lintOnSave": true,
在 Visual Studio Code 中测试 Python 代码
unittest
以及pytest
.Python: Configure Tests
从命令面板运行该命令。VS Code 将提示您从受支持的测试框架之一中进行选择,并指定包含您的测试的文件夹。.vscode/settings.json
:"python.testing.pytestEnabled": true,
"python.testing.pytestArgs": [
"tests"
],
python.testing.<framework>Args
使用首选的测试框架进行编辑以添加任何其他命令行标志。上面的示例显示了 pytest 的配置选项。pytest.ini
而不是 VS Code 设置放入。这样,您就可以使配置与任何自动化测试或CI/CD工具保持一致。Python: Run All Tests
从命令面板运行命令来执行测试。这将使用配置的参数启动测试运行器,并将测试输出放入Python 测试日志输出面板:使用 Visual Studio Code 任务系统
setup.py
文件来构建要在 PyPI 上分发的包,则可以使用任务系统自动构建源(Python)和二进制(编译的 Python)分发包。.vscode/tasks.json
文件中定义。要试用它,请创建.vscode/tasks.json
并复制此配置: 1{
2 "version": "2.0.0",
3 "tasks": [
4 {
5 "type": "shell",
6 "command": "${command:python.interpreterPath}",
7 "args": ["setup.py", "bdist_wheel", "sdist"],
8 "isBackground": true,
9 "options": {"cwd": "${workspaceFolder}"},
10 "label": "Build Wheel",
11 "group": {
12 "kind": "build",
13 "isDefault": true
14 }
15 }
16 ]
17}
shell
,它指定这应该在您配置的 shell 下运行。${command:python.interpreterPath}
,它是此环境的 Python 解释器的内置变量。这包括任何激活的虚拟环境。"options": {"cwd": "${workspaceFolder}"}
指定这应该在项目的根目录下运行。如果需要,您可以将其更改为子文件夹。"group"
被设置为"build"
,而这个任务将成为默认的工作,因为你设置"isDefault"
到true
。这意味着此任务将作为默认构建任务运行。Tasks: Run Build Task
从命令面板运行或使用内置键盘快捷键Cmd+F9或Ctrl+F9。在“*终端”*选项卡下,您可以找到构建命令的输出,该命令的输出名称为您指定的任何内容"label"
:manage.py
从命令行自动运行?您可以使用shell
类型创建任务。这样,您可以manage.py
使用要运行的 Django 子命令以及任何参数来执行:{
"version": "2.0.0",
"tasks": [
{
"type": "shell",
"command": "${command:python.interpreterPath}",
"args": ["manage.py", "makemigrations"],
"isBackground": true,
"options": {"cwd": "${workspaceFolder}"},
"label": "Make Migrations"
}
]
}
Tasks: Run Task
命令面板中的命令并从列表中选择Make Migrations任务。collectstatic
.tasks.json
.setup.py
例子,如果你想先建立自己的包的源代码分发,你可以添加以下任务tasks.json
:...
{
"type": "shell",
"command": "${command:python.interpreterPath}",
"args": ["setup.py", "sdist"],
"isBackground": true,
"options": {"cwd": "${workspaceFolder}"},
"label": "Build Source",
}
dependsOn
以及需要首先运行的任务标签列表:{
"version": "2.0.0",
"tasks": [
{
"type": "shell",
"command": "${command:python.interpreterPath}",
"args": ["setup.py", "bdist_wheel"],
"isBackground": true,
"options": {"cwd": "${workspaceFolder}"},
"label": "Build Wheel",
"group": {
"kind": "build",
"isDefault": true
},
"dependsOn": ["Build Source"]
}
]
}
"dependsOrder": "parallel"
到任务配置中。tox
与pip
并运行tox-quickstart
命令:$ python -m pip install tox
$ tox-quickstart
tasks.json
:{
"type": "shell",
"command": "tox",
"args": [],
"isBackground": false,
"options": {"cwd": "${workspaceFolder}"},
"label": "Run tox",
"group": {
"kind": "test",
"isDefault": true
}
}
Tasks: Run Test Task
命令面板运行此任务,该任务将使用终端选项卡中的输出执行 tox :spmeesseman.vscode-taskexplorer
)添加简单的用户界面控件运行您的预配置任务。安装后,任务资源管理器将成为资源管理器视图中的面板。它会扫描你的项目自动发现的任务npm
,make
,gulp
,和许多其他的构建工具。你可以在vscode组下找到你的任务:在 Visual Studio Code 中调试 Python 脚本
x == 3
var.upper()
.vscode/launch.json
. VS Code 的 Python 调试器可以启动任何启动配置并将调试器附加到它。uvicorn
启动FastAPI应用程序。通常,您可能只使用命令行:$ python -m uvicorn example_app.main:app
launch.json
:{
"configurations": [
{
"name": "Python: FastAPI",
"type": "python",
"request": "launch",
"module": "uvicorn",
"cwd": "${workspaceFolder}",
"args": [
"example_app.main:app"
],
}
]
}
"type"
配置设置为"python"
,它告诉 VS Code 使用 Python 调试器。您还设置"module"
指定要运行的 Python 模块,在本例中为"uvicorn"
. 您可以在 下提供任意数量的参数"args"
。如果您的应用程序需要环境变量,您也可以使用env
参数设置这些变量。.vscode/launch.json
文件中声明一个适当的 Python 解释器的显式路径作为一个选项: 1{
2 "configurations": [
3 {
4 "name": "Python: FastAPI",
5 "type": "python",
6 "python": "${workspaceFolder}/venv/bin/python",
7 "request": "launch",
8 "module": "uvicorn",
9 "cwd": "${workspaceFolder}",
10 "args": [
11 "example_app.main:app"
12 ],
13 }
14 ]
15}
"python"
。在此示例中,解释器位于venv
您在工作区文件夹的根目录下创建的 Python 虚拟环境中。如果您想使用不同的 Python 解释器,您可以通过编辑第 6 行中显示的路径来定义它的路径以适合您的设置。掌握远程开发
ms-vscode-remote.vscode-remote-extensionpack
) 提供。您需要安装此扩展包才能在 VS Code 中显示远程调试功能。.devcontainer/devcontainer.json
文件并将工作区作为远程容器打开Remote-Containers: Reopen in Container
命令并选择 Python 3 图像.devcontainer/devcontainer.json
与简单地打开容器相比,创建文件具有显着的优势:Remote-Containers: Reopen in Container
从命令面板运行命令。.devcontainer/devcontainer.json
基于Dockerfile
Python的泛型创建配置。Dockerfile
位于.devcontainer/
目录内。如果您的项目已经有一个Dockerfile
,您可以通过更改.devcontainer/devcontainer.json
..devcontainer/devcontainer.json
来指定:Dockerfile
python -m pip install <package>
,例如,.devcontainer/devcontainer.json
并取消注释指定的行"postCreateCommand"
:{
...
// Use 'postCreateCommand' to run commands after the Container is created.
"postCreateCommand": "python3 -m pip install -r requirements.txt",
}
devcontainer.json
参考。Dockerfile
或 devcontainer 规范进行更改后,通过右键单击正在运行的容器并选择Rebuild Container从远程资源管理器重建容器:Dockerfile
.Remote-SSH: Open SSH Configuration File
在命令面板中运行,您可以打开本地 SSH 配置文件。这是一个标准的SSH 配置文件,用于列出主机、端口和私钥的路径。该IdentityFile
选项默认为~/.ssh/id_rsa
,因此验证的最佳方式是私钥和公钥对。Host 192.168.86.30
HostName 192.168.86.30
User development
IdentityFile ~/path/to/rsa
Host Test-Box
HostName localhost
User vagrant
Port 2222
C:\> wsl --install
--install
命令执行以下操作:ms-vscode-remote.remote-wsl
)扩展。之后,您就可以在 Visual Studio Code 中使用 WSL。Remote-WSL: Open Folder in WSL
从 VS Code 中的命令面板运行。在 Linux 子系统中为您的代码选择目标目录。Remote-WSL: Reopen Folder in WSL
从命令面板运行。Dockerfile
而不是直接在 WSL 主机上工作。使用数据科学工具
ms-toolsai.jupyter
)。pip
作为包管理器,以及conda
来自Anaconda 发行版。conda
如果您使用大量第三方包,则应将其用作包管理器,因为 Anaconda 发行版已代表您解决了构建依赖项,从而更容易安装包。.zip/
文件夹并解压缩,或者克隆 GitHub repo并使用 VS Code 打开它。进一步描述的步骤也适用于包含.ipynb
笔记本文件的任何其他工作区。conda
包管理器。如果要使用本节中显示的命令,则需要安装 Anaconda。conda
环境。您可以conda
从终端为 VS Code创建一个专门的环境,而不是将包安装到基本环境中:$ conda create --name vscode python=3.8
conda
名为的环境后vscode
,您可以在其中安装一些常见的依赖项:$ conda install -n vscode -y numpy scipy pandas matplotlib ipython ipykernel ipympl
Python: Select Interpreter
从 VS Code 命令面板运行命令并搜索vscode
以选择新conda
环境:conda
环境中的 Python 解释器,vscode
.conda
环境在列表中不可用,您可能需要通过Developer: Reload Window
从命令面板运行命令来重新加载窗口。Notebook: Select Notebook Kernel
从命令面板运行命令。键入vscode
以选择conda
安装了依赖项的新创建的环境:conda
环境作为笔记本的内核将使您的笔记本能够访问您在该环境中安装的所有依赖项。这是执行代码单元所必需的。Jupyter: Focus on Variables View
命令来使该视图成为焦点。ndarray
和 Pandas DataFrames:mechatroner.rainbow - csv
の便利な拡張機能で、VS Code で CSV ファイルを開いて視覚化できるようになります。 Rainbow CSV: Align CSV Columns
コマンドを実行して、すべての列を整列することもできます。 Rainbow CSV: RBQL
を実行すると、RBQL コンソールにアクセスできます。クエリを実行すると、結果が一時 CSV ファイルとして新しいタブに表示され、保存してさらなるデータ分析作業に使用できます。 Visual Studio Code にボーナス拡張機能を追加する
streetsidesoftware.code-spell-checker
) は、次のスペル チェッカーです。変数名、文字列内のテキスト、および Python docstring のチェック: ms-azuretools.vscode-docker
) は簡単に作成、管理、および実行できます。コンテナー化されたアプリケーションのデバッグ: rangav.vscode-thunder-client
) は、VS Code の HTTP クライアントです。 REST API のテストを支援するために設計されたターミナルと UI。 Flask、FastAPI、Django Rest Framework などのフレームワークで API を開発およびテストしている場合は、すでに Postman やcurl などのツールを使用してアプリケーションをテストしている可能性があります。 tonybaloney.vscode-pets
) は、次のような興味深い拡張機能です。 VS Code ウィンドウに 1 つ以上の小さなペットを配置します: 結論