TurboGears - Написание расширений

Расширения TurboGears обозначены tgext.* package. Инструментарий Gearbox предоставляет команду tgext для создания образца расширения. Например -

gearbox tgext -n myextension

Другие необязательные параметры для этой команды:

--author - имя автора пакета.
--email - емейл автора пакета.
--licence- лицензия, используемая для пакета. По умолчанию - MIT.
--description - Описание упаковки.
--keywords - Ключевые слова пакета (по умолчанию: turbogears2.extension).

Это создаст каталог tgext.myextension, внутри которого находится простой пример расширения.

Run the setup.py внутри каталога -

Python setup.py install

В _init_.py файл внутри tgext/myextension папка содержит -

Plugme function - Это точка входа в расширение.
SetupExtension class - здесь происходит инициализация расширения.
On_startup function - внутри класса находится ловушка, зарегистрированная в функции __call__ внутри класса.

Краткая версия 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!')

После установки расширения включите его, сделав следующие дополнения в приложении app_cfg.py конфигурационный файл.

from tgext.myextension import plugme

plugme(base_config)

Если мы запустим сервер с помощью команды сервера gearbox, уведомление о новом зарегистрированном расширении можно будет просмотреть на консоли следующим образом:

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