naming convention for functions that mutate their arguments?

[mike p.]

Hi all,

I was wondering if there was any official/recommended way to denote that a
Python function may mutate one or more of its arguments? I took a glance at
PEP 8, but didn't see anything along these lines. A google search turned up
something similar (
http://aspn.activestate.com/ASPN/Mail/Message/1457714) but I didn't run
across a resolution.

Thanks!
mike

 

[Terry Reedy]

Hi all,

I was wondering if there was any official/recommended way to denote that a
Python function may mutate one or more of its arguments?

The list mutation methods all return None to remind of this. Otherwise,
read doc strings.

Terry J. Reedy