Limnoria/scripts/supybot-newplugin

207 lines
7.9 KiB
Plaintext
Raw Normal View History

#!/usr/bin/env python
2004-08-28 14:32:02 +02:00
###
# Copyright (c) 2002-2004, Jeremiah Fincher
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions, and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the author of this software nor the name of
# contributors to this software may be used to endorse or promote products
# derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
__revision__ = "$Id$"
import supybot
import os
import sys
import os.path
2003-10-02 07:49:40 +02:00
import optparse
if sys.version_info < (2, 3, 0):
sys.stderr.write('This script requires Python 2.3 or newer.\n')
sys.exit(-1)
2004-07-24 07:18:26 +02:00
import supybot.conf as conf
2004-07-25 20:24:51 +02:00
from supybot.questions import *
template = '''
###
2004-02-19 08:04:08 +01:00
# Copyright (c) 2004, Jeremiah Fincher
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions, and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the author of this software nor the name of
# contributors to this software may be used to endorse or promote products
# derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
"""
Add the module docstring here. This will be used by the setup.py script.
"""
2004-09-10 08:27:23 +02:00
import supybot
__revision__ = "$%s$"
2004-09-10 08:27:23 +02:00
__author__ = supybot.authors.unknown
2004-09-11 22:25:42 +02:00
__contributors__ = {}
2004-07-24 07:18:26 +02:00
import supybot.conf as conf
import supybot.utils as utils
2004-10-27 09:37:46 +02:00
from supybot.commands import *
2004-10-03 10:58:44 +02:00
import supybot.plugins as plugins
2004-10-27 09:37:46 +02:00
import supybot.ircutils as ircutils
2004-07-24 07:18:26 +02:00
import supybot.privmsgs as privmsgs
2004-09-10 08:27:23 +02:00
import supybot.registry as registry
2004-07-24 07:18:26 +02:00
import supybot.callbacks as callbacks
def configure(advanced):
# This will be called by setup.py to configure this module. Advanced is
# a bool that specifies whether the user identified himself as an advanced
# user or not. You should effect your configuration by manipulating the
# registry as appropriate.
2004-07-25 20:24:51 +02:00
from supybot.questions import expect, anything, something, yn
2004-01-27 19:43:20 +01:00
conf.registerPlugin(%r, True)
2004-10-27 09:37:46 +02:00
conf.registerPlugin(%s)
# This is where your configuration variables (if any) should go.
class %s(%s):
%s
Class = %s
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
'''.strip() # This removes the newlines that precede and follow the text.
2003-10-02 07:49:40 +02:00
def main():
parser = optparse.OptionParser(usage='Usage: %prog [options]',
version='Supybot %s' % conf.version)
parser.add_option('-r', '--regexp', action='store_true', dest='regexp',
help='uses a regexp-based callback.')
parser.add_option('-n', '--name', action='store', dest='name',
help='sets the name for the plugin.')
parser.add_option('-t', '--thread', action='store_true', dest='threaded',
help='makes the plugin threaded.')
(options, args) = parser.parse_args()
if options.name:
name = options.name
if options.regexp:
kind = 'regexp'
else:
kind = 'command'
if options.threaded:
threaded = True
else:
threaded = False
else:
name = something('What should the name of the plugin be?')
if name.endswith('.py'):
name = name[:-3]
while name[0].islower():
print 'Plugin names must begin with a capital.'
name = something('What should the name of the plugin be?')
if name.endswith('.py'):
name = name[:-3]
2004-08-27 07:41:43 +02:00
print textwrap.dedent("""
2003-10-02 07:49:40 +02:00
Supybot offers two major types of plugins: command-based and
regexp-based. Command-based plugins are the kind of plugins
2004-08-27 07:41:43 +02:00
you've seen most when you've used supybot. They're also the most
featureful and easiest to write. Commands can be nested, for
instance, whereas regexp-based callbacks can't do nesting.
2003-10-02 07:49:40 +02:00
That doesn't mean that you'll never want regexp-based callbacks.
2004-08-27 07:41:43 +02:00
They offer a flexibility that command-based callbacks don't
offer; however, they don't tie into the whole system as well.
2003-10-02 07:49:40 +02:00
If you need to combine a command-based callback with some
regexp-based methods, you can do so by subclassing
callbacks.PrivmsgCommandAndRegexp and then adding a class-level
attribute "regexps" that is a sets.Set of methods that are
regexp-based. But you'll have to do that yourself after this
2004-08-27 07:41:43 +02:00
wizard is finished.)""").strip()
print
2003-10-02 07:49:40 +02:00
kind = expect('Do you want a command-based plugin' \
' or a regexp-based plugin?', ['command', 'regexp'])
2004-08-27 07:41:43 +02:00
print textwrap.fill(textwrap.dedent("""
Sometimes you'll want a callback to be threaded. If its methods
(command or regexp-based, either one) will take a significant amount
of time to run, you'll want to thread them so they don't block the
entire bot.""").strip())
2003-10-02 07:49:40 +02:00
print
2004-03-02 20:35:35 +01:00
threaded = yn('Does your plugin need to be threaded?')
2003-10-02 07:49:40 +02:00
if threaded:
threaded = 'threaded = True'
else:
threaded = 'pass'
if kind == 'command':
className = 'callbacks.Privmsg'
else:
className = 'callbacks.PrivmsgRegexp'
if name.endswith('.py'):
name = name[:-3]
while name[0].islower():
print 'Plugin names must begin with a capital.'
name = something('What should the name of the plugin be?')
if name.endswith('.py'):
name = name[:-3]
2003-09-25 04:21:36 +02:00
fd = file(name + '.py', 'w')
2004-10-27 09:37:46 +02:00
fd.write(template % ('Id', name, name, name, className, threaded, name))
fd.close()
print 'Your new plugin template is %s.py.' % name
2003-10-02 07:49:40 +02:00
if __name__ == '__main__':
try:
main()
except KeyboardInterrupt:
pass
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: