Merge lp:~stefanor/objgraph/filename-514422 into lp:objgraph

[Stefano Rivera]

[Stefano Rivera (stefanor)]

You asked for a patch :)

[Marius Gedminas (mgedmin)]

On Sat, Jan 30, 2010 at 12:29:12AM -0000, Stefano Rivera wrote:
> Stefano Rivera has proposed merging lp:~stefanor/objgraph/filename-514422 into lp:objgraph.
>
> Requested reviews:
> Marius Gedminas (mgedmin)
> Related bugs:
> #514422 Creates files in the current directory
> https://bugs.launchpad.net/bugs/514422
>
>
> You asked for a patch :)

You're awesome! And switching to subprocess.Popen too!

I'm currently in the middle of a Game Jam with brains leaking out my
ears. I should have time to merge this by the end of tomorrow.

Marius Gedminas
--
Favorite MS-DOS error message: "Drive C: not ready, close door."

[Marius Gedminas (mgedmin)]

It was merged but launchpad still shows the merge request as "pending". Not very smart of it, I'd say. Let's see what happens if I do this...

review: Approve

=== modified file 'README.txt'
--- README.txt	2009-03-24 23:08:10 +0000
+++ README.txt	2010-01-30 00:29:12 +0000
@@ -24,7 +24,7 @@
     >>> x = []
     >>> y = [x, [x], dict(x=x)]
     >>> import objgraph
-    >>> objgraph.show_refs([y])
+    >>> objgraph.show_refs([y], filename='sample-graph')
 
 You should see a graph like this:
 
@@ -33,7 +33,7 @@
 
 Now try
 
-    >>> objgraph.show_backrefs([x])
+    >>> objgraph.show_backrefs([x], filename='sample-backref-graph')
 
 and you'll see
 

=== modified file 'examples.txt'
--- examples.txt	2009-03-25 00:23:51 +0000
+++ examples.txt	2010-01-30 00:29:12 +0000
@@ -16,6 +16,6 @@
     >>> del x, y, z
 
     >>> import objgraph
-    >>> objgraph.show_backrefs(objgraph.by_type('Nondestructible'))
+    >>> objgraph.show_backrefs(objgraph.by_type('Nondestructible'), filename='finalizers')
 
 .. image:: finalizers.png

=== modified file 'objgraph.py'
--- objgraph.py	2009-11-16 15:13:05 +0000
+++ objgraph.py	2010-01-30 00:29:12 +0000
@@ -75,6 +75,8 @@
 import weakref
 import operator
 import os
+import os.path
+import subprocess
 
 
 def count(typename):
@@ -204,7 +206,7 @@
 
 
 def show_backrefs(objs, max_depth=3, extra_ignore=(), filter=None, too_many=10,
-                  highlight=None):
+                  highlight=None, filename='backrefs'):
     """Generate an object reference graph ending at ``objs``
 
     The graph will show you what objects refer to ``objs``, directly and
@@ -236,11 +238,12 @@
     """
     show_graph(objs, max_depth=max_depth, extra_ignore=extra_ignore,
                filter=filter, too_many=too_many, highlight=highlight,
-               edge_func=gc.get_referrers, swap_source_target=False)
+               edge_func=gc.get_referrers, swap_source_target=False,
+               filename=filename)
 
 
 def show_refs(objs, max_depth=3, extra_ignore=(), filter=None, too_many=10,
-              highlight=None):
+              highlight=None, filename='refs'):
     """Generate an object reference graph starting at ``objs``
 
     The graph will show you what objects are reachable from ``objs``, directly
@@ -272,7 +275,8 @@
     """
     show_graph(objs, max_depth=max_depth, extra_ignore=extra_ignore,
                filter=filter, too_many=too_many, highlight=highlight,
-               edge_func=gc.get_referents, swap_source_target=True)
+               edge_func=gc.get_referents, swap_source_target=True,
+               filename=filename)
 
 #
 # Internal helpers
@@ -280,10 +284,10 @@
 
 def show_graph(objs, edge_func, swap_source_target,
                max_depth=3, extra_ignore=(), filter=None, too_many=10,
-               highlight=None):
+               highlight=None, filename='objects'):
     if not isinstance(objs, (list, tuple)):
         objs = [objs]
-    f = file('objects.dot', 'w')
+    f = file(filename + '.dot', 'w')
     print >> f, 'digraph ObjectGraph {'
     print >> f, '  node[shape=box, style=filled, fillcolor=white];'
     queue = []
@@ -344,13 +348,17 @@
                 break
     print >> f, "}"
     f.close()
-    print "Graph written to objects.dot (%d nodes)" % nodes
-    if os.system('which xdot >/dev/null') == 0:
+    print "Graph written to %s.dot (%d nodes)" % (filename, nodes)
+    if program_in_path('xdot'):
         print "Spawning graph viewer (xdot)"
-        os.system("xdot objects.dot &")
+        subprocess.Popen(['xdot', filename + '.dot'])
     else:
-        os.system("dot -Tpng objects.dot > objects.png")
-        print "Image generated as objects.png"
+        pngfile = file(filename + '.png', 'wb')
+        dot = subprocess.Popen(['dot', '-Tpng', filename + '.dot'],
+                               stdout=pngfile)
+        dot.wait()
+        pngfile.close()
+        print "Image generated as %s.png" % filename
 
 
 def obj_node_id(obj):
@@ -416,3 +424,9 @@
                     return ' [label="%s"]' % quote(safe_repr(k))
     return ''
 
+
+def program_in_path(program):
+    path = os.environ.get("PATH", os.defpath).split(os.pathsep)
+    path = [os.path.join(dir, program) for dir in path]
+    path = [True for file in path if os.path.isfile(file)]
+    return bool(path)

=== modified file 'setup.py'
--- setup.py	2009-03-25 00:02:24 +0000
+++ setup.py	2010-01-30 00:29:12 +0000
@@ -17,23 +17,20 @@
     return d['__version__']
 
 
-def build_script_to_build_images():
-    yield 'import os'
+def build_images():
+    env = {}
+    block = []
     for line in itertools.chain(open(relative('README.txt')),
                                 open(relative('examples.txt'))):
-        if line.startswith('    >>>') or line.startswith('    ...'):
-            yield line[8:].rstrip()
-        if line.startswith('.. image:: '):
-            filename = line.split()[2]
-            yield 'os.system("dot -Tpng objects.dot > %s")' % filename
-
-
-def script_to_build_images():
-    return '\n'.join(build_script_to_build_images())
-
-
-def build_images():
-    os.popen(sys.executable, 'w').write(script_to_build_images())
+        if line.startswith('    ...'):
+            block.append(line[8:].rstrip())
+        if line.startswith('    >>>'):
+            if block:
+                exec('\n'.join(block), env)
+                block = []
+            block.append(line[8:].rstrip())
+    if block:
+        exec('\n'.join(block), env)
 
 
 if len(sys.argv) > 1 and sys.argv[1] == '--show-image-script':