From 0050abb61d00e39828cb04965e462e266f8e9f9a Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Fri, 30 Jul 2010 15:45:29 -0400 Subject: [PATCH] Added hooke.plugin.license and removed get-warrenty info from short_license. Also uncommented update_authors() and update_files() in update_copyright, since I'm no longer testing the pyfile code ;). --- hooke/plugin/__init__.py | 1 + hooke/plugin/license.py | 46 ++++++++++++++++++++++++++++++++++++++++ hooke/plugin/playlist.py | 2 +- hooke/ui/commandline.py | 1 - hooke/ui/gui/__init__.py | 3 +-- update_copyright.py | 27 +++++++++-------------- 6 files changed, 59 insertions(+), 21 deletions(-) create mode 100644 hooke/plugin/license.py diff --git a/hooke/plugin/__init__.py b/hooke/plugin/__init__.py index 4249730..4ce9020 100644 --- a/hooke/plugin/__init__.py +++ b/hooke/plugin/__init__.py @@ -58,6 +58,7 @@ BUILTIN_MODULES = [ 'config', 'curve', 'debug', + 'license', 'note', 'playlist', 'system', diff --git a/hooke/plugin/license.py b/hooke/plugin/license.py new file mode 100644 index 0000000..d405bf9 --- /dev/null +++ b/hooke/plugin/license.py @@ -0,0 +1,46 @@ +# Copyright (C) 2010 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 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 +# . + +"""The ``license`` module provides :class:`LicensePlugin` and +associated :class:`hooke.command.Command`\s for displaying Hooke's +licensing information. +""" + +from .. import __license__ +from ..command import Command, Argument, Failure +from ..plugin import Builtin + + +class LicensePlugin (Builtin): + def __init__(self): + super(LicensePlugin, self).__init__(name='license') + self._commands = [LicenseCommand(self)] + + +# Define commands + +class LicenseCommand (Command): + """Show licensing information. + """ + def __init__(self, plugin): + super(LicenseCommand, self).__init__( + name='license', + help=self.__doc__, plugin=plugin) + + def _run(self, hooke, inqueue, outqueue, params): + outqueue.put(__license__) diff --git a/hooke/plugin/playlist.py b/hooke/plugin/playlist.py index bcfb756..62137d0 100644 --- a/hooke/plugin/playlist.py +++ b/hooke/plugin/playlist.py @@ -21,8 +21,8 @@ several associated :class:`hooke.command.Command`\s for handling :mod:`hooke.playlist` classes. """ -import os.path import glob +import os.path from ..command import Command, Argument, Failure from ..playlist import FilePlaylist diff --git a/hooke/ui/commandline.py b/hooke/ui/commandline.py index 197a80e..291f395 100644 --- a/hooke/ui/commandline.py +++ b/hooke/ui/commandline.py @@ -412,7 +412,6 @@ class CommandLine (UserInterface): def run(self, commands, ui_to_command_queue, command_to_ui_queue): cmd = self._cmd(commands, ui_to_command_queue, command_to_ui_queue) cmd.cmdloop(self._splash_text(extra_info={ - 'get-warrenty':'run `warrenty`', 'get-details':'run `license`', })) diff --git a/hooke/ui/gui/__init__.py b/hooke/ui/gui/__init__.py index 3290584..574ca29 100644 --- a/hooke/ui/gui/__init__.py +++ b/hooke/ui/gui/__init__.py @@ -243,8 +243,7 @@ class HookeFrame (wx.Frame): dialog = wx.MessageDialog( parent=self, message=self.gui._splash_text(extra_info={ - 'get-warrenty':'click "help->warrenty"', - 'get-details':'click "help->license"', + 'get-details':'click "Help -> License"', }), caption='About Hooke', style=wx.OK|wx.ICON_INFORMATION) diff --git a/update_copyright.py b/update_copyright.py index ef2799a..894b417 100755 --- a/update_copyright.py +++ b/update_copyright.py @@ -60,10 +60,9 @@ 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. +%(project)s comes with ABSOLUTELY NO WARRANTY and is licensed +under the GNU Lesser General Public License. For details, +%(get-details)s """.strip() COPY_RIGHT_TAG='-xyz-COPY' + '-RIGHT-zyx-' # unlikely to occur in the wild :p @@ -511,17 +510,14 @@ def _copyright_string(original_year, final_year, authors, prefix='', ... prefix='', ... text=SHORT_COPY_RIGHT_TEXT, ... author_format_fn=_short_author_formatter, - ... extra_info={ - ... 'get-warrenty':'%(get-warrenty)s', - ... 'get-details':'%(get-details)s', - ... }, + ... extra_info={'get-details':'%(get-details)s'}, ... formatter_kwargs={'width': 50}, ... ) # doctest: +ELLIPSIS 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 """ if original_year == final_year: date_range = '%s' % original_year @@ -711,10 +707,7 @@ def update_pyfile(path, original_year_fn=original_year, _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', - }), + extra_info={'get-details':'%(get-details)s'}), '""".strip() % extra_info', ] new_contents = '\n'.join(lines)+'\n' @@ -759,8 +752,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) -- 2.26.2