hyperquant 0.1.0__py3-none-any.whl

hyperquant/logkit.py

@@ -0,0 +1,190 @@
+import logging
+import sys
+import unicodedata
+from datetime import datetime
+from zoneinfo import ZoneInfo
+from colorama import Fore, Style, init
+import os
+import traceback
+
+init(autoreset=True)
+
+# ====================================================================================================
+# ** 添加ok的日志级别 **
+# 给默认的logging模块，添加一个用于表达成功的级别
+# ====================================================================================================
+OK_LEVEL = 25
+logging.addLevelName(OK_LEVEL, "OK")
+
+def ok(self, message, *args, **kwargs):
+    if self.isEnabledFor(OK_LEVEL):
+        self._log(OK_LEVEL, message, args, **kwargs)
+
+logging.Logger.ok = ok
+
+# ====================================================================================================
+# ** 辅助函数 **
+# - get_display_width(): 获取文本的显示宽度，中文字符算作1.685个宽度单位，以尽量保持显示居中
+# ====================================================================================================
+def get_display_width(text: str) -> int:
+    width = 0
+    for char in text:
+        if unicodedata.east_asian_width(char) in ('F', 'W', 'A'):
+            width += 1.685
+        else:
+            width += 1
+    return int(width)
+
+# ====================================================================================================
+# ** 自定义Logger类封装所有功能 **
+# ====================================================================================================
+class Logger:
+    OK_LEVEL = 25
+    FORMATS = {
+        logging.DEBUG: ('', ''),
+        logging.INFO: (Fore.BLUE, "🔵 "),
+        logging.WARNING: (Fore.YELLOW, "🔔 "),
+        logging.ERROR: (Fore.RED, "❌ "),
+        logging.CRITICAL: (Fore.RED + Style.BRIGHT, "⭕ "),
+        OK_LEVEL: (Fore.GREEN, "✅ "),
+    }
+
+    def __init__(self, name='Log', show_time=False, use_color=True, timezone="Asia/Shanghai"):
+        # 设置日志级别
+        self.logger = logging.getLogger(name)
+        self.logger.setLevel(logging.DEBUG)
+        self.show_time = show_time
+        self.timezone = timezone  # 新增时区配置
+
+        # 如果已存在 handlers，先清理
+        if self.logger.hasHandlers():
+            self.logger.handlers.clear()
+
+        # 控制台输出 handler
+        console_handler = MinConsoleHandler(sys.stdout)
+        console_handler.setFormatter(MinFormatter(use_color=use_color, show_time=show_time, timezone=timezone))
+        self.logger.addHandler(console_handler)
+
+        # 禁用传播到根日志记录器
+        self.logger.propagate = False
+
+    def divider(self, name='', sep='=', display_time=True):
+        """打印带时间戳的分割线"""
+        seperator_len = 72
+        now = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
+        middle = f' {name} {now} ' if display_time else f' {name} '
+        middle_width = get_display_width(middle)
+        decoration_count = max(4, (seperator_len - middle_width) // 2)
+        line = sep * decoration_count + middle + sep * decoration_count
+
+        if get_display_width(line) < seperator_len:
+            line += sep
+
+        self.logger.debug(line)
+
+    def get_logger(self):
+        """返回 logger 实例"""
+        return self.logger
+
+    # 为各个日志级别创建方法，便于编辑器提示
+    def ok(self, message, *args, **kwargs):
+        return self.logger.ok(message, *args, **kwargs)
+
+    def info(self, message, *args, **kwargs):
+        return self.logger.info(message, *args, **kwargs)
+
+    def debug(self, message, *args, **kwargs):
+        return self.logger.debug(message, *args, **kwargs)
+
+    def warning(self, message, *args, **kwargs):
+        return self.logger.warning(message, *args, **kwargs)
+
+    def error(self, message, *args, **kwargs):
+        return self.logger.error(message, *args, **kwargs)
+
+    def critical(self, message, *args, **kwargs):
+        return self.logger.critical(message, *args, **kwargs)
+    
+    def exception(self, message, *args, **kwargs):
+        return self.logger.exception(message, *args, **kwargs)
+
+class MinFormatter(logging.Formatter):
+    def __init__(self, use_color=True, show_time=False, timezone="Asia/Shanghai"):
+        super().__init__("%(message)s")
+        self.use_color = use_color
+        self.show_time = show_time
+        self.timezone = timezone  # 新增时区配置
+
+    def format(self, record):
+        original_message = record.getMessage()
+
+        # 使用配置的时区
+        local_tz = ZoneInfo(self.timezone)
+        timestamp = f"[{datetime.now(local_tz).strftime('%Y-%m-%d %H:%M:%S')}] " if self.show_time else ""
+
+        if self.use_color:
+            color, prefix = Logger.FORMATS.get(record.levelno, ('', ''))
+            formatted_message = f"{timestamp}{color}{prefix}{original_message}{Style.RESET_ALL}"
+        else:
+            _, prefix = Logger.FORMATS.get(record.levelno, ('', ''))
+            formatted_message = f"{timestamp}{prefix}{original_message}"
+
+        # 添加异常信息
+        if record.exc_info:
+            exc_text = ''.join(traceback.format_exception(*record.exc_info))
+            formatted_message += f"\n{Fore.RED}{exc_text}{Style.RESET_ALL}" if self.use_color else f"\n{exc_text}"
+
+        return formatted_message
+
+class MinConsoleHandler(logging.StreamHandler):
+    def emit(self, record):
+        if record.levelno == logging.DEBUG:
+            print(self.format(record), flush=True)
+        elif record.levelno == Logger.OK_LEVEL:
+            super().emit(record)
+            print()
+        else:
+            super().emit(record)
+
+# ====================================================================================================
+# ** 功能函数 **
+# ====================================================================================================
+def get_logger(name=None, file_path=None, show_time=False, use_color=True, timezone="Asia/Shanghai") -> Logger:
+    if name is None:
+        name = '_'
+    logger_instance = Logger(name, show_time, use_color, timezone)  # 传递时区参数
+    if file_path:
+        # 如果目录不存在，创建目录
+        os.makedirs(os.path.dirname(file_path), exist_ok=True)
+        add_file_handler(logger_instance.get_logger(), file_path, show_time, timezone)
+    return logger_instance
+
+def add_file_handler(logger: logging.Logger, path: str, show_time=False, timezone="Asia/Shanghai"):
+    # 添加文件日志输出，启用时间戳
+    file_handler = logging.FileHandler(path)
+    file_handler.setFormatter(MinFormatter(use_color=False, show_time=show_time, timezone=timezone))  # 传递时区参数
+    logger.addHandler(file_handler)
+
+# ====================================================================================================
+# ** 示例使用 **
+# ====================================================================================================
+if __name__ == '__main__':
+    # 获取日志对象
+    logger = get_logger('xx', 'logs/application.log', show_time=True, use_color=True)  # This will use Logger
+
+    # 输出日志信息
+    logger.debug("调试信息，没有标记和颜色，等同于print")
+    logger.info("提示信息，蓝色的，可以记录一些中间结果")
+    logger.ok("完成提示，绿色的，通常表示成功和完成")
+    logger.warning("警告信息，黄色的，通常表示警告")
+    logger.error("错误信息，红色的，通常是报错的相关提示")
+    logger.critical("重要提示，深红色。通常是非常关键的信息")
+
+    # 使用 divider 方法
+    logger.divider("这是一个分割线", sep='*', display_time=True)
+
+    # 触发一个异常
+    try:
+        1 / 0
+    except Exception:
+        logger.exception("捕获到一个异常，程序将继续运行。")

hyperquant-0.1.0.dist-info/METADATA

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: hyperquant
+Version: 0.1.0
+Summary: A minimal yet hyper-efficient backtesting framework for quantitative trading
+Project-URL: Homepage, https://github.com/yourusername/hyperquant
+Project-URL: Issues, https://github.com/yourusername/hyperquant/issues
+Author-email: MissinA <1421329142@qq.com>
+License: MIT
+Keywords: backtesting,hyperquant,quant,trading
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.8
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: pyecharts>=2.0.8
+Description-Content-Type: text/markdown
+
+# minquant
+
+minquant is a minimalistic framework for quantitative trading strategies. It allows users to quickly validate their strategy ideas with ease and efficiency.
+
+## Core APIs
+
+### `core.py`
+主要功能包括：
+- `ExchangeBase` 和 `Exchange` 类：实现基础的交易功能
+  - 资产管理（初始资金、已实现/未实现盈亏等）
+  - 下单交易（买入、卖出、平仓等）
+  - 仓位管理和风控
+  - 账户状态更新和记录
+- `gen_back_time` 函数：回测时间周期管理，支持训练和测试时间区间的生成
+
+### `draw.py`
+主要功能包括：
+- 支持多种图表类型：K线、曲线、柱状图等
+- 提供丰富的交互功能：
+  - 时间轴缩放和跳转
+  - 自动播放功能
+  - 多图表联动显示
+  - 指标叠加功能
+- 提供详细的数据标注：
+  - 交易信号标记
+  - 数据显示和提示
+  - 自定义颜色和样式
+
+### `logkit.py`
+主要功能包括：
+- 自定义日志级别和格式化：
+  - DEBUG: 调试信息
+  - INFO: 普通信息（蓝色）
+  - OK: 成功信息（绿色）
+  - WARNING: 警告信息（黄色）
+  - ERROR: 错误信息（红色）
+  - CRITICAL: 严重错误（深红色）
+- 支持多种日志输出：
+  - 控制台彩色输出
+  - 文件日志记录
+- 提供便捷的日志分割线和时间戳功能
+- 支持异常信息的格式化输出
+- 可配置时区和时间显示
+
+## 使用方法
+
+### 1. 初始化交易环境
+```python
+from core import Exchange
+# 创建交易实例，设置初始资金和交易品种
+exchange = Exchange(
+    trade_symbols=['BTCUSDT'],  # 交易品种
+    initial_balance=10000,      # 初始资金
+    fee=0.0002,                # 手续费率
+    recorded=True              # 是否记录交易历史
+)
+```
+
+### 2. 执行交易操作
+```python
+# 买入操作
+exchange.Buy('BTCUSDT', price=30000, amount=0.1, time='2024-01-01')
+
+# 卖出操作
+exchange.Sell('BTCUSDT', price=31000, amount=0.1, time='2024-01-02')
+
+# 获取账户状态
+print(exchange.stats)
+```
+
+### 3. 绘制分析图表
+```python
+from draw import draw
+import pandas as pd
+
+# 准备数据
+data_df = pd.DataFrame({
+    'date': [...],      # 时间列
+    'open': [...],      # 开盘价
+    'close': [...],     # 收盘价
+    'high': [...],      # 最高价
+    'low': [...],       # 最低价
+    'volume': [...]     # 成交量
+})
+
+# 配置图表
+data_dict = [
+    {
+        'series_name': 'K线图',
+        'draw_type': 'Kline',
+        'height': 60,
+        'col': ['open', 'close', 'low', 'high']
+    },
+    {
+        'series_name': '成交量',
+        'draw_type': 'Bar',
+        'height': 20,
+        'col': 'volume'
+    }
+]
+
+# 绘制图表
+draw(
+    df=data_df,
+    data_dict=data_dict,
+    date_col='date',
+    title='BTC/USDT'
+)
+```
+
+### 4. 日志记录
+```python
+from logkit import get_logger
+
+# 创建日志实例
+logger = get_logger(
+    name='strategy',                  # 日志名称
+    file_path='logs/strategy.log',    # 日志文件路径
+    show_time=True,                   # 显示时间戳
+    use_color=True                    # 使用彩色输出
+)
+
+# 记录不同级别的日志
+logger.debug("调试信息")
+logger.info("普通信息")
+logger.ok("成功信息")
+logger.warning("警告信息")
+logger.error("错误信息")
+logger.critical("严重错误")
+
+# 使用分割线
+logger.divider("回测开始", sep='=', display_time=True)
+```

hyperquant-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+hyperquant/__init__.py,sha256=NRq3MhT7sETNAP-EQ0y5fYgzZl2eAmo9llun1lojYl0,84
+hyperquant/core.py,sha256=wYCQw10_Nzx1KUJnkuO6IqksElOWXZ8xaKp38oJfphY,18838
+hyperquant/draw.py,sha256=jweENVzf0nWHogzUliwJHI2PgbeQ3V2H749cMJ256k0,54614
+hyperquant/logkit.py,sha256=WALpXpIA3Ywr5DxKKK3k5EKubZ2h-ISGfc5dUReQUBQ,7795
+hyperquant-0.1.0.dist-info/METADATA,sha256=jfV05dHrbYj4rldc1gM9c-IkW5BISCpOqRT3ToUtWNo,4161
+hyperquant-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hyperquant-0.1.0.dist-info/RECORD,,

hyperquant-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any