litefs package

Build a web server framework using Python. Litefs was developed to implement a server framework that can quickly, securely, and flexibly build Web projects. Litefs is a high-performance HTTP server. Litefs has the characteristics of high stability, rich functions, and low system consumption.

Author: leafcoder Email: leafcoder@gmail.com

Subpackages

Submodules

litefs.config module

配置管理

支持多种配置来源和分层管理

class litefs.config.Config(config_file: str | None = None, **kwargs)[源代码]

基类：ConfigLoadersMixin, ConfigCryptoMixin

配置管理类

支持多种配置来源和分层管理： 1. 默认配置（内置） 2. 环境配置（如 config.production.yaml） 3. 本地配置（如 config.local.yaml） 4. 环境变量 5. 代码中的配置

配置优先级（从高到低）：代码配置 > 环境变量 > 本地配置 > 环境配置 > 默认值

DEFAULT_CONFIG: Dict[str, Any] = {'cache_backend': 'tree', 'cache_clean_period': 60, 'cache_expiration_time': 3600, 'cache_max_size': 10000, 'celery_backend': None, 'celery_broker': None, 'celery_config': None, 'config_encrypted_keys': [], 'config_env': None, 'config_file': None, 'config_secret_key': None, 'database_cache_table': 'cache', 'database_max_overflow': 20, 'database_pool_recycle': 3600, 'database_pool_size': 10, 'database_pool_timeout': 30, 'database_session_table': 'sessions', 'database_url': None, 'debug': False, 'default_page': 'index,index.html', 'error_pages_dir': None, 'file_cache_clean_period': 60, 'file_cache_expiration_time': 3600, 'host': 'localhost', 'i18n_cookie_name': 'locale', 'i18n_default_locale': 'en', 'i18n_enabled': False, 'i18n_locale_dir': 'locales', 'i18n_param_name': 'locale', 'i18n_supported_locales': ['en'], 'listen': 1024, 'log': './default.log', 'mail_default_from': None, 'mail_host': 'localhost', 'mail_max_retries': 3, 'mail_password': None, 'mail_port': 25, 'mail_template_dir': 'templates/email', 'mail_timeout': 30, 'mail_use_ssl': False, 'mail_use_tls': True, 'mail_username': None, 'max_request_size': 10485760, 'max_upload_size': 52428800, 'memcache_key_prefix': 'litefs:', 'memcache_servers': 'localhost:11211', 'memcache_session_key_prefix': 'litefs:session:', 'port': 9090, 'prometheus_enabled': False, 'prometheus_namespace': 'litefs', 'prometheus_path': '/metrics', 'redis_db': 0, 'redis_host': 'localhost', 'redis_key_prefix': 'litefs:', 'redis_password': None, 'redis_port': 6379, 'redis_session_key_prefix': 'litefs:session:', 'session_backend': 'memory', 'session_expiration_time': 3600, 'session_http_only': True, 'session_max_size': 1000000, 'session_name': 'litefs.sid', 'session_same_site': 'Lax', 'session_secure': None}

ENV_PREFIX: str = 'LITEFS_'

get(key: str, default: Any | None = None) → Any[源代码]

获取配置项

参数:

key -- 配置键
default -- 默认值

返回:

配置值

items() → List[tuple][源代码]: 获取所有配置项

keys() → List[str][源代码]: 获取所有配置键

set(key: str, value: Any)[源代码]

设置配置项

参数:

key -- 配置键
value -- 配置值

to_dict() → Dict[str, Any][源代码]

转换为字典

返回:: 配置字典

update(**kwargs)[源代码]

批量更新配置

参数:: **kwargs -- 配置项

values() → List[Any][源代码]: 获取所有配置值

litefs.config.load_config(config_file: str | None = None, env_prefix: str | None = None, **kwargs) → Config[源代码]

加载配置

参数:

config_file -- 配置文件路径
env_prefix -- 环境变量前缀（默认为 LITEFS_）
**kwargs -- 其他配置项

返回:

Config 对象

litefs.config.merge_configs(*configs: Config | Dict[str, Any]) → Config[源代码]

合并多个配置

参数:: *configs -- 配置对象或字典
返回:: 合并后的 Config 对象

litefs.core module

Litefs 应用核心

Litefs 类通过 Mixin 组合各能力模块：

RoutingMixin 路由注册与 WebSocket 入口（app/routing_mixin.py）
ProtocolMixin WSGI / ASGI 协议适配与错误处理（app/protocol_mixin.py）
ExtensionMixin 中间件、插件、健康检查与数据库扩展（app/extension_mixin.py）
ServerMixin 服务器启动、关闭与热重载（app/server_mixin.py）

本文件仅保留应用装配逻辑（构造函数）与向后兼容的符号再导出，对外接口（from litefs.core import Litefs, make_config, ...）保持不变。

class litefs.core.Litefs(**kwargs: Any)[源代码]

基类：RoutingMixin, ProtocolMixin, ExtensionMixin, ServerMixin

Litefs Web 应用

组合路由、协议适配、扩展能力与服务器生命周期，构造函数负责装配配置、日志、会话、缓存、中间件、路由、数据库与插件系统。

litefs.exceptions module

统一异常处理体系

提供完整的 HTTP 异常类和错误处理机制

exception litefs.exceptions.BadGateway(message: str | None = None, description: str | None = None)[源代码]