python代码中的特殊注释
python代码中的特殊注释
**
# noqa**：- 用法：
some_code = "example" # noqa - 功能：告诉
flake8等工具忽略当前行的所有警告。
- 用法：
**
# type: ignore**：- 用法：
import some_module # type: ignore - 功能：告诉
mypy等类型检查器忽略当前行的类型检查警告。
- 用法：
**
# pylint: disable=some-message**：- 用法：
some_code = "example" # pylint: disable=unused-variable - 功能：告诉
pylint工具忽略特定的警告消息（例如未使用的变量）。
- 用法：
**
# isort: skip**：- 用法：
import some_module # isort: skip - 功能：告诉
isort工具在自动排序导入语句时跳过当前行。
- 用法：
# fmt: off和 **# fmt: on**：- 用法：
1
2
3# fmt: off
some_code = "example"
# fmt: on - 功能：告诉
black等代码格式化工具在# fmt: off和# fmt: on之间的代码不要进行格式化。
- 用法：
**
# todo**：- 用法：
# todo: implement this function - 功能：标记待办事项，一些编辑器或工具可能会识别它以列出待办事项。
- 用法：
**
# fixme**：- 用法：
# fixme: handle this exception properly - 功能：标记需要修复的问题。
- 用法：
**
# ruff: ignore**：- 用法：
some_code = "example" # ruff: ignore - 功能：告诉
ruff工具忽略当前行的警告。
- 用法：
# type: Any或其他类型注释：- 用法：
def my_function(param: Any) -> None: pass # type: (Any) -> None - 功能：用于类型注释，告诉类型检查器某个变量或函数的返回类型。
- 用法：
# coding: utf-8或其他编码声明：- 用法：
# coding: utf-8 - 功能：指定文件的编码格式，通常放在文件的第一行或第二行。
- 用法：
**
# mypy: ignore-errors**：- 用法：
# mypy: ignore-errors - 功能：告诉
mypy忽略文件中的所有类型错误。
- 用法：
**
# mypy: strict**：- 用法：
# mypy: strict - 功能：告诉
mypy对文件进行严格类型检查。
- 用法：
**
# pragma: no cover**：- 用法：
def my_function(): # pragma: no cover - 功能：告诉代码覆盖率工具（如
coverage.py）忽略这一行代码。
- 用法：
**
# jshint ignore:line**：- 用法：
var myVar = 'value'; // jshint ignore:line - 功能：告诉
JSHint工具忽略当前行的警告（虽然这是针对JavaScript的，但一些Python工具可能也有类似的约定）。
- 用法：
# isort: off和 **# isort: on**：- 用法：
1
2
3# isort: off
import some_module
# isort: on - 功能：告诉
isort工具在# isort: off和# isort: on之间的代码不要进行导入排序。
- 用法：
**
# type: ignore[attr-defined]**：- 用法：
obj.attr # type: ignore[attr-defined] - 功能：告诉
mypy等类型检查器忽略特定的属性定义警告。
- 用法：
**
# type: ignore[misc]**：- 用法：
some_code # type: ignore[misc] - 功能：告诉
mypy等类型检查器忽略特定的杂项警告。
- 用法：
**
# cython: language_level=3**：- 用法：
# cython: language_level=3 - 功能：告诉Cython编译器使用Python 3的语言级别。
- 用法：
**
# flake8: noqa**：- 用法：
# flake8: noqa - 功能：告诉
flake8工具忽略当前文件的所有警告（通常放在文件的顶部）。
- 用法：
**
# check-arg-names: false**：- 用法：
def my_function(a, b): # check-arg-names: false - 功能：告诉某些代码分析工具忽略参数名称检查。
- 用法：
这些注释通常用于控制代码分析工具的行为，帮助开发者在特定情况下避免不必要的警告或错误。使用这些注释时，应确保它们的目的是明确的，并且不会隐藏代码中的实际问题。
哪些跟编辑器绑定的特殊注释
有一些注释或标记是与特定编辑器或IDE绑定的，用于控制编辑器的行为，如代码折叠、任务列表、代码分析等。以下是一些常见的与编辑器绑定的注释：
**
# region和# endregion**：- 用于定义代码折叠区域。
- 示例：
1
2
3
4# region My Region
def my_function():
print("Hello, World!")
# endregion
**
# todo、# fixme、# note、# hack**：- 这些注释用于标记待办事项、需要修复的问题、重要说明或临时解决方案，一些编辑器会自动识别这些标记并提供任务列表视图。
- 示例：
1
2
3
4# todo: implement this function
# fixme: handle this exception properly
# note: this is a workaround for a known issue
# hack: temporary solution until a better approach is found
# pylint: disable和 **# pylint: enable**：- 用于在特定代码块中禁用或启用
pylint的特定警告。 - 示例：
1
2
3# pylint: disable=unused-variable
some_unused_variable = 42
# pylint: enable=unused-variable
- 用于在特定代码块中禁用或启用
**
# type: ignore**：- 用于告诉类型检查器（如
mypy）忽略特定行的类型错误。 - 示例：
1
import some_module # type: ignore
- 用于告诉类型检查器（如
**
# isort: skip_file**：- 用于告诉
isort工具忽略整个文件的导入排序。 - 示例：
1
2
3# isort: skip_file
import b
import a
- 用于告诉
# fmt: off和 **# fmt: on**：- 用于告诉代码格式化工具（如
black）在特定代码块中禁用格式化。 - 示例：
1
2
3# fmt: off
some_code = "example"
# fmt: on
- 用于告诉代码格式化工具（如
**
# noinspection**：- 用于告诉IDE（如PyCharm）忽略特定的代码检查。
- 示例：
1
2# noinspection PyUnresolvedReferences
import some_module
**
# mypy: ignore-errors**：- 用于告诉
mypy忽略整个文件的类型错误。 - 示例：
1
# mypy: ignore-errors
- 用于告诉
这些注释通常由特定的编辑器或IDE解释，并用于控制编辑器的行为或提供额外的信息。使用这些注释时，应确保了解它们的用途和影响，并且不会隐藏代码中的实际问题。
本博客所有文章除特别声明外，均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源 念念不忘，必有回响！
相关推荐
2025-02-15
python库parse的使用
深入浅出解析 Python parse 库的使用parse 是 Python 中一个强大的字符串解析库，它能够根据指定的格式从字符串中提取出所需的数据。与 Python 内置的字符串格式化功能（如 str.format()）相反，parse 库的作用是从格式化字符串中反向提取数据。 1. 安装 parse 库在开始使用 parse 库之前，需要先安装它。可以通过以下命令安装： 1pip install parse 2. 基本用法parse 库的核心功能是通过 parse() 函数从字符串中提取数据。其基本语法如下： 123from parse import parseresult = parse(format_string, input_string) format_string：格式化字符串，用于定义提取数据的模式。 input_string：需要解析的输入字符串。 result：解析结果，返回一个 Result 对象。如果解析失败，返回 None。 示例 1：提取简单数据1234from parse import parseresult =...
2022-05-08
python类型注释
我找到一些来自于官方的关于python类型注释的资源，我将其复制下来，用于个人收藏。良好的类型注释习惯能让代码的可读性大大增强，同时也能够保证后续加入的人员能够快速理解与使用。 变量Python 3.6 在 PEP 526 中引入了用于注释变量的语法，我们在大多数示例中都使用它。 123456789101112# This is how you declare the type of a variable type in Python 3.6age: int = 1# You don't need to initialize a variable to annotate ita: int # Ok (no value at runtime until assigned)# The latter is useful in conditional brancheschild: boolif age < 18: child = Trueelse: child =...
2025-02-15
decouple库介绍
python-decouple：简化配置管理的利器在现代软件开发中，合理地管理配置文件是确保项目安全性和可维护性的关键。python-decouple是一个强大的库，它帮助开发者将配置信息从代码中分离出来，使得项目更加灵活和安全。 安装安装python-decouple非常简单，只需一条pip命令： 1pip install python-decouple 核心特性 简化配置管理：通过简单易用的API，方便开发者管理配置信息。 解耦配置与代码：避免硬编码配置，提高代码的可维护性。 支持多种文件格式：支持读取和解析多种配置文件格式，如.env、.ini、.yaml等。 增强安全性：安全地存储敏感信息，如密码、API密钥等。 基本用法创建配置文件在项目根目录下创建一个.env文件，示例如下： 1234#...
2022-10-16
分类
常见的机器学习分类有，支持向量机、决策树、KNN、朴素贝叶斯，以前在学习机器学习的时候就简单学过，现在需要用在图像分类上了。一时间蒙了，忘记怎么图像转以前的数据了，现在在GitHub上找到一个不错的例子，特此记录一下。 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126import osimport cv2import numpy as npfrom sklearn.model_selection import train_test_splitfrom sklearn.metrics import...
2022-09-06
不常见的python类型校验
以前写过关于python类型校验的相关总结，但是不怎么全面，有些不常见的特殊情况并未被记录。 任意类型any若声明某函数时指定函数传入参数的数据类型为any，则调用该函数时该参数的参数类型可以为任意类型。 1234def demo(name: any, age: 'int > 0' = 20) -> str: # ->str 表示该函数的返回值是str类型的 print(name, type(name)) print(age, type(age)) return "hello world" 类型别名1234567# 给List[float]类型取个别名为VectorVector = List[float]def scale(scalar: float, vector: Vector) -> Vector: return [scalar * num for num in vector]new_vector = scale(2.0, [1.0, -4.2,...
2022-08-11
conda那些命令
命令 创建虚拟环境 ： conda create --name my_first_env python=3.6 列出虚拟环境 ： conda env list 激活虚拟环境 ： conda activate my_first_env 查看环境信息 ： conda info -e 根据路径激活虚拟环境 ： conda source /root/python/bin/activate 推出虚拟环境 ： conda deactivate 删除虚拟环境 ： conda remove -n your_env_name --all 创建时候安装需要的包 ： conda create -n env_name numpy matplotlib python=2.7 在离线的时候创建虚拟环境 ： conda create -n env_name --offline python=3.8 环境复制 ： conda create --name new_env_name --clone old_env_name 查看所有包 : conda list conda...
