Skip to content

Docstring Updater

remove_docstrings(code)

No valid docstring found.

Source code in repo_agent/utils/docstring_updater.py 
30
31
32
33
34
35
36
37
def remove_docstrings(code):
    """
    No valid docstring found.

    """

    pattern = re.compile(r'^\s*("""|\'\'\').*?^\s*\1', re.DOTALL | re.MULTILINE)
    return pattern.sub("", code)

update_doc(node, new_docstring)

Replaces the docstring of a given AST node with new content, handling indentation to maintain code structure. If no docstring exists, it adds one; otherwise, it updates the existing one.

Parameters:

Name Type Description Default
node

The AST node to update.

 required
new_docstring

The new docstring content.

 required

Returns:

Type Description

The updated AST node.
Source code in repo_agent/utils/docstring_updater.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
def update_doc(node, new_docstring):
    """
    Replaces the docstring of a given AST node with new content, handling indentation to maintain code structure. If no docstring exists, it adds one; otherwise, it updates the existing one.

    Args:
        node: The AST node to update.
        new_docstring: The new docstring content.

    Returns:
        The updated AST node.

    """

    indent = "    " if not isinstance(node, ast.Module) else ""
    lines = new_docstring.split("\n")
    if len(lines) > 1:
        lines[1:] = [indent + line for line in lines[1:]]
    processed_doc = "\n" + indent + "\n".join(lines) + "\n" + indent
    if ast.get_docstring(node) is None:
        node.body.insert(0, ast.Expr(value=ast.Str(s=processed_doc)))
    else:
        node.body[0] = ast.Expr(value=ast.Str(s=processed_doc))
    return node