Sublime 从本地上传文件或是目录到服务器

字数 1122阅读 428
人生苦短,我用Python。

问题描述:
最近在使用ST3进行代码编写,之前用的是Atom或是vscode,并没有一个十分中意的代码编辑器,主要还是看使用的心情吧,有的时候使用不同的编辑器。由于部分的代码是在本地机器(Macbook pro)上编写测试,等到测试成功或是可以使用的时候直接上传到服务器(n多核+高性能GPU+ubutun)上面,让服务器去跑实验,这个时候就需要使用ssh将本地的代码文件或是目录上传到server上面。但是每次都用scp去上传总是有点麻烦,所以这里就直接编写了一个ST3的插件,让插件自动完成代码的上传。(这是受启发于pycharm pro的功能)

前置条件:

  1. ssh已经将你的公钥上传到server中,所以能够实现免密登录。并且在terminal中scp的时候也可以不用输密码;
  2. 熟悉python编码;
  3. 本地代码库有专门的地址
  4. server上面有也专门的代码库,一般是存放在你的个人用户目录下

预期结果:

  1. 打开文件编辑之后,通过鼠标右键或是快捷键就能将刚才编辑的文件上传到服务器上。
  2. 通过再ST3的左边的打开的目录列表上通过鼠标右键的菜单能够将选中的目录下的所有文件上传到服务器上。
  3. 可以设置多个服务器,当服务器只有一个的时候默认上传到这个服务器上;当有多个服务器的时候,在使用菜单或是快捷键的时候会出现选择服务器的界面,能够将文件上传到指定的服务器上。

下一步实现:

  1. 能够在ST3的terminal中显示scp的传输过程(python调用shell命令scp的时候不显示过程)
  2. 将服务器的配置写在配置文件中而不是硬编码
  3. 将用户名和密码放在配置文件中

插件结果截图:


传输单文件到server上面
将文件和文件夹传递到服务器

怎样编写插件

ST3的插件使用的语言主要是Python,在ST3的安装目录中我们可以发现两个python文件sublime.pysublime_plugin.py这两个不同的插件。这两个module就是ST3在生成新插件的时候默认导入的两个模块,里面包含了不同的class。通过继承不同的class来完成插件的编写。

定义好了插件之后,还可以添加顶部菜单,右键菜单以及编辑器左边的sidebar的右键菜单。同时还能够定义不同的快捷键来调用相应的功能。由于文件和文件夹通过scp使用的是不同的命令,所以这里需要定义两个不同的插件。

首先,我们通过ST3的[tools]->[Developers]->[New Plugin] 来自动的建立一个插件,可以看出自动建立的插件是一个python的类,并且这个类继承的TextCommand类,插件的主要功能代码就是写在run函数里面。将你需要实现的功能写在这个run函数里面。主要就是解析path,然后构造server上面的代码的path。再添加到一个右键快捷菜单中。

文件夹下的所有文件

此时并不能得到的一个特定的文件路径,如果需要将某个文件下的所有文件全部上传到server上的话,那么scp中需要带有一个-r的命令表示递归。需要找到文件夹的路径,我们在左侧的project树状结构中可以使用右键菜单,但是我们可以看到,系统自带的只有[new file][rename][new folder][delete folder][find in folder]这几种菜单,通过查看API(非官方的API)可以看到通过定义一个Side Bar.sublime-menu 文件就能将菜单和功能相互连接起来了。

快捷键和邮件菜单

通过上图我们可以看出sublime-keymap是快捷键的配置,sublime-menu是右键菜单的配置,Context指的是在文件编辑状态下的右键菜单,而Side Bar则是左边的树状结构中的右键菜单设置。

最后,通过编码和连接菜单就能完成预期得功能,接下来就是利用这个插件代替你打开命令行手敲scp命令了。happy coding

推荐阅读更多精彩内容