# This file is auto-generated by generate_models.py
# This file may be manually edited after generation
# The file has been formatted using isort and black

from typing import Any, ClassVar, Dict, List

from sqlalchemy import Column, PrimaryKeyConstraint, text

from tushare_models.core import Base, Date, DateTime, Float, Integer, String
from tushare_models.core.dialect_config import apply_table_dialect_options


class Dividend(Base):
    """分红送股数据"""

    __tablename__: str = "dividend"
    __api_id__: ClassVar[int] = 103
    __api_name__: ClassVar[str] = "dividend"
    __api_title__: ClassVar[str] = "分红送股数据"
    __api_info_title__: ClassVar[str] = "分红送股数据"
    __api_path__: ClassVar[List[str]] = ["数据接口", "股票数据", "财务数据"]
    __api_path_ids__: ClassVar[List[int]] = [1, 2, 5]
    __api_points_required__: ClassVar[int] = 0
    __api_special_permission__: ClassVar[bool] = False
    __has_vip__: ClassVar[bool] = False
    __dependencies__: ClassVar[List[str]] = []
    __primary_key__: ClassVar[List[str]] = ["ts_code", "end_date", "ann_date"]
    __start_date__: ClassVar[str | None] = None
    __end_date__: ClassVar[str | None] = None
    __api_params__: ClassVar[Dict[str, Any]] = {
        "ts_code": {"type": "String", "required": False, "description": "TS代码"},
        "ann_date": {"type": "String", "required": False, "description": "公告日（格式：YYYYMMDD，下同）"},
        "end_date": {"type": "String", "required": False, "description": "分红年度"},
        "record_date": {"type": "String", "required": False, "description": "股权登记日期"},
        "ex_date": {"type": "String", "required": False, "description": "除权除息日"},
        "imp_ann_date": {"type": "String", "required": False, "description": "实施公告日"},
        "limit": {"type": "Int64", "required": False, "description": "单次返回数据长度"},
        "offset": {"type": "Int64", "required": False, "description": "请求数据的开始位移量"},
    }

    __mapper_args__ = {"primary_key": __primary_key__}
    __table_args__ = (
        PrimaryKeyConstraint(*__primary_key__),
        {
            "comment": "分红送股数据",
            # MySQL引擎
            "mysql_engine": "InnoDB",
        },
    )

    ts_code = Column("ts_code", String(16), nullable=False, comment="TS代码")
    end_date = Column("end_date", Date, nullable=False, comment="分送年度")
    ann_date = Column("ann_date", Date, nullable=False, comment="预案公告日(董事会)")
    div_proc = Column("div_proc", String(), nullable=True, comment="实施进度")
    stk_div = Column("stk_div", Float, nullable=True, comment="每股送转")
    stk_bo_rate = Column("stk_bo_rate", Float, nullable=True, comment="每股送股比例")
    stk_co_rate = Column("stk_co_rate", Float, nullable=True, comment="每股转增比例")
    cash_div = Column("cash_div", Float, nullable=True, comment="每股分红(税后)")
    cash_div_tax = Column("cash_div_tax", Float, nullable=True, comment="每股分红(税前)")
    record_date = Column("record_date", Date, nullable=True, comment="股权登记日")
    ex_date = Column("ex_date", Date, nullable=True, comment="除权除息日")
    pay_date = Column("pay_date", Date, nullable=True, comment="派息日")
    div_listdate = Column("div_listdate", Date, nullable=True, comment="红股上市日")
    imp_ann_date = Column("imp_ann_date", Date, nullable=True, comment="实施公告日")
    base_date = Column("base_date", Date, nullable=True, comment="基准日")
    base_share = Column("base_share", Float, nullable=True, comment="实施基准股本(万)")
    update_flag = Column("update_flag", Date, nullable=True, comment="是否变更过(1表示变更)")

apply_table_dialect_options(Dividend)
