Changeset 45

Timestamp:

24/06/07 05:55:07 (17 months ago)

Author:

gak

Message:

check to see if examples scripts are run from the command line (so epydoc can parse them without running them)

Location:

trunk/examples

Files:

• basic.py (modified) (1 diff)
• colours.py (modified) (3 diffs)
• filter.py (modified) (1 diff)
• import.py (modified) (1 diff)
• large.py (modified) (1 diff)
• recursive.py (modified) (1 diff)
• regexp.py (modified) (1 diff)

trunk/examples/basic.py

@@ -39 +39 @@
         pass
 
-banana = Banana()
-banana.eat()
+def main():
+    banana = Banana()
+    banana.eat()
+    pycallgraph.make_dot_graph('basic.png')
 
-pycallgraph.make_dot_graph('basic.png')
+if __name__ == '__main__':
+    main()
 
 # vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

trunk/examples/colours.py

@@ -1 @@
-#!/usr/bin/env python
+    #!/usr/bin/env python
 """
 pycallgraph
@@ -25 +25 @@
 This example demonstrates several different methods on colouring your graph.
 
-See U{http://www.graphviz.org/doc/info/attrs.html#k:color} for details on how
+See U{http://www.graphviz.org/doc/info/attrs.html    #k:color} for details on how
 to return colour formats to Graphviz.
 """
@@ -33 +33 @@
 import pycallgraph
 
-# Do the trace, remember the values for later
-pycallgraph.start_trace()
-import HTMLParser
-pycallgraph.stop_trace()
+def main():
+    # Do the trace, remember the values for later
+    pycallgraph.start_trace()
+    import HTMLParser
+    pycallgraph.stop_trace()
 
-# Set the edge colour to black for all examples
-pycallgraph.settings['edge_colour'] = lambda a, b: 'black'
+    # Set the edge colour to black for all examples
+    pycallgraph.settings['edge_colour'] = lambda a, b: 'black'
 
-# Default node colouring
-pycallgraph.make_dot_graph('colours-default.png')
+    # Default node colouring
+    pycallgraph.make_dot_graph('colours-default.png')
 
-# Rainbow
-def rainbow(calls, total_time):
-    """Colour using only changes in hue.
+    # Rainbow
+    def rainbow(calls, total_time):
+        """Colour using only changes in hue.
 
-    It will go from 0 to 0.8 which is red, orange, yellow, green, cyani, blue
-    then purple.
+        It will go from 0 to 0.8 which is red, orange, yellow, green, cyani, blue
+        then purple.
 
