[Distutils] buildout examples clarification

[Jim Fulton]

On Wed, Dec 23, 2009 at 4:05 PM, Reinout van Rees <reinout at vanrees.org> wrote:
> On 12/23/09 8:38 PM, Jeff Kunce wrote:
>>
>> I am using the buildout page on pypi as a reference
>>   http://pypi.python.org/pypi/zc.buildout
>>
>> What is the python shell used for the examples?  I can follow what is
>> going on, but I'm not familiar with some of the functions used. For
>> example:
>>   >>>  write(sample_buildout, 'recipes', 'mkdir.py', ...)
>>
>> Sorry if this is a silly question, but I'm stumped.  Thanks.
>
> Those write() and cat() and ls() methods are helper methods that are
> provided by zc.buildout's own test setup.
>
>
> (Technically: they're injected into the test's globals namespace, look for a
> ``test.globs['write'] = some_write_method`` in test*.py if you want the
> details)
>
> Really handy when testing zc.buildout. But they might just be a "little bit
> hidden" away in the test setup code ;-)

The buildout tests (and future real documentation) would benefit greatly from
manuel, which would allow me to get rid of all (or most) of these helper
functions and make the examples far more readable.  So much to do ...

Jim

-- 
Jim Fulton