如何消除PyCharm中‘Expected type SupportsWrite[str], got TextIO instead’警告

这个警告是因为PyCharm的类型检查器认为open返回的TextIO对象和json.dump期望的SupportsWrite[str]类型不匹配——虽然代码能正常运行，但类型提示逻辑导致了黄色下划线。可以用以下几种方法解决：

方法一：显式指定文件编码 #

给open函数加上encoding="utf-8"参数，让PyCharm更准确地识别文件对象的类型，通常就能消除警告：

import json

class Account:
    """Creates a new account"""
    def __init__(self, name: str, account_no: int, pin: int, balance: float):
        self.name = name.capitalize()
        self.account_no = account_no
        self.pin = pin
        self.balance = balance
        self._update_ledger()
        
    def _update_ledger(self):
        # Gets the current ledgers
        with open("ledgers.json", "r", encoding="utf-8") as fp:
            customers = json.load(fp)
        # Updates the ledgers
        with open("ledgers.json", "w", encoding="utf-8") as fp:
            customers[self.name] = self.__dict__
            json.dump(customers, fp, indent=2)

方法二：用类型转换明确告知检查器 #

通过typing.cast强制转换类型，直接告诉PyCharm当前的文件对象符合json.dump的类型要求：

import json
from typing import SupportsWrite, cast

class Account:
    """Creates a new account"""
    def __init__(self, name: str, account_no: int, pin: int, balance: float):
        self.name = name.capitalize()
        self.account_no = account_no
        self.pin = pin
        self.balance = balance
        self._update_ledger()
        
    def _update_ledger(self):
        # Gets the current ledgers
        with open("ledgers.json", "r") as fp:
            customers = json.load(fp)
        # Updates the ledgers
        with open("ledgers.json", "w") as fp:
            customers[self.name] = self.__dict__
            json.dump(customers, cast(SupportsWrite[str], fp), indent=2)

方法三：更新PyCharm和类型库 #

有时候这个问题是因为PyCharm的类型定义文件或者typeshed库版本过旧，导致对json.dump的参数类型推断不准确。更新PyCharm到最新版本，或者更新相关的类型依赖库，就能自动解决这个警告。

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