[Python-Dev] Re: def fn (args) [dec,dec]:

Greg Ewing greg at cosc.canterbury.ac.nz
Wed Aug 11 03:57:03 CEST 2004


> > Perhaps someone can post some real-life use cases written with this
> > syntax,
> 
> well, how about this:
> 
>     def someMethod(klass, anarg, otharg, lastarg):
>         """
>             Summary.
> 
>             Long description that explains the details about someMethod.
>             Aliquam venenatis orci in risus. Nunc ornare aliquam

I was hoping for some real live code, e.g. an excerpt from
PyObjC. This is still a made-up example.

>    @param(anarg, aClass, 'desc of anarg')
>    @param(otharg, othClass, 'desc of otharg')
>    @param(lastarg, lastClass, "longer desc of lastarg because it's special")
>    @return(rClass, 'return value description')
>    @precondition(some_validator, lastarg)
>    @postcondition(rv_validator)
>    @classmethod
>    def someMethod(klass, anarg, otharg, lastarg):
>        """
>            Summary.

And this looks awful - the method name is almost completely
lost under the deluge of preceding junk!

Greg Ewing, Computer Science Dept, +--------------------------------------+
University of Canterbury,	   | A citizen of NewZealandCorp, a	  |
Christchurch, New Zealand	   | wholly-owned subsidiary of USA Inc.  |
greg at cosc.canterbury.ac.nz	   +--------------------------------------+


More information about the Python-Dev mailing list