-    See U{http://en.wikipedia.org/wiki/Hue} for more information on hue.
-    """
-    return '%f 0.8 0.8' % (calls * 0.8)
+        See U{http://en.wikipedia.org/wiki/Hue} for more information on hue.
+        """
+        return '%f 0.8 0.8' % (calls * 0.8)
 
-pycallgraph.settings['node_colour'] = rainbow
-pycallgraph.make_dot_graph('colours-rainbow.png')
+    pycallgraph.settings['node_colour'] = rainbow
+    pycallgraph.make_dot_graph('colours-rainbow.png')
 
-# Greyscale
-def greyscale(calls, total_time):
-    """Goes from dark grey to a light grey."""
-    return '0 0 %f' % (calls / 2 + 0.4)
+    # Greyscale
+    def greyscale(calls, total_time):
+        """Goes from dark grey to a light grey."""
+        return '0 0 %f' % (calls / 2 + 0.4)
 
-pycallgraph.settings['node_colour'] = greyscale
-pycallgraph.make_dot_graph('colours-greyscale.png')
+    pycallgraph.settings['node_colour'] = greyscale
+    pycallgraph.make_dot_graph('colours-greyscale.png')
 
-# Differences between calls and total time
-def orange_green(calls, total_time):
-    """Make a higher total time have an orange colour and a higher number of
-    calls have a green colour using RGB.
-    """
-    return '#%02X%02X%02X' % (
-        0x30 + total_time * 0xc0,
-        0x30 + calls * 0xc0 + total_time * 0x70,
-        0x30,
-    )
+    # Differences between calls and total time
+    def orange_green(calls, total_time):
+        """Make a higher total time have an orange colour and a higher number of
+        calls have a green colour using RGB.
+        """
+        return '    #%02X%02X%02X' % (
+            0x30 + total_time * 0xc0,
+            0x30 + calls * 0xc0 + total_time * 0x70,
+            0x30,
+        )
 
-pycallgraph.settings['node_colour'] = orange_green
-pycallgraph.make_dot_graph('colours-orange-green.png')
+    pycallgraph.settings['node_colour'] = orange_green
+    pycallgraph.make_dot_graph('colours-orange-green.png')
 
-# Random!
-def rand(calls, total_time):
-    """Random with a touch of usefulness"""
-    return '%f %f %f' % (random.random(), calls * 0.5 + 0.5, calls * 0.5 + 0.5)
+    # Random!
+    def rand(calls, total_time):
+        """Random with a touch of usefulness"""
+        return '%f %f %f' % (random.random(), calls * 0.5 + 0.5, calls * 0.5 + 0.5)
 
-pycallgraph.settings['node_colour'] = rand
-pycallgraph.make_dot_graph('colours-random.png')
+    pycallgraph.settings['node_colour'] = rand
+    pycallgraph.make_dot_graph('colours-random.png')
 
+if __name__ == '__main__':
+    main()
 
+# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

trunk/examples/filter.py

@@ -65 +65 @@
     pycallgraph.make_dot_graph('filter-max-depth.png')
 
-filter_exclude()
-filter_include()
-filter_max_depth()
+def main():
+    filter_exclude()
+    filter_include()
+    filter_max_depth()
+
+if __name__ == '__main__':
+    main()
 
 # vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

trunk/examples/import.py

@@ -28 +28 @@
 import pycallgraph
 
-pycallgraph.settings['dont_exclude_anything'] = True
+def main():
+    pycallgraph.settings['dont_exclude_anything'] = True
+    import_list = ['pickle', 'htmllib']
 
-import_list = ['pickle', 'htmllib']
+    for imp in import_list:
+        pycallgraph.start_trace()
+        __import__(imp)
+        pycallgraph.make_dot_graph('import-%s.png' % imp)
 
-for imp in import_list:
-    pycallgraph.start_trace()
-    __import__(imp)
-    pycallgraph.make_dot_graph('import-%s.png' % imp)
+if __name__ == '__main__':
+    main()
 
 # vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

trunk/examples/large.py

@@ -29 +29 @@
 import pycallgraph
 
-pycallgraph.start_trace()
-import urllib
-from xml.dom.minidom import parse, parseString
-parseString(urllib.urlopen('http://w3.org/').read())
-pycallgraph.make_dot_graph('large.png')
+def main():
+    pycallgraph.start_trace()
+    import urllib
+    from xml.dom.minidom import parse, parseString
+    parseString(urllib.urlopen('http://w3.org/').read())
+    pycallgraph.make_dot_graph('large.png')
+
+if __name__ == '__main__':
+    main()
 
 # vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

trunk/examples/recursive.py

@@ -36 +36 @@
     return n * factorial(n-1)
 
-for a in xrange(1, 10):
-    print factorial(a)
 
-pycallgraph.make_dot_graph('recursive.png')
+def main(self):
+    for a in xrange(1, 10):
+        print factorial(a)
+
+    pycallgraph.make_dot_graph('recursive.png')
+
+if __name__ == '__main__':
+    main()
 
 # vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

trunk/examples/regexp.py

@@ -28 +28 @@
 import re
 
-pycallgraph.start_trace()
+def main():
+    pycallgraph.start_trace()
+    re.search('(hel[j-s]o).*(th[^e]*ere)', 'hello there')
+    pycallgraph.make_dot_graph('regexp.png')
 
-re.search('(hel[j-s]o).*(th[^e]*ere)', 'hello there')
-
-pycallgraph.make_dot_graph('regexp.png')
+if __name__ == '__main__':
+    main()
 
 # vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: