python virtualenv and hug

最新推荐文章于 2024-04-22 08:51:15 发布

hlang8160

最新推荐文章于 2024-04-22 08:51:15 发布

阅读量488

点赞数

分类专栏： python

python 专栏收录该内容

22 篇文章 0 订阅

订阅专栏

virtualenv

在开发Python应用程序的时候，系统安装的Python3只有一个版本：3.4。所有第三方的包都会被pip安装到Python3的site-packages目录下。

如果我们要同时开发多个应用程序，那这些应用程序都会共用一个Python，就是安装在系统的Python 3。如果应用A需要jinja 2.7，而应用B需要jinja 2.6怎么办？

这种情况下，每个应用可能需要各自拥有一套“独立”的Python运行环境。virtualenv就是用来为一个应用创建一套“隔离”的Python运行环境。

首先，我们用pip安装virtualenv：

$ pip3 install virtualenv

然后，假定我们要开发一个新的项目，需要一套独立的Python运行环境，可以这么做：

第一步，创建目录：

Mac:~ michael$ mkdir myproject
Mac:~ michael$ cd myproject/
Mac:myproject michael$

第二步，创建一个独立的Python运行环境，命名为venv：

Mac:myproject michael$ virtualenv --no-site-packages venv
Using base prefix '/usr/local/.../Python.framework/Versions/3.4'
New python executable in venv/bin/python3.4
Also creating executable in venv/bin/python
Installing setuptools, pip, wheel...done.

命令virtualenv就可以创建一个独立的Python运行环境，我们还加上了参数--no-site-packages，这样，已经安装到系统Python环境中的所有第三方包都不会复制过来，这样，我们就得到了一个不带任何第三方包的“干净”的Python运行环境。

新建的Python环境被放到当前目录下的venv目录。有了venv这个Python环境，可以用source进入该环境：

Mac:myproject michael$ source venv/bin/activate
(venv)Mac:myproject michael$

注意到命令提示符变了，有个(venv)前缀，表示当前环境是一个名为venv的Python环境。

下面正常安装各种第三方包，并运行python命令：

(venv)Mac:myproject michael$ pip install jinja2
...
Successfully installed jinja2-2.7.3 markupsafe-0.23
(venv)Mac:myproject michael$ python myapp.py
...

在venv环境下，用pip安装的包都被安装到venv这个环境下，系统Python环境不受任何影响。也就是说，venv环境是专门针对myproject这个应用创建的。

退出当前的venv环境，使用deactivate命令：

(venv)Mac:myproject michael$ deactivate 
Mac:myproject michael$

此时就回到了正常的环境，现在pip或python均是在系统Python环境下执行。

完全可以针对每个应用创建独立的Python运行环境，这样就可以对每个应用的Python环境进行隔离。

virtualenv是如何创建“独立”的Python运行环境的呢？原理很简单，就是把系统Python复制一份到virtualenv的环境，用命令source venv/bin/activate进入一个virtualenv环境时，virtualenv会修改相关环境变量，让命令python和pip均指向当前的virtualenv环境。

小结

virtualenv为应用提供了隔离的Python运行环境，解决了不同应用间多版本的冲突问题。

RESTful API 框架 HUG 指南

如果你在用 Python3，如果你需要搭建一个 API 服务，如果时间很紧，那么 HUG 可能就是你的最佳选择！本文将用轻松易懂的实例教程来带大家走入 HUG 的世界。

更新历史

2017.03.09: 完成初稿

准备工作

HUG 是基于 Python3 的，所以我们来安装一下。一般来说我们会使用 virtualenv 来隔离不同的环境，不然不同的包容易『打架』。比较简单，跟着敲命令即可。

      
      
       
       # 安装 Python3，其中 pip3 会随着 Python3 一并安装
      
      
      
      
       
       # 编译时间会比较长，请耐心等待
      
      
      
      
       
       brew install python3
      
      
      
      
       
       # 安装 VirtualEnv 方便隔离开发
      
      
      
      
       
       pip3 install virtualenv
      
      
      
      
       
       # 新建一个 ~/hug 文件夹来保存
      
      
      
      
       
       virtualenv -p python3 ~/hug
      
      
      
      
      
      
       
       # 激活环境
      
      
      
      
       
       source ~/hug/bin/activate
      
      
      
      
       
       # 离开环境
      
      
      
      
       
       deactivate

配置完成之后，我们就可以安装 hug 啦，直接 pip3 install hug --upgrade 即可。恭喜，一切完事儿！（如果你手滑，可以再 pip3 install bottle 一下，之后有用）

Hello World

