MyPy-PyCharm 开源项目教程

MyPy-PyCharm 开源项目教程

mypy-pycharmA plugin providing both real-time and on-demand scanning of Python files with Mypy from within PyCharm/IDEA.项目地址:https://gitcode.com/gh_mirrors/my/mypy-pycharm

1. 项目的目录结构及介绍

MyPy-PyCharm 项目的目录结构如下：

mypy-pycharm/
├── .github/
│   └── workflows/
│       └── ci.yml
├── .idea/
│   └── ...
├── mypy_pycharm/
│   ├── __init__.py
│   ├── __main__.py
│   ├── plugin.xml
│   └── resources/
│       └── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• .github/workflows/ci.yml: GitHub Actions 的持续集成配置文件。
• .idea/: PyCharm 的项目配置文件夹。
• mypy_pycharm/: 项目的主要代码文件夹。
  • __init__.py: 模块初始化文件。
  • __main__.py: 项目的启动文件。
  • plugin.xml: PyCharm 插件的配置文件。
  • resources/: 插件所需的资源文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的许可证文件。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目的安装脚本。

2. 项目的启动文件介绍

项目的启动文件是 mypy_pycharm/__main__.py。这个文件主要负责插件的初始化和启动。以下是该文件的主要内容：

import sys
from pathlib import Path
from mypy_pycharm import main

if __name__ == "__main__":
    sys.exit(main.run())

启动文件介绍

• import sys: 导入系统模块，用于处理系统相关的操作。
• from pathlib import Path: 导入路径处理模块，用于处理文件路径。
• from mypy_pycharm import main: 导入主模块，用于启动插件。
• if __name__ == "__main__":: 判断是否是主程序入口。
• sys.exit(main.run()): 调用主模块的 run 方法并退出程序。

3. 项目的配置文件介绍

项目的配置文件主要是 mypy_pycharm/plugin.xml。这个文件定义了 PyCharm 插件的配置信息。以下是该文件的主要内容：

<idea-plugin>
  <id>com.leinardi.pycharm.mypy</id>
  <name>MyPy</name>
  <version>1.0</version>
  <vendor email="roberto.leinardi@gmail.com" url="https://github.com/leinardi">Roberto Leinardi</vendor>
  <description><![CDATA[
    MyPy integration for PyCharm.
  ]]></description>
  <change-notes><![CDATA[
    Initial release.
  ]]></change-notes>
  <idea-version since-build="191"/>
  <depends>com.intellij.modules.python</depends>
  <extensions defaultExtensionNs="com.intellij">
    <configurationType implementation="com.leinardi.pycharm.mypy.MyPyConfigurationType"/>
    <inspectionToolProvider implementation="com.leinardi.pycharm.mypy.MyPyInspectionToolProvider"/>
  </extensions>
  <actions>
    <action id="com.leinardi.pycharm.mypy.MyPyAction" class="com.leinardi.pycharm.mypy.MyPyAction" text="Run MyPy" description="Run MyPy on the current file">
      <add-to-group group-id="CodeMenu" anchor="last"/>
    </action>
  </actions>
</idea-plugin>

配置文件介绍

• <idea-plugin>: 定义插件的根元素。
• <id>: 插件的唯一标识符。
• <name>: 插件的名称。
• <version>: 插件的版本号。
• <vendor>: 插件的作者信息。
• <description>: 插件的描述信息。
• <change-notes>: 插件的更新日志。
• `<idea-

mypy-pycharmA plugin providing both real-time and on-demand scanning of Python files with Mypy from within PyCharm/IDEA.项目地址:https://gitcode.com/gh_mirrors/my/mypy-pycharm