pygraphviz 2.0.2__tar.gz → 2.0.3__tar.gz

{pygraphviz-2.0.2/pygraphviz.egg-info → pygraphviz-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pygraphviz
-Version: 2.0.2
+Version: 2.0.3
 Summary: Python interface to Graphviz
 Author: Manos Renieris
 Author-email: Aric Hagberg <aric.hagberg@gmail.com>, Dan Schult <dschult@colgate.edu>

{pygraphviz-2.0.2 → pygraphviz-2.0.3}/doc/source/conf.py

@@ -36,6 +36,7 @@ sphinx_gallery_conf = {
     "ignore_pattern": "skip_",
     "image_scrapers": ("pygraphviz",),
     "min_reported_time": 60.0,
+    "parallel": True,
 }
 
 # Prevent numpydoc from trying to create toctree prematurely - suppresses a

{pygraphviz-2.0.2 → pygraphviz-2.0.3}/doc/source/release/index.rst

@@ -7,7 +7,7 @@ Releases
 .. toctree::
    :maxdepth: 2
 
-   release_dev
+   release_2.0.3
    release_2.0.2
    release_2.0.1
    release_2.0

pygraphviz-2.0.3/doc/source/release/release_2.0.3.rst

@@ -0,0 +1,30 @@
+pygraphviz 2.0.3
+================
+
+We're happy to announce the release of pygraphviz 2.0.3!
+
+Bug Fixes
+---------
+
+- Fix scraper path handling (`#651 <https://github.com/pygraphviz/pygraphviz/pull/651>`_).
+- Fix DLL dependencies of bundled Windows executables (`#653 <https://github.com/pygraphviz/pygraphviz/pull/653>`_).
+
+Contributors
+------------
+
+4 authors added to this release (alphabetically):
+
+- Eric Larson (`@larsoner <https://github.com/larsoner>`_)
+- Jarrod Millman (`@jarrodmillman <https://github.com/jarrodmillman>`_)
+- Mridul Seth (`@MridulS <https://github.com/MridulS>`_)
+- Ross Barnowski (`@rossbar <https://github.com/rossbar>`_)
+
+4 reviewers added to this release (alphabetically):
+
+- Eric Larson (`@larsoner <https://github.com/larsoner>`_)
+- Jarrod Millman (`@jarrodmillman <https://github.com/jarrodmillman>`_)
+- Mridul Seth (`@MridulS <https://github.com/MridulS>`_)
+- Ross Barnowski (`@rossbar <https://github.com/rossbar>`_)
+
+_These lists are automatically generated, and may not be complete or may contain
+duplicates._

{pygraphviz-2.0.2 → pygraphviz-2.0.3}/pygraphviz/__init__.py

@@ -32,7 +32,7 @@ from ._graphviz import (
     GRAPHVIZ_PATCH_VERSION,
 )
 
-__version__ = "2.0.2"
+__version__ = "2.0.3"
 __graphviz_version__ = (
     f"{GRAPHVIZ_MAJOR_VERSION}.{GRAPHVIZ_MINOR_VERSION}.{GRAPHVIZ_PATCH_VERSION}"
 )

{pygraphviz-2.0.2 → pygraphviz-2.0.3}/pygraphviz/scraper.py

@@ -27,6 +27,11 @@ class PNGScraper:
             'image_scrapers': ('matplotlib', 'pygraphviz'),
         }
 
+    Only ``.png`` files whose names appear in the code block that was just
+    executed are collected (e.g., ``"star.png"`` in ``A.draw("star.png")``), so
+    examples in the same directory can be built in parallel (sphinx-gallery's
+    ``parallel`` option) without collecting each other's images.
+
     This class is based on the recipe provide in [1]_.
 
     References
