Flask 备注一(单元测试，Debugger, Logger)

Posted 2020-06-23

Flask 备注一(单元测试，Debugger, Logger)

Flask是一个使用python开发Web程序的框架。依赖于Werkzeug提供完整的WSGI支持，以及Jinja2提供templates支持。Flask的设计理念是提供Micro以及方便的框架。"Micro"是因为除了提供基本特性功能的实现外，其他的功能（例如数据库访问）都是通过extension来完成。方便的特点是因为提供了简单易用的必要特性和功能，提供的功能包含：

1. 内置的开发服务器和调试工具。
2. 集成单元测试支持。
3. 支持Templates（依赖JinJa2提供）
4. 完整的WSGI支持（依赖Werkzeug提供）
5. 安全Cookie和Sessions
6. Thread-Locals，例如在每个Request里面的对象只在线程里面有意义。

Templates

Flask使用jinja2作为templates引擎。jinjia2的默认的语法设定如下：

• {%. .. %} 包含statements（逻辑处理代码块）
• {{ ... }} 包含expressions （输出到tempalte的语句）
• {# ... #} 包含comments （注释，不会输出到template的语句）
• # ... ## 包含单行statements （单行处理代码块）

单元测试

Flask通过test_client提供了非常简单的方式来创建测试的上下文环境（Local Context）。这样可以通过各种方式来完成单元测试，最基本的方式是通过python自带的unittest来完成集成的测试用例。

unittest

使用unittest的Flask单元测试的框架如下:

import os
import xxxx
import unittest
import tempfile

class XxxxTestCase(unittest.TestCase):

    def setUp(self):
        self.db_fd, xxxx.app.config[‘DATABASE‘] = tempfile.mkstemp()
        xxxx.app.config[‘TESTING‘] = True
        self.app = xxxx.app.test_client()
        xxxx.init_db()

    def tearDown(self):
        os.close(self.db_fd)
        os.unlink(xxxx.app.config[‘DATABASE‘])

if __name__ == ‘__main__‘:
    unittest.main()

在上述例子里面：

1. xxxx是一个自定义的简单的flask程序，xxxx.app是一个Flask类的对象，对应一个Web应用。
2. 在setUp函数里面，将Flask的Web应用的TESTING参数配置为True，并创建了一个对应的测试客户端(test_client)，包含测试需要的上下文环境。
3. 在setUp函数里面，创建了xxxx的数据库文件并进行了初始化。

4. 在tearDown函数里面，关闭了数据库文件并删除。
   在unittest中测试用例的函数必须哟以test单词开始，例如testFunc1，这样测试框架可以将此函数作为测试用例执行。执行测试用例之前先执行setUp函数进行初始化，之后执行tearDown进行资源释放。基本的测试用例如下：

   def testemptydb(self):
   rv = self.app.get(‘/‘)
   assert ‘No entries here so far‘ in rv.data

Local Context

unittest框架通过setUp创建了testclient以及需要的上下文环境，并且在tearDown函数里面进行销毁。同样可以使用testclient在任意代码中完成验证测试。因为test_client创建了一个临时的上下文环境，在任何区域中都可以通过with语句是此context在范围内有效，因此在这个范围内可以验证request以及session的信息。
验证request信息的简单例子：

with app.test_client() as c:
    rv = c.get(‘/?number=42‘)
    assert request.args[‘number‘] == ‘42‘

验证session信息的简单例子：

with app.test_client() as c:
    rv = c.get(‘/‘)
    assert flask.session[‘foo‘] == 42

如果需要修改testclient创建的临时context中的session信息，可以通过sessiontranscation来获取session对象进行修改。如下简单实例：

with app.test_client() as c:
    with c.session_transcation() as sess:
        sess[‘a_key‘] = ‘a value‘

Debug&Logging

在程序中，错误永远无法避免，错误有可能是代码逻辑问题，服务器问题，网络问题或者是硬件问题，环境问题等等。Flask提供了两种方式定位问题，其一可以打开程序的调试模式，通过调试器(debugger)跟踪程序的执行信息；另外就是Flask提供了完善的日志系统，记录程序的运行信息。

Debug

Flask通过必要的参数设置，来确定是否使用Debug模式以及是否使用自带的调试器。这些参数包含：

• debug。True: 设置Debug模式; False: 非Debug模式
• use_debugger。True: 使用内部调试器; Flase: 不实用内部调试器
• use_reloader。True: 在Excpetion时，是否reload和fork当前进程进行调试; False: Nothing.

如果使用第三方类似于Aptana/Eclipse等调试器，需要设置debug为True，usedebugger和usereloader为False。

通过内置的debugger，当程序出现exception时，在错误界面提供一个交互式的界面，而且在这个界面里面可以执行任意的代码进行程序调试。这样存在着巨大的安全隐患，因此永远不要在产品服务器上开启调试模式。

Logging

Flask附带的Logger依赖于Python内置的日志系统，通过默认Logging库设置日志的处理Handler，日志Format以及处理的Level。程序中通过Flask的Logger所写的Log通过系统自带的日志系统进行过滤和格式化，然后输出到所设置的Handler中。

handler可以是文件也可以是邮件，一般情况下的应用场景是，将大部分的日志信息保存到文件中，将重点需要关注的日志信息发送到邮件中。

• 文件Handler。文件Handler包含四种：

  • FileHandler，对应文件系统的一个文件。
  • RotatingFileHandler, 对应文件系统的一个文件，在输出一定数量的信息之后，重头开始。
  • NTEventLogHandler，对应Windows操作系统的日志系统。
  • SysLogHandler，对应Unix Syslog系统。

• 邮件Handler。通常使用smtphandler进行邮件发送。

• Handler的简单示例如下：

  if not app.debug:
  import logging
  from logging.handler import SMTPHandler, FileHandler

  file_handler = FileHandler(/var/test/flask.log)
  file_handler.setLevel(logging.WARNING)
  
  email_handler = SMTPHandler(‘127.0.0.1‘,
                              ‘[email protected]‘
                              ADMINS,
                              ‘Your Application Failed!!!‘)
  app.logger.addHandler(file_handler)
  app.logger.addHandler(email_handler)
  

Formatter是Python自带的日志系统提供的，可以对Handler进行设置需要保存的信息格式。一般情况下，在邮件Handler中保存详细的多行文本信息；在文件Handler里面保存单行重要信息。Log的格式参数如下：

• %(levelname)s || 日志级别(包含:‘DEBUG‘, ‘INFO‘, ‘WARNING‘, ‘ERROR‘, ‘CRITICAL‘) ||
• %(pathname)s || Log产生的源文件路径 ||
• %(filename)s || Log产生的源文件名称 ||
• %(module)s || Log产生的模块 ||
• %(funcName)s || Log产生的函数名称 ||
• %(lineno)d || Log产生的所在文件行号 ||
• %(asctime)s || Log产生的时间格式是：YYYY-MM-DD hh-mm-ss, mmm(,之后是毫秒数)
• %(message)s || Log的信息 ||

Email日志格式设置的简单示例：

from logging import Formatter
mail_handler.setFormatter(Formatter(‘‘‘
    Message type:       %(levelname)s
    Location:           %(pathname)s:%(lineno)d
    Module:             %(module)s
    Function:           %(funcName)s
    Time:               %(asctime)s
    Message:            %(message)s
‘‘‘))

文件日志格式设置的简单示例：

from logging import Formatter
file_handler.setFormatter(Formatter(
    ‘%(asctime)s %(levelname)s: %(message)s ‘
    ‘[in %(pathname)s:%(lineno)d]‘
    ))

Flask中使用的第三库都有自己的日志策略，同样可以使用getlogger获取每个依赖库的logger设置统一的Handler。如下示例：

from logging import getLogger
loggers = [app.logger, getLogger(‘sqlalchemy‘),
           getLogger(‘otherlibrary‘)]
for logger in loggers:
    logger.addHandler(mail_handler)
    logger.addHandler(file_handler)