Flask 最佳实践(一)

Flask是一个轻量级而强大的Python Web框架,它的简洁性和灵活性使其成为许多开发者的首选。然而,为了确保项目的可维护性和可扩展性,我们需要遵循一些最佳实践。本文将探讨Flask中一些关键的最佳实践。

1. 项目结构

构建一个清晰的项目结构是确保项目可维护性的第一步。一个典型的Flask项目结构可能如下:

/myflaskapp/venv                    # 虚拟环境目录/app/main_blueprint      # 主蓝图/templates           # 模板文件目录/static              # 静态文件目录 (CSS, JS, 图片等)__init__.pyviews.py/auth_blueprint      # 认证蓝图/templates           # 模板文件目录/static              # 静态文件目录 (CSS, JS, 图片等)__init__.pyviews.py__init__.py          # 应用包初始化config.py            # 配置文件models.py            # 数据库模型/migrations              # 数据库迁移脚本/tests              # 单元测试文件config.py                # 项目配置文件manage.py                # 命令行管理脚本requirements.txt         # 依赖列表

通过按功能组织代码,能够更容易地定位和修改特定部分的代码。

2. __init__.py

在Flask项目中,__init__.py 文件通常包含一些初始化和配置的逻辑。这个文件在一个包(即Flask应用)的根目录中被放置,它用于定义包的初始化逻辑。以下是一些可能在 __init__.py 文件中出现的常见逻辑:

创建Flask应用实例:
__init__.py中,通常会创建Flask应用的实例。这是整个应用的核心,它负责处理请求和响应。

```python
from flask import Flaskapp = Flask(__name__)
```

配置应用:
__init__.py 中设置应用的配置信息,例如数据库连接、密钥、调试模式等。

```python
app.config['DEBUG'] = True
app.config['SECRET_KEY'] = 'your_secret_key'
```

注册蓝图:
如果使用了Flask的蓝图(Blueprint)来组织应用,那可以在 __init__.py 中导入并注册这些蓝图。

```python
from .views import main_blueprintapp.register_blueprint(main_blueprint)
```

初始化数据库或其他扩展:
如果使用了数据库或其他Flask扩展,那可以在 __init__.py 中初始化这些扩展。

```python
from flask_sqlalchemy import SQLAlchemydb = SQLAlchemy(app)
```

定义全局变量或常量:
__init__.py 中可以定义一些全局的变量或常量,以便在整个应用中共享。

```python
MAX_ITEMS_PER_PAGE = 10
```

错误处理:
可以在 __init__.py 中定义全局的错误处理器,处理应用中可能发生的错误。

```python
@app.errorhandler(404)
def page_not_found(error):return render_template('404.html'), 404
```

总体而言,__init__.py 是整个应用的入口点,可以在其中组织和配置应用的基本元素。然而,随着项目的增长,最好将不同的功能划分到不同的模块或文件中,以保持代码的清晰性和可维护性。

3. 蓝图

Flask蓝图(Blueprint)是一种组织和分隔Flask应用的方式,它允许你将应用划分为模块化的组件。使用蓝图,你可以更好地组织代码、提高可维护性,并支持应用的可扩展性。

蓝图的优势
  1. 模块化组织: 蓝图允许你将应用划分为独立的模块,每个模块可以包含自己的路由、模板、静态文件等。

  2. 可复用性: 你可以将蓝图定义在一个应用中,然后在其他应用中重复使用,促使代码重用。

  3. 命名空间隔离: 蓝图允许你使用相同的路由路径,但在不同的蓝图中。这有助于在大型应用中防止路由冲突。

  4. 延迟绑定: 使用蓝图,你可以在应用对象已经存在后再注册路由。这对于工厂模式创建应用实例很有用。

蓝图使用实例

步骤1:创建蓝图

# app/index/__init__.pyfrom flask import Blueprintindex_blueprint = Blueprint('index', __name__,url_prefix="/index",template_folder="templates",static_folder="static")from . import views
# app/auth/__init__.pyfrom flask import Blueprintauth_blueprint = Blueprint('auth', __name__)from . import views

步骤2:在蓝图中定义路由

