[Python-Dev] Convention on functions that shadow existing stdlib functions

Georg Brandl g.brandl at gmx.net
Sat Jul 30 09:02:12 CEST 2011


Am 27.07.2011 19:47, schrieb Terry Reedy:
> On 7/27/2011 1:27 PM, Brett Cannon wrote:
> 
>>     Perhaps what we could do is move the documentation for test.support to
>>     the devguide, and then vet the test suite so that unlink and friends
>>     are always called as 'support.unlink', etc.
>>
>>
>> I like this solution since this issue of documenting test.support keeps
>> coming up. Otherwise we can not document test.support,
> 
> We already do.
> 
> 25.6. test.support — Utility functions for tests

FWIW, this heading could give wrong impressions.  I just changed it to

:mod:`test.support` --- Utilities for the Python test suite

and also added another note under it that the API is subject to change
at any time.

> is about half of the page that also contains
> 25.5. test — Regression tests package for Python
> The latter contains
> 25.5.1. Writing Unit Tests for the test package
> which should also be moved to the dev guide if 25.6 is.

Georg



More information about the Python-Dev mailing list