本文介绍: 在。

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

1. 项目结构

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

/myflaskapp
    /venv                    # 虚拟环境目录
    /app
        /main_blueprint      # 主蓝图
        	/templates           # 模板文件目录
        	/static              # 静态文件目录 (CSS, JS, 图片等)
            __init__.py
            views.py
        /auth_blueprint      # 认证蓝图
        	/templates           # 模板文件目录
        	/static              # 静态文件目录 (CSS, JS, 图片等)
            __init__.py
            views.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 Flask

app = 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_blueprint

app.register_blueprint(main_blueprint)
```

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

```python
from flask_sqlalchemy import SQLAlchemy

db = 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__.py

from flask import Blueprint

index_blueprint = Blueprint('index', __name__,url_prefix="/index",template_folder="templates",static_folder="static")

from . import views
# app/auth/__init__.py

from flask import Blueprint

auth_blueprint = Blueprint('auth', __name__)

from . import views

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

# app/index/views.py

from . import index_blueprint

@index_blueprint.route('/')
def index():
    return render_template('index.html')
# auth/views.py

from . 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__.py

from flask import Flask
from .index import index_blueprint

app = Flask(__name__)

# 注册蓝图
app.register_blueprint(index_blueprint)
app.register_blueprint(auth_blueprint)

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

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

<!-- app/index/templates/index.html --&gt;

<!DOCTYPE html&gt;
<html lang="en"&gt;
<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_foldertemplates,那么必须将模板创建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 打印查找模板的步骤。

原文地址:https://blog.csdn.net/weixin_39987031/article/details/134805377

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任

如若转载,请注明出处:http://www.7code.cn/show_47352.html

如若内容造成侵权/违法违规/事实不符,请联系代码007邮箱suwngjj01@126.com进行投诉反馈,一经查实,立即删除

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注