I tried to set up multiple Dash Apps inside a Flask App and use Flask Babel.
from flask import Flask, request
from flask_babel import Babel, gettext
from werkzeug.middleware.dispatcher import DispatcherMiddleware
def init_app():
"""Construct core Flask application."""
app = Flask(__name__, instance_relative_config=False)
app.config.from_object("config.Config")
babel = Babel(app)
#babel.localeselector
def get_locale():
return request.accept_languages.best_match(app.config["LANGUAGES"])
with app.app_context():
# Import parts of our core Flask app
from . import routes
from .plotly.sec import init_dashboard_sec
from .plotly.bafin import init_dashboard_bafin
# app = init_dashboard(app)
app = DispatcherMiddleware(app, {
"/s": init_dashboard_sec(app),
"/b": init_dashboard_bafin(app)
})
return app
However, since I added the babel decorated function I get the following error:
RuntimeError: Working outside of request context.
This typically means that you attempted to use functionality that needed
an active HTTP request. Consult the documentation on testing for
information about how to avoid this problem.
I tried to move the function to a different position but the error stayed the same.
I don't know if it is the correct solution but the following is working:
from flask import Flask, request
from flask_babel import Babel, gettext
from werkzeug.middleware.dispatcher import DispatcherMiddleware
def init_app():
"""Construct core Flask application."""
app = Flask(__name__, instance_relative_config=False)
app.config.from_object("config.Config")
babel = Babel(app)
with app.app_context():
# Import parts of our core Flask app
from . import routes
from .plotly.sec import init_dashboard_sec
from .plotly.bafin import init_dashboard_bafin
# app = init_dashboard(app)
app = DispatcherMiddleware(app, {
"/s": init_dashboard_sec(app),
"/b": init_dashboard_bafin(app)
})
#babel.localeselector
def get_locale():
return request.accept_languages.best_match(["de", "en"])
return app
So babel gets initialized outside of the app context but the localselector is inside the context. For me it does not make much sense since the localeselector is still out of a request context but its working.
if you are probably working on the the terminal testing stuff out and you get the error just do this
from your_app import create_app
app = create_app()
with app.test_request_context(
'/make_report/2017', data={'format': 'short'}):
##do something here
for more information you can vist this part of the docs to learn more https://flask.palletsprojects.com/en/2.1.x/reqcontext/
I'm trying to test my database how it behaves in a many-to-many relationships. I'm struggling to access the application context of the Flask app.
I ran the Python terminal in the parent folder of the app and followed the steps found on SO and elsewhere. I could manage (i think) to import the app, create it, push the context, import the db. However, whenever I want to import models I'm prompted with a:
Error ModuleNotFoundError: No module named 'db'
Despite the fact that db is definately defined:
This is the screenshot of the complete process.
The folder structure is:
- app
--__int__.py
This is the app/init.py file:
from flask import Flask,Blueprint
from flask_sqlalchemy import SQLAlchemy
from app.config import Config
from mailjet_rest import Client
db = SQLAlchemy()
mailjet = Client(auth=(Config.MJ_APIKEY_PUBLIC, Config.MJ_APIKEY_PRIVATE), version='v3.1')
def create_app(config_class=Config):
app = Flask(__name__)
app.config.from_object(Config)
db.init_app(app)
from app.views.users import users
from app.views.data import data
from app.views.admin import admin
app.register_blueprint(users,url_prefix='/users')
app.register_blueprint(data,url_prefix='/data')
app.register_blueprint(admin,url_prefix='/admin')
# with app.app_context():
# db.create_all()
return app
I'd greatly appreciate any input!
Thank you,
Matija
The solution was quite simple. I ought to import models from app.models and not from db.
The steps I took:
Rename the folder to app
Ran Flask shell command on the app level
Imported app
Import models from app.models
I am calling a module inside urbancloth package from home.py
This runs the __init__ file but doesn't run another module present in urbancloth.
The directory structure is as follows -
The code in home.py:
from urbancloth import app
if __name__ == '__main__':
app.run(debug =True)
The code in __init__.py:
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
app = Flask(__name__)
app.config['SECRET_KEY'] = 'b0fe7021532f0541f87226aafd71ec77'
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///site.db'
db = SQLAlchemy(app)
from urbancloth import routes
and the error message is-
I am following Sir CoreySchafers Flask tutorials
Github for original code
If you will look at you error closely
from urabncloth import app
Looking at your directory there is no urabncloth it is urbancloth. Just a typo. So in your routes.py change the package name.
Hope this solves your problem!!!
My flask app is based on Miguel Grinberg's mega tutorial XIV with some extra stuff and it was all working fine and could be accessed from browser on localhost:5000. I decided to switch to an application factory approach as per Grinberg's XV tutorial BUT with no blueprints. Now when I enter localhost:5000 I get a URL not found. I am guessing my routes.py is not being picked up for some reason.
I have thoroughly worked through Grinberg's XV tutorial and the associated code and aligned everything less blueprints. These are the links I have explored that I have based my current app on: -
https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-xv-a-better-application-structure
http://flask.pocoo.org/docs/1.0/tutorial/factory/
Dave W Smith's answer in Configure Python Flask App to use "create_app" factory and use database in model class
and others.
From what I have read implementing an application factory should be really simple. The examples work.
The flask server starts from the command prompt in a venv as always.
Here is my directory structure.
myapp
app.py
config.py
...
/app
__init__.py
routes.py
models.py
forms.py
...
Here is the code slightly simplified for clarity.
# app.py
#=============================================
from app import create_app, db
from app.models import User, Post
app = create_app()
#app.shell_context_processor
def make_shell_context():
return {'db': db, 'User': User, 'Post' :Post}
# __init__.py
#=============================================
...
import os
from flask import Flask, request, current_app
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate
...
from config import Config
db = SQLAlchemy()
migrate = Migrate()
...
def create_app(config_class=Config):
app = Flask(__name__)
app.config.from_object(config_class)
db.init_app(app)
migrate.init_app(app, db)
...
# logging, email servers, etc configured
return app
from app import models
# routes.py
#=============================================
from datetime import datetime
from flask import render_template, flash, redirect, url_for, request, g, \
jsonify, current_app
...
from app import app, db
from app.forms import LoginForm, RegistrationForm, EditProfileForm,
PostForm,ResetPassword,RequestForm, ResetPasswordForm
from app.models import User, Post
...
#app.route('/', methods=['GET', 'POST'])
#app.route('/index', methods=['GET', 'POST'])
#login_required
def index():
form = PostForm()
if form.validate_on_submit():
...
page = request.args.get('page', 1, type=int)
...
return render_template('index.html', title=_('Home'), form=form,
posts=posts.items, next_url=next_url,
prev_url=prev_url)
#app.route ....
# models.py
#=============================================
from datetime import datetime
from hashlib import md5
from time import time
from flask import current_app
from flask_login import UserMixin
from werkzeug.security import generate_password_hash, check_password_hash
import jwt
from app import db, login
class User(UserMixin, db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(64), index=True, unique=True)
...
This may be irrelevant but it is one thing I tried. Note in routes.py that I have from app import app, db, if I remove app and add from flask import current_app then the #app decorators show as undefined.
Another point, because its a problem with routes. If I change the last line of __init__.py to from app import routes, models I get a different error.
flask.cli.NoAppException
flask.cli.NoAppException: While importing "metapplica", an ImportError was raised:
Traceback (most recent call last):
File "c:\users\markko~1\dropbox\python\projects\metapp~1\venv\lib\site-packages\flask\cli.py", line 236, in locate_app
__import__(module_name)
File "C:\Users\Mark Kortink\Dropbox\Python\projects\metapplica\metapplica.py", line 1, in <module>
from app import create_app, db, cli
File "C:\Users\Mark Kortink\Dropbox\Python\projects\metapplica\app\__init__.py", line 75, in <module>
from app import routes, models
File "C:\Users\Mark Kortink\Dropbox\Python\projects\metapplica\app\routes.py", line 8, in <module>
from app import app, db
ImportError: cannot import name 'app' from 'app' (C:\Users\Mark Kortink\Dropbox\Python\projects\metapplica\app\__init__.py)
It was this error that led me to try the current_app change mentioned above.
I start the app like this.
cd C:\Users\...\myapp
venv\Scripts\activate
set FLASK_APP=app.py
set FLASK_DEBUG=1
flask run
I know the problem is probably really basic but can anyone see why the above code would give a URL not found or not be able to find the routes?
=== NEXT PHASE ================
Following the recommendations from #silver below my new names are: -
myapp
runapp.py
...
/mapp
__init__.py
...
I went through all my code and changed from app[.xxx] import yyy to from myapp[.xxx] import yyy. This flushed out a few new errors where I was referencing app which I fixed by substituting current_app.
My new error is
RuntimeError
RuntimeError: Working outside of application context.
This typically means that you attempted to use functionality that needed
to interface with the current application object in some way. To solve
this, set up an application context with app.app_context(). See the
documentation for more information.
Traceback (most recent call last)
File "C:\Users\Mark Kortink\Dropbox\Python\projects\myapp\runapp.py", line 1, in <module>
from mapp import create_app, db, cli
File "C:\Users\Mark Kortink\Dropbox\Python\projects\myapp\mapp\__init__.py", line 75, in <module>
from mapp import routes, models
File "C:\Users\Mark Kortink\Dropbox\Python\projects\myapp\mapp\routes.py", line 16, in <module>
#current_app.before_request
Without being able to run it myself it's a little hard to be sure.
But I think this is the crux of the matter:
This may be irrelevant but it is one thing I tried. Note in routes.py that I have from app import app, db, if I remove app and add from flask import current_app then the #app decorators show as undefined.
If you want to register anything to the app that's actually running, it has to be through from flask import current_app. That's the thing about Flask application factories -- you only get access to the name of the application that's actually running in two places:
In the factory function itself: create_app, before you return the app object, and
Via from flask import current_app
It looks like Python is able to successfully import the name app in routes.py, since you say the application starts. The only place that from app import app could resolve to is from your app.py file at the top level of your myapp package. That means that each time routes.py is initialized, it's calling the create_app function, and getting a new app object. So understandably, the top-level app object that Flask is serving is not the same one that has routes registered to it.
I recommend renaming your files so that nothing has the name "app" except the object returned by create_app.
Then, in routes.py try:
from datetime import datetime
from flask import render_template, flash, redirect, url_for, request, g, \
jsonify
from flask import current_app as app_ref
...
from app_internals import db # assuming you've renamed the app package
from app_internals.forms import LoginForm, RegistrationForm, EditProfileForm,
PostForm,ResetPassword,RequestForm, ResetPasswordForm
from app_internals.models import User, Post
...
current_app = app_ref._get_current_object()
#current_app.route('/', methods=['GET', 'POST'])
#current_app.route('/index', methods=['GET', 'POST'])
#login_required
def index():
form = PostForm()
if form.validate_on_submit():
...
page = request.args.get('page', 1, type=int)
...
return render_template('index.html', title=_('Home'), form=form,
posts=posts.items, next_url=next_url,
prev_url=prev_url)
#current_app.route ....
In case someone is struggling with similar issues (flask 'mysteriously' not serving routes that should be there, perhaps in conjunction with a create_app factory method):
flask routes is actually showing the routes it detects. the output looks like this (for just one 'hello' endpoint at the root url):
Endpoint Methods Rule
-------- ------- -----------------------
hello GET /
static GET /static/<path:filename>
the SERVER_NAME setting can be responsible (this was the case for me). I had changed it to 0.0.0.0 without realizing it makes a difference for the routing. There is a bug report/discussion on github on that topic.
I just ran into this issue too with Miguel Grinberg's tutorial. It's a pretty fantastic tutorial till some of the later sections which feel rushed.
Anyway.
You need to pass the context.
In the factory function you need to do.
def create_app(config_class=Config):
app = Flask(__name__)
with app.app_context():
from app import routes
Then like the person posted above.
for routes.py change all the #app to #current_app
from flask import current_app
#current_app.route('/')
#current_app.route('/index', methods=['GET', 'POST'])
#login_required
def index():
this works for me.
I'm learning Blueprints for Flask, but I am having trouble with importing the correct modules. This is my setup:
Folder structure:
- app.py
templates/
nomad/
- __init__.py
- nomad.py
app.py
from flask import Flask
from nomad.nomad import nblueprint
app = Flask(__name__)
app.register_blueprint(nblueprint)
nomad.py
from flask import render_template, Blueprint, abort
from app import app
nblueprint = Blueprint('nblueprint', __name__, template_folder='templates')
# Routes for this blueprint
#app.route ....
__init__.py is empty
The error I'm getting: ImportError: cannot import name nblueprint. I know my import statement is probably wrong, but what should it be and why?
EDIT:
If I remove from app import app, then I can successfully import nblueprint in app.py. But I need app in nomad.py because it needs to handle routes. Why is that line causing issues with importing, and how would I get around this?
Blueprints is for define application route so you don't need to use app instance and blueprint in same place for route defination.
#nomad.py
#nblueprint.route('/')
You are getting error because while you register the blueprint at the same time you use app instance. So as you said when you remove the from app ... it solve the problem.
The recommend way is define your view for that blueprint in blueprint package in your example nomad package, it should be like this:
...
nomad/
__init__.py
views.py
#nomad/__init__.py
nblueprint = Blueprint(...)
#nomad/views.py
from . import nblueprint
#nblueprint.route('/')
...