CODEWITHSUNDEEP
pythonhtmlwebflask
shuji
shuji

Reputation: 7527

Flask: How to serve static html?

I am trying to serve a static html file, but returns a 500 error (a copy of editor.html is on .py and templates directory) This is all I have tried:

from flask import Flask
app = Flask(__name__, static_url_path='/templates')
@app.route('/')
def hello_world():
    #return 'Hello World1!' #this works correctly!
    #return render_template('editor.html')
    #return render_template('/editor.html')
    #return render_template(url_for('templates', filename='editor.html'))
    #return app.send_static_file('editor.html') #404 error (Not Found)
    return send_from_directory('templates', 'editor.html')

This is the response:

Title: 500 Internal Server Srror

Internal Server Error

The server encountered an internal error and was unable to complete your request. Either the server is overloaded or there is an error in the application.

Upvotes: 20

Views: 49026

Answers (4)

Rate Morgan
Rate Morgan

Reputation: 305

from flask import Flask, render_template
app = Flask(__name__, template_folder='templates')

@app.route('/')
def hello_world():
    return render_template('editor.html')

Upvotes: 0

Danyal
Danyal

Reputation: 533

send_from_directory and send_file need to be imported from flask.

Your code sample would work if you do the following:

from flask import Flask, send_from_directory
app = Flask(__name__, static_url_path='/templates')

@app.route('/')
def hello_world():
    return send_from_directory('templates', 'editor.html')

However, remember if this file loads other files e.g. javascript, css, etc. you would have to define routes for them too.

Also, as far as I understand, this is not the recommended method on production because it's slow.

Upvotes: 0

Binoy S Kumar
Binoy S Kumar

Reputation: 289

All the answers are good but what worked well for me is just using the simple function send_file from Flask. This works well when you just need to send an html file as response when host:port/ApiName will show the output of the file in browser 


@app.route('/ApiName')
def ApiFunc():
    try:
        #return send_file('relAdmin/login.html')
        return send_file('some-other-directory-than-root/your-file.extension')
    except Exception as e:
        logging.info(e.args[0])```

Upvotes: 5

Martijn Pieters
Martijn Pieters

Reputation: 1121924

Reducing this to the simplest method that'll work:

  1. Put static assets into your static subfolder.
  2. Leave Flask set to the default, don't give it a static_url_path either.
  3. Access static content over the pre-configured /static/ to verify the file works

If you then still want to reuse a static file, use current_app.send_static_file(), and do not use leading / slashes:

from flask import Flask, current_app
app = Flask(__name__)

@app.route('/')
def hello_world():
    return current_app.send_static_file('editor.html')

This looks for the file editor.html directly inside the static folder.

This presumes that you saved the above file in a folder that has a static subfolder with a file editor.html inside that subfolder.

Some further notes:

  • static_url_path changes the URL static files are available at, not the location on the filesystem used to load the data from.
  • render_template() assumes your file is a Jinja2 template; if it is really just a static file then that is overkill and can lead to errors if there is actual executable syntax in that file that has errors or is missing context.

Upvotes: 36

Related Questions