Python中csv.DictReader.fieldnames类型及Pylance警告解决

具体场景 #

读取CSV文件表头时，使用csv.DictReader创建读取器，通过reader.fieldnames提取表头。已知CSV文件的表头是字符串列表，但Pylance提示该属性可能为None，引发类型提示冲突。

代码示例 #

import sys
import tabulate
import csv
import typing

def main() -> None:
    menu: list[list[str]] = list()
    
    try:
        file: typing.TextIO
        with open(sys.argv[1]) as file:
            reader: csv.DictReader = csv.DictReader(file)
            headings: list[str] = reader.fieldnames
            row: dict[str,str]
            for row in reader:
                menu.append([row[headings[0]],row[headings[1]],row[headings[2]]])            
    except IOError:
        sys.exit("CSV file does not exist")
    else:
        print(tabulate.tabulate(menu, headers=headings, tablefmt="grid"))

if __name__ == "__main__":
    main()

遇到的警告 #

• 给headings标注list[str]类型时：

  Expression of type "Sequence[Unknown] | None" cannot be assigned to declared type "list[str]"
  

• 不标注类型时：

  Object of type "None" is not subscriptable
  

需要解决该问题，而非忽略警告。

解决方案 #

1. 明确fieldnames的实际类型 #

根据Python标准库定义，csv.DictReader.fieldnames的类型是Sequence[str] | None。当CSV文件为空（无首行）或指定fieldnames参数但未读取文件时，该属性为None；正常读取有表头的文件后，它会是字符串序列（通常为list[str]）。

2. 类型校验+断言（推荐） #

既然确认CSV文件必有表头，可通过运行时检查排除None，再用类型断言告知Pylance具体类型：

import sys
import tabulate
import csv
import typing

def main() -> None:
    menu: list[list[str]] = list()
    
    try:
        with open(sys.argv[1]) as file:
            reader: csv.DictReader = csv.DictReader(file)
            headings = reader.fieldnames
            # 运行时检查，避免空文件导致的None
            if headings is None:
                sys.exit("CSV file has no header row")
            # 断言为list[str]，解决类型提示
            headings: list[str] = headings
            row: dict[str, str]
            for row in reader:
                menu.append([row[headings[0]], row[headings[1]], row[headings[2]]])            
    except IOError:
        sys.exit("CSV file does not exist")
    else:
        print(tabulate.tabulate(menu, headers=headings, tablefmt="grid"))

if __name__ == "__main__":
    main()

3. 条件分支推导类型 #

先标注headings为Sequence[str] | None，通过条件分支排除None后，Pylance会自动推导后续类型：

import sys
import tabulate
import csv
from typing import Sequence

def main() -> None:
    menu: list[list[str]] = list()
    
    try:
        with open(sys.argv[1]) as file:
            reader: csv.DictReader = csv.DictReader(file)
            headings: Sequence[str] | None = reader.fieldnames
            if headings is None:
                sys.exit("CSV file has no header row")
            # 进入分支后，Pylance识别headings为Sequence[str]
            row: dict[str, str]
            for row in reader:
                menu.append([row[headings[0]], row[headings[1]], row[headings[2]]])            
    except IOError:
        sys.exit("CSV file does not exist")
    else:
        print(tabulate.tabulate(menu, headers=headings, tablefmt="grid"))

if __name__ == "__main__":
    main()

4. 手动读取表头初始化DictReader #

手动读取首行作为表头，再传入DictReader的fieldnames参数，彻底避免None的可能：

import sys
import tabulate
import csv
import typing

def main() -> None:
    menu: list[list[str]] = list()
    
    try:
        with open(sys.argv[1]) as file:
            # 手动读取首行作为表头
            headings: list[str] = next(csv.reader(file))
            # 用已知表头初始化DictReader
            reader: csv.DictReader = csv.DictReader(file, fieldnames=headings)
            row: dict[str, str]
            for row in reader:
                menu.append([row[headings[0]], row[headings[1]], row[headings[2]]])            
    except IOError:
        sys.exit("CSV file does not exist")
    except StopIteration:
        sys.exit("CSV file is empty")
    else:
        print(tabulate.tabulate(menu, headers=headings, tablefmt="grid"))

if __name__ == "__main__":
    main()

内容的提问来源于stack exchange，提问作者Rohit Gupta