modelx 模块#

顶级模块modelx包含API函数。 按照惯例,modelx在全局命名空间中被赋值为mx

>> import modelx as mx

在顶层模块中定义的属性。

models#

get_models()的别名。 适用于 Python 3.7 或更新版本

Type:

dict

获取对象#

get_models()

返回一个将模型名称映射到模型的字典。

get_object(name[, as_proxy])

根据完整名称获取一个modelx对象。

cur_model([model])

获取和/或设置当前模型。

cur_space([space])

获取和/或设置当前模型的当前空间。

创建对象#

new_model([name])

创建并返回一个新模型。

new_space([name, bases, formula])

在当前模型中创建并返回一个新的空间。

defcells([space, name, is_cached])

用于从Python函数创建或更新单元格的装饰器。

uncached([space, name])

用于从Python函数创建或更新未缓存单元格的装饰器。

cached([space, name, is_cached])

用于从Python函数创建或更新单元格的装饰器。

保存模型#

write_model(model, model_path[, backup, ...])

将模型写入文件。

zip_model(model, model_path[, backup, ...])

将模型归档为zip文件

export_model(model, path)

将给定模型导出为一个独立的Python包。

read_model(model_path[, name])

从文件中读取模型。

递归限制#

get_recursion()

返回公式递归限制

set_recursion([maxdepth])

设置公式递归限制。

重新计算模式#

get_recalc()

如果依赖值被重新计算则返回True,如果被清除则返回False

set_recalc(recalc)

设置重新计算选项。

IPython 配置#

setup_ipython()

为modelx设置IPython shell。

restore_ipython()

恢复IPython的默认错误消息。

追踪调用堆栈#

start_stacktrace([maxlen])

激活堆栈追踪。

stop_stacktrace()

停用堆栈追踪。

get_stacktrace([summarize])

获取堆栈跟踪。

clear_stacktrace()

清除堆栈跟踪。

错误报告#

get_error()

返回上次公式执行期间引发的异常

get_traceback([show_locals])

追溯最近的公式错误。

trace_locals([index])

返回最后一次回溯中公式执行的局部变量。

use_formula_error([use])

指定是否替换公式执行期间引发的错误

handle_formula_error([handle])

指定是否引发FormulaError