相关工具 ############# .. _adding-third-party-libraries-to-your-application: 添加第三方依赖包 ================= 除了使用新浪云上已经预装的模块之外,您还可以通过以下方式给自己的应用添加第三方依赖包。 首先,在应用的根目录下创建一个第三方依赖包目录 ``vendor`` 。 .. code-block:: console $ mkdir vendor 调用 ``pip`` 命令安装依赖包,使用其 ``-t`` 选项指定第三方包的安装目录。 .. code-block:: console $ pip install -t vendor PACKAGE ... 将 ``vendor`` 目录和应用的代码一起提交,即可在应用代码里使用安装的第三方依赖包了。 .. note:: 需要 pip 6.0.0 或者更高版本。 如果依赖包安装的目录名不为 ``vendor`` ,你需要在 ``index.wsgi`` 文件的最开始,添加以下代码,将目录加入到 sys.path 中。 .. code-block:: python import sae sae.add_vendor_dir('路径') # 注意:以上代码得放在 index.wsgi 的最前面,所有其它代码之前。 .. module:: sae .. function:: add_vendor_dir(dir) 将 site 目录或者 virtualenv 目录加入到 sys.path 中 :param dir: site 目录或者 virtualenv 目录的相对路径(相对于应用的根目录) 本地开发环境 ================= 本地开发环境仅为应用开发便利之用,对新浪云 Python 环境的模拟并不完全。 安装 -------- 直接使用 `pip` 或者 `easy_install` 安装 `sae-python-dev` 包即可。 或者可以选择从 github 下载源码安装。 :: $ git clone https://github.com/sinacloud/sae-python-dev-guide.git $ cd sae-python-dev-guide/dev_server $ python setup.py install 基本使用 ------------- 进入应用的本地开发目录,也就是 index.wsgi 和 config.yaml 所在的目录。运行如下的命令启动测试 server: :: $ dev_server.py MySQL config not found: app.py Start development server on http://localhost:8080/ 访问 http://localhost:8080 端口就可以访问你的应用了。 使用 MySQL 服务 ---------------- 首先配置好 MySQL 本地开发 server。然后使用 `--mysql` 参数运行 dev_server.py。 :: $ dev_server.py --mysql=user:password@host:port 现在你可以在应用代码中像在新浪云线上环境一样使用 MySQL 服务了。 dev_server.py 默认使用名为 `app_应用名` 的数据库。 使用 Storage 服务 -------------------- 使用 `--storage-path` 参数运行 dev_server.py。 :: $ dev_server.py --storage-path=/path/to/local/storage/data 本地的 Storage 服务使用以下的目录结构来模拟线上的 Storage。 :: storage-path/ domain1/ key1 key2 domain2/ domain3/ --storage-path 配置的路径下每个子文件夹会映射为 Storage 中的一个 domain, 而每个子文件夹下的文件映射为 domain 下的一个 key,其内容为对应 key 的数据。 .. note:: 为方便调试,dev_server 自带的 sae.storage 在某个 domain 不存在的情况下会自动创建该 domain。 线上环境中的 domain 需要在新浪云后台面板中手动创建。 使用 pylibmc ----------------- dev_server 自带了一个 dummy pylibmc,所以无须安装 pylibmc 就可以直接使用 Memcached 服务了。 该模块将所有的数据存贮在内存中,dev_server.py 进程结束时,所有的数据都会丢失。 使用 KVDB -------------- KVDB 默认数据存在内存中,dev_server.py 进程结束时,数据会全部丢失,如果需要保存数据, 请使用如下命令行启动 dev_server.py。 :: $ dev_server.py --kvdb-file=/path/to/kvdb/local/file 命令行工具 saecloud ===================== 部署代码 --------------- 进入应用目录(也就是 config.yaml 和 index.wsgi 所在的目录)。 :: $ cat config.yaml name: memorystone version: 2 $ saecloud deploy saecloud 从 config.yaml 文件获得信息,判断将要把代码部署到哪个应用的哪个版本。上面的命令会将应用部署到 memorystone 的版本 2 上。 saecloud deploy 命令接受一个可选参数:应用代码所在路径,默认为当前目录'.'。 .. note:: 1. 删除应用版本目前仍然只能在前端管理界面中操作。 2. 如果代码量较大,则上传时间较慢,请耐心等待。 3. 不推荐混合使用 saecloud deploy 和 svn 命令行,虽然 saecloud deploy 部署之前会自动更新代码,但是如果有代码冲突则会导致本地状态不一致。 4. 使用 saecloud 部署代码如果遇到奇怪的 svn 错误,解决办法为删除本地缓存目录: `rm -rf ~/.saecloud`。 导出应用代码 ---------------- 导出 memorystone 应用版本 2 到本地目录: :: $ saecloud export memorystone 2 --username fooxxx@gmail.com --password barxxx Exporting to memorystone 第一个参数为应用名字,第二个参数为版本,可选,默认为版本 1。 第一次使用时,请指定你的代码访问帐号信息:username 安全邮箱,password。之后的命令不用在输入此信息。 .. note:: `deploy` 和 `export` 命令需要用到 svn,请先安装 svn 命令行工具。 windows 用户可以在这里下载:http://sourceforge.net/projects/win32svn/ .. .. _cloudsql.py: .. cloudsql.py .. ================ .. .. cloudsql.py 是新浪云 MySQL 服务的一个命令行客户端,用户可以使用 cloudsql.py 来直接操作应用的线上数据库。 :: .. .. alan@sina:~/python$ cloudsql.py -u ACCESSKEY -p SECRETKEY APP_NAME .. SAE MySQL Client .. .. Type "help" or "?" for help. .. .. Connecting to Cloud SQL database "app_shellpy" on host w.rdc.sae.sina.com.cn. .. Using readline for history management. .. Loading history file "/home/alan/.saecloud/app_shellpy.hist" .. mysql> .. .. 如果想要在代码中直接操作线上的数据库,在 `import MySQLdb` (并不一定要安装 MySQLdb 包)之前执行以下的代码即可: :: .. .. # 只在本地开发环境中执行 .. import os .. if 'SERVER_SOFTWARE' not in os.environ: .. from sae._restful_mysql import monkey .. monkey.patch() 可用插件 ================ 新浪云 Python Shell --------------------- 新浪云 Python Shell 是一个 wsgi 中间件,提供了一个在线的 interactive shell,便于在线调 试 app,查看系统信息等。(由 shellpy_ 修改而来)。 .. _shellpy: http://code.google.com/p/google-app-engine-samples/source/browse/trunk/shell/shell.py .. py:class:: ShellMiddleware(app, password=None) :module: sae.ext.shell app: 你的应用 callable password: 可选,登录 shell 时需要输入的口令,用于保护 shell 不被非法访问。 使用步骤: - 该插件需要使用 `Memcached` 服务,请事先开启。 - 修改 index.wsgi,启用 shell 插件,示例如下:: import sae from sae.ext.shell import ShellMiddleware def app(environ, start_response): status = '200 OK' response_headers = [('Content-type', 'text/plain')] start_response(status, response_headers) return ["Hello, world!"] application = sae.create_wsgi_app(ShellMiddleware(app)) - 访问地址 https://.sinaapp.com/_sae/shell ,根据提示输入你设置的口令 - 或者你也可以在命令行下面使用 `saecloud shell [-p PASSWORD]` 来访问在线 shell。 :: alan@sina:~/shellpy$ saecloud shell pylabs -proot Python 2.7.3 (default, Mar 27 2013, 18:11:21) [GCC 4.4.6 20120305 (Red Hat 4.4.6-4)] Type "help", "copyright", "credits" or "license" for more information. >>> .. warning:: 测试期间请谨慎使用,建议不使用时从源码中注释掉此 shell。 .. include:: ../services/libraries.rst