TurboGears - Menulis Ekstensi

Ekstensi TurboGears diidentifikasi oleh tgext.* package. Toolkit Gearbox menyediakan perintah tgext untuk membuat ekstensi sampel. Misalnya -

gearbox tgext -n myextension

Parameter opsional lainnya untuk perintah ini adalah -

--author - nama pembuat paket.
--email - email penulis paket.
--licence- lisensi yang digunakan untuk paket. Defaultnya adalah MIT.
--description - Deskripsi paket.
--keywords - Kata kunci paket (default: turbogears2.extension).

Ini akan membuat direktori tgext.myextension, yang memiliki ekstensi contoh sederhana di dalamnya.

Run the setup.py di dalam direktori -

Python setup.py install

Itu _init_.py file di dalam tgext/myextension folder berisi -

Plugme function - Ini adalah titik masuk perpanjangan.
SetupExtension class - inisialisasi ekstensi terjadi di sini.
On_startup function - di dalam kelas ada hook yang terdaftar pada fungsi __call__ di dalam kelas.

Versi singkat dari tgext\myextension\__init__.py.

from tg import config
from tg import hooks
from tg.configuration import milestones

import logging
log = logging.getLogger('tgext.myextension')

def plugme(configurator, options = None):
   if options is None:
      options = {}
   log.info('Setting up tgext.myextension extension...')
   milestones.config_ready.register(SetupExtension(configurator))
   
   return dict(appid='tgext.myextension')
	
class SetupExtension(object):
   def __init__(self, configurator):
      self.configurator = configurator
      
   def __call__(self):
      log.info('>>> Public files path is %s' % config['paths']['static_files'])
      hooks.register('startup', self.on_startup)
      
   def echo_wrapper_factory(handler, config):
      def echo_wrapper(controller, environ, context):
         log.info('Serving: %s' % context.request.path)
         return handler(controller, environ, context)
      return echo_wrapper
      
   self.configurator.register_wrapper(echo_wrapper_factory)
   
   def on_startup(self):
      log.info('+ Application Running!')

Setelah ekstensi dipasang, hidupkan dengan membuat tambahan berikut di aplikasi app_cfg.py file konfigurasi.

from tgext.myextension import plugme

plugme(base_config)

Jika kami meluncurkan server menggunakan perintah server kotak roda gigi, pemberitahuan tentang ekstensi yang baru terdaftar dapat dilihat di konsol dengan berikut -

14:29:13,250 INFO [tgext.myextension] Setting up tgext.myextension extension...
14:29:13,453 INFO [tgext.myextension] >>> Public files path is c:\tghello\hello\hello\public
14:29:13,453 INFO [tgext.myextension] + Application Running!

Starting Standard HTTP server on http://127.0.0.1:8080