Skip to content
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.

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

Allow configuration of trailing commas in multi-line signatures #12975

Merged
merged 22 commits into from
Jan 21, 2025
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
fmt
  • Loading branch information
TLouf committed Jan 8, 2025
commit ad7aeb209dc6a9787d48d899004284c7954ff8b2
9 changes: 7 additions & 2 deletions sphinx/domains/javascript.py
Original file line number Diff line number Diff line change
@@ -110,7 +110,9 @@ def handle_signature(self, sig: str, signode: desc_signature) -> tuple[str, str]
and (len(sig) > max_len > 0)
)

trailing_comma = self.env.config.javascript_trailing_comma_in_multi_line_signatures
trailing_comma = (
self.env.config.javascript_trailing_comma_in_multi_line_signatures
)

display_prefix = self.get_display_prefix()
if display_prefix:
@@ -571,7 +573,10 @@ def setup(app: Sphinx) -> ExtensionMetadata:
'javascript_maximum_signature_line_length', None, 'env', {int, type(None)}
)
app.add_config_value(
'javascript_trailing_comma_in_multi_line_signatures', True, 'env', bool,
'javascript_trailing_comma_in_multi_line_signatures',
True,
'env',
bool,
)
return {
'version': 'builtin',
5 changes: 4 additions & 1 deletion sphinx/domains/python/__init__.py
Original file line number Diff line number Diff line change
@@ -1081,7 +1081,10 @@ def setup(app: Sphinx) -> ExtensionMetadata:
'python_maximum_signature_line_length', None, 'env', {int, type(None)}
)
app.add_config_value(
'python_trailing_comma_in_multi_line_signatures', True, 'env', bool,
'python_trailing_comma_in_multi_line_signatures',
True,
'env',
bool,
)
app.add_config_value('python_display_short_literal_types', False, 'env')
app.connect('object-description-transform', filter_meta_fields)
9 changes: 6 additions & 3 deletions sphinx/domains/python/_annotations.py
Original file line number Diff line number Diff line change
@@ -398,7 +398,8 @@ def _pformat_token(self, tok: Token, native: bool = False) -> str:


def _parse_type_list(
tp_list: str, env: BuildEnvironment,
tp_list: str,
env: BuildEnvironment,
multi_line_parameter_list: bool = False,
trailing_comma: bool = True,
) -> addnodes.desc_type_parameter_list:
@@ -463,7 +464,8 @@ def _parse_type_list(


def _parse_arglist(
arglist: str, env: BuildEnvironment,
arglist: str,
env: BuildEnvironment,
multi_line_parameter_list: bool = False,
trailing_comma: bool = True,
) -> addnodes.desc_parameterlist:
@@ -526,7 +528,8 @@ def _parse_arglist(


def _pseudo_parse_arglist(
signode: desc_signature, arglist: str,
signode: desc_signature,
arglist: str,
multi_line_parameter_list: bool = False,
trailing_comma: bool = True,
) -> None:
25 changes: 19 additions & 6 deletions sphinx/domains/python/_object.py
Original file line number Diff line number Diff line change
@@ -331,7 +331,10 @@ def handle_signature(self, sig: str, signode: desc_signature) -> tuple[str, str]
if tp_list:
try:
signode += _parse_type_list(
tp_list, self.env, multi_line_type_parameter_list, trailing_comma,
tp_list,
self.env,
multi_line_type_parameter_list,
trailing_comma,
)
except Exception as exc:
logger.warning(
@@ -341,22 +344,32 @@ def handle_signature(self, sig: str, signode: desc_signature) -> tuple[str, str]
if arglist:
try:
signode += _parse_arglist(
arglist, self.env, multi_line_parameter_list, trailing_comma,
arglist,
self.env,
multi_line_parameter_list,
trailing_comma,
)
except SyntaxError:
# fallback to parse arglist original parser
# (this may happen if the argument list is incorrectly used
# as a list of bases when documenting a class)
# it supports to represent optional arguments (ex. "func(foo [, bar])")
_pseudo_parse_arglist(
signode, arglist, multi_line_parameter_list, trailing_comma,
signode,
arglist,
multi_line_parameter_list,
trailing_comma,
)
except (NotImplementedError, ValueError) as exc:
# duplicated parameter names raise ValueError and not a SyntaxError
logger.warning("could not parse arglist (%r): %s", arglist, exc,
location=signode)
logger.warning(
'could not parse arglist (%r): %s', arglist, exc, location=signode
)
_pseudo_parse_arglist(
signode, arglist, multi_line_parameter_list, trailing_comma,
signode,
arglist,
multi_line_parameter_list,
trailing_comma,
)
else:
if self.needs_arglist():
Loading
Oops, something went wrong.