本教程目的是搭建一套基于pycharm的服务器部署,本地无痛开发的python环境,其中包含三个特性:项目文件自动同步,本地调试远程代码,git版本控制(待完善)
需要注意的是部分特性需要pycharm professional版本,目前学生用户可申请免费使用。
远程项目同步
打开pycharm,上方菜单
Tools -> Deployment -> Configuration
点击左上+号新建server配置,建议选择SFTP或FTP协议(事先确认服务器已开启该服务)
如图填写Host, FTP协议绑定的Port, user name, password和root path. (web server URL可忽略)
Root path建议设置为服务器的项目群根目录。
然后切换至Mappings标签,Deployment path设置为本地项目群根目录。
此时,远程目录和本地目录映射关系建立完成。
可以通过菜单
View -> Tool Windows -> Remote Host
打开远程文件浏览器窗口,测试服务器是否连通。
示例:
假设Root path为/home/admin/MyProject,Deployment path为D:/LocalProject/,那么本地D:/LocalProject/projectA将直接上传至/home/admin/MyProject/projectA。反之同理。
远程调试
以下我们需要添加远程python解释器。也就是调用服务器的python环境。
菜单
Run -> Edit Configurations
左上角+号添加Python remote debug
1. 按照指导,第一步在服务器端安装pydevd-pycharm,第二步输入本机ip和任意端口(不和其它服务冲突即可)。注意,本机是指你当前写代码的电脑。(稍后会解释执行原理和注意事项)
2. 将第二步的两行脚本添加至项目主文件内,个人倾向于加在比如main.py的import部分。确保该修改上传至服务器后,在pycharm右上角选择配置好的解释器,并执行debug(如图4.1所示)。
3. 在服务器的terminal中执行该python文件。
如图4所示,本地成功进入debug模式!
对图4稍加介绍:程序暂停于蓝色位置,即添加的脚本处。使用方式类似visual studio,断点在行号后点按即可。
另外建议debug开启以下几个窗口/功能:
1) 标准控制台输出,如图4.2所示。所有服务器端std output都会在这里显示
2) 堆栈,如图4.3所示。可以实现函数内层调用时的跳转
3) 监控变量,如图4.4所示。基础操作,不赘述了
4) ipython交互操作,如图4.5所示。点击红框中的图标,即可激活交互功能,在程序暂停时手动执行其它代码,类似matlab。该功能需在pycharm中配置ipython交互功能,请自行搜索其他教程。
远程调试的原理和注意事项
原理:服务器在执行该程序时,会断点在添加的脚本处,并监听是否有来自于该IP:port的访问。本机开启debug模式后会向配置好的远程服务器发送请求,此时两端建立通信。
注意事项:由于服务器需要监听本地IP,需满足以下条件之一:1) 本地终端IP是公网IP,2) 服务器与终端处于同一局域网内(使用VPN)
如果服务器对外访问需通过代理服务器,还可能需要在pycharm的settings中配置proxy(记忆模糊,不确定)