Invenio开发指导(二)--扩展

柔情只为你懂 2021-09-22 06:50 269阅读 0赞

扩展：

扩展是什么，它们的目的是什么？一个扩展是一个小的代码段，它能够便于集成第三方库。许多类似的扩展早已经得到发展，你能够在Flask Extensions 注册表中发现它们。每个人在开发一个新的扩展的时候都应该检查一下是否有可用的扩展。当开发一个扩展，遵循Flask Extension 开发指导，能够帮助你的扩展更好运行。

现有的扩展插件：

所有的扩展都位于flask\_something 的包里面，其中something是你想要连接的扩展名。例如，如果你想要加入一个叫login的扩展支持，你需要命名你的扩展包名为 invenio.ext.login。

另外，如果扩展仅仅从current\_app.config读配置文件，你可以仅仅在Extension中列出选项，例如flask\_something，其中something必须要接收一个应用对象作为第一个参数。

class Something(object):
        def __init__(self, app, optional=None):
            pass

那么扩展实际上是什么样子的呢？一个扩展需要确保它能够同时与多个Flask应用实例工作。

代码结构：

让我们首先创建一个扩展桥。这个扩展桥的例子将对Flask Login 提供最基本的支持。

首先我们将创建如下的文件结构。

invenio/ext/login/
         __init__.py
         legacy_user.py
         README

这里是重要文件的内容：

\_\_init\_\_.py文件包含setup\_app()函数。

from .legacy_user import UserInfo
    
    def setup_app(app):
        """Setup login extension."""
    
        # Let's create login manager.
        _login_manager = LoginManager(app)
        _login_manager.login_view = app.config.get('CFG_LOGIN_VIEW',
                                                   'webaccount.login')
        _login_manager.anonymous_user = UserInfo
    
        @_login_manager.user_loader
        def _load_user(uid):
            """
            Function should not raise an exception if uid is not valid
            or User was not found in database.
            """
            return UserInfo(int(uid))
    
        return app

legacy.py包含了UserMixin对象的实现。

from flask_login import UserMixin
    from werkzeug.datastructures import CallbackDict, CombinedMultiDict
    
    class UserInfo(CombinedMultiDict, UserMixin):
    
        """
        This provides legacy implementations for methods that Flask-Login
        and Invenio 1.x expect user objects to have.
        """
    
        def __init__(self, uid=None, force=False):
            ...