Pycharm中进行Python远程开发

朱雀 2022-09-25 11:28 309阅读 0赞

http://[blog.csdn.net/pipisorry/article/details/52269952][blog.csdn.net_pipisorry_article_details_52269952]

PyCharm提供两种远程调试(Remote Debugging)的方式:  
    配置远程的解释器（remote interpreter）  
    配置Python调试服务器（Python Debug Server）\[[配置Python调试服务器][Python]\]  
本文主要说明远程的解释器（remote interpreter）的配置。[  
][Link 1]

[皮皮blog][Link 1]

# pycharm 通过 SFTP 远程编辑项目的配置 #

\{这个相当于代码同步，类似git上传，同步后你可以在服务器上直接运行上传的代码；这个配置好后，才能在pycharm远程调试时候将代码上传到服务器正确位置/正确路径上\}

打开pycharm，File -> Settings…( Ctrl + Alt + s ) -> Deployment  
点击 + 按钮，添加一个

![Center][]

## 设置连接    ##

设置好IP、端口、用户名、密码, root path:/home/piting/mine/python\_workspace, 就是打开remote host时候看到的运程主机的根目录。[  
][Link 2]

![Center 1][]

Note: Root path 如/home/piting/mine/python\_workspace这个路径要在远程服务器上存在，否则并不会自动创建和同步。

## 设置第二个标签页Mappings ##

设置本地路径和远程路径，本地路径最好是一个项目路径，直接映射到你想开发的项目中。

路径的解释：

![Center 2][]

![Center 3][]

右击项目名称，可以看到下拉菜单中多了一些选项，可以都试试，同步到远程服务器，这样就可以在本地开发，在linux上运行了，非常方便[![pycharm\_upload][pycharm_upload]][pycharm_upload]

## Deployment相关设置    ##

### 设置自动上传 ###

每次都要去点击上传，虽然比较有选择性，但毕竟还是不方便，所以设置了自动上传

tools > deployment > automatic upload(always)

### 查看远程目录 ###

tools > deployment > browse remote host

这样就可以在侧边栏找到远程目录，图形化界面上传和下载。

[皮皮blog][Link 1]

# pycharm 远程调试 #

\{这个是本地编辑代码，扔到远端服务器上执行，然后 debug 结果本地显示\[其实也添加了deployment功能\]\}

尤其是对于 windows 的机器调试 Linux 服务器端的程序。如果你是在 Windows 上使用 PyCharm 等 IDE 快速方便地进行开发，但是由于管理端使用了一些公司的公共组件，而这些组件又只提供了 Linux 上的 Python 接口，因此必须在 Linux 上运行 Django 程序。值得庆幸的是，大多数的 IDE 都提供了远程调试功能， PyCharm 也可以经过简单配置进行远程调试。

## 配置远程 Python 解释器 ##

lz使用anaconda在服务器上搭建了一个python开发环境。因为没有root权限问题。

或者也可以使用python virtualenv搭建的虚拟开发环境，所以是先将ubuntu\_env配置好的env上传到服务器上scp -r ./ubuntu\_env/ root@192.168.0.111:/home/pipi/ENV\[[ssh用法及命令 ][ssh_] \]，再修路径实现python在服务器上的配置的\[[python虚拟环境virtualenv安装和配置 ][python_virtualenv_]\]。

在 PyCharm 中打开 Python 解释器的设置面板，路径为 File => Settings (Ctrl+Alt+S) => Python Interpreter:

点击右上角齿轮，Add Remote，填写 SSH 相关的设置  
![Center 4][]

做完后可能需要等一些时间。这个过程中 PyCharm 会将一些工具和调试 Server 发到你配置的 .pycharm\_helper 目录中，并且对机器上已经安装的库类生成 skeletons，并传回 Windows 上进行保存。Python skeletons 是一些包括库类 API 定义的文件，用来给 PyCharm 做代码静态分析。JetBrains 的帮助文档提供了更详细的说明，参见 Important Note 一节。

最后，你需要在解释器设置面板，选中 Remote Interpreter 做为项目的默认解释器。

## 配置部署信息 ##

\{这个就是上面的pycharm 通过 SFTP 远程编辑项目的配置，直接用就可以\}

在 PyCharm 中打开部署的设置面板，路径为 Tool => Deployment => Configuration。

Type 建议选择 SFTP，常见的 OpenSSH Server 提供了这种协议的支持。

第二个 Tab (Mappings) 需要填写部署的路径，注意这个路径对应你项目的根目录，所以你很可能需要为它建一个空文件夹。勾选上 “Use this server as default”。除此之外还有个 Web path 的设置，应该是用来配置网页上查看文件的服务，可以无视。

配置好部署面板后，建议把自动同步开启 (Tool => Deployment => Automatics Upload(always))，这样在 PyCharm 中对文件进行修改，可以马上同步到 Linux 上。同时建议先做一次同步。

同步可以通过很多方式完成，比如在 Project 面板 (Alt+1) 上对项目根目录右键 “Upload to”，也可以在菜单中上传 (Tool => Deployment => Upload to)。如果菜单中 Upload to 不可点击，请尝试打开项目的一个 py 文件，并把焦点放在编辑器中。

在deployment mapping标签项中设置好路径后才能在project interpreter中看到自动设置的path mapping

![Center 5][]

## 配置运行配置 ##

\{如果不使用django，这个可以不用配置\}

在 PyCharm 中打开运行配置面板，路径为 Run => Run/Debug Configurations:  
[![PyCharm-Run-Configuration][]][PyCharm-Run-Configuration]

