refactor(filetree): rename package's namespace as hrc

HydroRoll-Team · Jun 20, 2024 · a2477b2 · a2477b2
1 parent 2e5b7e8
commit a2477b2
Show file tree

Hide file tree

Showing 28 changed files with 81 additions and 18 deletions.
diff --git a/hrc/LibCore.py b/hrc/LibCore.py
diff --git a/hydro_roll_core/libcore.pyi → hrc/LibCore.pyi b/hydro_roll_core/libcore.pyi → hrc/LibCore.pyi
@@ -1,4 +1,4 @@
-class libcore(object):
+class LibCore(object):
     """Core library for hydro roll"""
 
     def __init__(self, name: str = ""): ...

diff --git a/hrc/__init__.py b/hrc/__init__.py
@@ -0,0 +1,2 @@
+from .LibCore import *
+from . import rules
diff --git a/hydro_roll_core/cli.py → hrc/cli.py b/hydro_roll_core/cli.py → hrc/cli.py
diff --git a/hydro_roll_core/config.py → hrc/config.py b/hydro_roll_core/config.py → hrc/config.py
diff --git a/hydro_roll_core/const.py → hrc/const.py b/hydro_roll_core/const.py → hrc/const.py
diff --git a/hydro_roll_core/core.py → hrc/core.py b/hydro_roll_core/core.py → hrc/core.py
diff --git a/hydro_roll_core/dependencies.py → hrc/dependencies.py b/hydro_roll_core/dependencies.py → hrc/dependencies.py
diff --git a/hydro_roll_core/development/__init__.py → hrc/development/__init__.py b/hydro_roll_core/development/__init__.py → hrc/development/__init__.py
diff --git a/hydro_roll_core/development/character.py → hrc/development/character.py b/hydro_roll_core/development/character.py → hrc/development/character.py
diff --git a/hydro_roll_core/document/__init__.py → hrc/document/__init__.py b/hydro_roll_core/document/__init__.py → hrc/document/__init__.py
diff --git a/hydro_roll_core/exceptions.py → hrc/exceptions.py b/hydro_roll_core/exceptions.py → hrc/exceptions.py
diff --git a/hydro_roll_core/feature/__init__.py → hrc/feature/__init__.py b/hydro_roll_core/feature/__init__.py → hrc/feature/__init__.py
diff --git a/hydro_roll_core/log.py → hrc/log.py b/hydro_roll_core/log.py → hrc/log.py
diff --git a/hydro_roll_core/performance/__init__.py → hrc/performance/__init__.py b/hydro_roll_core/performance/__init__.py → hrc/performance/__init__.py
diff --git a/hydro_roll_core/py.typed → hrc/py.typed b/hydro_roll_core/py.typed → hrc/py.typed
diff --git a/hydro_roll_core/rule_package.py → hrc/rule_package.py b/hydro_roll_core/rule_package.py → hrc/rule_package.py
diff --git a/hydro_roll_core/rules/BaseRule/JudgeRule.py → hrc/rules/BaseRule/JudgeRule.py b/hydro_roll_core/rules/BaseRule/JudgeRule.py → hrc/rules/BaseRule/JudgeRule.py
@@ -1,14 +1,9 @@
 import dataclasses
 from dataclasses import dataclass
 from typing import Literal, Optional, Union
-from typing_extensions import override
 
 @dataclass
-class JudgeRule(object):
-    """判定规则"""
-    property: type
-
-class Custom(JudgeRule):
+class Custom(object):
     ...
 
 class Attribute(Custom):

diff --git a/hydro_roll_core/rules/BaseRule/__init__.py → hrc/rules/BaseRule/__init__.py b/hydro_roll_core/rules/BaseRule/__init__.py → hrc/rules/BaseRule/__init__.py
@@ -1,8 +1,8 @@
 import dataclasses
 from dataclasses import dataclass
 from typing import Literal, Optional, Union
-from typing_extensions import override
 
+from . import JudgeRule
 
 @dataclass
 class CharacterCard(object):

