Metadata-Version: 2.1
Name: zhDateTime
Version: 1.0.2
Summary: 一个简单的小巧的中式日期时间库，附带数字汉字化操作。
Home-page: https://gitee.com/EillesWan/zhDateTime
Author: Eilles Wan
Author-email: EillesWan@outlook.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# 简易 Python 中式日期时间库

### 简介

一个简单小巧的轻量级中式日期时间库，支持农历公历互相转换，支持时辰刻数的时间表达转换，支持整数汉字化。

### 用法

1.  农历与公历

```python
from zhDateTime import DateTime,zhDateTime

# 利用DateTime类创建公历日期
solar_date = DateTime(2020,5,20)
# 利用to_lunar函数转换为农历日期
lunar_date = solar.to_lunar()

# 利用zhDateTime类创建农历日期
date_lunar = zhDateTime(2024,3,False,13)    # 此处之False示意是否为闰月
# 利用to_solar函数转换为公历日期
date_solar = date_lunar.to_solar()


# 也可以通过各自的类函数进行自主创建
a_solar_date = DateTime.from_lunar(2024,3,False,13)
a_lunar_date = zhDateTime.from_solar(2020,5,20)


# zhDateTime类可以进行汉字化输出
print(DateTime.now().to_lunar().hanzify())
# 输出应类似 二〇二四 甲辰龙年三月十三日 午时 零十四分三秒九二 余十九微七十八纤
# 也可以分日期和时间输出不同部分
print(DateTime.now().to_lunar().date_hanzify())
# 类似 二〇二四 甲辰龙年三月十二日
print(DateTime.now().to_lunar().time_hanzify())
# 类似 午时三刻 又一分三十秒三九 余五十五微六十纤


# 此二类者，皆可己为加减
print(
    (zhDateTime(2024,3,False,12) + (DateTime.now() - DateTime(2024,3,1)))
    - (DateTime.now().to_lunar() - zhDateTime(2023,2,False,1))
)
# 输出应为zhDateTime类，类似 农历 2023年3月22日 0时4刻0分0秒0
```

2.  汉字数字表示法

```python
# 对整数进行汉字分组

# 分离各个单位，不进行其他处理
from zhDateTime import int_group
print(int_group(1010045760500200000000026410400044640400000002))
# 应为 [10, '载', 1004, '正', 5760, '涧', 5002, '沟', 0, '穰', 0, '秭', 264, '垓', 1040, '京', 44, '兆', 6404, ' 亿', 0, '万', 2]

# 分离单位的同时，包括中间的“零”
from zhDateTime import int_group_seperated
print(int_group_seperated(1010045760500200000000026410400044640400000002))
# 应为 [10, '载', 1004, '正', 5760, '涧', 5002, '沟', '零', 264, '垓', 1040, '京', '零', 44, '兆', 6404, '亿', ' 零', 2]

# 输出分离后的字符串，包括中间的“零”
from zhDateTime import int_2_grouped_han_str
print(int_2_grouped_han_str(1010045760500200000000026410400044640400000002))
# 应为 10载1004正5760涧5002沟零264垓1040京零44兆6404亿零2


# 四位以内整数的汉字化读法
from zhDateTime import lkint_hanzify
lkint_hanzify(1534)
# 一千五百三十四
lkint_hanzify(1020)
# 一千零二十
lkint_hanzify(29)
# 廿九

# 常规整数汉字化读法
from zhDateTime import int_hanzify
int_hanzify(1010045760500200000000026410400044640400000002)
# 十载一千零四正五千七百六十涧五千零二沟零二百六十四垓一千零四十京零四十四兆六千四百零四亿零二

```

3.  日期相关数据

```python
# 就这四个函数，，，自己看一下函数文档吧
from zhDateTime import (
    shichen_ke_2_hour_minute,
    hour_minute_2_shichen_ke,
    get_lunar_month_list,
    get_lunar_new_year,
    verify_lunar_date,
)

```

### 参标

1. 本库的农历日期计算方法参照[《中华人民共和国国家标准 GB/T 33661—2017〈农历的编算和颁行〉》](https://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=E107EA4DE9725EDF819F33C60A44B296)
2. 本库的时刻表达方法参照[时辰\_百度百科](https://baike.baidu.com/item/%E6%97%B6%E8%BE%B0/524274)中，唐以后的“十二时辰制”，此制是目前最为广为人知的时辰表示方法；对于宋以后的“二十四时辰”制，本库虽有提供相关内容，但并不实际采用
3. 本库中的拼音参照[《中华人民共和国国家标准 GB/T 16159-2012〈汉语拼音正词法基本规则〉》](https://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=5645BD8DB9D8D73053AD3A2397E15E74)
4. 本库中的汉字大数表示方法，参照[徐岳．数术记遗．](https://ctext.org/wiki.pl?if=gb&res=249044&remap=gb)<font color=gray size=0.5>《周髀算经》，汉</font>
5. 本库中的汉字数字表示方法参照[读数法\_百度百科](https://baike.baidu.com/item/%E8%AF%BB%E6%95%B0%E6%B3%95/22670728)中，十进制读数法的相关内容
6. 本库的汉字数字用法参照[《中华人民共和国国家标准 GB/T 15835-2011〈出版物上数字用法的规定〉》](https://xb.sasu.edu.cn/__local/9/03/2D/4990C7C8DFC8D015AC7CD1FA1F9_237F574B_5DAA5.pdf)

### 致谢

1. 感谢[香港天文台](https://www.hko.gov.hk/tc/index.html)的[公历与农历日期对照表](https://www.hko.gov.hk/tc/gts/time/conversion1_text.htm)提供的自公历 1901 年至公历 2100 年的农历日期对照数据
2. 感谢[zhdate](https://github.com/CutePandaSh/zhdate)项目启发，以至于作者决定开发此项目，作者曾去那贡献过代码（awa）
3. 感谢[cnlunar 相关代码](https://github.com/OPN48/cnlunar/blob/master/cnlunar/config.py)为存储日期的方式样式提供启发
4. 感谢[中国哲学书电子化计划](https://ctext.org/zhs)为古代文献的查考提供便捷实用的途径
