到期含利息收益

# 依赖版本：
# python==3.9
# QuantLib==1.43
from datetime import datetime
import traceback
import QuantLib as ql

# ============================================================
# 工具函数（原 util 模块内联）
# ============================================================
def _parse_date(s: str) -> ql.Date:
    """解析 'yyyy-mm-dd' 字符串为 ql.Date"""
    d = datetime.strptime(s.strip(), "%Y-%m-%d")
    return ql.Date(d.day, d.month, d.year)


def _map_period(period: int):
    """年付息次数 -> (ql.Period, ql.Frequency)"""
    mapping = {
        0:  (None,                     ql.NoFrequency),
        1:  (ql.Period(ql.Annual),     ql.Annual),
        2:  (ql.Period(ql.Semiannual), ql.Semiannual),
        3:  (ql.Period(4, ql.Months),  ql.EveryFourthMonth),
        4:  (ql.Period(ql.Quarterly),  ql.Quarterly),
        6:  (ql.Period(ql.Bimonthly),  ql.Bimonthly),
        12: (ql.Period(ql.Monthly),    ql.Monthly),
    }
    if period not in mapping:
        raise ValueError(f"不支持的 Period: {period}")
    return mapping[period]


def _map_basis(basis: int):
    """日计数基准编号 -> ql.DayCounter"""
    mapping = {
        0:  ql.ActualActual(ql.ActualActual.ISDA),
        1:  ql.Thirty360(ql.Thirty360.USA),
        2:  ql.Actual360(),
        3:  ql.Actual365Fixed(),
        4:  ql.Thirty360(ql.Thirty360.BondBasis),
        5:  ql.Thirty360(ql.Thirty360.ISDA),
        6:  ql.Thirty360(ql.Thirty360.European),
        7:  ql.Actual365Fixed(),
        8:  ql.ActualActual(ql.ActualActual.ISMA),
        9:  ql.Actual360(),
        10: ql.Actual365Fixed(),
        11: ql.Thirty360(ql.Thirty360.EurobondBasis),
        12: ql.Actual365Fixed(),
        13: ql.Business252(),
    }
    if basis not in mapping:
        raise ValueError(f"暂不支持的 Basis: {basis}")
    return mapping[basis]


# ============================================================
# 核心计算函数
# ============================================================
def qjquant_calu_yldmat(
    settle_var: str,
    maturity_var: str,
    issue_var: str,
    face_var: float,
    price_var: float,
    coupon_var: float,
    basis_var: int = 0,
):
    try:
        # ---------- 参数校验 ----------
        if face_var <= 0:
            return {"ok": False, "msg": "面值必须为正"}
        if coupon_var < 0:
            return {"ok": False, "msg": "票面利率不能为负"}
        if price_var <= 0:
            return {"ok": False, "msg": "价格必须为正"}

        settle_date   = _parse_date(settle_var)
        maturity_date = _parse_date(maturity_var)
        issue_date    = _parse_date(issue_var)

        if settle_date >= maturity_date:
            return {"ok": False, "msg": "结算日必须早于到期日"}
        if issue_date > settle_date:
            return {"ok": False, "msg": "发行日必须早于或等于结算日"}

        dc = _map_basis(basis_var)

        # ---------- 计算年分数与到期金额（与 prmat 一致）----------
        T_issue_to_mat = dc.yearFraction(issue_date, maturity_date)
        T_issue_to_set = dc.yearFraction(issue_date, settle_date)

        # 到期赎回金额 = 面值 + 累计利息（单利）
        redemption_amount = face_var * (1.0 + coupon_var * T_issue_to_mat)

        # 应计利息（结算日之前累计）
        accru_interest = face_var * coupon_var * T_issue_to_set

        # ---------- 全价 = 净价 + 应计利息 ----------
        dirty_price = price_var + accru_interest

        # ---------- 设置评估日与现金流 ----------
        ql.Settings.instance().evaluationDate = settle_date

        # 到期单笔现金流
        cf = ql.SimpleCashFlow(redemption_amount, maturity_date)
        leg = [cf]

        # ---------- 用 CashFlows.yieldRate 反解收益率 ----------
        y = ql.CashFlows.yieldRate(
            leg,
            dirty_price,
            dc,
            ql.Simple,
            ql.Annual,
            True,  # includeSettlementDateFlows
        )

        return {
            "ok": True,
            "yield": round(y, 4),
        }

    except ValueError as ve:
        traceback.print_exc()
        return {"ok": False, "msg": f"参数错误: {ve}"}
    except Exception as e:
        traceback.print_exc()
        return {"ok": False, "msg": f"未知错误: {e}"}


# ============================================================
# 示例：复制本文件后直接运行
# ============================================================
if __name__ == "__main__":
    print("=" * 60)
    print("示例 1：附息，实际/实际（basis=0）")
    print("=" * 60)
    r1 = qjquant_calu_yldmat(
        settle_var="2024-03-15",
        maturity_var="2029-06-20",
        issue_var="2024-01-01",
        face_var=100.0,
        price_var=95.5,
        coupon_var=0.05,
        basis_var=0,
    )
    print(r1)

    print()
    print("=" * 60)
    print("示例 2：零息债（coupon=0，实际/实际）")
    print("=" * 60)
    r2 = qjquant_calu_yldmat(
        settle_var="2024-03-15",
        maturity_var="2026-06-20",
        issue_var="2024-01-01",
        face_var=100.0,
        price_var=92.0,
        coupon_var=0.0,
        basis_var=0,
    )
    print(r2)

    print()
    print("=" * 60)
    print("示例 3：附息，30/360 USA（basis=1）")
    print("=" * 60)
    r3 = qjquant_calu_yldmat(
        settle_var="2024-03-15",
        maturity_var="2029-06-20",
        issue_var="2024-01-01",
        face_var=100.0,
        price_var=98.0,
        coupon_var=0.05,
        basis_var=1,
    )
    print(r3)

    print()
    print("=" * 60)
    print("示例 4：附息，实际/365 Fixed（basis=3）")
    print("=" * 60)
    r4 = qjquant_calu_yldmat(
        settle_var="2024-06-15",
        maturity_var="2027-12-31",
        issue_var="2024-01-01",
        face_var=100.0,
        price_var=97.0,
        coupon_var=0.03,
        basis_var=3,
    )
    print(r4)