autoboot 0.12.1

IoC with auto config framework

autoboot

一个Python语言的仿SpringBoot开发方式，支持IoC组件容器、注解式注册、配置驱动开发、事件通知、插件扩展的快速开发框架。

Purpose

在使用Python开发AI应用服务时遇到以下问题：

• 在.env里添加配置的方式，在获取配置参数时很容易写错，且调用没有代码提示。
• 配置参数较多时会让查找起来比较混乱，无法分类进行管理。
• 各种对象创建在各个函数和方法里，但多时候只需要创建一个单例。
• 很多代码和函数写在全局执行文件，创建的上下文数据在调用其它函数时需要层层传递。

autoboot vs SpringBoot

由于Python有自身的语法特性，开发时也得到了天然的优化支持，以下是对比的测试环境：

开发语言	框架	server
Python 3.11	autoboot 0.10	uvicorn
Java 1.8	SpringBoot 2.7	Tomcat

• 基于单容器设计，使用简单，学习成本低。
• 不需要扫描组件所在的包，所有组件只需要声明即可（除Listener特殊组件需要配置扫描外）。
• 所有声明的组件只有在调用时才会创建并缓存，实现了SpringBoot推荐的懒加载创建方式。
• 配置采用.env + yaml组合，.env用于支持多环境配置项，主配置使用autoboot.yaml，框架扩展了yaml自定义指令!env用于从.env中获取配置参数。
• 没有历史遗留包袱，启动创建的对象少，占用内存低。
• 微服务项目的启动速度快到可以在1-2秒内启动完成，相比SpringBoot的10几秒，快了至少10倍。

Quick Start

Install

pip install autoboot

Usage

配置

• 启动配置文件./config/.env

# 环境名称（默认值：dev，框架根据这个配置项来加载当前的环境配置）
ENV_NAME=dev

# 应用名
APPLICATION_NAME=demo

• 环境配置文件./config/.env.dev

APPLICATION_NAME=demo-dev

• 主配置文件./config/autoboot.yaml

autoboot:
  application:
    # !env 引用 .env 里的配置参数 
    name: !env $APPLICATION_NAME
    # 微服务模块名
    module: api
    # 日志
    log:
      dir: logs
      # !!str 明确定义为字符串类型
      max_size: !!str 100 MB
      retention: !!str 30 days

创建并启动容器

from autoboot import AutoBoot, AutoBootConfig

context = Autoboot(AutoBootConfig(config_dir="./config"))
context.run()

# 或者直接使用 loguru.logger，日志的配置同样生效
Autoboot.logger.info("Context run succeed!")

Advanced Features

自定义配置

主配置文件

api:
  # 在环境配置文件.env添加：API_SECRET_KEY=xxx
  secret: !env $API_SECRET_KEY

创建配置类api_properties.py

from autoboot.annotation import static_property

class ApiProperties:

  @static_property("api.secret")
  def secret() -> str:
    # 返回的值作为默认的配置值
    return ""

创建并启动容器

from autoboot import AutoBoot, AutoBootConfig
from .api_properties import ApiProperties

context = Autoboot(AutoBootConfig(config_dir="./config"))
context.run()

# 在容器启动完成后获取
Autoboot.logger.info("api.secret: {}", ApiProperties.secret())

注册组件

类式注册组件

创建组件hello_service.py文件：

from autoboot.annotation import component

@component()
class HelloService(object):
  def __init__(self):
    pass

  def hello(self):
    return "Hello World!"

函数式注册组件

如果注册的类来自第三方库，无法采用继承Component的方式，那么可以通过下面方式来注册：

from autoboot.annotation import component
from .hello_service import HelloService


@component(name='HelloService')
def hello_service():
  return HelloService()

调用组件

from autoboot import AutoBoot, AutoBootConfig
from .hello_service import HelloService

context = Autoboot(AutoBootConfig(config_dir="./config"))
context.run()

# 在容器启动完成后调用
# HelloService() 会在创建对象后自动注册到容器，且多次调用返回同一个实例
assert id(HelloService()) == id(HelloService())
Autoboot.logger.info("HelloService.hello: {}", HelloService().hello())

监听容器事件

主配置文件

autoboot:
  application:
    # 扫描监听器包
    scan_listener_packages:
      - listener

项目下创建目录listener

• 在该目录创建__init__.py

from .app_listener import AppListener

__all__ = ["AppListener"]

• 在该目录创建app_listener.py

from autoboot import AutoBoot
from autoboot.event import ApplicationListener
from autoboot.meta import Listener

@Listener
class AppListener(ApplicationListener):

  def on_env_prepared(self, config: dict[str, Any]):
    AutoBoot.logger.info("listen: env prepared!")
  
  def on_started(self):
    AutoBoot.logger.info("listen: app started!")

发送事件

基于Action的事件发送与监听

from dataclasses import dataclass
from autoboot.event import emitter, Event
from loguru import logger

@dataclass(slots=True)
class PayOrder:
  no: str

@emitter.on("pay_action")
def received_payment(event: Event[str]):
  logger.info("received_payment")
  assert(event.data == "pay order: 1001")


emitter.emit(action="pay_action", event=Event("pay order: 1001"))

基于事件类型自动匹配的发送与监听

from dataclasses import dataclass
from autoboot.event import emitter, Event
from loguru import logger

@dataclass(slots=True)
class PayOrder:
  no: str

@emitter.on_event
def received_pay(event: Event[PayOrder]):
  logger.info("received_pay")
  assert(event.data == PayOrder("1001"))

emitter.emit(event=Event(PayOrder("1001")))

扩展插件

创建插件my_plugin.py

from autoboot.plugin import AppPlugin

class MyPlugin(AppPlugin):
  def install(self):
    AutoBoot.logger.info("plugin: installed!")

  def on_env_prepared(self, config: dict[str, Any]):
    AutoBoot.logger.info("plugin: env prepared!")

  def on_started(self):
    AutoBoot.logger.info("plugin: started!")

安装插件

from autoboot import AutoBoot, AutoBootConfig
from .my_plugin import MyPlugin

context = Autoboot(AutoBootConfig(config_dir="./config"))
context.apply(MyPlugin())
context.run()

Ecosystem

• autoboot-web
• autoboot-data

Contributors

有问题可以在issues开话题讨论，如果你有新的想法，创建新的feat或pref分支并提交PR。

License

MIT License