按照通常的 Hello World 惯例，我们就来写一个 API，给访问这个 API 的用户问好。就是如下 7 行（文件名为 hello.py）：

      
      
       
       import time
      
      
      
      
       
       import hug
      
      
      
      
      
      
       
       @hug.get('/hello')
      
      
      
      
       
       def hello(name):
      
      
      
          
       
       """Say Hello to the User"""
      
      
      
      
       
           ticks = time.time()
      
      
      
          
       
       return 
       
       "Hello {name}! Now is {ticks}".format(**locals())

然后我们在命令行里输入 hug -f hello.py，就可以看到如下萌萌的启动界面：

然后我们来访问一下 127.0.0.1:8000，发现返回的结果是这个：

      
      
       
       {
      
      
      
          
       
       "404": 
       
       "The API call you tried to make was not defined. Here's a definition of the API to help you get going :)",
      
      
      
          
       
       "documentation": {
      
      
      
              
       
       "handlers": {
      
      
      
                  
       
       "/hello": {
      
      
      
                      
       
       "GET": {
      
      
      
                          
       
       "usage": 
       
       "Say Hello to the User",
      
      
      
                          
       
       "outputs": {
      
      
      
                              
       
       "format": 
       
       "JSON (Javascript Serialized Object Notation)",
      
      
      
                              
       
       "content_type": 
       
       "application/json"
      
      
      
      
       
                           },
      
      
      
                          
       
       "inputs": {
      
      
      
                              
       
       "name": {
      
      
      
                                  
       
       "type": 
       
       "Basic text / string value"
      
      
      
      
       
                               }
      
      
      
      
       
                           }
      
      
      
      
       
                       }
      
      
      
      
       
                   }
      
      
      
      
       
               }
      
      
      
      
       
           }
      
      
      
      
       
       }

这个告诉我们，嘿这个 API 我们没有定义噢，但是我们很贴心的给你列出来已经定义的 API，剩下的你自己看咯！

好，我们现在知道了，要访问的是 127.0.0.1:8000/hello，于是我们打开浏览器再试一次，发现结果是这个：

      
      
       
       {
      
      
      
          
       
       "errors": 
      
      
      
      
       
               {
      
      
      
                  
       
       "name": 
       
       "Required parameter 'name' not supplied"
      
      
      
      
       
               }
      
      
      
      
       
       }

噢，这个错误提醒我们，一定要给出 name 这个参数，好，那我们访问 127.0.0.1:8000/hello?name=wdxtub，结果终于对了，像这样（给出了名字，也给出了当前的时间戳）：

      
      
       
       "Hello wdxtub! Now is 1489061160.552566"

但是这个方法还有一点不好，就是我们改动了代码，并不会自动重新载入，每次都要手动重启很麻烦，那怎么办呢？下一节我们就来搞这个问题。

自动重启及 API 测试

还记得我们之前手滑安装的 bottle 吗？接下来就有用啦，我们把代码改成如下（注意新增的 import 和下面的 if 部分）：

      
      
       
       import hug
      
      
      
      
       
       import time
      
      
      
      
       
       from bottle 
       
       import run
      
      
      
      
      
      
       
       @hug.get('/hello')
      
      
      
      
       
       def hello(name):
      
      
      
          
       
       """Say Hello to the User"""
      
      
      
      
       
           ticks = time.time()
      
      
      
          
       
       return 
       
       "Hello {name}! Now is {ticks}".format(**locals())
      
      
      
      
      
      
       
       if __name__ == 
       
       "__main__":
      
      
      
      
       
           app = __hug__.http.server()
      
      
      
      
       
           run(app=app, reloader=
       
       True, port=
       
       8000)

然后在命令行中输入 python hello.py，就可以看到我们的 API 服务器启动起来了，如果这个时候我们对 hello.py 做些修改，bottle 会自动帮我们重启，非常方便！比如我们可以加入下面几行：

      
      
       
       @hug.get('/', output=hug.output_format.json)
      
      
      
      
       
       def root():
      
      
      
          
       
       return {
       
       'msg': 
       
       "欢迎来到 HUG 指南"}

稍等一下，就可以访问 127.0.0.1:8000 了。当然，使用浏览器测试 API 其实是不太方便的，这里推荐一下 Postman 这个 Chrome 应用，可以很方便地进行各类测试。比如像这样：

重新认识 HUG

官方的标题起的很威武霸气 - 拥抱未来的 API(Embrace the APIs of the future)。借用其简介：

Drastically simplify API development over multiple interfaces. With hug, design and develop your API once, then expose it however your clients need to consume it. Be it locally, over HTTP, or through the command line - hug is the fastest and most modern way to create APIs on Python3.

从前面的例子中我们其实也可以简单领略到 HUG 的魅力，这里简单总结一下：