commit

Makefile

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+
+help: ## Show this help message
+	@perl -nle'print $& if m{^[a-zA-Z0-9_-]+:.*?## .*$$}' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-40s\033[0m %s\n", $$1, $$2}'
+
+
+update-gzip: ## Update all *.tsv.gz file
+	python ./bin/update_gzip.py
+
+
+restore-tsv: ## Restore all *.tsv file
+	python ./bin/restore_tsv.py

bin/restore_tsv.py

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+from wotlkdoc.docs.dataframe import restore_tsv
+
+restore_tsv()

bin/update_gzip.py

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+from wotlkdoc.docs.dataframe import update_gzip
+
+update_gzip()

docs/source/01-管理服务器-Manage-Server/02-搭建服务器-Installation-Guide/07-使用模块-Module/01-Eluna/index.rst

@@ -4,3 +4,27 @@ Eluna 是一个允许你在服务端添加 Lua 脚本的模块. 本质上跟 WOW
 
 - https://www.azerothcore.org/catalogue.html#/details/413964782
 - https://github.com/azerothcore/mod-eluna
+- https://www.azerothcore.org/pages/eluna/index.html
+
+我们来看一段示例代码:
+
+.. code-block:: lua
+
+    local PLAYER_EVENT_ON_LOGIN = 3
+
+    local function OnLogin(event, player)
+        player:SendBroadcastMessage("Hello world")
+    end
+
+    RegisterPlayerEvent(PLAYER_EVENT_ON_LOGIN, OnLogin)
+
+很明显, 这就是一个典型的事件驱动的程序.
+
+``RegisterPlayerEvent`` 这是一个负责注册 PlayerEvent 的方法. 所有的 Register 都可以在这个文档 https://www.azerothcore.org/pages/eluna/Global/index.html 里找到. 这里面是所有的全局函数, 你搜索 Register 就可以看到所有可以用来注册的事件.
+
+``PLAYER_EVENT_ON_LOGIN`` 定义了这具体是一个什么样的 PlayerEvent, 在这篇源码 https://github.com/ElunaLuaEngine/Eluna/blob/master/Hooks.h 中你可以找到对于不同类型的 Event, 每个具体的 Event Code 是什么.
+
+而 ``OnLogin`` 则是一个函数, 用来处理 PlayerEvent 的数据. 这个函数具体有哪些参数同样可以在 https://github.com/ElunaLuaEngine/Eluna/blob/master/Hooks.h 中找到. 根据文档, 它有两个参数.
+
+
+E

requirements.txt

@@ -1,4 +1,4 @@
-polars
+polars==0.14.5
 pypinyin==0.47.1
 rstobj==0.0.7
 boto3==1.24.66

wotlkdoc/__init__.py

@@ -5,7 +5,7 @@
 """
 
 __version__ = "0.0.1"
-__short_description__ = "Package short description."
+__short_description__ = "World of Warcraft - The Wrath of Lich King Document"
 __license__ = "MIT"
 __author__ = "Sanhe Hu"
 __author_email__ = "husanhe@gmail.com"

wotlkdoc/docs/__init__.py

@@ -1,54 +1,52 @@
 # -*- coding: utf-8 -*-
 
-import logging
-
-try:
-    from . import consumable
-    from . import faction
-    from . import mount
-    from . import gps
-    from . import images
-    from ..df_to_list_table import df_to_list_table
-
-    doc_data = dict(
-        # consumable
-        lt_consumable_vanilla=consumable.lt_consumable_vanilla,
-        lt_consumable_tbc=consumable.lt_consumable_tbc,
-        lt_consumable_wlk=consumable.lt_consumable_wlk,
-        rst_list_item_enhancement=consumable.rst_list_item_enhancement,
-
-        lt_faction_vanilla=faction.lt_faction_vanilla,
-        lt_faction_tbc=faction.lt_faction_tbc,
-        lt_faction_wlk=faction.lt_faction_wlk,
-        lt_mount=mount.lt_mount,
-
-        # gps zone
-        lt_list_east_map_gps=gps.lt_list_east_map_gps,
-        lt_list_kali_map_gps=gps.lt_list_kali_map_gps,
-        lt_list_tbc_map_gps=gps.lt_list_tbc_map_gps,
-        lt_list_wlk_map_gps=gps.lt_list_wlk_map_gps,
-
-        # gps city
-        lt_list_main_city_gps=gps.lt_list_main_city_gps,
-
-        # gps class trainer
-        lt_list_class_trainer_gsp=gps.lt_list_class_trainer_gsp,
-
-        # gps trade skill trainer
-        lt_list_trade_skill_trainer_gsp=gps.lt_list_trade_skill_trainer_gsp,
-
-        # gps instance, dungeon, raid
-        list_of_lt_list_instance_gps=gps.list_of_lt_list_instance_gps,
-
-        func_df_to_list_table=df_to_list_table,
-
-        # image links
-        # maps
-        img_map_tbc=images.img_map_tbc,
-        img_map_wlk=images.img_map_wlk,
-        img_map_cities=images.img_map_cities,
-    )
-
-
-except Exception as e:
-    logging.warning(str(e))
+# import logging
+#
+# try:
+#     from . import consumable
+#     from . import faction
+#     from . import mount
+#     from . import gps
+#     from . import images
+#     from ..df_to_list_table import df_to_list_table
+#
+#     doc_data = dict(
+#         # consumable
+#         lt_consumable_vanilla=consumable.lt_consumable_vanilla,
+#         lt_consumable_tbc=consumable.lt_consumable_tbc,
+#         lt_consumable_wlk=consumable.lt_consumable_wlk,
+#         rst_list_item_enhancement=consumable.rst_list_item_enhancement,
+#
+#         lt_faction_vanilla=faction.lt_faction_vanilla,
+#         lt_faction_tbc=faction.lt_faction_tbc,
+#         lt_faction_wlk=faction.lt_faction_wlk,
+#         lt_mount=mount.lt_mount,
+#
+#         # gps zone
+#         lt_list_east_map_gps=gps.lt_list_east_map_gps,
+#         lt_list_kali_map_gps=gps.lt_list_kali_map_gps,
+#         lt_list_tbc_map_gps=gps.lt_list_tbc_map_gps,
+#         lt_list_wlk_map_gps=gps.lt_list_wlk_map_gps,
+#
+#         # gps city
+#         lt_list_main_city_gps=gps.lt_list_main_city_gps,
+#
+#         # gps class trainer
+#         lt_list_class_trainer_gsp=gps.lt_list_class_trainer_gsp,
+#
+#         # gps trade skill trainer
+#         lt_list_trade_skill_trainer_gsp=gps.lt_list_trade_skill_trainer_gsp,
+#
+#         # gps instance, dungeon, raid
+#         list_of_lt_list_instance_gps=gps.list_of_lt_list_instance_gps,
+#
+#         func_df_to_list_table=df_to_list_table,
+#
+#         # image links
+#         # maps
+#         img_map_tbc=images.img_map_tbc,
+#         img_map_wlk=images.img_map_wlk,
+#         img_map_cities=images.img_map_cities,
+#     )
+# except Exception as e:
+#     logging.warning(str(e))

wotlkdoc/docs/dataframe.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+
+"""
+本模块提供了对数据文件进行编辑, 管理, 引用的工作流.
+
+1. 把数据文件 check in 到代码库的时候, 存的是 .tsv.gz 文件. 你可以用 ``make update_gzip``
+    命令进行批量更新.
+2. 你编辑数据内容的时候, 是用 ``make restore`` 命令将 .tsv.gz 恢复成 .tsv 文件
+    (如果 .tsv 已经存在则认为你正在编辑, 不进行恢复), 然后 copy paste .tsv 文件的内容
+    到 Google Sheet 中编辑. 满意了再用 #1 中的步骤更新, 并 check in 到代码库.
+3. 对数据的 DataFrame 进行引用的时候用的是 :class:`TsvGzReader`` 类,  初始化的时候
+    只 pass 一个 ``reader = TsvGzReader(__file__)`` 参数, 让它能定位到你当前目录.
+    然后用 df = reader.read_df("filename.tsv.gz") 来读取 DataFrame 数据.
+"""
+
+import gzip
+import attr
+from attrs_mate import AttrsClass
+from pathlib_mate import Path
+import polars as pl
+
+
+def gzip_compress(f_in: str, f_out: str):
+    with gzip.open(f_out, "wb") as f:
+        f.write(Path(f_in).read_bytes())
+
+
+def gzip_decompress(f_in: str, f_out: str):
+    with gzip.open(f_in, "rb") as f:
+        Path(f_out).write_bytes(f.read())
+
+
+dir_here = Path.dir_here(__file__)
+
+
+def update_gzip():
+    for path in dir_here.select_by_ext(recursive=True, ext=".tsv"):
+        path_gz = Path(path.abspath + ".gz")
+        gzip_compress(f_in=path.abspath, f_out=path_gz.abspath)
+
+
+def restore_tsv():
+    for path_gz in dir_here.select_by_ext(recursive=True, ext=".gz"):
+        path_tsv = path_gz.change(new_basename=path_gz.fname)
+        if not path_tsv.exists():
+            gzip_decompress(f_in=path_gz.abspath, f_out=path_tsv.abspath)
+
+
+@attr.s
+class TsvGzReader(AttrsClass):
+    file: str = attr.ib()
+
+    @property
+    def dir_here(self) -> Path:
+        return Path(self.file).parent
+
+    def read_df(self, filename: str) -> pl.DataFrame:
+        p = self.dir_here / filename
+        return pl.read_csv(p.abspath, sep="\t")
+
+
+def example():
+    reader = TsvGzReader(__file__)
+    print(reader.read_df("example-items.tsv.gz"))