Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Welcome to Software Development on Codidact!

Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.

Post History

77%
+5 −0
Q&A How can I properly type-hint methods in different files that would lead to circular imports?

I am writing a Python package where I have two classes in different files that (indirectly) depend on each other. If I wouldn't care about type-hints, there would be no problem, but unfortunately,...

2 answers  ·  posted 1y ago by mr Tsjolder‭  ·  edited 1y ago by Alexei‭

#2: Post edited by user avatar Alexei‭ · 2023-08-24T06:19:52Z (about 1 year ago)
added relevant tag
#1: Initial revision by user avatar mr Tsjolder‭ · 2023-08-20T05:41:36Z (about 1 year ago)
How can I properly type-hint methods in different files that would lead to circular imports?
I am writing a Python package where I have two classes in different files that (indirectly) depend on each other.
If I wouldn't care about type-hints, there would be no problem, but unfortunately, I do like static type-hinting.
Therefore, I need one class for typing the methods of the other and vice versa.
Of course, this leads to a circular import, but using [forward references](https://peps.python.org/pep-0484/#forward-references), I managed to arrive at the following code:

```python
# process.py

from helpers import Helper

class Process:

    def do_something(self, helper: Helper):
        ...
```

```python
# helpers.py

class Helper:
    
    def update(self, process: "Process"):
        ...
```

This code runs without problems, but when running `mypy`, it complains that `Name "Process" is not defined`.
I know I could [silence these errors](https://mypy.readthedocs.io/en/stable/common_issues.html#spurious-errors-and-locally-silencing-the-checker), but I was wondering whether there is a "proper" way to fix the type-hinting in this case.