[Python/ERROR] Circular import (Runtime과 Import Time의 차이점)

에러메시지

ImportError: cannot import name 'db' from partially initialized module 'app' (most likely due to a circular import)

해당 에러는 모듈 간에 서로를 "상호 참조"할 때 발생한다.
새로운 모듈을 import 해줄 때 꼬이면 해당 에러가 발생한다.

 

 

---

나의 경우 Flask 프레임워크를 이용해서 아래와 같은 폴더 구조로 개발하다가 위의 에러를 만나게 되었다. (아래 폴더구조는 단순화한 것임)

app/
├── __init__.py
├── models.py
├── routers.py
├── config.py
└── run.py
app.py

 

1. __init__.py와 models.py와 app.py 파일을 각각 자세히 살펴보자.

# __init__.py

from flask import Flask
from config import Config
from flask_sqlalchemy import SQLAlchemy
from app.models import app

db = SQLAlchemy()

def create_app(config_class=Config):     
    app.config['SQLALCHEMY_DATABASE_URI'] = Config.SQLALCHEMY_DATABASE_URI
    app.secret_key = Config.SECRET_KEY

    db.init_app(app)
    
    from app.views import main
    app.register_blueprint(main.bp)

    return app

# models.py

from flask import Flask
from app import db
from datetime import datetime

app = Flask(__name__)

class User(db.Model):
    __tablename__ = 'user'

    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(20), nullable=False)
    email = db.Column(db.String(255), nullable=False)
    password = db.Column(db.String(255), nullable=False)

...

# 파일이 직접 실행될 때만 데이터베이스 테이블을 생성하도록 한다. (실제 application에서는 제거)
if __name__ == "__main__":
    with app.app_context():
        db.create_all()

# app.py

from app import create_app
from app import db
from config import Config

app = create_app(config_class=Config)

if __name__ == '__main__':
    app.run(debug=True, port=8000)

 

2. 살펴보면 models.py와 app폴더 안의 __init__.py 파일이 서로를 참조하고 있는 것을 볼 수 있다.

__init__.py의 from app.models import app ↔️ models.py의 from app import db

(꼭 필요한 부분만 보자면 아래와 같다)

# __init__.py

from flask import Flask
from config import Config
from flask_sqlalchemy import SQLAlchemy
from app.models import app  # 여기

db = SQLAlchemy()

def create_app(config_class=Config):     
    app.config['SQLALCHEMY_DATABASE_URI'] = Config.SQLALCHEMY_DATABASE_URI
    app.secret_key = Config.SECRET_KEY

    db.init_app(app)

    return app

# models.py

from flask import Flask
from app import db  # 여기

app = Flask(__name__)

if __name__ == "__main__":
    with app.app_context():
        db.create_all()

 

3. 아래와 같이 참조하는 코드들을 바꿔주었다.

# __init__.py

from flask import Flask
from config import Config
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

def create_app(config_class=Config): 
    app = Flask(__name__)  # 여기
    
    app.config['SQLALCHEMY_DATABASE_URI'] = Config.SQLALCHEMY_DATABASE_URI
    app.secret_key = Config.SECRET_KEY
    
    db.init_app(app)
    
    from app.views import main
    app.register_blueprint(main.bp)

    return app

- models.py에 있던 app = Flask(__name__) 인스턴스 생성 구문을 __init__.py의 create_app() 메서드 안에 지역 인스턴스로 생성

# models.py

from flask import Flask
from app import db
from datetime import datetime

class User(db.Model):
    __tablename__ = 'user'

    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(20), nullable=False)
    email = db.Column(db.String(255), nullable=False)
    password = db.Column(db.String(255), nullable=False)

# app.py

from app import create_app
from app import db
from config import Config

app = create_app(config_class=Config)

if __name__ == '__main__':
    with app.app_context():
        db.create_all()
    app.run(debug=True, port=8088)

- models.py에 있는 if문을 app.py 파일의 if문 안에 추가

 

 

위와 같이 바꿔줌으로써 에러를 해결하였다.

 

---

이러한 에러가 왜 발생했는지 알아보자

python에서는 코드의 실행 시점과 모듈을 임포트하는 시점이 분리되어 있기 때문이다.

그래서 모듈 간의 순환 참조 문제가 발생하게 되는 것이다.

(python은 상호참조되는 모듈 내부의 코드를 순차적으로 실행하기 때문에, 하나의 모듈이 임포트할 때 해당 모듈 내부에서 다른 모듈을 참조하고, 그 다른 모듈에서 다시 처음 모듈을 참조하는 식으로 순환 참조 발생하게 된 것)

 

• Runtime: 모듈을 임포트한 후 해당 모듈 내의 클래스나 함수를 실제로 사용하는 시점. 이때 클래스나 함수의 본문이 실행되며 코드가 실제로 동작한다.
• Import Time: Python은 모듈을 임포트할 때 해당 모듈의 코드를 파싱한다. 이때 모듈 내부의 클래스, 함수, 변수 등이 정의되고 실행된다. 즉 모듈이 임포트되는 시점에서는 클래스나 함수의 실제 실행은 발생하지 않고, 단순히 코드만 분석된 후 실제 실행은 미루어진다.

 

이러한 문제를 해결하기 위한 방법으로는 프로젝트 구조에 따라 그때마다 달라지겠지만, 

결국 임포트 시점과 실행 시점을 적절하게 조율하는 것으로 해결할 수 있다.

 

 

 

 

[참고 링크]

https://blog.mathpresso.com/python-circular-imports-e89c5bf16510

https://mapadubak.tistory.com/82

https://flask.palletsprojects.com/en/2.3.x/api