< 可调用对象列表
无编辑摘要 |
|||
(未显示同一用户的7个中间版本) | |||
第2行: | 第2行: | ||
== ''class'' <code>CFG</code> == | == ''class'' <code>CFG</code> == | ||
=== ''method'' <code>load</code> === | === ''method'' <code>load</code> === | ||
<syntaxhighlight lang="py3"> | <syntaxhighlight lang="py3"> | ||
CFG.load() | |||
</syntaxhighlight> | </syntaxhighlight> | ||
此方法可以加载配置文件。 | 此方法可以加载配置文件。 | ||
第14行: | 第11行: | ||
=== ''method'' <code>get</code> === | === ''method'' <code>get</code> === | ||
<syntaxhighlight lang="py3"> | <syntaxhighlight lang="py3"> | ||
CFG.get(q: str, default: Union[Any, None] = None, cfg_type: Union[type, tuple, None] = None) -> Any | |||
</syntaxhighlight> | </syntaxhighlight> | ||
参数: | 参数: | ||
* {{Instructor param|q|str}}:配置项 | * {{Instructor param|q|str}}:配置项 。 | ||
* <code>default</code>:默认值 | * <code>default</code>:默认值 。 | ||
* <code>cfg_type</code>:配置项类型,输入类型或类型元组,若值与类型不匹配则输出日志警告 | * <code>cfg_type</code>:配置项类型,输入类型或类型元组,若值与类型不匹配则输出日志警告 。 | ||
返回:配置值,若为空则尝试输出默认值 | 返回:配置值,若为空则尝试输出默认值 。 | ||
此方法可以获取配置值。 | 此方法可以获取配置值。 | ||
第26行: | 第23行: | ||
=== ''method'' <code>write</code> === | === ''method'' <code>write</code> === | ||
<syntaxhighlight lang="py3"> | <syntaxhighlight lang="py3"> | ||
CFG.write(q: str, value: Union[Any, None], secret: bool = False) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
参数: | 参数: | ||
* {{Instructor param|q|str}}:配置项 | * {{Instructor param|q|str}}:配置项 。 | ||
* <code>value</code>:值 | * <code>value</code>:值 。 | ||
* {{Instructor param|secret|bool}}:是否写入 <code>secret</code> 类以参与内容安全检查,默认 False | * {{Instructor param|secret|bool}}:是否写入 <code>secret</code> 类以参与内容安全检查,默认 False 。 | ||
此方法可以修改配置项。 | 此方法可以修改配置项。 | ||
=== ''method'' <code>delete</code> === | === ''method'' <code>delete</code> === | ||
<syntaxhighlight lang="py3"> | <syntaxhighlight lang="py3"> | ||
CFG.delete(q: str) -> bool | |||
</syntaxhighlight> | </syntaxhighlight> | ||
参数: | 参数: | ||
* {{Instructor param|q|str}}:配置项 | * {{Instructor param|q|str}}:配置项 。 | ||
返回:若删除成功返回 True,否则返回 False | 返回:若删除成功返回 True,否则返回 False 。 | ||
此方法可以删除配置项。 | 此方法可以删除配置项。 | ||
第46行: | 第43行: | ||
=== ''method'' <code>get_url</code> === | === ''method'' <code>get_url</code> === | ||
<syntaxhighlight lang="py3"> | <syntaxhighlight lang="py3"> | ||
CFG.get_url(q: str, default: Union[str, None] = None) -> Union[str, None] | |||
</syntaxhighlight> | </syntaxhighlight> | ||
参数: | 参数: | ||
* {{Instructor param|q|str}}:配置项 | * {{Instructor param|q|str}}:配置项 。 | ||
* <code>default</code>:默认值 | * <code>default</code>:默认值 。 | ||
返回:配置值,若最后没有“/”则会添加,若为空则尝试输出默认值 | 返回:配置值,若最后没有“/”则会添加,若为空则尝试输出默认值 。 | ||
此方法可以获取配置值,更方便 URL 的连接。 | 此方法可以获取配置值,更方便 URL 的连接。 | ||
== ''var'' <code>Config</code> == | == ''var'' <code>Config</code> == | ||
方法 <code>CFG.get</code> 的引用,见[[#method_get]] | 方法 <code>CFG.get</code> 的引用, 参 见 [[#method_get]] 。 |
2024年9月22日 (日) 05:59的最新版本
此部分可调用机器人的配置文件。
class CFG
method load
CFG.load()
此方法可以加载配置文件。
method get
CFG.get(q: str, default: Union[Any, None] = None, cfg_type: Union[type, tuple, None] = None) -> Any
参数:
-
q
:配置项。 default
:默认值。cfg_type
:配置项类型,输入类型或类型元组,若值与类型不匹配则输出日志警告。
返回:配置值,若为空则尝试输出默认值。
此方法可以获取配置值。
method write
CFG.write(q: str, value: Union[Any, None], secret: bool = False)
参数:
-
q
:配置项。 value
:值。-
secret
:是否写入secret
类以参与内容安全检查,默认 False。
此方法可以修改配置项。
method delete
CFG.delete(q: str) -> bool
参数:
-
q
:配置项。
返回:若删除成功返回 True,否则返回 False。
此方法可以删除配置项。
method get_url
CFG.get_url(q: str, default: Union[str, None] = None) -> Union[str, None]
参数:
-
q
:配置项。 default
:默认值。
返回:配置值,若最后没有“/”则会添加,若为空则尝试输出默认值。
此方法可以获取配置值,更方便 URL 的连接。
var Config
方法 CFG.get
的引用,参见 #method_get。