ExtraAPI
IDEPY Next框架,提供了系列集成工程的API,可以通过访问变量idepy_next.extra
进行调用。
import idepy_next
idepy_next.extra.check_support_and_update_edgechromium()
更多的功能方法介绍如下:
extra
set_app
设置应用基础信息
app_name: 应用名称,程序开机自启使用的文件名,如IdepyNext,则自启使用IdepyNext.exe
set_auto_start
设置应用开机自动启动
enabled: 设置开机启动程序自身,True为设置,False为取消。
is_enabled_auto_start
检查程序是否开机启动
return: bool
hotkeys_reg
注册全局热键
key:按键,组合键为:alt+ctrl+h、单按键为:h
oncall: 热键触发函数
suppress: 当本程序触发热键时,其他项目不触发热键
hotkeys_list
获取组成的热键
return: list 注册的热键列表
tray_start
启动托盘图标
name: 托盘名称
icon_path: 图标目录
menu_list:菜单项目 [{ text: Any,action: Any}],text为菜单项名称,action为对应的回调函数。
tray_stop
关闭托盘图标
show_system_notify
显示系统通知,仅Window系统可用。
title: 标题
msg: 信息
duration: 持续时间默认10s
show_message_box_draw
显示消息框,使用单独窗口绘制
message: 提示消息
title: 提示标题
height: 高度
width: 宽度
block: 是否阻塞,等待用户关闭后执行操作
config_get
获取程序配置项
key_path: 配置项的键
default: 返回默认值
config_data
获取程序配置项
config_update
更新程序配置项
key_path: 配置项键,如base.time
value: 对应项的值
check_support_and_update_edgechromium
检查是否支持edgechromium,并提示更新,强制退出程序
param exit_now 为真时,运行安装程序后自动退出
:return: bool
get_master_window
获取主窗口对象
set_jinjia_data
设置jinjia模板的数据,需要页面刷新后才生效
template_path_or_jinjia_id 输入模板文件的目录,如:/windows/window1/index.html,开头和连接符使用/,且相对于static/src目录的路径,或jinjia模板id。
data 设置的数据值
get_jinjia_data
获取jinjia模板的数据
template_path_or_jinjia_id 输入模板文件的目录,如:/windows/window1/index.html,使用反斜杠,且相对于static/src目录的路径,或jinjia模板id。
remove_jinjia_data
移除jinjia模板的数据
template_path_or_jinjia_id 输入模板文件的目录,如:/windows/window1/index.html,使用反斜杠,且相对于static/src目录的路径,或jinjia模板id。
extra.settings
一般使用以下方式进行导入,该配置项主要保存常用的配置项。
from idepy_next.extra import settings as idepy_settings
PROJECT_PATH
当前项目的目录,pyinstaller打包后,为释放文件的目录(sys._MEIPASS),运行时为当前目录。PROJECT_STATIC_LIB_PATH
当前项目的目录支持库目录,与PROJECT_PATH拼接,PROJECT_PATH, "./static/lib"DEFAULT_WINDOW_GROUP_INSTANCE
外部链接窗口群组实例对象DEFAULT_WINDOW_GROUP_ARGS
外部链接窗口默认参数,可参考webview.create_window_group方法。
服务器私密选项
1.0.8支持
PRIVATE_SERVER_START
设为True时,服务器
使用打包加密后的静态资源
1.0.8支持
生产环境下,idepy.json也要配置相关打包参数。
USE_ZIP_SERVER
设为True,使用项目目录下的static.rpak静态资源密码ZIP_SERVER_PASSWORD
访问静态资源包的密码