Re: RFC: automatically listing fixed bugs for NEWS

[Joseph Myers <joseph at codesourcery dot com>]

On Thu, 5 Nov 2015, Siddhesh Poyarekar wrote:

> > What do people think of using this script - put in 
> > scripts/list-fixed-bugs.py, say - to replace the manual NEWS edits when 
> > fixing bugs?
> 
> If we plan to have additional scripts that are run only for releases and
> are not part of the build process, it might be a good idea to keep them

We already have scripts that are not part of the build process, e.g. 
update-copyrights.

> in a separate 'release' or 'releng' directory.  That'll help us keep
> simple constraints in place like ensuring that none of the build scripts
> are python since that will create an additional dependency.

The only time at which such a constraint is likely to be checked is at 
patch review time, so I don't see this helping.

(Personally I think several scripts in the scripts/ directory should move 
to other subdirectories, if only used by the build/test process in those 
subdirectories.  But once the directory just has miscellaneous scripts, 
whether used at top level by the build process or outside the build 
process, I'm more doubtful of further splitting.)

> > list-fixed-bugs.py
> 
> Could you confirm if the script comes clean through scripts/pylint?
> FWIW, that ought to go into that separate release directory too.

The only version of pylint available on Ubuntu 14.04 seems to be for 
Python 2 not Python 3, so I get spurious messages relating to that.

C: 43, 0: Unnecessary parens after 'print' keyword (superfluous-parens)
C:  1, 0: Invalid module name "list-fixed-bugs" (invalid-name)
E: 29, 0: No name 'request' in module 'urllib' (no-name-in-module)
F: 29, 0: Unable to import 'urllib.request' (import-error)
E: 36,15: Module 'urllib' has no 'request' member (no-member)

(Since urllib module names had changed in Python 3, it seemed most 
appropriate to write the script in Python 3 form, rather than complicating 
it with compatibility code for different versions of Python.)

> > def list_fixed_bugs(version):
> >     """List the bugs fixed in a given version."""
> 
> The PEP8 format (that is what I remember we had agreed on for the
> benchtests script) requires you to describe each parameter as well IIRC.

<https://www.python.org/dev/peps/pep-0008/#documentation-strings> points 
to PEP 257.  I think this fits the "One-liners are for really obvious 
cases." there.  (I was taking the localedata/unicode-gen/*.py scripts as 
examples.)

-- 
Joseph S. Myers
joseph@codesourcery.com