Lint & Format

Author: LY-Xiang

detection/__init__.py

@@ -1 +0,0 @@
-

detection/checker.py

@@ -1,34 +1,65 @@
+"""
+定义检查器，
+用预定义与自定义的子检查器传参初始化，
+调用检查函数，
+返回特定结果。
+"""
+
 from collections.abc import Callable
 from typing import Self
 
 type Checker_t = Callable[[tuple], bool]
 
 
 class Checker:
-    results = dict()
+    """
+    检查器
+    """
+
+    results = {}
 
     def __init__(self, SubCheckers: dict[Checker_t, str]) -> None:
+        """
+        初始化
+        :param SubCheckers: 子检查器字典, 绑定错误信息
+        """
         self.subCheckers = SubCheckers
 
     def execTask(self, Content: tuple) -> Self:
+        """
+        调用检查函数
+        :param Content: 待检查内容
+        """
         for func in self.subCheckers.keys():
             self.results[func] = func(Content)
         return self
 
     def getResults(self) -> dict[Checker_t, bool]:
+        """
+        获取结果(bool 返回值)
+        :return: 检查函数绑定返回值的字典
+        """
         return self.results
 
     def __bool__(self) -> bool:
         return all(self.results.values())
 
     def __str__(self) -> str:
-        tmp = list()
+        tmp = []
         for func, result in self.results.items():
             if not result:
                 tmp.append(self.subCheckers[func])
         return ";".join(tmp)
 
 
 class CheckerNoMsg(Checker):
+    """
+    继承 Checker, 不传检查信息
+    """
+
     def __init__(self, SubCheckers: tuple[Checker_t, ...]) -> None:
-        self.subCheckers = {SubChecker: "" for SubChecker in SubCheckers}
+        """
+        初始化
+        :param SubCheckers: 仅包含子检查器的元组
+        """
+        super().__init__(SubCheckers={SubChecker: "" for SubChecker in SubCheckers})

detection/subCheckers.py

@@ -1,10 +1,33 @@
+"""
+预定义子检查器
+"""
+
+
 def isNotSpace(Content: tuple[str]) -> bool:
+    """
+    判断是否为空串
+    包装 str.isspace()
+    :param Content: 待检查内容
+    :return: 若不是空串则返回真
+    """
     return not Content[0].isspace()
 
 
 def isNum(Content: tuple[str]) -> bool:
+    """
+    判断字符串内容是否为十进制整数
+    包装 str.isdecimal(), 允许前后空字符和一位符号前缀(+/-)
+    :param Content: 待检查内容
+    :return: 若是十进制整数则返回真
+    """
     return any(Content[0].strip().removeprefix(prefix).isdecimal() for prefix in "+-")
 
 
 def isNotNegative(Content: tuple[str]) -> bool:
+    """
+    判断十进制整数是否为非负数
+    调用 .isNum 判断十进制整数
+    :param Content: 待检查内容
+    :return: 若是十进制非负整数则返回真
+    """
     return isNum(Content) and Content[0].strip()[0] != "-"

generation/__init__.py

@@ -1 +1,5 @@
+"""
+定义模块常量
+"""
+
 BOX_CAPACITY = 27

generation/constructor.py

@@ -1,4 +1,14 @@
+# pylint: disable = C0301, R0903
+"""
+定义地图与箱子的简单构造对象和构造器
+"""
+
+
 class Map:
+    """
+    简单地图构造对象
+    """
+
     TEMPLATE = '{{Count:1b,Slot:{Slot}b,id:"minecraft:filled_map",tag:{{map:{MapId}}}}}'
 
     def __init__(self, Slot: int, MapId: int) -> None:
@@ -10,6 +20,10 @@ def __str__(self) -> str:
 
 
 class Box:
+    """
+    简单箱子构造对象
+    """
+
     TEMPLATE = '{{Count:1b,{Slot}id:"minecraft:chest",tag:{{BlockEntityTag:{{Items:{Items},id:"minecraft:chest"}},display:{{Name:\'{{"Italic":false,"Extra":[{{"text":""}},{{"color":"dark_gray","text":"["}},{{"color":"dark_aqua","text":"{Begin}"}},{{"color":"gray","text":","}},{{"color":"aqua","text":"{End}"}},{{"color":"dark_gray","text":")"}}],"text":""}}\'}}}}}}'
 
     def __init__(self, Begin: int, End: int, Slot: int = -1) -> None:
@@ -30,4 +44,8 @@ def __str__(self) -> str:
 
 
 class Constructor(Box):
-    pass
+    """
+    构造器
+    继承自 Box
+    完全等同
+    """

generation/iterator.py

@@ -1,8 +1,19 @@
+"""
+定义迭代(生成)器
+"""
+
 from . import BOX_CAPACITY
-from .constructor import Box, Map
+from .constructor import Box, Map  # pylint: disable = R0401
 
 
 def iterator(Begin: int, End: int) -> list[Map | Box]:
+    """
+    迭代(生成)器
+    通过传入左闭右开区间得到对象
+    :param Begin: 地图起始编号
+    :param End: 地图结束编号
+    :return: 装有 Map/Box 对象的列表
+    """
     from math import ceil, log
 
     step = BOX_CAPACITY ** ceil(log(End - Begin, 27) - 1) if End - Begin > 1 else 1

main.py

@@ -1,10 +1,12 @@
+"""
+main
+"""
+
+import pyperclip
 from detection.checker import CheckerNoMsg as Checker
 from detection.subCheckers import isNotSpace, isNum, isNotNegative
 from generation.constructor import Constructor
 
-import pyperclip
-
-
 mapId = input("输入第一张地图画的编号:\n")
 mapNum = input("输入需遍历的地图画数量:\n")
 
@@ -29,8 +31,6 @@
     try:
         pyperclip.copy(strBox)
     except pyperclip.PyperclipException as exception:
-        print(
-            f"复制失败!\n请手动复制到剪贴板\n以下是pyperclip原始报错信息:\n{exception}"
-        )
+        print(f"复制失败!\n请手动复制到剪贴板\n以下是pyperclip原始报错信息:\n{exception}")
     else:
         print("已复制到剪贴板!")

pyproject.toml

@@ -0,0 +1,8 @@
+[tool.black]
+line-length = 100
+unstable = true
+
+[tool.pylint.main]
+disable = ["invalid-name", "import-outside-toplevel"]
+[tool.pylint.format]
+max-line-length = 100