TurboGears - 书写扩展

TurboGears是一个开源的Python web框架，帮助开发人员建立高效的Web应用程序。TurboGears拥有许多强大的内置功能和工具，但开发人员有时需要定制他们的应用程序或添加新的功能，这就需要编写扩展。

扩展种类

TurboGears中的扩展可以分为两种类型：

中间件

中间件是在应用程序和Web服务器之间的组件，可以拦截每个请求/响应，对它们进行处理或修改。TurboGears允许应用程序使用中间件来实现各种功能，如认证、缓存、安全等。

插件

插件是TurboGears应用程序的组成部分，它们为应用程序添加了新的功能。插件可以是视图、模板、控制器、模型、命令等等。

编写中间件

编写中间件最简单的方法是编写一个简单的Python类，其定义了一个call方法。下面是一个简单的例子：

class MyMiddleware(object):
    def __init__(self, app):
        self.app = app
    
    def call(self, environ, start_response):
        # Do something with the request
        response = self.app(environ, start_response)
        # Do something with the response
        return response

在上面的代码中，我们定义了一个名为MyMiddleware的类，它接受一个应用程序实例作为构造函数参数，并实现了一个call方法。call方法接受两个参数：HTTP请求环境和HTTP响应起始函数。在call方法中，我们可以对请求/响应对象进行任何操作。

编写插件

编写插件的方法因类型而异。更具体地说，我们将详细讨论控制器、视图和模板插件的编写步骤。

控制器插件

编写控制器插件的方法如下：

1. 从tg.controllers模块导入TGController类。
2. 创建一个继承自TGController的类，该类定义了您的控制器方法。
3. 在您的应用程序中注册您的控制器。

下面是一个简单的例子：

from tg.controllers import TGController
from tg import expose

class MyController(TGController):
    @expose()
    def index(self):
        return 'Hello, world!'

config['routes.map'] = 'myapp.controllers'
config['routes.root'] = 'myapp.controllers.MyController'

在这个例子中，我们定义了一个名为MyController的控制器类，并使用@expose装饰器定义了一个名为index的控制器方法。在我们的配置文件（config.py）中，我们将控制器类注册到我们的应用程序中，并将路由根目录设置为我们的控制器。

视图插件

编写视图插件的方法如下：

1. 在tg.templates包中创建一个新的目录，并在其中创建一个新的模板文件。
2. 新增视图函数，该视图函数返回一RenderResponse实例，定义实际的视图渲染过程。
3. 在您的应用程序中定义并注册您的视图函数。

下面是一个简单的例子：

from tg import render_template
from tg.controllers import TGController

class MyController(TGController):
    def my_view(self):
        return render_template('my_template.mako', var1='Hello', var2='World')

config['routes.map'] = 'myapp.controllers'
config['routes.root'] = 'myapp.controllers.MyController'

在这个例子中，我们定义了一个名为MyController的控制器类，并定义了名为my_view的视图函数。在该函数中，我们使用TG框架中的render_template函数将my_template.mako模板文件与var1和var2变量一起呈现。在我们的配置文件（config.py）中，我们将控制器类注册到我们的应用程序，并将路由根目录设置为我们的控制器。

模板插件

编写模板插件的方法如下：

1. 在tgext.templates包中创建一个新的模板插件。该插件需要实现ITemplateEngine接口，其定义了实现视图模板所需的所有方法。
2. 在您的应用程序中注册您的模板插件。

下面是一个简单的例子：

from tgext.pluggable import PluggableSession, app_model
from tgext.templates.base import TemplateEngine

class MyTemplateEngine(TemplateEngine):
    @classmethod
    def can_render(cls, template):
        return template.endswith('.mako')
    
    def render(self, template_name, template_vars, cache_key=None, cache_type=None):
        # Writes the current session back to the database after each response
        session = PluggableSession.get(app_model)
        
        # Do some stuff to render the template
        return template_content

config['tgext.pluggable.engines'] = {'mako': MyTemplateEngine}
config['tgext.pluggable.apps'] = {'myapp': {'use_sqlalchemy': True}}

在上面的代码中，我们定义了一个名为MyTemplateEngine的模板插件，它是从TemplateEngine类继承的，该类具有ITemplateEngine接口所需的所有方法。在我们的配置文件（config.py）中，我们将模板引擎注册为myapp应用程序的默认模板引擎。我们还启用了数据库会话管理并将它与我们的应用程序一起使用。

结论

TurboGears是一个功能强大的Python web框架，它提供了许多内置的功能和工具。使用TurboGears，开发人员可以轻松编写中间件和插件，在应用程序中实现定制逻辑和新功能。无论是为了优化性能、提高安全性还是实现其他目的，编写中间件和插件都是非常有用的。