TurboGears - Escrevendo extensões

As extensões do TurboGears são identificadas por tgext.* package. Um kit de ferramentas Gearbox fornece o comando tgext para criar uma extensão de amostra. Por exemplo -

gearbox tgext -n myextension

Outros parâmetros opcionais para este comando são -

--author - nome do autor do pacote.
--email - email do autor do pacote.
--licence- licença usada para o pacote. O padrão é MIT.
--description - Descrição do pacote.
--keywords - Palavras-chave do pacote (padrão: turbogears2.extension).

Isso criará um diretório tgext.myextension, que contém uma extensão de amostra simples.

Run the setup.py dentro do diretório -

Python setup.py install

o _init_.py arquivo dentro tgext/myextension pasta contém -

Plugme function - Este é o ponto de entrada da extensão.
SetupExtension class - a inicialização da extensão ocorre aqui.
On_startup function - dentro da classe está um gancho registrado na função __call__ dentro da classe.

Breve versão do 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!')

Assim que a extensão estiver instalada, ligue-a fazendo as seguintes adições no aplicativo app_cfg.py arquivo de configuração.

from tgext.myextension import plugme

plugme(base_config)

Se iniciarmos o servidor usando um comando de servidor de caixa de engrenagens, a notificação de uma extensão recém-registrada pode ser vista no console da seguinte forma -

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