Circular import of db reference using Flask-SQLAlchemy and Blueprints

by

I fixed the problem with the help of the Application Factory pattern. I declare the database in a third module and configure it later in the same module in which I start the application.

This results in the following imports:

  • database.py → app.py
  • views.py → app.py
  • database.py → views.py

There is no circular import. It is important to make sure that the application was started and configured before calling database operations.

Here is an example application:

app.py

from database import db
from flask import Flask
import os.path
from views import User
from views import people


def create_app():
    app = Flask(__name__)
    app.config['DEBUG'] = True
    app.config['SQLALCHEMY_DATABASE_URI'] = "sqlite:////tmp/test.db"
    db.init_app(app)    
    app.register_blueprint(people, url_prefix='')
    return app 


def setup_database(app):
    with app.app_context():
        db.create_all()
    user = User()
    user.username = "Tom"
    db.session.add(user)
    db.session.commit()    


if __name__ == '__main__':
    app = create_app()
    # Because this is just a demonstration we set up the database like this.
    if not os.path.isfile('/tmp/test.db'):
      setup_database(app)
    app.run()

database.py

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

views.py

from database import db
from flask.blueprints import Blueprint


people = Blueprint('people', __name__,
                 template_folder="templates",
                 static_folder="static")


class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), unique=True)


@people.route("https://stackoverflow.com/")
def test():
  user = User.query.filter_by(username="Tom").first()
  return "Test: Username %s " % user.username

More Related Contents:

  1. How to execute raw SQL in Flask-SQLAlchemy app
  2. jsonify a SQLAlchemy result set in Flask [duplicate]
  3. Flask-SQLAlchemy import/context issue
  4. How to build a flask application around an already existing database?
  5. Flask Download a File
  6. Implementing Flask-Login with multiple User Classes
  7. Flask sqlalchemy many-to-many insert data
  8. How to delete a record by id in Flask-SQLAlchemy
  9. Is a SQLAlchemy query vulnerable to injection attacks?
  10. Flask-SQLAlchemy db.create_all() raises RuntimeError working outside of application context
  11. Get inserted key before commit session
  12. Querying with function on Flask-SQLAlchemy model gives BaseQuery object is not callable error
  13. AttributeError: ‘int’ object has no attribute ‘_sa_instance_state’
  14. ImportError: No module named flaskext.sqlalchemy
  15. Getting first row from sqlalchemy
  16. flask-sqlalchemy or sqlalchemy
  17. Flask-SQLAlchemy Constructor
  18. sqlalchemy.exc.OperationalError: (sqlite3.OperationalError) no such table
  19. Flask, SQLAlchemy : KeyError: ‘SQLALCHEMY_TRACK_MODIFICATIONS’
  20. Tyring to set up modelview with Flask-Admin causes ImportError
  21. SQLAlchemy ordering by count on a many to many relationship
  22. flask sqlalchemy query with keyword as variable
  23. How many concurrent requests does a single Flask process receive?
  24. Why does the session cookie work when serving from a domain but not when using an IP?
  25. Running a Dash app within a Flask app
  26. Debugging a Flask app running in Gunicorn
  27. How to schedule a function to run every hour on Flask?
  28. Clear valid form after it is submitted
  29. Python Flask, TypeError: ‘dict’ object is not callable
  30. How to use g.user global in flask

Leave a Comment