X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=update_copyright.py;h=55aa1a5a01ee944a2981c51fbcb76eece2430ed1;hb=a0f5948309cc4644a8e2e0bf2bf433b92e52b76a;hp=ef2799a7955ba994c5ec028d8745e76e1f2e8184;hpb=bf293ebc6a54c65097f3c10fe716d90d38ac317e;p=hooke.git diff --git a/update_copyright.py b/update_copyright.py index ef2799a..55aa1a5 100755 --- a/update_copyright.py +++ b/update_copyright.py @@ -1,18 +1,18 @@ #!/usr/bin/python # -# Copyright (C) 2010 W. Trevor King +# Copyright (C) 2010-2012 W. Trevor King # # This file is part of Hooke. # -# Hooke is free software: you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, either -# version 3 of the License, or (at your option) any later version. +# Hooke is free software: you can redistribute it and/or modify it +# under the terms of the GNU Lesser General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # -# Hooke is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU Lesser General Public License for more details. +# Hooke is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General +# Public License for more details. # # You should have received a copy of the GNU Lesser General Public # License along with Hooke. If not, see @@ -36,35 +36,21 @@ import time PROJECT_INFO = { 'project': 'Hooke', - 'vcs': 'Mercurial', + 'vcs': 'Git', } # Break "copyright" into "copy" and "right" to avoid matching the # REGEXP if we decide to go back to regexps. -COPY_RIGHT_TEXT=""" -This file is part of %(project)s. - -%(project)s is free software: you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public -License as published by the Free Software Foundation, either -version 3 of the License, or (at your option) any later version. - -%(project)s is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Lesser General Public License for more details. - -You should have received a copy of the GNU Lesser General Public -License along with %(project)s. If not, see -. -""".strip() - -SHORT_COPY_RIGHT_TEXT=""" -%(project)s comes with ABSOLUTELY NO WARRANTY; %(get-warrenty)s -for details. This is free software, and you are welcome to -redistribute it under certain conditions; %(get-details)s -for details. -""".strip() +COPY_RIGHT_TEXT = [ + 'This file is part of %(project)s.', + '%(project)s is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.', + '%(project)s is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.', + 'You should have received a copy of the GNU Lesser General Public License along with %(project)s. If not, see .' + ] + +SHORT_COPY_RIGHT_TEXT = [ + '%(project)s comes with ABSOLUTELY NO WARRANTY and is licensed under the GNU Lesser General Public License. For details, %(get-details)s.' + ] COPY_RIGHT_TAG='-xyz-COPY' + '-RIGHT-zyx-' # unlikely to occur in the wild :p @@ -77,27 +63,7 @@ COPY_RIGHT_TAG='-xyz-COPY' + '-RIGHT-zyx-' # unlikely to occur in the wild :p # } # Git-based projects are encouraged to use .mailmap instead of # ALIASES. See git-shortlog(1) for details. -ALIASES = { - 'A. Seeholzer': - ['A. Seeholzer'], - 'Alberto Gomez-Casado': - ['albertogomcas'], - 'Massimo Sandal ': - ['Massimo Sandal', - 'devicerandom', - 'unknown'], - 'Fabrizio Benedetti': - ['fabrizio.benedetti.82'], - 'Richard Naud ': - ['Richard Naud'], - 'Rolf Schmidt ': - ['Rolf Schmidt', - 'illysam'], - 'Marco Brucale': - ['marcobrucale'], - 'Pancaldi Paolo': - ['pancaldi.paolo'], - } +ALIASES = {} # List of paths that should not be scanned for copyright updates. # IGNORED_PATHS = ['./.git/'] @@ -115,14 +81,22 @@ IGNORED_FILES = ['COPYING', 'COPYING.LESSER'] # ('path', 'to', 'module.py'):['John Doe'], # } AUTHOR_HACKS = { - ('hooke','driver','hdf5.py'):['Massimo Sandal'], + ('hooke','driver','hdf5.py'):['Massimo Sandal '], ('hooke','driver','mcs.py'):['Allen Chen'], - ('hooke','driver','mfp3d.py'):['A. Seeholzer','Richard Naud','Rolf Schmidt', - 'Alberto Gomez-Casado'], - ('hooke','util','peak.py'):['Fabrizio Benedetti'], - ('hooke','plugin','showconvoluted.py'):['Rolf Schmidt'], - ('hooke','ui','gui','formatter.py'):['Francesco Musiani','Massimo Sandal'], - ('hooke','ui','gui','prettyformat.py'):['Rolf Schmidt'], + ('hooke','driver','mfp3d.py'):[ + 'A. Seeholzer', + 'Richard Naud', + 'Rolf Schmidt ', + 'Alberto Gomez-Casado '], + ('hooke','util','peak.py'):[ + 'Fabrizio Benedetti '], + ('hooke','plugin','showconvoluted.py'):[ + 'Rolf Schmidt '], + ('hooke','ui','gui','formatter.py'):[ + 'Francesco Musiani', + 'Massimo Sandal '], + ('hooke','ui','gui','prettyformat.py'):[ + 'Rolf Schmidt '], } # Work around missing year holes in the VCS history. @@ -470,23 +444,21 @@ def _long_author_formatter(copyright_year_string, authors): lines.append(' '*(len(copyright_year_string)+1) + author) return lines -def _short_author_formatter(copyright_year_string, authors, **kwargs): +def _short_author_formatter(copyright_year_string, authors): """ >>> print '\\n'.join(_short_author_formatter( ... copyright_year_string='Copyright (C) 1990-2010', - ... authors=['Jack', 'Jill', 'John']*5, - ... width=50)) - Copyright (C) 1990-2010 Jack, Jill, John, Jack, - Jill, John, Jack, Jill, John, Jack, Jill, John, - Jack, Jill, John + ... authors=['Jack', 'Jill', 'John']*5)) + Copyright (C) 1990-2010 Jack, Jill, John, Jack, Jill, John, Jack, Jill, John, Jack, Jill, John, Jack, Jill, John """ blurb = '%s %s' % (copyright_year_string, ', '.join(authors)) - return textwrap.wrap(blurb, **kwargs) + return [blurb] -def _copyright_string(original_year, final_year, authors, prefix='', +def _copyright_string(original_year, final_year, authors, text=COPY_RIGHT_TEXT, extra_info={}, author_format_fn=_long_author_formatter, - formatter_kwargs={}): + formatter_kwargs={}, prefix='', wrap=True, + **wrap_kwargs): """ >>> print _copyright_string(original_year=2005, ... final_year=2005, @@ -508,36 +480,57 @@ def _copyright_string(original_year, final_year, authors, prefix='', >>> print _copyright_string(original_year=2005, ... final_year=2005, ... authors=['A ', 'B '], + ... text=SHORT_COPY_RIGHT_TEXT, + ... author_format_fn=_short_author_formatter, + ... extra_info={'get-details':'%(get-details)s'}, ... prefix='', + ... width=50, + ... ) + Copyright (C) 2005 A , B + + Hooke comes with ABSOLUTELY NO WARRANTY and is + licensed under the GNU Lesser General Public + License. For details, %(get-details)s. + >>> print _copyright_string(original_year=2005, + ... final_year=2005, + ... authors=['A ', 'B '], ... text=SHORT_COPY_RIGHT_TEXT, + ... extra_info={'get-details':'%(get-details)s'}, ... author_format_fn=_short_author_formatter, - ... extra_info={ - ... 'get-warrenty':'%(get-warrenty)s', - ... 'get-details':'%(get-details)s', - ... }, - ... formatter_kwargs={'width': 50}, - ... ) # doctest: +ELLIPSIS + ... wrap=False, + ... prefix='', + ... ) Copyright (C) 2005 A , B - Hooke comes with ABSOLUTELY NO WARRANTY; %(get-warrenty)s. - This is free software, and you are welcome to redistribute it - under certain conditions; %(get-details)s for details. + Hooke comes with ABSOLUTELY NO WARRANTY and is licensed under the GNU Lesser General Public License. For details, %(get-details)s. """ + for key in ['initial_indent', 'subsequent_indent']: + if key not in wrap_kwargs: + wrap_kwargs[key] = prefix + if original_year == final_year: date_range = '%s' % original_year else: date_range = '%s-%s' % (original_year, final_year) copyright_year_string = 'Copyright (C) %s' % date_range + lines = author_format_fn(copyright_year_string, authors, **formatter_kwargs) - lines.append('') + for i,line in enumerate(lines): + lines[i] = prefix + line + info = dict(PROJECT_INFO) for key,value in extra_info.items(): info[key] = value - lines.extend((text % info).splitlines()) - for i,line in enumerate(lines): - lines[i] = (prefix + line).rstrip() - return '\n'.join(lines) + text = [paragraph % info for paragraph in text] + + if wrap == True: + text = [textwrap.fill(p, **wrap_kwargs) for p in text] + else: + assert wrap_kwargs['subsequent_indent'] == '', \ + wrap_kwargs['subsequent_indent'] + sep = '\n%s\n' % prefix.rstrip() + return sep.join(['\n'.join(lines)] + text) def _tag_copyright(contents): """ @@ -699,24 +692,31 @@ def update_pyfile(path, original_year_fn=original_year, current_year = time.gmtime()[0] authors = authors_fn() authors = _replace_aliases(authors, with_email=False, aliases=ALIASES) + paragraphs = _copyright_string( + original_year, current_year, authors, + text=SHORT_COPY_RIGHT_TEXT, + extra_info={'get-details':'%(get-details)s'}, + author_format_fn=_short_author_formatter, wrap=False, + ).split('\n\n') lines = [ _copyright_string(original_year, current_year, authors, prefix='# '), - '', + '', 'import textwrap', '', '', 'LICENSE = """', _copyright_string(original_year, current_year, authors, prefix=''), '""".strip()', '', - 'def short_license(extra_info):', - ' return """', - _copyright_string(original_year, current_year, authors, prefix='', - text=SHORT_COPY_RIGHT_TEXT, - author_format_fn=_short_author_formatter, - extra_info={ - 'get-warrenty':'%(get-warrenty)s', - 'get-details':'%(get-details)s', - }), - '""".strip() % extra_info', + 'def short_license(extra_info, wrap=True, **kwargs):', + ' paragraphs = [', ] + for p in paragraphs: + lines.append(" '%s' %% extra_info," % p.replace("'", r"\'")) + lines.extend([ + ' ]', + ' if wrap == True:', + ' for i,p in enumerate(paragraphs):', + ' paragraphs[i] = textwrap.fill(p, **kwargs)', + r" return '\n\n'.join(paragraphs)", + ]) new_contents = '\n'.join(lines)+'\n' _set_contents(path, new_contents, dry_run=dry_run, verbose=verbose) @@ -759,8 +759,8 @@ automatically. test() sys.exit(0) - #update_authors(dry_run=options.dry_run, verbose=options.verbose) - #update_files(files=args, dry_run=options.dry_run, verbose=options.verbose) + update_authors(dry_run=options.dry_run, verbose=options.verbose) + update_files(files=args, dry_run=options.dry_run, verbose=options.verbose) if options.pyfile != None: update_pyfile(path=options.pyfile, dry_run=options.dry_run, verbose=options.verbose)