[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment: Benjamin merged this to py3k/3.1 as part of r73623/r73625. -- status: open - closed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment: Applied to 2.7 in r73529 and 2.6 in r73530. Leaving ticket open until I can apply it to 3.1 and 3.2. Thanks for your help, Lucas. -- resolution: - fixed stage: patch review - committed/rejected versions: -Python 2.6, Python 2.7 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Lucas Prado Melo lukepada...@gmail.com added the comment: I think this patch is ok. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Changes by R. David Murray rdmur...@bitdance.com: Removed file: http://bugs.python.org/file14338/issue5230.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment: Here is an updated patch that cleans up the unit test (I wasn't correctly restoring sys.path). -- Added file: http://bugs.python.org/file14343/issue5230.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment: OK, I finally had time to come back to this, and figured out what I think is a final fix. It passes all the tests we've come up with, at least. Let me know if you see any problems with it, and if not I'll apply it. -- assignee: - r.david.murray versions: +Python 3.2 -Python 3.0 Added file: http://bugs.python.org/file14338/issue5230.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Changes by R. David Murray rdmur...@bitdance.com: Removed file: http://bugs.python.org/file14205/issue5230.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment: I've uploaded a new version of the patch and test suite. I wanted a few more test cases but didn't want to litter the test directory with little test files, so I borrowed some techniques from test_import and created the modules to import on the fly. I haven't come up with a fix for your last test case (yet?). I've commented the test to indicate this. I think to fix it we may need to look into the traceback itself. -- Added file: http://bugs.python.org/file14205/issue5230.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Lucas Prado Melo lukepada...@gmail.com added the comment: I had lots of stuff to do lately, sorry it took me so long to answer. Here is the patch as we intended, but there is a bug yet. What if the non-existent imported module has the same name of the module itself? $ cat pydoc_badimport3.py import this_doesnt_exist.pydoc_badimport3 $ pydoc pydoc_badimport3 I tested this possibility, and I found out that there is a bug in this situation yet: pydoc still tells the user that the module couldn't be found. -- Added file: http://bugs.python.org/file14172/pydocs.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Changes by Lucas Prado Melo lukepada...@gmail.com: Removed file: http://bugs.python.org/file14140/pydocs.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Lucas Prado Melo lukepada...@gmail.com added the comment: Take a look at the output: $ python pydoc.py test.pydoc_badimport2 problem in test.pydoc_badimport2 - type 'exceptions.ImportError': No module named i_dont_exist.neither_do_i This is different from what you expected. How do we change this output? (I was talking about this issue in the last message) -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment:
I'm sorry, I mistyped. That is the error message I was expecting (it's
derived from the one 'import' gives in that case). If the test were
like this:
elif exc is ImportError and str(value).endswith(path.split('.')[-1]):
then I think the tests would pass (but I haven't checked yet).
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue5230
___
___
Python-bugs-list mailing list
Unsubscribe:
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment: Thanks. The unit tests don't pass, though, at least not when I apply the patch to trunk. I get three failures. So the patch isn't correct as it stands. 'path' is the full module path (test.i_am_not_here in the case of one of the test failures), but what appears in the error message is just the name of the module that wasn't found. Also consider the case where the import is 'import some.nested.module', and the module that isn't found is 'nested'. In fact it may be worth writing an additional test for that case. Also I'd recommend renaming badimport_module.py pydoc_badimport.py so as to be parallel to the other pydoc auxiliary test files. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Lucas Prado Melo lukepada...@gmail.com added the comment: Ok. New patch that passes the unit tests and with a new unit test covering inexistant nested modules. -- Added file: http://bugs.python.org/file14140/pydocs.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Changes by Lucas Prado Melo lukepada...@gmail.com: Removed file: http://bugs.python.org/file14138/pydocs.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Lucas Prado Melo lukepada...@gmail.com added the comment: by the way, I was not acquainted with this unit test thing... sorry -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment: No need to apologize, and thank you for taking the time to learn this stuff. (Six months ago I didn't know how the python unit test suite worked either...and I keep learning new things.) For me your new test fails...and it isn't quite the one I had in mind. The test fails because with your patch pydoc correctly reports that there is no documentation for the non-existent temrinal module, while your test is expecting it to report a missing module. (This makes me wonder...is the existing behavior of pydoc optimal? With this patch in place would it be better to report that there is no such module rather than that there is no documentation found? But let's ignore that issue for the moment since this patch is required even if we were to change that message.) The test I had in mind would be a file pydoc_badimport2.py containing: import test.i_dont_exist.neither_do_i In that case, your patch will fail, because the error message will report that i_dont_exist can't be found. It's funny how these seemingly simple things turn out to be not quite so simple. Perhaps we could extract the last token (the module name) from the error message, and only do the no doc message if it is equal to the last element of the path name. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Lucas Prado Melo lukepada...@gmail.com added the comment: I didn't understand what you mean: what should be shown when pydoc tries to generate documentation for a module with the bad import 'import test.i_dont_exist.neither_do_i'? I am not a native english speaker, so please excuse me if you don't understand something I've written or the other way around. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment: It should generate: problem in pydoc_badimport2 - type 'exceptions.ImportError': No module named i_dont_exist If you'd like I can do the final fixup and apply the patch. I'm happy to let you get it working if you want, though, and I appreciate the work you've done so far either way. -- stage: test needed - patch review ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Lucas Prado Melo lukepada...@gmail.com added the comment: Thanks :) It seems that the error message carried by the ImportError object comes from Python/import.c:1504. What should we do: a) Edit Python/import.c b) Change the ImportError object c) Anything else. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Lucas Prado Melo lukepada...@gmail.com added the comment: I've written a patch. Hope you like it :) -- keywords: +patch nosy: +conf Added file: http://bugs.python.org/file14136/pydocs.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment: Thanks :) PEP 8 recommends spaces after commas in a list. Also, we should have a unit tests before we commit the fix. If you feel like writing them that would be most welcome. -- components: +Library (Lib) nosy: +r.david.murray stage: needs patch - test needed versions: +Python 2.7, Python 3.1 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Lucas Prado Melo lukepada...@gmail.com added the comment: The same patch with whitespaces. Is it ok now? -- Added file: http://bugs.python.org/file14137/pydocs.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Changes by Lucas Prado Melo lukepada...@gmail.com: Removed file: http://bugs.python.org/file14136/pydocs.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
R. David Murray rdmur...@bitdance.com added the comment: You are still missing a space between 'module' and 'named' ;) -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Changes by Lucas Prado Melo lukepada...@gmail.com: Removed file: http://bugs.python.org/file14137/pydocs.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Lucas Prado Melo lukepada...@gmail.com added the comment: A new patch with an unit test and with whitespaces. -- Added file: http://bugs.python.org/file14138/pydocs.diff ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Changes by Daniel Diniz aja...@gmail.com: -- keywords: +easy priority: - normal versions: +Python 2.6, Python 3.0 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
Changes by Benjamin Peterson benja...@python.org: -- stage: - needs patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue5230] pydoc reports misleading failure if target module raises an ImportError
New submission from Jean-Paul Calderone exar...@divmod.com: If pydoc is used to try to look up the documentation for a module which does not exist, this is reported reasonably: exar...@charm:~$ pydoc foobarbaz no Python documentation found for 'foobarbaz' exar...@charm:~$ However, if it is used to look up the documentation for a module which does exist but which itself imports a module which does not exist, then the same report is made: exar...@charm:~$ cat foobarbaz.py import barbazquux exar...@charm:~$ pydoc foobarbaz no Python documentation found for 'foobarbaz' exar...@charm:~$ This is somewhat misleading, since it suggests that there is no such module foobarbaz, when the problem is solved by installing the module barbazquux: exar...@charm:~$ touch barbazquux.py exar...@charm:~$ pydoc foobarbaz Help on module foobarbaz: ... exar...@charm:~$ I'm sure the cause of this is the incautious handling of ImportError by pydoc, resulting in the mistaken identification of the problem. -- messages: 81821 nosy: exarkun severity: normal status: open title: pydoc reports misleading failure if target module raises an ImportError type: behavior ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue5230 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
