Metadata-Version: 2.1
Name: zhDateTime
Version: 2.0.1
Summary: 中式日期时间库，附带数字汉字化功能。
Keywords: midi,minecraft,minecraft: bedrock edition
Author: 金羿Eilles
Maintainer-Email: =?utf-8?b?6YeR576/RWlsbGVz?= <EillesWan@outlook.com>
License:                 木兰宽松许可证, 第2版
         
         木兰宽松许可证， 第2版
         2020年1月 http://license.coscl.org.cn/MulanPSL2
         
         您对“软件”的复制、使用、修改及分发受木兰宽松许可证，第2版（“本许可证”）的如下条款的约束：
         
         0.   定义
         
         “软件” 是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。
         
         “贡献” 是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。
         
         “贡献者” 是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。
         
         “法人实体” 是指提交贡献的机构及其“关联实体”。
         
         “关联实体” 是指，对“本许可证”下的行为方而言，控制、受控制或与其共同受控制的机构，此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。
         
         1.   授予版权许可
         
         每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可，您可以复制、使用、修改、分发其“贡献”，不论修改与否。
         
         2.   授予专利许可
         
         每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的（根据本条规定撤销除外）专利许可，供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求，不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地，就“软件”或其中的“贡献”对任何人发起专利侵权诉讼（包括反诉或交叉诉讼）或其他专利维权行动，指控其侵犯专利权，则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。
         
         3.   无商标许可
         
         “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可，但您为满足第4条规定的声明义务而必须使用除外。
         
         4.   分发限制
         
         您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发，不论修改与否，但您必须向接收者提供“本许可证”的副本，并保留“软件”中的版权、商标、专利及免责声明。
         
         5.   免责声明与责任限制
         
         “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下，“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任，不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。
         
         6.   语言
         
         “本许可证”以中英文双语表述，中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致，以中文版为准。
         
         条款结束
         
         如何将木兰宽松许可证，第2版，应用到您的软件
         
         如果您希望将木兰宽松许可证，第2版，应用到您的新软件，为了方便接收者查阅，建议您完成如下三步：
         
         1， 请您补充如下声明中的空白，包括软件名、软件的首次发表年份以及您作为版权人的名字；
         
         2， 请您在软件包的一级目录下创建以“LICENSE”为名的文件，将整个许可证文本放入该文件中；
         
         3， 请将如下声明文本放入每个源文件的头部注释中。
         
         Copyright (c) [Year] [name of copyright holder]
         [Software Name] is licensed under Mulan PSL v2.
         You can use this software according to the terms and conditions of the Mulan PSL v2.
         You may obtain a copy of Mulan PSL v2 at:
                  http://license.coscl.org.cn/MulanPSL2
         THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
         EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
         MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
         See the Mulan PSL v2 for more details.
         
         
                         Mulan Permissive Software License，Version 2
         
         Mulan Permissive Software License，Version 2 (Mulan PSL v2)
         January 2020 http://license.coscl.org.cn/MulanPSL2
         
         Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions:
         
         0. Definition
         
         Software means the program and related documents which are licensed under this License and comprise all Contribution(s).
         
         Contribution means the copyrightable work licensed by a particular Contributor under this License.
         
         Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License.
         
         Legal Entity means the entity making a Contribution and all its Affiliates.
         
         Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity.
         
         1. Grant of Copyright License
         
         Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not.
         
         2. Grant of Patent License
         
         Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken.
         
         3. No Trademark License
         
         No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in section 4.
         
         4. Distribution Restriction
         
         You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software.
         
         5. Disclaimer of Warranty and Limitation of Liability
         
         THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
         
         6. Language
         
         THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL.
         
         END OF THE TERMS AND CONDITIONS
         
         How to Apply the Mulan Permissive Software License，Version 2 (Mulan PSL v2) to Your Software
         
         To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps:
         
         Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner;
         Create a file named "LICENSE" which contains the whole context of this License in the first directory of your software package;
         Attach the statement to the appropriate annotated syntax at the beginning of each source file.
         
         Copyright (c) [Year] [name of copyright holder]
         [Software Name] is licensed under Mulan PSL v2.
         You can use this software according to the terms and conditions of the Mulan PSL v2.
         You may obtain a copy of Mulan PSL v2 at:
                  http://license.coscl.org.cn/MulanPSL2
         THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
         EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
         MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
         See the Mulan PSL v2 for more details.
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: Chinese (Simplified)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Mulan Permissive Software License v2 (MulanPSL-2.0)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Project-URL: Repository, https://gitee.com/EillesWan/zhDateTime
Project-URL: Issues, https://gitee.com/EillesWan/zhDateTime/issues
Project-URL: Mirror-Repository, https://github.com/EillesWan/zhDateTime
Project-URL: Mirror-Issues, https://github.com/EillesWan/zhDateTime/issues
Requires-Python: <4.0,>=3.8
Provides-Extra: dev
Requires-Dist: twine; extra == "dev"
Requires-Dist: rich; extra == "dev"
Description-Content-Type: text/markdown

