项目由 uv 管理,依赖装在 .venv。此前各处的提示语仍写作 `python main.py ...`,用户若在未激活虚拟环境时照抄,会因缺少 fastapi 而失败——这是正确性问题,不只是措辞。 涉及:main.py(12 行,含 prog 与各条 hint)、ai_player.py(5 行)、farm/client.py、farm/server/__main__.py(3 行,含 prog)、farm/server/__init__.py、farm/server/daemon.py、README(4 处示例与目录树注释)。 刻意保留 main.py:26 与 README:49 的「没装 uv?」兜底说明,那里 `python main.py` 是正确写法。 验收:ruff 全通过 / format 26 文件无改动 / pyright 0 错误 / 97 项测试通过。
182 lines
6.7 KiB
Python
182 lines
6.7 KiB
Python
"""``uv run python -m farm.server`` —— 服务器进程入口(前台运行)。
|
||
|
||
守护进程模式会由 :class:`farm.server.daemon.DaemonManager` 用同样的命令行
|
||
再拉起一个本模块的实例,只是不带 ``--daemon``。
|
||
"""
|
||
|
||
from __future__ import annotations
|
||
|
||
import argparse
|
||
import importlib.util
|
||
import os
|
||
import sys
|
||
|
||
from .. import config
|
||
from .daemon import DEFAULT_LOG_FILE, DEFAULT_PID_FILE, PROJECT_ROOT, DaemonManager
|
||
|
||
|
||
def build_parser() -> argparse.ArgumentParser:
|
||
parser = argparse.ArgumentParser(
|
||
prog="uv run python -m farm.server",
|
||
description="SimpleFarm 游戏服务器:HTTP 接口给 AI,WebSocket 给实时界面。",
|
||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
||
)
|
||
parser.add_argument(
|
||
"--host", default="127.0.0.1", help="监听地址,默认 127.0.0.1;局域网联机用 0.0.0.0"
|
||
)
|
||
parser.add_argument("--port", type=int, default=8765, help="监听端口,默认 8765")
|
||
parser.add_argument("--token", default=None, help="访问令牌,设置后所有接口都要带")
|
||
parser.add_argument(
|
||
"--tick",
|
||
type=float,
|
||
default=config.DEFAULT_TICK_SECONDS,
|
||
help=f"每多少秒推进一天,默认 {config.DEFAULT_TICK_SECONDS:.0f} 秒",
|
||
)
|
||
parser.add_argument("--save-dir", default=None, help="存档目录,默认 <项目根>/saves")
|
||
parser.add_argument(
|
||
"--save", dest="save_file", default=None, help="兼容旧参数:指定 default 牧场的存档文件"
|
||
)
|
||
parser.add_argument("--max-sessions", type=int, default=64, help="同时在线的牧场上限")
|
||
parser.add_argument(
|
||
"--idle-timeout",
|
||
type=float,
|
||
default=1800.0,
|
||
help="无人访问多少秒后把牧场移出内存(存档保留),默认 1800",
|
||
)
|
||
parser.add_argument("--world", default="SimpleFarm 公共农场", help="世界名称")
|
||
parser.add_argument(
|
||
"--log-level", default="info", choices=["critical", "error", "warning", "info", "debug"]
|
||
)
|
||
parser.add_argument("--access-log", action="store_true", help="打印每个 HTTP 请求")
|
||
parser.add_argument("--no-remote-control", action="store_true", help="禁止通过接口停机")
|
||
parser.add_argument(
|
||
"--daemon", action="store_true", help="转到后台运行(等价于 uv run main.py serve --daemon)"
|
||
)
|
||
parser.add_argument(
|
||
"--pid-file", default=None, help="把本进程 pid 写到该文件(守护进程模式会自动指定)"
|
||
)
|
||
parser.add_argument("--log-file", default=DEFAULT_LOG_FILE, help=argparse.SUPPRESS)
|
||
return parser
|
||
|
||
|
||
def clamp_tick(value: float) -> float:
|
||
return max(config.MIN_TICK_SECONDS, min(config.MAX_TICK_SECONDS, float(value)))
|
||
|
||
|
||
def dependency_hint() -> str:
|
||
return (
|
||
"缺少运行服务器所需的依赖。请先安装:\n"
|
||
" uv sync\n"
|
||
"如果不想用 uv,也可以用 pip:\n"
|
||
" pip install fastapi 'uvicorn[standard]'\n"
|
||
f"\n当前解释器:{sys.executable}"
|
||
)
|
||
|
||
|
||
def main(argv=None) -> int:
|
||
args = build_parser().parse_args(argv)
|
||
save_dir = args.save_dir or os.path.join(PROJECT_ROOT, "saves")
|
||
if args.save_file:
|
||
save_dir = os.path.dirname(os.path.abspath(args.save_file)) or save_dir
|
||
|
||
if args.daemon:
|
||
manager = DaemonManager(
|
||
host=args.host,
|
||
port=args.port,
|
||
token=args.token,
|
||
tick=clamp_tick(args.tick),
|
||
save_dir=save_dir,
|
||
pid_file=args.pid_file or DEFAULT_PID_FILE,
|
||
log_file=args.log_file or DEFAULT_LOG_FILE,
|
||
)
|
||
ok, message = manager.start()
|
||
print(message)
|
||
return 0 if ok else 1
|
||
|
||
try:
|
||
import uvicorn
|
||
except ImportError:
|
||
print(dependency_hint(), file=sys.stderr)
|
||
return 2
|
||
# 只探测"在不在",不真的导入——uvicorn 需要它才能完成 WebSocket 协议升级
|
||
ws_ok = importlib.util.find_spec("websockets") is not None
|
||
|
||
from .app import ServerConfig, create_app
|
||
|
||
cfg = ServerConfig(
|
||
host=args.host,
|
||
port=args.port,
|
||
token=args.token,
|
||
tick_seconds=clamp_tick(args.tick),
|
||
save_dir=save_dir,
|
||
max_sessions=max(1, args.max_sessions),
|
||
idle_timeout=max(60.0, args.idle_timeout),
|
||
world_name=args.world,
|
||
allow_remote_control=not args.no_remote_control,
|
||
)
|
||
app = create_app(cfg)
|
||
|
||
server_config = uvicorn.Config(
|
||
app,
|
||
host=cfg.host,
|
||
port=cfg.port,
|
||
log_level=args.log_level,
|
||
access_log=args.access_log,
|
||
loop="asyncio",
|
||
lifespan="on",
|
||
)
|
||
server = uvicorn.Server(server_config)
|
||
# 让 POST /api/admin/shutdown 能触发优雅退出(lifespan 里会把存档写掉)
|
||
app.state.handle.on_stop(lambda: setattr(server, "should_exit", True))
|
||
|
||
# pid 文件由**本进程**写:父进程(守护进程管理器)拿到的 pid 未必是真正
|
||
# 在监听端口的那个(Windows 上 venv 的 python.exe 可能是转发器)。
|
||
def write_pid_file() -> None:
|
||
if not args.pid_file:
|
||
return
|
||
try:
|
||
os.makedirs(os.path.dirname(args.pid_file) or ".", exist_ok=True)
|
||
with open(args.pid_file, "w", encoding="utf-8") as handle:
|
||
handle.write(str(os.getpid()))
|
||
except OSError as exc:
|
||
print(f"⚠ 无法写入 pid 文件 {args.pid_file}:{exc}", file=sys.stderr)
|
||
|
||
app.state.handle.on_start(write_pid_file)
|
||
|
||
print(f"SimpleFarm 服务器启动中(pid {os.getpid()})…")
|
||
print(f" 监听 http://{cfg.host}:{cfg.port}/")
|
||
print(f" 存档目录 {save_dir}")
|
||
print(f" 实时通道 ws://{cfg.host}:{cfg.port}/ws?farm=<牧场名>")
|
||
if not ws_ok:
|
||
print(
|
||
" ⚠ 未检测到 websockets 库,/ws 实时通道可能不可用;"
|
||
"网页端会自动降级为轮询。安装:pip install 'uvicorn[standard]'"
|
||
)
|
||
if cfg.token:
|
||
print(" 已启用访问令牌:请求需带 X-API-Token 头或 ?token= 参数")
|
||
|
||
server.run()
|
||
|
||
# 收尾:把自己写的 pid 文件清掉,避免下次 status 看到"幽灵进程"
|
||
if args.pid_file:
|
||
try:
|
||
if os.path.exists(args.pid_file):
|
||
with open(args.pid_file, encoding="utf-8") as handle:
|
||
if handle.read().strip() == str(os.getpid()):
|
||
os.remove(args.pid_file)
|
||
except OSError:
|
||
pass
|
||
|
||
if not getattr(server, "started", False):
|
||
print(
|
||
f"启动失败:端口 {cfg.port} 可能已被占用。换一个端口试试:--port {cfg.port + 1}",
|
||
file=sys.stderr,
|
||
)
|
||
return 3
|
||
print("服务器已停止。")
|
||
return 0
|
||
|
||
|
||
if __name__ == "__main__":
|
||
sys.exit(main())
|