Refactor draw_path_collection to make hatchcolors a keyword-only argument

Author: r3kste

lib/matplotlib/backend_bases.py

@@ -208,7 +208,7 @@ def draw_markers(self, gc, marker_path, marker_trans, path,
     def draw_path_collection(self, gc, master_transform, paths, all_transforms,
                              offsets, offset_trans, facecolors, edgecolors,
                              linewidths, linestyles, antialiaseds, urls,
-                             offset_position, hatchcolors=None):
+                             offset_position, *, hatchcolors=None):
         """
         Draw a collection of *paths*.
 
@@ -277,7 +277,8 @@ def draw_quad_mesh(self, gc, master_transform, meshWidth, meshHeight,
 
         return self.draw_path_collection(
             gc, master_transform, paths, [], offsets, offsetTrans, facecolors,
-            edgecolors, linewidths, [], [antialiased], [None], 'screen', hatchcolors)
+            edgecolors, linewidths, [], [antialiased], [None], 'screen',
+            hatchcolors=hatchcolors)
 
     def draw_gouraud_triangles(self, gc, triangles_array, colors_array,
                                transform):

lib/matplotlib/backend_bases.pyi

@@ -63,6 +63,7 @@ class RendererBase:
         antialiaseds: bool | Sequence[bool],
         urls: str | Sequence[str],
         offset_position: Any,
+        *,
         hatchcolors: ColorType | Sequence[ColorType] | None = None,
     ) -> None: ...
     def draw_quad_mesh(

lib/matplotlib/backends/backend_pdf.py

@@ -2030,7 +2030,7 @@ def draw_path(self, gc, path, transform, rgbFace=None):
     def draw_path_collection(self, gc, master_transform, paths, all_transforms,
                              offsets, offset_trans, facecolors, edgecolors,
                              linewidths, linestyles, antialiaseds, urls,
-                             offset_position, hatchcolors=None):
+                             offset_position, *, hatchcolors=None):
         # We can only reuse the objects if the presence of fill and
         # stroke (and the amount of alpha for each) is the same for
         # all of them
@@ -2075,7 +2075,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,
                 self, gc, master_transform, paths, all_transforms,
                 offsets, offset_trans, facecolors, edgecolors,
                 linewidths, linestyles, antialiaseds, urls,
-                offset_position, hatchcolors)
+                offset_position, hatchcolors=hatchcolors)
 
         padding = np.max(linewidths)
         path_codes = []

lib/matplotlib/backends/backend_ps.py

@@ -674,7 +674,7 @@ def draw_markers(
     def draw_path_collection(self, gc, master_transform, paths, all_transforms,
                              offsets, offset_trans, facecolors, edgecolors,
                              linewidths, linestyles, antialiaseds, urls,
-                             offset_position, hatchcolors=None):
+                             offset_position, *, hatchcolors=None):
         if hatchcolors is None:
             hatchcolors = []
         # Is the optimization worth it? Rough calculation:
@@ -692,7 +692,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,
                 self, gc, master_transform, paths, all_transforms,
                 offsets, offset_trans, facecolors, edgecolors,
                 linewidths, linestyles, antialiaseds, urls,
-                offset_position, hatchcolors)
+                offset_position, hatchcolors=hatchcolors)
 
         path_codes = []
         for i, (path, transform) in enumerate(self._iter_collection_raw_paths(

lib/matplotlib/backends/backend_svg.py

@@ -736,7 +736,7 @@ def draw_markers(
     def draw_path_collection(self, gc, master_transform, paths, all_transforms,
                              offsets, offset_trans, facecolors, edgecolors,
                              linewidths, linestyles, antialiaseds, urls,
-                             offset_position, hatchcolors=None):
+                             offset_position, *, hatchcolors=None):
         if hatchcolors is None:
             hatchcolors = []
         # Is the optimization worth it? Rough calculation:
@@ -754,7 +754,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,
                 gc, master_transform, paths, all_transforms,
                 offsets, offset_trans, facecolors, edgecolors,
                 linewidths, linestyles, antialiaseds, urls,
-                offset_position, hatchcolors)
+                offset_position, hatchcolors=hatchcolors)
 
         writer = self.writer
         path_codes = []

lib/matplotlib/collections.py

@@ -432,7 +432,7 @@ def draw(self, renderer):
                     self.get_facecolor(), self.get_edgecolor(),
                     self._linewidths, self._linestyles,
                     self._antialiaseds, self._urls,
-                    "screen", self.get_hatchcolor()
+                    "screen", hatchcolors=self.get_hatchcolor()
                 )
             except TypeError:
                 hatchcolors_arg_supported = False
@@ -442,11 +442,12 @@ def draw(self, renderer):
                 ipaths, ilinestyles = self._get_inverse_paths_linestyles()
                 args = [offsets, offset_trf, [mcolors.to_rgba("none")], self._gapcolor,
                         self._linewidths, ilinestyles, self._antialiaseds, self._urls,
-                        "screen", self.get_hatchcolor()]
+                        "screen"]
 
                 if hatchcolors_arg_supported:
                     renderer.draw_path_collection(gc, transform.frozen(), ipaths,
-                                                  self.get_transforms(), *args)
+                                                  self.get_transforms(), *args,
+                                                  hatchcolors=self.get_hatchcolor())
                 else:
                     # If the renderer does not support the hatchcolors argument,
                     # iterate over the paths and draw them one by one.
@@ -463,11 +464,12 @@ def draw(self, renderer):
 
             args = [offsets, offset_trf, self.get_facecolor(), self.get_edgecolor(),
                     self._linewidths, self._linestyles, self._antialiaseds, self._urls,
-                    "screen", self.get_hatchcolor()]
+                    "screen"]
 
             if hatchcolors_arg_supported:
                 renderer.draw_path_collection(gc, transform.frozen(), paths,
-                                              self.get_transforms(), *args)
+                                              self.get_transforms(), *args,
+                                              hatchcolors=self.get_hatchcolor())
             else:
                 path_ids = renderer._iter_collection_raw_paths(
                     transform.frozen(), paths, self.get_transforms())

src/_backend_agg_wrapper.cpp

@@ -236,7 +236,7 @@ PYBIND11_MODULE(_backend_agg, m, py::mod_gil_not_used())
              "gc"_a, "master_transform"_a, "paths"_a, "transforms"_a, "offsets"_a,
              "offset_trans"_a, "facecolors"_a, "edgecolors"_a, "linewidths"_a,
              "dashes"_a, "antialiaseds"_a, "ignored"_a, "offset_position"_a,
-             "hatchcolors"_a = py::array_t<double>().reshape({0, 4}))
+             py::kw_only(), "hatchcolors"_a = py::array_t<double>().reshape({0, 4}))
         .def("draw_quad_mesh", &PyRendererAgg_draw_quad_mesh,
              "gc"_a, "master_transform"_a, "mesh_width"_a, "mesh_height"_a,
              "coordinates"_a, "offsets"_a, "offset_trans"_a, "facecolors"_a,