diff --git a/hrc/rules/__init__.py b/hrc/rules/__init__.py
@@ -0,0 +1 @@
+from . import BaseRule
diff --git a/hydro_roll_core/typing.py → hrc/typing.py b/hydro_roll_core/typing.py → hrc/typing.py
diff --git a/hydro_roll_core/utils.py → hrc/utils.py b/hydro_roll_core/utils.py → hrc/utils.py
diff --git a/hydro_roll_core/__init__.py b/hydro_roll_core/__init__.py
diff --git a/hydro_roll_core/rules/__init__.py b/hydro_roll_core/rules/__init__.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -20,8 +20,8 @@ repository = "https://github.com/HydroRoll-Team/HydroRollCore"
 documentation = "https://core.hydroroll.team/"
 
 [project.scripts]
-hrc = "hydro_roll_core.cli:Cli"
-hydrorollcore = "hydro_roll_core.cli:Cli"
+hrc = "hrc.cli:Cli"
+hydrorollcore = "hrc.cli:Cli"
 
 [tool.ruff]
 # Exclude a variety of commonly ignored directories.
@@ -87,7 +87,7 @@ skip-magic-trailing-comma = false
 line-ending = "auto"
 
 [tool.maturin]
-module-name = "hydro_roll_core.libcore"
+module-name = "hrc.LibCore"
 
 [tool.pdm.dev-dependencies]
 docs = [

diff --git a/src/lib.rs b/src/lib.rs
@@ -9,7 +9,7 @@ fn process_rule_pack(rule_pack: &str) -> PyResult<String> {
 
 /// A Python module implemented in Rust.
 #[pymodule]
-#[pyo3(name = "libcore")]
+#[pyo3(name = "LibCore")]
 fn libcore(_py: Python, m: &PyModule) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(process_rule_pack, m)?)?;
     Ok(())

diff --git a/tests/test_BaseRule.py b/tests/test_BaseRule.py
@@ -0,0 +1,69 @@
+__rule_book__ = "BASIC ROLEPLAYING"
+
+# General Rule Pack Standard(GRPSv1)
+
+# 规则书剖析
+
+# 共有的大类
+# ============================
+# judge role - 判定规则
+# - 事件判定规则
+# character card - 人物卡(属性)
+# playing time* - *
+
+
+# 可选的大类
+# ----------------------------
+# settings - 背景设定
+# custom rule - 自定义规则
+# - 特殊胜利手段(意外死亡、看月亮看死的等)
+# expansion rule - 拓展规则
+# - coc 中的伤害价值、调整
+# - 装备中的盾牌
+# - 药水、符文等各种各样时尚小垃圾
+
+# 不同的大类(举例)
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+#
+
+
+# 规则包剖析
+
+# 根据细类区分
+
+# 词条 - Wiki
+# 查询条目 - Query
+# 规定算法 - Algorithm
+
+# 游戏时长 - Duration
+# 战斗轮、追逐轮、行动轮
+# 回合
+# 幕间
+# 战役
+# 模组
+
+# 判定规则
+# - 属性|判定 规则
+# - 技能判定规则
+# - 自定义类判定规则
+
+# 人物卡
+# - 属性列表*
+# - 技能列表*
+# - 人物塑造
+# - 姓名、年龄、种族、阵营
+
+
+# ==============================================
+
+# MyRule
+from hrc.rules.BaseRule import JudgeRule
+
+class JudgeAttr(JudgeRule.Attribute):
+    """来自判定规则 - 属性判定
+
+    属性判定规则(模式)"""
+
+
+class JudgeCustom(JudgeRule.Custom):
+    ...
diff --git a/tests/test_corelib.py b/tests/test_corelib.py
@@ -1,15 +1,12 @@
-from hydro_roll_core import libcore
+from hrc import LibCore
 
-cb = libcore
+cb = LibCore
 
 
 def main():
     rule_pack = "example_rule_pack"
     result = cb.process_rule_pack(rule_pack)
     print(result)
-    print(cb.name)
-    cb.name = "a"
-    print(cb.name)
 
 
 if __name__ == "__main__":