Docutils: Documentation Utilities

On 2010-11-08, Nils-Hero Lindemann wrote:

Thanks for the bug report. As Python 3 support is still patchy, we
appreciate the feedback but cannot guarantee fast or simple solutions.
Documentation patches are welcome.

Also, testing under windows is impossible for me.

> ! Not subscribed to this user list. Contact me via <nils@...> !

I'll send you a copy of the post to the list. Could you consider
following the discussion there, e.g. via Gmane?

> I run Python v3.1.2 under XP v5.1.2600
> Dont know version of cmd, it is the one which was included with XP.

...

> Did "python setup.py install" from a cmd inside that extracted
> 'docutils'-folder.

> Then i did two things, running the testsuite and building the docs:

> 1. Tried the converted testsuite for python 3 like described here ...
> http://docutils.sourceforge.net/README.html#running-the-test-suite

Are you sure you tried the converted test suite? The mentioned document
points to the non-converted test suite (it was written in before 3000).


> C:\user\nilshero\Desktop\docutils\build\lib\test>python alltests.py

On my system, the converted test suite is under

  ... docutils/build/lib.linux-x86_64-3.1/test/

> ERROR: Can't import test_readers.test_python.test_functions, skipping its tests:

> Traceback (most recent call last):
>   File "C:\user\nilshero\Desktop\docutils\build\lib\test\package_unittest.py", l
> ine 101, in loadTestModules
>     module = import_module(mod)
>   File "C:\user\nilshero\Desktop\docutils\build\lib\test\package_unittest.py", l
> ine 132, in import_module
>     mod = __import__(name)
>   File "C:\user\nilshero\Desktop\docutils\build\lib\test\test_readers\test_pytho
> n\test_functions.py", line 13, in <module>
>     from docutils.readers.python.moduleparser import trim_docstring
>   File "C:\user\nilshero\Desktop\docutils\build\lib\docutils\readers\python\__in
> it__.py", line 14, in <module>
>     from docutils.readers.python import moduleparser

>   File "C:\user\nilshero\Desktop\docutils\build\lib\docutils\readers\python\modu
> leparser.py", line 211, in <module>
>     import compiler
> ImportError: No module named compiler

The compiler module is removed from the stdlib in Python 3.x. The
3.x-test-suite therefore disables tests of Docutils-parts requiring it.

Also messages like this suggest the wrong test version is used ...

...

> TypeError: sequence item 0: expected str instance, bytes found

...

> 2. when building the docs (plus '--traceback') like described here ...
> http://docutils.sourceforge.net/README.html#usage
> ... i get this (complete cmd):

The same question here:

> C:\user\nilshero\Desktop\docutils>python build\lib\tools\buildhtml.py --config=t
> ools\docutils.conf --traceback

is this the Python-3 version of the tools?


Günter

Hi, Günter, thanks for answering - Grüß Gott übrigens :-)

> Documentation patches are welcome.

Lets see what it is. Currently the only patch i could provide is:
'it seems to work well with Python 3 under XP, but the doc can not be compiled
due to a encoding error and the tests fail with 15 Errors, reason may be
partially wrong conversion to py3'.

> Also, testing under windows is impossible for me.

And i can not install old (too complex) or new (too hungry) Linux on my
512 MB RAM Laptop.

> > 1. Tried the converted testsuite for python 3 like described here ...
> > http://docutils.sourceforge.net/README.html#running-the-test-suite
> 
> Are you sure you tried the converted test suite?

Yes. after a build there are two suites, one is (or looks like) python3 code
(eg print-functions) and the other is not. i tested the py3 suite in the
build/lib/test directory (more than once). it throws 15 errors.
i also now tested the py2.5 suite with py2.5 (have that installed too but it is
not on PATH) it works, no errors. then i testet the py2.5 suite with py3.
it (obviously) gives a syntax error (print statement). I also testet building
the doc under python 2.5 which worked without errors.

conclusion: it is the 2to3-tool.

greetings, nils

-- 
Nils-Hero Lindemann <nils@...>

On 2010-11-08, Nils-Hero Lindemann wrote:

> Lets see what it is. Currently the only patch i could provide is: 'it
> seems to work well with Python 3 under XP, but the doc can not be
> compiled due to a encoding error and the tests fail with 15 Errors,
> reason may be partially wrong conversion to py3'.

It works for me and others, so we have to sort out what is the difference...

>> > 1. Tried the converted testsuite for python 3 like described here ...
>> > http://docutils.sourceforge.net/README.html#running-the-test-suite

>> Are you sure you tried the converted test suite?

> Yes. after a build there are two suites, one is (or looks like) python3 code
> (eg print-functions) and the other is not. i tested the py3 suite in the
> build/lib/test directory (more than once). 

Fine.

> it throws 15 errors.

Not good.

> i also now tested the py2.5 suite with py2.5 (have that installed too
> but it is not on PATH) it works, no errors. 

Maybe Python 3 finds a 2.x version of some module(s) (e.g. from a
previous install) and takes this instead of the 2-3-converted?

> Then i testet the py2.5 suite with py3. it (obviously) gives a syntax
> error (print statement). 

What happens if you test the "should be Py3" suite with 2.5?

> I also tested building the doc under python
> 2.5 which worked without errors.

> conclusion: it is the 2to3-tool.

Im not sure about this. My suggestion is to compare sys.path for 3.x
and 2.5?

Günter
> greetings, nils

Hi again,

> What happens if you test the "should be Py3" suite with 2.5?

it throws a SyntaxError (because of p3 changed exception syntax).

> My suggestion is to compare sys.path for 3.x and 2.5?

checked it. did ...
>>> import sys
>>> sys.path
... in both python-cmds. sys.path is fine for both.
2.5.4 uses C:/p/python/2.5/...,
3.1.2 uses C:/p/python/3.1/...

btw. when i run docutils setup.py under py3, there is a long delay
(50 seconds) in the middle of install after the text ...
Skipping implicit fixer: buffer
Skipping implicit fixer: idioms
Skipping implicit fixer: set_literal
Skipping implicit fixer: ws_comma
... then after the following line ...
copying aux dirs
... another delay of 20 seconds. Have this often (always?) with
py3 installations. is it normal? May this be a reason that it does
not work right?

greetings, nils

On 2010-11-12, Nils-Hero Lindemann wrote:
> Hi again,

>> What happens if you test the "should be Py3" suite with 2.5?

> it throws a SyntaxError (because of p3 changed exception syntax).

>> My suggestion is to compare sys.path for 3.x and 2.5?

> checked it. did ...
>>>> import sys
>>>> sys.path
> ... in both python-cmds. sys.path is fine for both.
> 2.5.4 uses C:/p/python/2.5/...,
> 3.1.2 uses C:/p/python/3.1/...

Hm. Looks OK to me. 

Netx thing to try: while the tools/ and test/ sub-directories are not
copied/installed with Python 2.x, they are copied and the contents run
through 2to3 with Python 3.x. So, please check the paths of e.g.
alltests.py and buildhtml.py (there should be at least 2 versions of
these somewhere on your system).

> btw. when i run docutils setup.py under py3, there is a long delay
> (50 seconds) in the middle of install after the text ...
> Skipping implicit fixer: buffer
> Skipping implicit fixer: idioms
> Skipping implicit fixer: set_literal
> Skipping implicit fixer: ws_comma
> ... then after the following line ...
> copying aux dirs
> ... another delay of 20 seconds. Have this often (always?) with
> py3 installations. is it normal? May this be a reason that it does
> not work right?

I don't think so. I do have the delay, too, but the tests run fine also
under Py3k.

Günter