如果你发现你的运行配置中没有 Django 相关的项，请在项目设置的 Django 中勾选 Enable Django Support。

运行配置的设置有两点需要注意。Python Interpreter 需要选中之前建立的远程解释器。Path mappings 处，需要把本机的 manage.py 与 Linux 上的关联起来，比如：

C:/Evolution/Python/django\_website/manage.py <=> /home/onlyice/work/django\_website/manage.py

这可能是 PyCharm 的 bug：在使用远程解释器后，PyCharm 并不会自动将 Django 运行配置中的 manage.py 文件定位到 Linux 上的那份，而是会尝试使用下面的命令来启动 Django 调试 Server:

/usr/bin/python2 manage.py C:/Evolution/Python/django\_website/manage.py

自然就找不到文件了。所以使用了 Path mappings 作为一种 hack 手段来解决。  
这时就可以打断点调试啦

## Trouble Shooting ##

Q: 点击调试运行失败，显示 “Cant set remote tunneling”

A: 调试时 PyCharm 调用将 Python Debug Server (pydevd.py) 绑定在一个随机端口上，再使用 SSH 的端口转发将数据通过 SSH 端口转到 Debug Server 去。需要检查你的 sshd 配置 (默认是 /etc/ssh/sshd\_config) 是否禁用了 TCP 转发 (AllowTcpFowarding)，这个配置默认是打开的。

[皮皮blog][Link 1]

## 出错问题 ##

### pycharm channel is not opened ###

pycharm不能同步deployment中设置的文件内容了，在remote host窗口中打开文件提示the file is identical to local但实际上完全不同，上传多次才能成功，或者干脆就提示channel is not opened。应该和sftp有关。

目前还没找到具体原因，可能是服务器问题，过会就自己好了。

也可能是pycharm的问题，或者系统的问题？希望解决的可以留言告知一下，谢谢！

\[[Can't Download From Remote Server via SFTP – JetBrains IntelliJ][Can_t Download From Remote Server via SFTP _ JetBrains IntelliJ]\]

### pandas出错    ###

pycharm console import pandas Backend Qt4Agg is interactive backend. Turning interactive mode on.  : cannot connect to X server  
import pandas  : cannot connect to X server

重启pycharm，或者也不知道怎么了就好了，不报错了。。。

### 运行出错    ###

ssh://piting@192.168.0.172:22/home/piting/ENV/anaconda3/bin/python3 -u /home/piting/mine/python\_workspace/Oth/Competition/TianChi/Regression.py  
/home/piting/ENV/anaconda3/bin/python3: can't open file '/home/piting/mine/python\_workspace/Oth/Competition/TianChi/Regression.py': \[Errno 2\] No such file or directory

点出remote host标签，发现没有这个目录，目录下也没有这个文件

解决：

mkdir -p 代码目录

再在remote host中右键 》 upload here

from: [http://blog.csdn.net/pipisorry/article/details/52269952][blog.csdn.net_pipisorry_article_details_52269952]

ref: \[PyCharm [Remote Debugging][] 指南\]

\[[pycharm奇淫技巧][pycharm]\]\*

\[[使用Pycharm进行Python远程开发][Pycharm_Python]\]

\[[Deployment in PyCharm][]\]

[blog.csdn.net_pipisorry_article_details_52269952]: http://blog.csdn.net/pipisorry/article/details/52269952
[Python]: http://dasheyuan.com/post/pycharm-remote-debugging/
[Link 1]: http://blog.csdn.net/pipisorry
[Center]: /images/20220718/af484bf097014ec79988e8f777683054.png
[Link 2]: http://mingmings.qiniudn.com/pycharm_mapping.jpg
[Center 1]: /images/20220718/2331c244ac7540fd9548dcdd47a1c75f.png
[Center 2]: /images/20220718/7967709a413a4479aca22470d4ba7b4a.png
[Center 3]: /images/20220718/85d74d167ae04f6facdab03d0f16ebe9.png
[pycharm_upload]: http://mingmings.qiniudn.com/pycharm_upload.jpg
[ssh_]: http://blog.csdn.net/pipisorry/article/details/52269785
[python_virtualenv_]: http://blog.csdn.net/pipisorry/article/details/39998317
[Center 4]: /images/20220718/cc2ce64a691b4e05b6c0e03353f86cab.png
[Center 5]: /images/20220718/9d06f596d6484055918db8796eae4d5d.png
[PyCharm-Run-Configuration]: http://mingmings.qiniudn.com/PyCharm-Run-Configuration.png
[Can_t Download From Remote Server via SFTP _ JetBrains IntelliJ]: https://g.linuxeye.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&ved=0ahUKEwidlszp-rPRAhVJzWMKHQW1AAQQFggaMAA&url=https%3A%2F%2Fintellij-support.jetbrains.com%2Fhc%2Fen-us%2Fcommunity%2Fposts%2F207002545-Can-t-Download-From-Remote-Server-via-SFTP&usg=AFQjCNGTnrKLCb2Y3sjOB3nHz77BXWVfAg&cad=rja
[Remote Debugging]: https://www.jetbrains.com/pycharm/webhelp/remote-debugging.html
[pycharm]: http://mingmings.org/note/2015/01/06/pycharm%E5%A5%87%E6%B7%AB%E6%8A%80%E5%B7%A7.html
[Pycharm_Python]: http://blog.tpircsboy.com/tech/pycharm_remote_development/
[Deployment in PyCharm]: http://confluence.jetbrains.com/display/PYH/Deployment+in+PyCharm