refactor visitor methods for parameters list-like nodes

Author: picnixz

sphinx/writers/html5.py

@@ -148,17 +148,26 @@ def visit_desc_returns(self, node: Element) -> None:
     def depart_desc_returns(self, node: Element) -> None:
         self.body.append('</span></span>')
 
-    def visit_desc_parameterlist(self, node: Element) -> None:
-        list_left_delim = node.list_left_delim  # type: ignore[attr-defined]
-        self.body.append(f'<span class="sig-paren">{list_left_delim}</span>')
+    def _visit_sig_parameter_list(
+        self,
+        node: Element,
+        parameter_group: type[Element],
+        sig_open_paren: str,
+        sig_close_paren: str,
+    ) -> None:
+        """Visit a signature parameters or type parameters list.
+
+        The *parameter_group* value is the type of a child node acting as a required parameter
+        or as a set of contiguous optional parameters.
+        """
+        self.body.append(f'<span class="sig-paren">{sig_open_paren}</span>')
         self.is_first_param = True
         self.optional_param_level = 0
         self.params_left_at_level = 0
         self.param_group_index = 0
         # Counts as what we call a parameter group either a required parameter, or a
         # set of contiguous optional ones.
-        self.list_is_required_param = [isinstance(c, addnodes.desc_parameter)
-                                       for c in node.children]
+        self.list_is_required_param = [isinstance(c, parameter_group) for c in node.children]
         # How many required parameters are left.
         self.required_params_left = sum(self.list_is_required_param)
         self.param_separator = node.child_text_separator
@@ -167,12 +176,25 @@ def visit_desc_parameterlist(self, node: Element) -> None:
             self.body.append('\n\n')
             self.body.append(self.starttag(node, 'dl'))
             self.param_separator = self.param_separator.rstrip()
+        self.context.append(sig_close_paren)
 
-    def depart_desc_parameterlist(self, node: Element) -> None:
+    def _depart_sig_parameter_list(self, node: Element) -> None:
         if node.get('multi_line_parameter_list'):
             self.body.append('</dl>\n\n')
-        list_right_delim = node.list_right_delim  # type: ignore[attr-defined]
-        self.body.append(f'<span class="sig-paren">{list_right_delim}</span>')
+        sig_close_paren = self.context.pop()
+        self.body.append(f'<span class="sig-paren">{sig_close_paren}</span>')
+
+    def visit_desc_parameterlist(self, node: Element) -> None:
+        self._visit_sig_parameter_list(node, addnodes.desc_parameter, '(', ')')
+
+    def depart_desc_parameterlist(self, node: Element) -> None:
+        self._depart_sig_parameter_list(node)
+
+    def visit_desc_tparameterlist(self, node: Element) -> None:
+        self._visit_sig_parameter_list(node, addnodes.desc_tparameter, '[', ']')
+
+    def depart_desc_tparameterlist(self, node: Element) -> None:
+        self._depart_sig_parameter_list(node)
 
     # If required parameters are still to come, then put the comma after
     # the parameter.  Otherwise, put the comma before.  This ensures that
@@ -216,6 +238,12 @@ def depart_desc_parameter(self, node: Element) -> None:
         if is_required:
             self.param_group_index += 1
 
+    def visit_desc_tparameter(self, node: Element) -> None:
+        self.visit_desc_parameter(node)
+
+    def depart_desc_tparameter(self, node: Element) -> None:
+        self.depart_desc_parameter(node)
+
     def visit_desc_optional(self, node: Element) -> None:
         self.params_left_at_level = sum([isinstance(c, addnodes.desc_parameter)
                                          for c in node.children])