# 简易 Python 中式日期时间库

### 简介

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

**敬告：该库自 2.0.0 版本开始与之前的所有版本接口不再兼容**

### 用法

1.  农历与公历

```python
# 导入模块中的类
from zhDateTime import DateTime, zhDateTime

# 利用 DateTime 类创建公历日期
western_date = DateTime(2020, 5, 20)
# 利用 chinesize 属性转换为农历日期
chinese_date = western_date.chinesize

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


# 也可以通过各自的类函数进行自主创建
a_western_date = DateTime.from_chinese_format(2024, 3, False, 13)
a_chinese_date = zhDateTime.from_western_format(2020, 5, 20)

# DateTime 类是增强型的 datetime.datetime 类，因此可以用相同的方式使用后者的函数
b_western_datetime = DateTime.now()
b_chinese_datetime = b_western_datetime.chinesize

# zhDateTime类可以进行汉字化输出
print(b_chinese_datetime.chinese_text)
# 输出应类似
# 公元二〇二五 农历乙巳蛇年 正月初三 丑时一刻 又十二分五十一秒八五 余五十一微六十二纤
# 公元二〇二五 农历乙巳蛇年 正月初三 丑时 零四分廿五秒八四 余四微六十四纤
# 公元二〇二五 农历乙巳蛇年 正月初三 子时四刻整

# 也可以分日期和时间输出不同部分（参照国家标准，此处公元2024年是农历年首所在年份）
print(b_chinese_datetime.date_hanzify())
# 类似
# 公元二〇二四 农历甲辰龙年 三月十二
print(b_chinese_datetime.time_hanzify())
# 类似
# 午时三刻 又一分三十秒三九 余五十五微六十纤
# 子时四刻整
# 丑时 零四分廿五秒八四
# 寅时二刻 又一分廿八秒
# 卯时一刻 又四分整
# 午时 零三十二秒 余四微三十六纤

# 汉字化的日期和时间函数是支持自定义格式的
print(b_chinese_datetime.date_hanzify("{干支年}{生肖}年{月份}月"))
# 类似 甲辰龙年三月
print(b_chinese_datetime.time_hanzify("{地支时}时{刻} {分}{秒}{忽}"))
# 类似 午时三刻 又一分三十秒三九
# 具体可用的格式参数请详见函数文档


# 此二类者，皆可各自加减
print(
    (zhDateTime(2024, 3, False, 12) + (DateTime.now() - DateTime(2024, 3, 1)))
    - (DateTime.now().chinesize - 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_chinese_calendar_month_list,  # 依据提供的公历年份，给出当年每月天数列表及闰月月份
    get_chinese_new_year,  # 依据提供的公历年份，返回当年的农历新年所在的公历日期
    verify_chinese_calendar_date,  # 检查所给出之农历日期是否符合本库之可用性
)
```

### 授权

zhDateTime 库源代码之授权采用 **木兰宽松许可证，第2版** 进行授权。

> 版权所有 © 2025 金羿ELS  
> Copyright (C) 2025 Eilles(EillesWan@outlook.com)
>
> zhDateTime is licensed under Mulan PSL v2.  
> You can use this software according to the terms and conditions of the Mulan PSL v2.  
> You may obtain a copy of Mulan PSL v2 at:  
>         http://license.coscl.org.cn/MulanPSL2  
> THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,  
> EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,  
> MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.  
> See the Mulan PSL v2 for more details.

### 参标

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)为古代文献的查考提供便捷实用的途径
