Thread: [Pythoncard-cvs] PythonCard/samples/widgets widgets.py,1.44,1.45

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/pythoncard/PythonCard/samples/widgets
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24928/samples/widgets

Modified Files:
	widgets.py 
Log Message:
added documentation.py, moved old dumpDocs and helper functions out of
widgets.py and created a new function to document a background


Index: widgets.py
===================================================================
RCS file: /cvsroot/pythoncard/PythonCard/samples/widgets/widgets.py,v
retrieving revision 1.44
retrieving revision 1.45
diff -C2 -d -r1.44 -r1.45
*** widgets.py	18 Sep 2005 03:59:22 -0000	1.44
--- widgets.py	29 Dec 2005 20:36:25 -0000	1.45
***************
*** 11,17 ****
  
  from PythonCard import dialog, model
- import os
- import inspect
- import wx
  
  BORDER = 5
--- 11,14 ----
***************
*** 242,395 ****
  
  
-     # KEA 2002-05-07
-     # some methods to build up component documentation
-     # using the built-in component specs
- 
-     def getAttributesList(self, attributes):
-         names = [a for a in attributes]
-         names.sort()
-         listX = []
-         for n in names:
-             if attributes[n].hasDefaultValueList():
-                 listX.append([n, attributes[n].getDefaultValueList()])
-             else:
-                 value = attributes[n].getDefaultValue()
-                 if value == '':
-                     value = "''"
-                 listX.append([n, value])
-         return listX
- 
-     def getEventsList(self, spec):
-         events = [e.name for e in spec.getEvents()]
-         events.sort()
-         return events
- 
-     def getMethodsList(self, object):
-         listX = []
-         methods = inspect.getmembers(object, inspect.ismethod)
-         for m in methods:
-             if m[0][0] in "abcdefghijklmnopqrstuvwxyz":
-                 listX.append(m[0])
-         return listX
- 
      def on_menuFileDumpWidgets_select(self, event):
          self.dumpDocs()
  
      def dumpDocs(self):
!         #try:
!         result = dialog.directoryDialog(None, 'Create widgets_documention in:', '')
          if result.accepted:
              widgetsDir = result.path
