如何避免python中指针属性的类型暗示导致的循环依赖

Question

考虑这两个模块（在同一个文件夹中）：

首先是人。派克

from typing import List

from .pet import Pet


class Person:
    def __init__(self, name: str):
        self.name = name
        self.pets: List[Pet] = []
    
    def adopt_a_pet(self, pet_name: str):
        self.pets.append(Pet(pet_name, self))

然后pet.py

from .person import Person

    
class Pet:
    def __init__(self, name: str, owner: Person):
        self.name = name
        self.owner = owner

上面的代码将无法工作，因为循环依赖。你会得到一个错误：

ImportError: cannot import name 'Person'

让它工作的一些方法：

1. 将类Person和Pet的定义保存在同一个文件中

e、 g.只要有：

class Pet:
    def __init__(self, name: str, owner):

到目前为止，我在列出的所有选项中看到了一些缺点。

还有别的办法吗？一个允许我

• 将类拆分为不同的文件

或者：有没有很好的理由去遵循我已经列出的解决方案之一？

Answer 1

由于类型注释，我有一个类似的循环依赖错误用例。考虑下面的项目结构：

my_module  
|- __init__.py (empty file)
|- exceptions.py
|- helper.py

内容：

# exceptions.py
from .helper import log

class BaseException(Exception):
    def __init__(self):
        log(self)

class CustomException(BaseException):
    pass

# helper.py
import logging
from .exceptions import BaseException

def log(exception_obj: BaseException):
    logging.error('Exception of type {} occurred'.format(type(exception_obj)))

我使用类似于这里描述的技术解决了这个问题

现在，helper.py的更新内容如下：

# helper.py
import logging

def log(exception_obj: 'BaseException'):
    logging.error('Exception of type {} occurred'.format(type(exception_obj)))

请注意在exception_obj参数的类型注释中添加的引号。这帮助我安全地删除了导致循环依赖的导入语句。

注意：如果您使用的是IDE（比如PyCharm），您仍然可能会收到导入类的建议，IDE提示的类型将无法按预期工作。但是代码运行时没有任何问题。当您希望对代码进行注释以供其他开发人员理解时，这将非常有用。

Answer 2

在进一步学习之后，我意识到有一种正确的方法可以做到这一点：继承：

首先，我定义了Person，没有[宠物]或OP中的方法。然后我定义了宠物，拥有类Person。然后我定义

from typing import List
from .person import Person
from .pet import Pet


class PetOwner(Person):
    def __init__(self, name: str):
        super().__init__(name)
        self.pets = []  # type: List[Pet]


    def adopt_a_pet(self, pet_name: str):
        self.pets.append(Pet(pet_name))

所有需要参考Pet的方法现在都应该在PetOwner中定义，并且Pet中使用的所有方法/个人属性都需要亲自定义。如果需要在Pet中使用仅存在于PetOwner中的方法/属性，则应定义Pet的新子类，例如OwnedPet。

当然，如果这个名字让我不安，我可以从Person和PetOwner分别改为BasePerson和Person或类似的名字。

Answer 3

我最近遇到了类似的问题，用以下方法解决了：

import typing

if typing.TYPE_CHECKING:
    from .person import Person


class Pet:
    def __init__(self, name: str, owner: 'Person'):
        self.name = name
        self.owner = owner

这里描述了第二种解决方案，它需要Python

from __future__ import annotations  # <-- Additional import.
import typing

if typing.TYPE_CHECKING:
    from .person import Person


class Pet:
    def __init__(self, name: str, owner: Person):  # <-- No more quotes.
        self.name = name
        self.owner = owner

从Python3.10开始，不再需要导入\uuuuu future\uuuu。