@@ -35,9 +40,6 @@ class PNGScraper:
        https://sphinx-gallery.github.io/stable/advanced.html
     """
 
-    def __init__(self):
-        self.seen = set()
-
     def __repr__(self):
         return "PNGScraper"
 
@@ -50,8 +52,10 @@ class PNGScraper:
         Parameters
         ----------
         block : tuple
-            A tuple containing the (label, content, line_number of the
-            block.
+            A tuple containing the (label, content, line_number) of the
+            block. Only PNG files whose names appear in ``content`` are
+            collected. If ``None``, all PNG files in the example's directory are
+            collected.
         block_vars : dict
             Dict of block variables
         gallery_conf : dict
@@ -68,19 +72,21 @@ class PNGScraper:
         except ImportError as e:
             raise ImportError("You must install `sphinx_gallery`") from e
 
-        # Find all PNG files in the directory of this example
+        # Find the PNG files in the directory of this example that were written
+        # by this code block
         path_current_example = os.path.dirname(block_vars["src_file"])
         pngs = sorted(glob(os.path.join(path_current_example, "*.png")))
+        if block is not None:
+            pngs = [png for png in pngs if os.path.basename(png) in block[1]]
 
-        # Iterate through PNGs and copy them to sphinx-gallery output dir
+        # Move PNGs to the sphinx-gallery output dir (so they can't be collected
+        # twice, while a later example can still write a file with the same name)
         image_names = []
         image_path_iterator = block_vars["image_path_iterator"]
         for png in pngs:
-            if png not in self.seen:
-                self.seen |= set(png)
-                this_image_path = next(image_path_iterator)
-                image_names.append(this_image_path)
-                shutil.move(png, this_image_path)
+            this_image_path = next(image_path_iterator)
+            image_names.append(this_image_path)
+            shutil.move(png, this_image_path)
 
         # Use figure_rst to generate rST for image files
         return figure_rst(image_names, gallery_conf["src_dir"])

pygraphviz-2.0.3/pygraphviz/tests/test_scraper.py

@@ -0,0 +1,88 @@
+import os
+import pytest
+
+import pygraphviz as pgv
+from pygraphviz.scraper import _get_sg_image_scraper
+
+
+def test_scraper(tmpdir):
+    pytest.importorskip("sphinx_gallery")
+    scraper = _get_sg_image_scraper()
+
+    ### Source
+    src_dir = str(tmpdir)
+    src_file = os.path.join(src_dir, "simple.py")  # no need for this to exist
+    # Create source PNG
+    A = pgv.AGraph()
+    A.add_edge(1, 2)
+    A.layout()
+    A.draw(os.path.join(src_dir, "simple.png"))
+
+    ### Target
+    out_dir = os.path.join(src_dir, "build", "html")
+    os.makedirs(out_dir)
+    out_file = os.path.join(out_dir, "simple.png")
+    # Target should **not** exist
+    assert not os.path.isfile(out_file)
+    # Copy source PNG to target location
+    block = None
+    block_vars = {
+        "image_path_iterator": (img for img in [out_file]),
+        "src_file": src_file,
+    }
+    gallery_conf = {"src_dir": src_dir, "builder_name": "html"}
+    scraper(block, block_vars, gallery_conf)
+    # Target should exist
+    assert os.path.isfile(out_file)
+
+
+def test_scraper_only_block_pngs(tmpdir):
+    """Only PNGs named in the block are collected, e.g. for parallel builds."""
+    pytest.importorskip("sphinx_gallery")
+    scraper = _get_sg_image_scraper()
+    src_dir = str(tmpdir)
+    A = pgv.AGraph()
+    A.add_edge(1, 2)
+    A.layout()
+    # "other.png" stands in for an image written by another example in the
+    # same directory that is running at the same time
+    for name in ("mine.png", "other.png"):
+        A.draw(os.path.join(src_dir, name))
+    out_dir = os.path.join(src_dir, "build", "html")
+    os.makedirs(out_dir)
+    out_files = [os.path.join(out_dir, f"img_{ii}.png") for ii in range(2)]
+    block = ("code", 'A.draw("mine.png")', 1)
+    block_vars = {
+        "image_path_iterator": iter(out_files),
+        "src_file": os.path.join(src_dir, "mine.py"),
+    }
+    gallery_conf = {"src_dir": src_dir, "builder_name": "html"}
+    rst = scraper(block, block_vars, gallery_conf)
+    assert os.path.isfile(out_files[0])
+    assert not os.path.isfile(out_files[1])
+    assert "img_0.png" in rst
+    assert not os.path.isfile(os.path.join(src_dir, "mine.png"))
+    assert os.path.isfile(os.path.join(src_dir, "other.png"))
+
+
+def test_scraper_same_name_twice(tmpdir):
+    """A file name reused by a later block (or example) is collected again."""
+    pytest.importorskip("sphinx_gallery")
+    scraper = _get_sg_image_scraper()
+    src_dir = str(tmpdir)
+    A = pgv.AGraph()
+    A.add_edge(1, 2)
+    A.layout()
+    out_dir = os.path.join(src_dir, "build", "html")
+    os.makedirs(out_dir)
+    block = ("code", 'A.draw("same.png")', 1)
+    gallery_conf = {"src_dir": src_dir, "builder_name": "html"}
+    for ii in range(2):
+        A.draw(os.path.join(src_dir, "same.png"))
+        out_file = os.path.join(out_dir, f"img_{ii}.png")
+        block_vars = {
+            "image_path_iterator": iter([out_file]),
+            "src_file": os.path.join(src_dir, f"example_{ii}.py"),
+        }
+        scraper(block, block_vars, gallery_conf)
+        assert os.path.isfile(out_file)

{pygraphviz-2.0.2 → pygraphviz-2.0.3/pygraphviz.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pygraphviz
-Version: 2.0.2
+Version: 2.0.3
 Summary: Python interface to Graphviz
 Author: Manos Renieris
 Author-email: Aric Hagberg <aric.hagberg@gmail.com>, Dan Schult <dschult@colgate.edu>

{pygraphviz-2.0.2 → pygraphviz-2.0.3}/pygraphviz.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ doc/source/release/release_1.13.rst
 doc/source/release/release_1.14.rst
 doc/source/release/release_2.0.1.rst
 doc/source/release/release_2.0.2.rst
+doc/source/release/release_2.0.3.rst
 doc/source/release/release_2.0.rst
 examples/README.txt
 examples/miles_dat.txt.gz

pygraphviz-2.0.2/pygraphviz/tests/test_scraper.py

@@ -1,36 +0,0 @@
-import os
-import pytest
-
-import pygraphviz as pgv
-from pygraphviz.scraper import _get_sg_image_scraper
-
-
-def test_scraper(tmpdir):
-    pytest.importorskip("sphinx_gallery")
-    scraper = _get_sg_image_scraper()
-
-    ### Source
-    src_dir = str(tmpdir)
-    src_file = os.path.join(src_dir, "simple.py")  # no need for this to exist
-    # Create source PNG
-    A = pgv.AGraph()
-    A.add_edge(1, 2)
-    A.layout()
-    A.draw(os.path.join(src_dir, "simple.png"))
-
-    ### Target
-    out_dir = os.path.join(src_dir, "build", "html")
-    os.makedirs(out_dir)
-    out_file = os.path.join(out_dir, "simple.png")
-    # Target should **not** exist
-    assert not os.path.isfile(out_file)
-    # Copy source PNG to target location
-    block = None
-    block_vars = {
-        "image_path_iterator": (img for img in [out_file]),
-        "src_file": src_file,
-    }
-    gallery_conf = {"src_dir": src_dir, "builder_name": "html"}
-    scraper(block, block_vars, gallery_conf)
-    # Target should exist
-    assert os.path.isfile(out_file)