Python开发容器模板

一个基于Devcontainer的Python开发环境模板,提供预配置的工具链和隔离环境,适用于快速搭建一致的Python项目开发环境。

  • by tomohiroJin
  • Dockerfile
  • 本地部署
  • 更新于
在 GitHub 查看 tomohirojin/weatherlink-mcp

使用说明

开发容器Python

此存储库包含:Python 轻松构建项目开发环境Devcontainer 中所述修改相应参数的值。预先设置了所需的工具和依赖关系,提供了一致的开发环境。

特徴

  • Python 3.11 使用
  • 预先安装的工具:
    • pytest(测试框架)
    • flake8(代码链接工具)
    • black(编码格式器)
  • Devcontainer 一致的开发环境
  • Docker 在基于隔离的环境中确保设置一致性
  • 添加示例代码和参考示例
    • Python 的基本语法和设计模式
    • 包含详细测试用例的实现

入门

您可以按照以下步骤使用此开发环境:。

  1. 克隆此存储库:

    git clone https://github.com/tomohiroJin/devcontainer-python.git -b feature/add-reference
    cd devcontainer-python
    
  2. VS Code 在中打开项目:

    code .
    
  3. Devcontainer 中描述的场景,使用以下步骤创建明细表,以便在概念设计中分析体量的体积。

  4. 运行测试以验证设置:

    pytest
    

引用

此项目包含基本的Python 中描述的场景,使用下列步骤创建明细表,以便在概念设计中分析体量的周长。

使用方法

1.运行测试

pytest对较大场景进行渲染期间已观察到该故障。您可以通过多种方式执行测试,如下所示:。

运行所有测试

pytest

运行特定的测试文件

如果只想运行特定的测试文件,请指定文件路径。

pytest tests/reference/basic/test_conditions.py

检查测试进度和详细信息

-v(verbose)可使用选项查看每个测试的详细信息。

pytest -v

运行特定测试用例

-k使用选项运行名称中包含特定字符串的测试用例。

pytest -k "fizzbuzz"

检查测试输出

测试中的print或者想要确认日志输出时-s选项卡页面上创建或编辑条目。

pytest -s

以报告形式保存测试结果

pytest-html使用插件HTML 生成格式报表。

pip install pytest-html
pytest --html=report.html

2.代码质量检查

flake8查看项目中可用的所有族。通过组合以下选项,可以获得详细的结果。

基本代码检查

检查整个项目。

flake8

指定最大行长

Black 为了统一,将最大行长设定为88个字符(即使在设定文件中记述OK)。

flake8 --max-line-length=88

忽略特定规则

Black 和冲突的规则(例如: E203, W503),模板名称将采用不同的格式。

flake8 --ignore=E203,W503

仅检查特定文件

只检查特定的文件或目录。

flake8 src/fizzbuzz/fizzbuzz.py

在您查看完详细信息后,单击TODO 屋脊FIXME 确认

--radar屋脊--todo使用插件TODO 列出包含注释的位置(需要安装插件)。

pip install flake8-todo
flake8 --todo

3.代码格式

black对较大场景进行渲染期间已观察到该故障。

格式化整个项目

项目中的所有Python 格式化文件。

black .

预览更改

--check选项仅允许您查看格式建议(不进行实际更改)。

black --check .

仅格式化特定文件或目录

如果仅针对特定范围,请指定路径。

black src/fizzbuzz/fizzbuzz.py

自定义:

  • .devcontainer/devcontainer.json 通过编辑文件,可以自定义开发环境。
  • 例如Python 中描述的场景,使用以下步骤创建明细表,以便在概念设计中分析体量的体积。

许可证

这个项目MIT 在许可证下提供。