Skip to content

fix: preserve tuple trailing comma (swev-id: sphinx-doc__sphinx-9367) #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
casey-brooks wants to merge 1 commit into
base: sphinx-doc__sphinx-9367
Choose a base branch
from
Open

fix: preserve tuple trailing comma (swev-id: sphinx-doc__sphinx-9367) #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions sphinx/pycode/ast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,11 +213,14 @@ def visit_UnaryOp(self, node: ast.UnaryOp) -> str:
return "%s %s" % (self.visit(node.op), self.visit(node.operand))

def visit_Tuple(self, node: ast.Tuple) -> str:
if node.elts:
return "(" + ", ".join(self.visit(e) for e in node.elts) + ")"
else:
if not node.elts:
return "()"

if len(node.elts) == 1:
return "(%s,)" % self.visit(node.elts[0])

return "(" + ", ".join(self.visit(e) for e in node.elts) + ")"

if sys.version_info < (3, 8):
# these ast nodes were deprecated in python 3.8
def visit_Bytes(self, node: ast.Bytes) -> str:
Expand Down
4 changes: 3 additions & 1 deletion tests/test_pycode_ast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,9 @@
("+ a", "+ a"), # UAdd
("- 1", "- 1"), # UnaryOp
("- a", "- a"), # USub
("(1, 2, 3)", "(1, 2, 3)"), # Tuple
("(1, 2, 3)", "(1, 2, 3)"), # Tuple
("(1,)", "(1,)"), # Tuple (single element)
("((1,),)", "((1,),)"), # Tuple (nested single element)
("()", "()"), # Tuple (empty)
])
def test_unparse(source, expected):
Expand Down