Django/DRF模型循环依赖下，如何实现PyCharm类型提示与代码补全？

针对你遇到的Company类方法参数引用后续定义的User类导致PyCharm提示“Unresolved reference”的问题，有以下几种实用方案：

1. 使用字符串形式的前向引用 #

直接将类型提示用单引号或双引号包裹，Python 3.7及以上版本原生支持这种语法，IDE也能正确识别并提供代码补全：

class Company(models.Model):
    some_field = models.TextField()

    def some_method(self, user: 'User'):
        pass


class User(AbstractUser):
    company = models.ForeignKey(Company, on_delete=models.CASCADE)

如果需要让字符串类型提示在运行时也能被解析（比如用于类型检查工具），可以在文件顶部添加：

from __future__ import annotations

这个导入会延迟类型提示的解析，直到所有类都定义完成。

2. 调整类定义顺序并使用模型字符串引用 #

因为User类依赖Company，默认不能直接调换顺序，但可以把ForeignKey的目标模型改为字符串引用，这样就能将User放在Company之前定义，此时Company的方法里可以直接使用User类型提示：

class User(AbstractUser):
    # 用字符串引用尚未定义的Company
    company = models.ForeignKey('Company', on_delete=models.CASCADE)


class Company(models.Model):
    some_field = models.TextField()

    def some_method(self, user: User):
        pass

3. 使用typing.ForwardRef显式声明前向引用 #

从typing模块导入ForwardRef，显式声明要引用的后续类，这种方式更适合复杂的类型场景：

from typing import ForwardRef

class Company(models.Model):
    some_field = models.TextField()

    def some_method(self, user: ForwardRef('User')):
        pass


class User(AbstractUser):
    company = models.ForeignKey(Company, on_delete=models.CASCADE)

以上方案都能解决IDE的类型提示错误，同时不影响代码运行，推荐第一种字符串形式的前向引用，简洁且兼容性好。

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