Minor notes/style fixes.

Author: anntzer

README.rst

@@ -279,8 +279,15 @@ Test suite
 
 Run ``run-mpl-test-suite.py`` to run the Matplotlib test suite with
 the Agg backend patched by the mplcairo backend.  Matplotlib *must* be
-editably-installed from a git checkout.  Certain tests that are known to fail
-(and listed in ``ISSUES.rst``) are automatically skipped.
+editably-installed from a git checkout.
+
+Nearly all image comparison tests "fail" as the renderers are fundamentally
+different; currently, the intent is to manually check the diff images.  Passing
+``--infinite-tolerance`` marks these tests as "passed" so that one can spot
+issues not related to rendering differences.
+
+Some other (non-image-comparison) tests are also known to fail (they are listed
+in ``ISSUES.rst``, with the relevant explanations), and automatically skipped.
 
 Notes
 =====

lib/mplcairo/base.py

@@ -30,7 +30,7 @@
 
 
 _log = logging.getLogger()
-# FreeType2 is thread-unsafe (as we rely on Matplotlib's unique FT_Library).
+# FreeType2 is thread-unsafe.
 _LOCK = RLock()
 MathTextParser._backend_mapping[
     "mplcairo"] = _mplcairo.MathtextBackendCairo

setup.py

@@ -12,10 +12,10 @@
 
 if sys.platform == "darwin":
     os.environ.setdefault("CC", "clang")
-    # Funnily enough, distutils uses $CC to compile c++ extensions but $CXX to
-    # *link* such extensions...  (Moreover, it does some funky changes to $CXX
-    # if either $CC or $CXX has multiple words -- see UnixCCompiler.link for
-    # details.)
+    # Funnily enough, distutils uses $CC to compile c++ extensions but
+    # $CXX to *link* such extensions...  (Moreover, it does some funky
+    # changes to $CXX if either $CC or $CXX has multiple words -- see e.g.
+    # https://bugs.python.org/issue6863.)
     os.environ.setdefault("CXX", "clang")
 
 from setupext import Extension, build_ext, find_packages, setup

src/_mplcairo.cpp

@@ -166,17 +166,11 @@ GraphicsContextRenderer::~GraphicsContextRenderer()
     // not called on e.g. a SVG surface before the GCR gets GC'd. e.g. comment
     // out this catch, and _finish() in base.py, and run
     //
-    // import gc
-    // from matplotlib import pyplot as plt
-    //
-    // fig = plt.gcf()
-    // file = open("/dev/null", "wb")
-    // fig.savefig(file, format="svg")
-    // file.close()
+    // import gc; from matplotlib import pyplot as plt
+    // with open("/dev/null", "wb") as file:
+    //     plt.gcf().savefig(file, format="svg")
     // plt.close("all")
-    // del fig
     // gc.collect()
-    // print("ok")
     std::cerr << "Exception ignored in destructor: " << e.what() << "\n";
   }
 }

src/_pattern_cache.cpp

@@ -43,7 +43,7 @@ void PatternCache::CacheKey::draw(
     case draw_func_t::Stroke:
       cairo_save(cr);
       cairo_set_line_width(cr, linewidth);
-      cairo_set_miter_limit(cr, linewidth); // cf. set_linewidth.
+      cairo_set_miter_limit(cr, linewidth);  // cf. set_linewidth.
       set_dashes(cr, dash);
       cairo_set_line_cap(cr, capstyle);
       cairo_set_line_join(cr, joinstyle);
@@ -82,7 +82,8 @@ size_t PatternCache::Hash::operator()(CacheKey const& key) const
 bool PatternCache::EqualTo::operator()(
   CacheKey const& lhs, CacheKey const& rhs) const
 {
-  return (lhs.path.is(rhs.path))
+  return
+    lhs.path.is(rhs.path)
     && lhs.matrix.xx == rhs.matrix.xx && lhs.matrix.xy == rhs.matrix.xy
     && lhs.matrix.yx == rhs.matrix.yx && lhs.matrix.yy == rhs.matrix.yy
     && lhs.matrix.x0 == rhs.matrix.x0 && lhs.matrix.y0 == rhs.matrix.y0
@@ -163,15 +164,15 @@ void PatternCache::mask(
     }
   }
   // Approximate ("quantize") the transform matrix, so that the transformed
-  // path is within 3 x (thresholds/3) of the path transformed by the original
-  // matrix.  1 x threshold will be added by the patterns_ cache.
+  // path is within 3x(threshold/3) of the path transformed by the original
+  // matrix.  1x threshold will be added by the patterns_ cache.
   // If the entire object is within the threshold of the origin in either
   // direction, then draw it directly, as doing otherwise would be highly
   // inaccurate (see e.g. test_mplot3d.test_quiver3d).
   auto const& bbox = it_bboxes->second;
-  // Here, gcc 7.2 (not cairo) fails to extend the lifetime of the temporaries
-  // whose references are bound to constant *references* (various issues on
-  // bugzilla; see also gotw#88); so bind values instead.
+  // Here, gcc 7.2 fails to extend the lifetime of the temporaries whose
+  // references are bound to constant *references* (various issues on bugzilla;
+  // see also gotw#88); so bind values instead.
   auto const x_max = std::max(std::abs(bbox.x), std::abs(bbox.x + bbox.width)),
              y_max = std::max(std::abs(bbox.y), std::abs(bbox.y + bbox.height));
   if (x_max < threshold_ || y_max < threshold_) {
@@ -202,7 +203,7 @@ void PatternCache::mask(
       case draw_func_t::Stroke:
         cairo_save(cr);
         cairo_set_line_width(cr, key.linewidth);
-        cairo_set_miter_limit(cr, key.linewidth); // cf. set_linewidth.
+        cairo_set_miter_limit(cr, key.linewidth);  // cf. set_linewidth.
         set_dashes(cr, key.dash);
         cairo_stroke_extents(cr, &x0, &y0, &x1, &y1);
         cairo_restore(cr);
@@ -219,7 +220,7 @@ void PatternCache::mask(
       throw std::runtime_error("Unexpected insertion failure into cache");
     }
   }
-  auto const& entry = it_patterns->second;  // Reference, as we have a unique_ptr.
+  auto const& entry = it_patterns->second;
   auto const& target_x = x + entry.x,
             & target_y = y + entry.y;
   auto const& i_target_x = std::floor(target_x),
@@ -236,6 +237,8 @@ void PatternCache::mask(
     auto const& raster_surface =
       cairo_image_surface_create(CAIRO_FORMAT_A8, width, height);
     auto const& raster_gcr =
+      // FIXME: Looks like building a full new gcr is too costly :/ (involves
+      // Python to build the additional state).
       GraphicsContextRenderer::make_pattern_gcr(raster_surface);
     key.draw(
       raster_gcr.cr_,

src/_raqm.cpp

@@ -1,9 +1,11 @@
 #include "_raqm.h"
+
 #include "_os.h"
-#include "_macros.h"
 
 #include <stdexcept>
 
+#include "_macros.h"
+
 namespace mplcairo {
 
 namespace raqm {

src/_util.cpp

@@ -1,6 +1,7 @@
-#include "_raqm.h"
 #include "_util.h"
 
+#include "_raqm.h"
+
 #include <stack>
 
 #include "_macros.h"