# app/index/views.pyfrom . import index_blueprint@index_blueprint.route('/')
def index():return render_template('index.html')
# auth/views.pyfrom . import auth_blueprint@auth_blueprint.route('/login')
def login():return 'Login page'@auth_blueprint.route('/logout')
def logout():return 'Logout page'

步骤3:创建 Flask 应用和蓝图

# app/__init__.pyfrom flask import Flask
from .index import index_blueprintapp = Flask(__name__)# 注册蓝图
app.register_blueprint(index_blueprint)
app.register_blueprint(auth_blueprint)

步骤4:使用蓝图中的模板

app/index/templates 目录下创建一个模板文件,例如 index.html

<!-- app/index/templates/index.html --><!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Main Page</title><link rel="stylesheet" href="{{ url_for('index.static',filename='css/index.css') }}"></head>
<body><h1>Hello, this is the main page!</h1>
</body>
</html>
<!-- app/index/static/css/index.css -->
body{color:red;
}
蓝图嵌套

可以把蓝图注册到另一个蓝图上

parent = Blueprint('parent', __name__, url_prefix='/parent')
child = Blueprint('child', __name__, url_prefix='/child')
parent.register_blueprint(child)
app.register_blueprint(parent)

子蓝图的名称会以父蓝图的名称作为前缀,子蓝图的 URL 也会以父蓝图的 URL 前缀作为前缀。

url_for('parent.child.create')
/parent/child/create

注册在父蓝图上的请求前钩子及其他钩子也会在子蓝图上触发。如果子蓝图未给某错误指定处理函数,会去寻找父蓝图上的错误处理函数。

访问蓝图目录下的静态文件

可以把文件夹的路径传给蓝图的 static_folder 参数来让蓝图提供静态文件,它既可以是绝对路径,也可以是相对于蓝图路径的相对路径:

admin = Blueprint('admin', __name__, static_folder='static')

默认情况下,路径最右端的部分将作为静态文件的 URL,可以通过指定 static_url_path 来改变。因为上例中文件夹名称是 static,所以静态文件可以通过蓝图的 url_prefix 加上 /static 访问。比如蓝图的 URL 前缀是 /admin,则静态文件的 URL 为 /admin/static。

端点的名称是 blueprint_name.static。可以使用 url_for() 来生成 URL,和应用中的静态文件夹一样:

url_for('admin.static', filename='style.css')

然而,如果蓝图没有 url_prefix 属性,将不能访问蓝图中的静态文件。这是因为这个情况下 URL 会是 /static,而应用级的 /static 路由会优先匹配。和模板文件夹不同,当 Flask 在应用的静态文件夹中找不到文件时,不会去搜索蓝图的静态文件夹。

访问蓝图的模板

如果你想在蓝图中暴露模板文件,你可以给 Blueprint 指定 template_folder 参数:

admin = Blueprint('admin', __name__, template_folder='templates')

对静态文件来说,路径可以是绝对路径,也可以相对于蓝图的资源文件夹。

模板文件夹会被添加到模板的搜索路径中,但比应用的模板文件夹优先级更低。这样可以很容易地在应用中覆写蓝图提供的模板。这也意味着如果不希望蓝图模板被意外覆盖,需要保证模板的相对路径与其他蓝图或应用的模板都不相同。如果有多个模板有相同的模板相对路径,第一个被注册的蓝图中的模板将被选中。

因此,如果蓝图位于 yourapplication/admin 中,想渲染模板 ‘admin/index.html’ 并且你指定了 template_folder 为 templates,那么必须将模板创建为 yourapplication/admin/templates/admin/index.html。 其中包含一个额外的 admin 是为了防止模板被应用模板文件夹中一个名叫 index.html 的模板文件所覆盖。

进一步阐明:如果有一个名为 admin 的蓝图,希望渲染蓝图的模板 index.html,最好按照如下方式存放模板文件:

yourpackage/blueprints/admin/templates/admin/index.html__init__.py

当需要使用此模板时,使用 admin/index.html 作为查找模板的名称。如果在加载模板时遇到任何问题,启用 EXPLAIN_TEMPLATE_LOADING 配置变量,它可以在每次 reder_template 调用时让 Flask 打印查找模板的步骤。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/209662.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Java实现Socket聊天室

