Manager Module

BaseManager

Bases: BaseModel, ABC

执行器，用于修改模块的文档字符串，目前只支持模块级别或文件级别。

子类需要重写 gen_docstring 方法以生成自定义的文档字符串。

Source code in lazynote/manager/base.py

class BaseManager(BaseModel, ABC):
    """
    执行器，用于修改模块的文档字符串，目前只支持模块级别或文件级别。

    子类需要重写 gen_docstring 方法以生成自定义的文档字符串。
    """

    parser: Optional[BaseParser] = Field(default_factory=BaseParser)
    pattern: DocstringMode

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        if self.parser is None:
            self.parser = BaseParser(skip_modules=kwargs.get('skip_modules', []))

    class Config:
        arbitrary_types_allowed = True

    @abstractmethod
    def gen_docstring(self, old_docstring: Optional[str], node_code: str) -> str:
        """
        生成新的文档字符串。子类必须实现此方法以实现自定义逻辑。

        :param old_docstring: 旧的文档字符串
        :param node_code: 节点代码
        :return: 新的文档字符串
        """
        pass

    @staticmethod
    def is_defined_in_module(member, module):
        if hasattr(member, '__module__'):
            return member.__module__ == module.__name__
        elif isinstance(member, property):
            return member.fget.__module__ == module.__name__
        elif isinstance(member, staticmethod):
            return member.__func__.__module__ == module.__name__
        elif isinstance(member, classmethod):
            return member.__func__.__module__ == module.__name__
        elif hasattr(member, '__wrapped__'):
            return member.__wrapped__.__module__ == module.__name__
        return False


    def _write_code_to_file(self, module, code: str):
        # 获取模块文件的路径
        module_file_path = inspect.getfile(module)

        # 将修改后的代码写回文件
        with open(module_file_path, 'w', encoding='utf-8') as file:
            file.write(code)

    def traverse(self, obj, skip_modules=None):
        if skip_modules is None:
            skip_modules = []

        if get_member_type(obj) == MemberType.PACKAGE:
            # 遍历包中的所有模块和子包
            for importer, modname, ispkg in pkgutil.walk_packages(obj.__path__, obj.__name__ + "."):

                if any(modname.startswith(skip_mod) for skip_mod in skip_modules):
                    continue  # 跳过不需要处理的模块及其子模块
                if ispkg:
                    # 包级别docstrings暂不处理
                    continue

                try:
                    submodule = importlib.import_module(modname)
                    self.parser.parse(submodule,self)
                except ImportError as e:
                    print(f"Error importing {modname}: {e}")

        elif get_member_type(obj) == MemberType.MODULE:
            # 处理单个模块或其他类型的对象
            self.parser.parse(obj, self)

    def modify_docstring(self, module):

        source_code = inspect.getsource(module)
        source_code = textwrap.dedent(source_code)  # 去除多余的缩进
        tree = cst.parse_module(source_code)

        transformer = BaseEditor(
            gen_docstring=self.gen_docstring, pattern=self.pattern,module=module)
        modified_tree = tree.visit(transformer)
        self._write_code_to_file(module, modified_tree.code)
        return modified_tree.code

gen_docstring(old_docstring, node_code) abstractmethod

生成新的文档字符串。子类必须实现此方法以实现自定义逻辑。

:param old_docstring: 旧的文档字符串 :param node_code: 节点代码 :return: 新的文档字符串

Source code in lazynote/manager/base.py

@abstractmethod
def gen_docstring(self, old_docstring: Optional[str], node_code: str) -> str:
    """
    生成新的文档字符串。子类必须实现此方法以实现自定义逻辑。

    :param old_docstring: 旧的文档字符串
    :param node_code: 节点代码
    :return: 新的文档字符串
    """
    pass

SimpleManager

Bases: BaseManager

Initialize the SimpleManager.

:param pattern: The docstring handling pattern. Should be one of: - DocstringMode.TRANSLATE - DocstringMode.POLISH - DocstringMode.CLEAR - DocstringMode.FILL

Source code in lazynote/manager/simple.py

class SimpleManager(BaseManager):
    """
        Initialize the SimpleManager.

        :param pattern: The docstring handling pattern. Should be one of:
                        - DocstringMode.TRANSLATE
                        - DocstringMode.POLISH
                        - DocstringMode.CLEAR
                        - DocstringMode.FILL
    """


    def gen_docstring(self, old_docstring: Optional[str], node_code: str) -> str:

        handler = DocstringHandler.get_handler(self.pattern)

        return handler(old_docstring, node_code)