本文整理汇总了Python中hug.API属性的典型用法代码示例。如果您正苦于以下问题：Python hug.API属性的具体用法？Python hug.API怎么用？Python hug.API使用的例子？那么恭喜您, 这里精选的属性代码示例或许可以为您提供帮助。您也可以进一步了解该属性所在类hug的用法示例。
在下文中一共展示了hug.API属性的3个代码示例，这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞，您的评价将有助于系统推荐出更棒的Python代码示例。
示例1: server
# 需要导入模块: import hug [as 别名]
# 或者: from hug import API [as 别名]
def server(
directory: str = "",
config_file: str = "pyproject.toml",
open_browser: bool = False,
port: int = None,
host: str = None,
modules: list = None,
) -> None:
"""Runs a development webserver enabling you to browse documentation locally.
- *directory*: The root folder of your project.
- *config_file*: The [TOML](https://github.com/toml-lang/toml#toml) formatted
config file you wish to use.
- *open_browser*: If true a browser will be opened pointing at the documentation server
- *port*: The port to expose your documentation on (defaults to: `8000`)
- *host*: The host to expose your documentation on (defaults to `"127.0.0.1"`)
- *modules*: One or more modules to render reference documentation for
"""
directory = directory if directory else os.getcwd()
api = hug.API("Doc Server")
project_config = project_configuration(directory, config_file, modules=modules)
with render.documentation_in_temp_folder(project_config) as doc_folder:
@hug.static("/", api=api)
def my_static_dirs(): # pragma: no cover
return (doc_folder,)
@hug.startup(api=api)
def custom_startup(*args, **kwargs): # pragma: no cover
print(logo.ascii_art)
if open_browser:
webbrowser.open_new(f"http://{project_config['host']}:{project_config['port']}")
api.http.serve(
host=host or project_config["host"],
port=port or project_config["port"],
no_documentation=True,
display_intro=False,
) 示例2: main
# 需要导入模块: import hug [as 别名]
# 或者: from hug import API [as 别名]
def main():
API.cli() 示例3: integrate_scout
# 需要导入模块: import hug [as 别名]
# 或者: from hug import API [as 别名]
def integrate_scout(hug_module_name, config):
http_interface = hug.API(hug_module_name).http
scout_middleware = ScoutMiddleware(
config=config, hug_http_interface=http_interface,
)
http_interface.add_middleware(scout_middleware)