!         else:
!             return
!         widgetsDir = os.path.join(widgetsDir, 'components')
!         if not os.path.exists(widgetsDir):
!             os.mkdir(widgetsDir)
!         imagesDir = os.path.join(widgetsDir, 'images')
!         if not os.path.exists(imagesDir):
!             os.mkdir(imagesDir)
! 
!         toc = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">'
!         toc += '<html>\n<head><title>%s</title></head><body>\n' % 'PythonCard Components'
!         toc += '<h1>PythonCard Components</h1>\n'
!         componentsList = []
! 
!         for w in self.components.itervalues():
!             if w.__class__.__name__.startswith(w.name[3:]):
!                 # document each widget
!                 name = w.__class__.__name__
!                 spec = w._spec
! 
!                 doc = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">'
!                 doc += '<html>\n<head><title>%s</title></head><body>\n' % (name + ': PythonCard component')
!                 doc += '<h1>Component: %s</h1>' % name
! 
!                 doc += '\n<img src="%s"><BR>\n' % ('images/' + name + '.png')
! 
!                 doc += '\n<h2>Required Attributes</h2>\n'
!                 doc += '<table border="1">\n'
!                 doc += '<tr><td><b>Name<b></td><td><b>Default value</b></td></tr>\n'
!                 for a in self.getAttributesList(spec.getRequiredAttributes()):
!                     doc += "<tr><td>%s</td><td>%s</td></tr>\n" % (a[0], a[1])
!                 doc += '</table>'
! 
!                 doc += '\n\n<h2>Optional Attributes</h2>\n'
!                 doc += '<table border="1">\n'
!                 doc += '<tr><td><b>Name<b></td><td><b>Default value</b></td></tr>\n'
!                 for a in self.getAttributesList(spec.getOptionalAttributes()):
!                     doc += "<tr><td>%s</td><td>%s</td></tr>\n" % (a[0], a[1])
!                 doc += '</table>'
! 
!                 doc += '\n\n<h2>Events:</h2>\n'
!                 doc += '<table border="1">\n'
!                 for e in self.getEventsList(spec):
!                     doc += "<tr><td>%s</td></tr>\n" % e
!                 doc += '</table>'
! 
!                 doc += '\n\n<h2>Methods:</h2>\n'
!                 doc += '<table border="1">\n'
!                 td = '<td><b>%s</b></td>' * 4
!                 tr = '<tr>' + td + '</tr>\n'
!                 doc += tr % ('method', 'args', 'doc string', 'comments')
!                 for e in self.getMethodsList(w):
!                     method = getattr(w, e)
!                     docstring = inspect.getdoc(method)
!                     if docstring is None:
!                         docstring = "&nbsp;"
!                     comments = inspect.getcomments(method)
!                     if comments is None:
!                         comments = "&nbsp;"
!                     #source = inspect.getcomments(method)
!                     argspec = inspect.getargspec(method)
!                     formattedargs = inspect.formatargspec(argspec[0], argspec[1], argspec[2], argspec[3])
!                     doc += "<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>\n" % \
!                         (e, formattedargs, docstring, comments)
!                 doc += '</table>'
! 
!                 # need to decide what we want to dump from the methods
!                 # we probably don't want to dump everything including
!                 # wxPython methods, so this is where we need to decide
!                 # on the case of the first letter of the method
!                 # whatever is done here should be the same thing used
!                 # to display methods in the shell
!                 # arg lists and tooltips (docstrings) will be used here too
! 
!                 # write out the documentation for the component
!                 doc += '\n<hr><img src="http://sourceforge.net/sflogo.php?group_id=19015&type=1" width="88" height="31" border="0" alt="SourceForge Logo">'
!                 doc += '\n</body>\n</html>'
!                 filename = name + '.html'
!                 path = os.path.join(widgetsDir, filename)
!                 f = open(path, 'w')
!                 f.write(doc)
!                 f.close()
! 
!                 # create an image using the actual component
!                 # on screen
!                 # comment this out once you have created the images
!                 # you want
!                 bmp = wx.EmptyBitmap(w.size[0], w.size[1])
!                 memdc = wx.MemoryDC()
!                 memdc.SelectObject(bmp)
!                 dc = wx.WindowDC(w)
!                 memdc.BlitPointSize((0, 0), w.size, dc, (0, 0))
!                 imgfilename = os.path.join(imagesDir, name + '.png')
!                 bmp.SaveFile(imgfilename, wx.BITMAP_TYPE_PNG)
!                 dc = None
!                 memdc.SelectObject(wx.NullBitmap)
!                 memdc = None
!                 bmp = None
! 
!                 componentsList.append('<a href="%s">%s</a><br>\n' % (filename, name))
  
-         # now create the table of contents, index.html
-         componentsList.sort()
-         for c in componentsList:
-             toc += c
-         toc += '\n<hr><img src="http://sourceforge.net/sflogo.php?group_id=19015&type=1" width="88" height="31" border="0" alt="SourceForge Logo">'
-         toc += '\n</body>\n</html>'
-         filename = os.path.join(widgetsDir, 'index.html')
-         f = open(filename, 'w')
-         f.write(toc)
-         f.close()
  
  if __name__ == '__main__':
--- 239,253 ----
  
  
      def on_menuFileDumpWidgets_select(self, event):
          self.dumpDocs()
  
      def dumpDocs(self):
!         from PythonCard import documentation
!         
!         result = dialog.directoryDialog(None, 'Create documention in:', '')
          if result.accepted:
              widgetsDir = result.path
!             documentation.dumpComponentDocs(self, widgetsDir)
  
  
  if __name__ == '__main__':

Thread: [Pythoncard-cvs] PythonCard/samples/widgets widgets.py,1.44,1.45

pythoncard-cvs