一、网络编程是什么&#xff1f; 在网络通信协议下&#xff0c;不同计算机上运行的程序&#xff0c;进行数据传输。 应用场景&#xff1a;即时通讯、网游对战、金融证券、国际贸易、邮件、等等。 不管是什么场景&#xff0c;都是计算机与计算机之间通过网络进行数据传输。 …

软件测试之接口测试自动化(详解版)

本着以和大家交流如何实现高效的接口测试为出发点&#xff0c;本文包含了我在接口测试领域的一些方法和心得&#xff0c;希望大家一起讨论和分享&#xff0c;内容包括但不仅限于&#xff1a; 服务端接口测试介绍接口测试自动化介绍接口测试自动化实践关于接口测试自动化的思考…

质量工程化,交付快速化

质量和速度之间权衡让人很难取舍&#xff0c;而通过推进质量工程&#xff0c;以系统化的方式识别和优化系统痛点&#xff0c;可以帮助团队构建既快又好的精益软件生产系统。原文: Quality Engineered, Speed Delivered 所有人都想要更快的速度。 但需要解决复杂问题: 权衡质量会…

Kotlin(十四) 扩展函数和运算符重载

目录 扩展函数 语法结构 代码示例 运算符重载 语法结构 一元操作符 二元操作符 数值类型操作符 等于和不等于操作符 比较操作符 调用操作符 扩展函数 语法结构 对于扩张函数的语法结构其实很简单&#xff0c;你想在那个类中添加扩张函数&#xff0c;那么你就用该类…

6. Zigzag Conversion

按照下标找规律注意leetcode的运行输出&#xff0c;如果其中一组用例出现死循环&#xff0c;输出结果会在一个文件&#xff0c;即部分测试用例正确&#xff0c;部分错误且出现死循环&#xff0c;则需辨别输出结果属于哪一份测试用例 class Solution { public:string convert(s…

(二)五种最新算法(SWO、COA、LSO、GRO、LO)求解无人机路径规划MATLAB

一、五种算法&#xff08;SWO、COA、LSO、GRO、LO&#xff09;简介 1、蜘蛛蜂优化算法SWO 蜘蛛蜂优化算法&#xff08;Spider wasp optimizer&#xff0c;SWO&#xff09;由Mohamed Abdel-Basset等人于2023年提出&#xff0c;该算法模型雌性蜘蛛蜂的狩猎、筑巢和交配行为&…

w3school学习笔记3(NumPy)

系列文章目录 文章目录 系列文章目录前言一、NumPy简介二、NumPy入门三、NumPy创建四、NumPy数组索引五、NumPy数组裁切六、NumPy数据类型七、NumPy副本/视图八、NumPy数据形状九、NumPy数组重塑十、NumPy数组迭代总结 前言 一、NumPy简介 1、什么是Numpy&#xff1f; NumPy是…

线上盲盒小程序,开启互联网盲盒时代

近年来&#xff0c;盲盒经济在国内非常火爆&#xff0c;各类盲盒品牌层出不穷&#xff0c;深受国内外年轻人、消费者的喜爱。 目前&#xff0c;根据数据显示&#xff0c;盲盒市场不仅在线下异常火热&#xff0c;线上盲盒也是成为了大众的新选择。各类电商平台中盲盒的成交额更…

Esxi7Esxi8设置VMFSL虚拟闪存的大小

Esxi7Esxi8设置VMFSL虚拟闪存的大小 ESXi7,8 默认安装会分配一个 VMFSL(VMFS-L)(Local VMFS)很大空间(120G), 感觉很浪费, 实际给 8G 就可以了, 最少 6G , 经实验,给2G没法安装 . Esxi7是虚拟闪存的 修改的方法是: 在安装时修改 设置 autoPartitionOSDataSize8192 在cdromBoo…

快捷切换raw页面到repo页面-Raw2Repo插件

Raw2Repo By Rick &#x1f4d6;快捷切换代码托管平台raw页面到repo页面 &#x1f517;github链接 https://github.com/rickhqh/Raw2Repo ✨Features 功能&#xff1a; ✅单击 Raw2Repo 插件按钮&#xff0c;即可跳转到相应的代码仓库页面。✅支持 GitHub、Gitee、GitCode …

spring boot整合mybatis进行部门管理管理的增删改查

