Method apply

share/docs/prettymethods.py:240–272

(self)

    default_priority = 800

    def apply(self):
        methods = (
            sig for sig in self.document.traverse(SphinxNodes.desc_signature)
            if "class" in sig
        )

        # Extra data for replace functions
        details = {}

        for ref in methods:
            name_node = ref.next_node(SphinxNodes.desc_name)
            name = name_node.astext()

            # Determine the class to associate with this method, so we can
            # swap __init__ with a named constructor.
            annotation_node = ref.next_node(SphinxNodes.desc_annotation)
            if annotation_node:
                annotation = annotation_node.astext().strip()
                if annotation == "class":
                    details["class_name"] = name

            parameters_node = ref.next_node(SphinxNodes.desc_parameterlist)

            # Transform special methods
            if name in SPECIAL_METHODS:
                name_node.replace_self(
                    SPECIAL_METHODS[name](name_node, parameters_node, details)
                )
                parameters_node.replace_self(())
            
            # Remove 'self' parameter from other methods
            elif is_method(parameters_node):
                parameters_node.replace_self(patch_node(parameters_node, ""))


def setup(app):