Thread: [Epydoc-devel] errors in 3.0alpha
Brought to you by:
edloper
From: Stefan S. <se...@sy...> - 2006-03-27 16:20:35
|
Hi there, I'm trying out the new 3.0alpha version, which generates a variety of errors on some of my code: Here is the top of the stack trace for one: File "/usr/local/lib/python2.3/site-packages/epydoc/docintrospecter.py", line 139, in introspect_docs return _valuedoc_cache[pyid] KeyError: -1208366636 Without really knowing what I was doing, I changed line 138 to if pyid in _valuedoc_cache: and the error went away. With that I get 'maximum recursion depth exceeded' with the following two functions in the recursion: File "/usr/local/lib/python2.3/site-packages/epydoc/docintrospecter.py", line 257, in introspect_module child_val_doc = introspect_docs(child, context=module_doc) File "/usr/local/lib/python2.3/site-packages/epydoc/docintrospecter.py", line 144, in introspect_docs val_doc = introspecter(value) (obviously the value is always the same). Are these known problems ? Any ideas how I can debug this further ? Thanks, Stefan |
From: Edward L. <ed...@gr...> - 2006-03-27 17:46:03
|
Hi, Stefan. Thanks for the bug reports. I *believe* that all the bugs you noted should be fixed in the most recent version of epydoc (i.e., in the subversion repository). But I can't test that without having a piece of sample code that elicits the problem. If you're comfortable with using subversion, please check out the most recent version of epydoc and see if the problem(s) still exist: <http://sourceforge.net/svn/?group_id=32455> If you'd rather not check out a copy from subversion, or the problem(s) still exist, please file a bug report on sourceforge: <http://sourceforge.net/tracker/?group_id=32455&atid=405618> If possible, please include an attachment containing a small piece of sample code that elicits the problem(s). Thanks! -Edward |
From: Stefan S. <se...@sy...> - 2006-03-27 18:20:39
|
Edward Loper wrote: > Hi, Stefan. > > Thanks for the bug reports. I *believe* that all the bugs you noted > should be fixed in the most recent version of epydoc (i.e., in the > subversion repository). But I can't test that without having a piece of > sample code that elicits the problem. If you're comfortable with using > subversion, please check out the most recent version of epydoc and see > if the problem(s) still exist: > > <http://sourceforge.net/svn/?group_id=32455> I had a look at that but wasn't quite sure what to check out. I expected the content of 'trunk' to be the root of the mainline, but it looks more as if http://svn.sourceforge.net/viewcvs.cgi/epydoc/trunk/epydoc/src/ is what I'm looking for (I judged simply by the existence of a 'setup.py' file). Also, I'm not sure what URL to feed to svn for the checkout. None of the ones I tried worked. Can you help ? Thanks ! > > If you'd rather not check out a copy from subversion, or the problem(s) > still exist, please file a bug report on sourceforge: > > <http://sourceforge.net/tracker/?group_id=32455&atid=405618> > > If possible, please include an attachment containing a small piece of > sample code that elicits the problem(s). Ok, I will try to. To be honest, the main reason for me to try out epydoc is because I was looking into the javadoc and rest parsers for inspiration, as I'd like to improve the synopsis tool (http://synopsis.fresco.org). Synopsis provides tools to parse source code in different languages (Python, IDL, C, C++) and then process the generated AST, for example into documentation. Thus there is considerable overlap with tools such as epydoc. May be there are some ideas to share... Regards, Stefan |
From: Edward L. <ed...@gr...> - 2006-03-27 18:32:55
|
Stefan Seefeld wrote: > I had a look at that but wasn't quite sure what to check out. I expected > the content of 'trunk' to be the root of the mainline, but it looks more > as if http://svn.sourceforge.net/viewcvs.cgi/epydoc/trunk/epydoc/src/ > is what I'm looking for To get the contents of the current trunk (including docs, source code, sandbox, etc), use: % svn co https://svn.sourceforge.net/svnroot/epydoc/trunk/epydoc epydoc To get just the source code for epydoc, use: % svn co https://svn.sourceforge.net/svnroot/epydoc/trunk/epydoc/src/epydoc epydoc > To be honest, the main reason for me to try out epydoc is because I was > looking into the javadoc and rest parsers for inspiration, [...] > Thus there is considerable overlap with tools such as epydoc. May be there > are some ideas to share... I'm sure there are -- I've taken more than a few good ideas from some of the other API documentation extractors out there, including javadoc, doxygen, pydoc, pythondoc, etc. A nice list of these tools is available at <http://www.stack.nl/~dimitri/doxygen/links.html> -Edward |
From: Stefan S. <se...@sy...> - 2006-03-27 18:49:16
|
Edward Loper wrote: > Stefan Seefeld wrote: > >> I had a look at that but wasn't quite sure what to check out. I expected >> the content of 'trunk' to be the root of the mainline, but it looks more >> as if http://svn.sourceforge.net/viewcvs.cgi/epydoc/trunk/epydoc/src/ >> is what I'm looking for > > > To get the contents of the current trunk (including docs, source code, > sandbox, etc), use: > > % svn co https://svn.sourceforge.net/svnroot/epydoc/trunk/epydoc epydoc > > To get just the source code for epydoc, use: > > % svn co > https://svn.sourceforge.net/svnroot/epydoc/trunk/epydoc/src/epydoc epydoc Thanks ! It appears none of the errors I reported are still there. I get a number of nicely formatted 'Error' and 'Warning' messages which I don't yet understand, but none of this look fatal. >> To be honest, the main reason for me to try out epydoc is because I was >> looking into the javadoc and rest parsers for inspiration, [...] >> Thus there is considerable overlap with tools such as epydoc. May be >> there >> are some ideas to share... > > > I'm sure there are -- I've taken more than a few good ideas from some of > the other API documentation extractors out there, including javadoc, > doxygen, pydoc, pythondoc, etc. A nice list of these tools is available > at <http://www.stack.nl/~dimitri/doxygen/links.html> Yeah, I'm aware of that list. :-) Thanks a lot ! Regards, Stefan |