shopyo_开发编程 skill-PHP中文网

shopyo

Polar Sponsor

爱发电赞助

.NET 9.0

立即下载

模块化 Flask 框架，用于构建可扩展、易维护的 Web 应用，配备隔离模块、事件驱动通信、CLI 工具及内置认证与数据功能。

Shopyo Skill: 肖普约是一个模块式的弗拉斯克框架, 设计用于可维护性、可扩展性和现实世界尺度

功能概述

Shopyo Skill: 肖普约是一个模块式的弗拉斯克框架, 设计用于可维护性、可扩展性和现实世界尺度是一项面向实际任务的技能，主要用于Project Structure.；A 典型的 Shopyo 项目:::.；

核心要点

CLI 命令；
Creat。
它将相关步骤、工具调用和结果整理方式集中到统一流程中，帮助使用者更快完成目标并减少重复操作。

使用与执行

使用时应结合输入条件选择合适的执行方式，核对必要参数、依赖环境与输出内容，并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景，可作为自动化工作流的一部分，也便于后续检查、调整和扩展。从功能定位来看，该技能强调把分散的操作要求整理成清晰、可复用的处理流程，使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。

结果检查与注意事项

实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数，再依据技能说明逐步执行；若输入条件不完整，应先补齐信息或采用保守配置，避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期，并对异常提示、缺失字段和边界情况进行处理；涉及批量任务时，还应保存进度，避免中断后重复操作。

Shopyo 技能

Shopyo 是一个模块化的 Flask 框架，专为可维护性、可扩展性及真实生产环境规模而设计。

项目结构

典型的 Shopyo 项目结构如下：

/project_root
├── app.py          # 入口文件，定义 create_app()
├── init.py         # 扩展初始化器（db、login_manager 等）
├── manage.py       # CLI 入口文件
├── config.py       # 基于配置环境（profile）的配置文件
└── modules/        # 模块化代码目录
    ├── box__default/
    │   ├── auth/
    │   └── settings/
    └── my_custom_module/

CLI 命令

# 环境配置
export SHOPYO_CONFIG_PROFILE=development
export FLASK_ENV=development
export FLASK_APP=app.py

# 新建项目
shopyo new myproject --demo
cd myproject
shopyo initialise

# 创建模块
shopyo startapp modulename [boxname]

# 创建 Box
shopyo startbox box__name

# 启动服务
shopyo run
flask run --debug

# 数据库操作
shopyo initialise   # 全新初始化（创建数据库、迁移文件、默认用户）
shopyo db migrate
shopyo db upgrade
shopyo clean        # 重置本地数据库

# 静态资源
shopyo collectstatic [module_path]  # 从模块中收集静态文件

# 其他命令
shopyo routes       # 显示所有路由
shopyo audit        # 检测项目潜在问题
shopyo rename old_name new_name  # 重命名模块

创建模块

shopyo startapp blog
# 或指定 Box
shopyo startapp blog box__ecommerce

生成以下目录结构：

modules/blog/
├── __init__.py
├── forms.py
├── global.py
├── info.json
├── models.py
├── view.py
├── static/
├── templates/
│   └── blog/
│       ├── blocks/
│       │   └── sidebar.html
│       ├── dashboard.html
│       └── index.html
└── tests/
    ├── test_blog_functional.py
    └── test_blog_models.py

info.json 结构

{
   "author": {"mail": "", "name": "", "website": ""},
   "display_string": "Page",
   "module_name": "page",
   "type": "show",
   "fa-icon": "fa fa-store",
   "url_prefix": "/page",
   "dashboard": "/dashboard"
}

模块视图模式

from shopyo.api.module import ModuleHelp

mhelp = ModuleHelp(__file__, __name__)
blueprint = mhelp.blueprint

@blueprint.route("/")
def index():
    context = mhelp.context()
    context.update({'message': 'Hello'})
    return mhelp.render('index.html', **context)

模型模式

from init import db
from shopyo.api.models import PkModel

class MyModel(PkModel):
    __tablename__ = 'mymodel'
    name = db.Column(db.String(100))

模板

继承基础模板：

{% extends "shopyo_base/main_base.html" %}
{% block content %}
Hello
{% endblock %}

使用 yo_render：

from shopyo.api.templates import yo_render

@blueprint.route("/demo")
def demo():
    return yo_render('blog/demo.html', {'key': 'value'})

Shopyo API

关键导入语句：

from shopyo.api.module import ModuleHelp, get_module, dispatch
from shopyo.api.models import PkModel
from shopyo.api.templates import yo_render
from shopyo.api.database import db
from shopyo.api.enhance import enhance_html

模块间通信

使用事件系统：

from shopyo.api.module import dispatch

# 触发事件
dispatch("user:registered", {"email": user.email})

# 监听事件
@dispatch("user:registered")
def send_welcome_email(email):
    pass

测试

pytest
pytest -v
pytest path/to/test.py
pytest --cov=shopyo
tox

global.py 模式

available_everywhere = {"x": 1}

configs = {
    "development": {"CONFIG_VAR": "DEVVALUE"},
    "production": {"CONFIG_VAR": "PRODVALUE"},
    "testing": {"CONFIG_VAR": "TESTVALUE"}
}