部门列表查询&#xff1a; 功能实现&#xff1a; 需求&#xff1a;查询数据库表中的所有部门数据&#xff0c;展示在页面上。 准备工作&#xff1a; 准备数据库表dept&#xff08;部门表&#xff09;&#xff0c;实体类Dept。在项目中引入mybatis的起步依赖&#xff0c;mysql的…

【ET8】1.ET8入门-运行指南

主要学习网址 论坛地址为&#xff1a;https://et-framework.cn Git地址为&#xff1a;GitHub - egametang/ET: Unity3D Client And C# Server Framework 官方QQ群 : 474643097 项目检出 检出项目切换到release8.0分支 GitHub地址&#xff1a;GitHub - egametang/ET: Unity…

[足式机器人]Part2 Dr. CAN学习笔记-数学基础Ch0-5Laplace Transform of Convolution卷积的拉普拉斯变换

本文仅供学习使用 本文参考&#xff1a; B站&#xff1a;DR_CAN Dr. CAN学习笔记-数学基础Ch0-5Laplace Transform of Convolution卷积的拉普拉斯变换 Laplace Transform : X ( s ) L [ x ( t ) ] ∫ 0 ∞ x ( t ) e − s t d t X\left( s \right) \mathcal{L} \left[ x\lef…

基于Swin_Transformer的图像超分辨率系统

1.研究背景与意义 项目参考AAAI Association for the Advancement of Artificial Intelligence 研究背景与意义 随着科技的不断发展&#xff0c;图像超分辨率技术在计算机视觉领域中变得越来越重要。图像超分辨率是指通过使用计算机算法将低分辨率图像转换为高分辨率图像的过…

AI:91-基于深度学习的手写数学表达式识别

🚀 本文选自专栏:人工智能领域200例教程专栏 从基础到实践,深入学习。无论你是初学者还是经验丰富的老手,对于本专栏案例和项目实践都有参考学习意义。 ✨✨✨ 每一个案例都附带有在本地跑过的核心代码,详细讲解供大家学习,希望可以帮到大家。欢迎订阅支持,正在不断更新…

51单片机的时钟电路与时序以及 复位电路和电源模式

51单片机的时钟电路与时序以及 复位电路和电源模式 本文主要涉及51单片机的时钟电路以及相关时序的知识&#xff0c;也讲解了了51单片机的复位电路以及电源模式。 文章目录 51单片机的时钟电路与时序以及 复位电路和电源模式一、时钟电路与时序1、 时钟电路设计1.1 内部时钟方式…

用stl写一个自动打分比赛的案例

我们要实现六名选手进行随机平均分为两组&#xff0c;先分别淘汰两组中的最后一名&#xff0c; 再决出第一名。 抽象选手 class player { public:string name;int score; }; 一个选手有名字和分数 首先我们需要vector容器保存选手的编号&#xff0c;便于后续的操作。 再用…

导入PR的视频画面是黑屏的怎么办?

在现代视频编辑领域中&#xff0c;越来越多的人使用Adobe Premiere Pro来编辑和制作视频&#xff0c;但是在某些情况下&#xff0c;用户可能需要透明背景的视频进行创作&#xff0c;那么如何创作透明背景的视频呢&#xff1f; 要制作具有透明背景的视频&#xff0c;我们需要使…

如何赢得并留住订阅者:12 个必须尝试的订阅营销策略

Netflix、Hubspot、Spotify 和 Slack 都是流行的基于订阅的服务&#xff0c;您可能每天都会使用它们&#xff0c;无论是工作还是娱乐。这些例子表明&#xff0c;订阅业务模式深受 SaaS 创业者的青睐。 这种模式的吸引力很容易理解&#xff0c;特别是考虑到订阅市场预计到 2025…

C //例10.5 有一个磁盘文件,内有一些信息。要求第1次将它的内容显示在屏幕上,第2次把它复制到另一文件上。

C程序设计 &#xff08;第四版&#xff09; 谭浩强 例10.5 例10.5 有一个磁盘文件&#xff0c;内有一些信息。要求第1次将它的内容显示在屏幕上&#xff0c;第2次把它复制到另一文件上。 IDE工具&#xff1a;VS2010 Note: 使用不同的IDE工具可能有部分差异。 代码块 方法&a…