Add Logging and Notification Messages to Flask Web Projects
by:
blow post content copied from Real Python
click here to view original post
After implementing the main functionality of a web project, you may find that your app is rough around the edges. Often, this boils down to the user experience (UX) of your project. For example, when you send a form, you don’t receive a success message, although everything worked fine. You want to build an immersive experience, but wrong URLs display unwelcoming error messages. Luckily, you can get valuable information from Flask through logging.
As an admin of a web project, you may know how to navigate your app without running into errors. But looking at the messages that the server sends you, you may notice that not all users do. That’s when a more verbose logging system can give you insights.
In this tutorial, you’ll learn how to:
- Create error pages
- Improve the user experience with notification messages
- Gain information with logging
Adding features like the ones listed above may keep your current functionality intact and enhance your web project with a better user experience that your visitors will love.
Get Your Code: Click here to download the free source code that shows you how to add error pages and logging to your Flask app.
Prerequisites
You’ll gain the most value from this tutorial if you’ve already created one or more Flask web projects yourself. It’ll also be helpful if you’ve worked with Jinja templating and HTML and CSS before.
Also, you should be comfortable using the terminal and have basic knowledge of Python. Although it helps to know about virtual environments and pip, you’ll learn how to set everything up as you work through the tutorial.
Project Overview
In this tutorial, you’ll continue to work on an existing Flask project. The project at hand is a public message board.
You’ll start with an existing Flask project and then implement logging and notification messages:
The demo video above shows the Flask project on the left and the terminal with server logs on the right. When you interact with the web app, you get helpful feedback with notification messages. As an admin, you can also see the info messages in your logs to help you understand how your users interact with your app.
In the next step, you’ll download the source code of the Flask project. However, you’ll notice that the codebase is quite generic so that you can transfer the instructions of this tutorial into your own Flask project.
Get Started
In this section, you’ll download all the requirements that you need for this tutorial and set up the development environment. Generally, you can leverage this tutorial to expand any Flask project that you’re currently working on. However, if you want to follow along closely, then you should perform the steps outlined below.
Grab the Prerequisites
To hit the ground running, you’ll build up on an existing Flask project with a database. That way, you don’t need to create a Flask project from scratch. Instead, you can focus on the main objectives of this tutorial, like adding an error page and displaying helpful messages to your users.
The code that you need is already in place for you. All you need to do is download the source code by clicking the link below:
Get Your Code: Click here to download the free source code that shows you how to add error pages and logging to your Flask app.
Alternatively, you can follow the Flask project with a database tutorial. Either way, you should end up with a folder structure that looks like this:
rp_flask_board/
├── board/
│ │
│ ├── static/
│ │ └── styles.css
│ │
│ ├── templates/
│ │ │
│ │ ├── pages/
│ │ │ ├── about.html
│ │ │ └── home.html
│ │ │
│ │ ├── posts/
│ │ │ ├── create.html
│ │ │ └── posts.html
│ │ │
│ │ ├── _navigation.html
│ │ └── base.html
│ │
│ ├── __init__.py
│ ├── database.py
│ ├── pages.py
│ ├── posts.py
│ └── schema.sql
│
└── board.sqlite
Once you’ve got the folder structure for your Flask project in place, you can read on to prepare the development environment that you’ll need to work on your web app.
Prepare Your Development Environment
Read the full article at https://realpython.com/flask-logging-messages/ »
[ Improve Your Python With 🐍 Python Tricks 💌 – Get a short & sweet Python Trick delivered to your inbox every couple of days. >> Click here to learn more and see examples ]
December 20, 2023 at 07:30PM
Click here for more details...
=============================
The original post is available in Real Python by
this post has been published as it is through automation. Automation script brings all the top bloggers post under a single umbrella.
The purpose of this blog, Follow the top Salesforce bloggers and collect all blogs in a single place through automation.
============================
Post a Comment