安科网

sublime3插件开发

Kwong

Kwong

2019-06-21

关注 关注

sublime Text 3 以下简称ST3是一个非常性感的文本编辑器，很多前端开发者在使用它。无插件，不神器，插件的使用可以使开发更方便快捷。目前社区里提供了各种各样的插件，在搜索里一搜就是各类插件的使用推荐，即使有这么多的插件，有时也不能满足我们的开发需要，今天就跟大家聊一下前段时间实现的（QcmsAux）插件的开发过程，希望给打算写插件的小伙伴们提供参考。

前期知识了解

1.了解Python

ST3是通过C++开发的，它的插件系统是通过Python来编写的，所以你一定要会Python，不一定非常精通，但是一定要了解，用到哪块儿知道去哪儿查。

推荐：Python基础教程 做为入门了解。

2. Python控制台

Sublime Text中内嵌了Python解释器。ST3中的Python和系统中的python是相互独立的。

我使用的是OSX系统，系统中的pythone版本是

python -V // Python2.7.10

打开Python控制台

  • 快捷键：Ctrl + `
  • 菜单： View -> Show Console

在这个控制台中查看，当前ST3中sublime的信息

sublime.version() // '3126'
sublime.platform() // 'osx'

查看ST3中python的版本

platform.python_version() //'3.3.6'

3. 重要的几个目录

Data目录

ST3几乎所有需要的文件都保存在Data目录下，不同的操作系统路径不同：

  • Windows: %APPDATA%Sublime Text 3
  • OS X: ~/Library/Application Support/Sublime Text 3
  • Linux: ~/.config/sublime-text-3

删除这个目录之前使用的插件和自定义的一些配置都会被同时删除，再次打开ST3,这个目录会被自动创建。

Packages目录

Data目录下的Packages目录是一个非常重要的目录，关于编程和标记语言的所有支持都保存在这里。

通过Sublime Text -> Preferences -> Browse Packages…可以打开该目录。

User 目录

User目录在Packages目录下，用于保存自定义plugins，snippets, macros(宏)。插件配置等都存在这个目录下。插件更新时，这个目录里的内容不会被修改。

准备工作

一个简单的插件示例

Tools -> Developer -> New Plugin, 使用这个命令可以创建一个插件示例，保存该文件，默认会保存在User目录下，默认文件名是 untitled.py

插件保存的位置

通过Package Control 安装的插件有的以源码的形式存入Packages目录，有的则以.sublime-package结尾的压缩包存在在上层目录的Installed Packages文件夹下。

ST3将会3个地方依次加载插件：

  1. Installed Pacages(only .sublime-package files)
  2. Packages
  3. Packages/User

根据约定，不会加载更深层次嵌套的文件，也就是说如果把 untitled.py 放在packages目录下会生效，但是如果放在User/new/下就不会生效。下面我直接放Packages/Example/下，文件名称改为Example.py，这里建议文件名和目录名保持一致。

我本机的目录/Users/rongl/Library/Application Support/Sublime Text 3/Packages/Example/

打开控制台，看到reloading plugin example.Example，说明插件已经被自动加载了，然后运行view.run_command('example'),如下会在第一行插入Hello, World! ，这样这个简单的插件就执行成功了。

Hello, World!import sublime
import sublime_plugin

class ExampleCommand(sublime_plugin.TextCommand):

    def run(self, edit):
        self.view.insert(edit, 0, "Hello, World!")

到目前为止已经完成了简单的插件的编写执行。在上面的示例中：

  • sublime_plugin.TextCommand:这是文本编辑相关的基类，文本编辑相关的命令都继承于这个基类。
  • ExampleCommand: 类名以Command结尾，之前的部分为命令名，其中首字母要大写。执行命令时则采用下划线风格的拼写，view.run_command中传入example，如果为MyExampleCommand，则传入my_example。
  • run(self,edit): 执行命令时会执行这个函数，这是固定格式。edit为API中提供的edit对象，在编辑时会用到。self,代表类ExampleCommand的实例。
  • self.view.insert(edit,point,content): point是init类型，指定编辑器中的一个坐标。所有插入，删除，选取等操作都通过self.view调用。

示例的效果就是在point位置插入content.

QcmsAux的开发过程

插件的主要功能

  1. 获取当前文件的路径，分析文件路径和文件名后缀，判断是否符合配置中指定的条件
  2. 如果未在qcms创建，调用qcms接口，在qcms创建文件，并返回新建文件的pid
  3. 已提交git，已在qcms创建，调用OBQ接口，发布到测试或上线
  4. 已提交git，调用OBQ接口，查看当前文件操作信息
  5. 调用验证接口，进行代码验证
  6. 跳转到OBQ平台，查看当前模板对应的query
  7. 跳转到OBQ平台，解锁当前模板
  8. 支持在SideBar中文件上右键弹出菜单上传到测试或上线

核心功能的实现

  1. QCMS创建页面查看QCMSAPI

sublime.load_settins加载插件的配置文件，配置文件内容格式为jsop,分User和default两种，分别位于Packages/User/<setting-name>和Packages/<package-name>/<setting-name>中，前者覆盖后者。

# 获取配置信息

settings = sublime.load_settins("QcmsAux.sublime-settings")

settings.get('key')

# 获取页面内容

content = view.substr(sublime.Region(0, view.size()))

# 往接口post信息,urllib发送数据和header伪代码

import urllib.parse
import urllib.request

url = 'http://localhost/login.php'
user_agent = 'Mozilla/4.0 (compatible; MSIE 5.5; Windows NT)'
values = {
    'act' : 'login',
    'login[email]' : [email protected]',
    'login[password]' : '123456'
}
headers = { 'User-Agent' : user_agent }

data = urllib.parse.urlencode(values)
req = urllib.request.Request(url, data, headers)
response = urllib.request.urlopen(req)
the_page = response.read()

print(the_page.decode("utf8"))

2.指定浏览器打开url

# MacOS
CHROME_PATH = 'open -a /Applications/Google\ Chrome.app %s'

# Windows
# chrome_path = 'C:\Program Files (x86)\Google\Chrome\Application\chrome.exe %s'
# 
# Windows
# chrome_path = 'C:\Program Files (x86)\Google\Chrome\Application\chrome.exe %s' 
url = "http://www.so.com"
webbrowser.get(CHROME_PATH).open(url,new=1)

耗时任务阻塞主线程

ST3已经提供了非常方便的异步执行耗时任务的方法set_timeout_async

快捷键

sublime大部分的配置都可以通过json文件来完成，键盘绑定也一样。不过它的键盘绑定是区分系统的，所以基本上要建立3个文件，而且命名为Default (Windows).sublime-keymap, Default (Linux).sublime-keymap 和 Default (OSX).sublime-keymap

菜单项

  • Main.sublime-menu 控制了程序的主菜单
  • Side Bar.sublime-menu 控制侧边栏文件或者目录的右键菜单
  • Context.sublime-menu 控制处于编辑状态的文件右键菜单

通过console打印

print xxxx

弹出式的窗口

sublime.error_message("hello world")

几个常见概念

Window:

打开的 sublime text 窗口

View

表示一个文本缓冲的视图，可以认为是打开的一个 tab。

Edit

继承自 sublime_plugin.TextCommand 的命令， Edit 为第一个参数。 打开一个 view 以后必须要指定 Edit 才能真正的 insert 字符。需要 view.begin_edit 开始使用编辑区，使用完要 end_edit 。根据 sublime 3 API 的说法，只能继承，不能被创建。

Region

表示缓冲区的一个区域。有两个init类型的属性a和b。Region.a表示区域开始的点，Region.b表示区域结束的点。

view 的 find_all 等可以匹配一系列的 region 出来

Selection(RegionSet)

表示选择的区域。函数sublime.View.sel()返回的类型就是Selection，表示目前选中的所有区域。Selection.add(Region)方法可以添加选择区域。

Point概念

int类型，代表缓冲区的一个位置。可以通过sublime.View.rowcol(point)将point转化为行列信息(int,int)。或通过sublime.View.text_point(row,col)将行列信息转化为point。

  • Point 是跟文本开头位置的偏移量
  • 获得当前光标位置的 point: view.sel()[0].a
  • 一个 region 的属性 a b 为起始的俩个 point

line:

这里看到 line 返回的是鼠标所在行的起始字符数，从文件头开始，算 UTF8 字符，一个中文也是一个字符，无论光标在何处，都是这样的结构(行开始字符数, 行结束字符)

mark = self.view.sel()[0]
line = self.view.line(mark.a)
sublime.status_message("hickdebug "  + time.strftime("%Y-%m-%d %X - ") + str(line))

内置命令

expand_selection

用内置的expand_selection命令，to参数设置为brackets 每个css规则区域内容就可以选中了

self.view.run_command("expand_selection", {"to": "brackets"})

python中执行shell命令的四种方式

  1. os.system()

这个方法得不到shell命令的输出

import os
os.system('ls')
# 执行ls命令
  1. popen()

这个方法能得到命令执行后的结果是一个字符串，要自行处理才能得到想要的信息

import os
str = os.popen("ls").read()
a = str.split('\n')
for b in a:
    print b
  1. commands模块

可以很方便的取得命令的输出（包括标准和错误输出）和执行状态位

commands.getstatusoutput(cmd) 返回(status,output)

import commands
a,b = commands.getstatusoutput('ls')
print a
# a是退出的状态
# 0 
print b
# b是输出结果
# 执行ls命令

commands.getoutput(cmd) 只返回输出结果

import commands
b = commands.getoutput('ls')
# 执行ls命令

commands.getstatus(file) 待补充

  1. subprocess模块

使用subprocess模块可以创建新的进程，可以与新建进程的输入/输出/错误管道连通，并可以获得新建进程执行的返回状态。使用subprocess模块的目的是替代os.system(),os.popen(),commands*等旧的函数和模块。

subprocess.call(command,shell=True)

import subprocess
subprocess.call('ls',shell=True)
# 执行ls命令

subprocess.Popen(command,shell=True)

import subprocess
subprocess.Popen('ls',shell=True)
# 执行ls命令

subprocess.Popen(command,stdout=subprocess.PIPE,shell=True)待补充

如果command不是一个可执行文件，shell=True是不可省略的。
shell=True表示在shell下执行command

常用语句功能

view.settings().get('syntax')

返回当前文件格式，常见的有

  • [tpl,inc,html] : Packages/HTML/HTML.sublime-syntax
  • css: Packages/CSS/CSS.sublime-syntax
  • php: Packages/PHP/PHP.sublime-syntax
  • js:Packages/JavaScript/JavaScript.sublime-syntax
  • py:Packages/Python/Python.sublime-syntax
if int(sublime.version()) > 3000
    print("sublime3")

判断sublime的版本信息

命令的拼写

['node', '/Users/guopeipei/Library/Application Support/Sublime Text 3/Packages/JSLint/linter.js', '--bitwise', '--browser', '--es6', '--eval', '--for', '--fudge', '--node', '--this', '/Users/guopeipei/project/M_so_com/m_so/resource/js/result/scrollTab.js']

Running node /Users/guopeipei/Library/Application Support/Sublime Text 3/Packages/JSLint/linter.js --bitwise --browser --es6 --eval --for --fudge --node --this /Users/guopeipei/project/M_so_com/m_so/resource/js/result/scrollTab.js

sublime.View类重要方法

sublime.View.find_by_class(point, forward, classes, <separators>)

通过Class查找,sublime提供的Class

  • sublime.CLASS_WORD_START
  • sublime.CLASS_WORD_END
  • sublime.CLASS_PUNCTUATION_START
  • sublime.CLASS_PUNCTUATION_END
  • sublime.CLASS_SUB_WORD_START
  • sublime.CLASS_SUB_WORD_END
  • sublime.CLASS_LINE_START
  • sublime.CLASS_LINE_END
  • sublime.CLASS_EMPTY_LINE
sublime.View.find_by_selector(selector)

根据语法选择器查找 ，selector是一个字符串。Scope Naming

sublime.py文件位置

/Applications/Sublime Text.app/Contents/MacOS/sublime.py

参考

  1. sublime插件开发从0到1
  2. 为sublime text 3开发插件
  3. Sublime Text非官方文档
  4. 非官方文档的翻译整理
  5. Sublime Text 3.0 API文档
  6. Sublime Text 3.0 API 中文版

python packages

Kwong

Kwong

0 关注 2 粉丝 0 动态

关注 关注

相关推荐

python 发送get请求接口详解

　　如果想用python做接口测试，我们首先有不得不了解和学习的模块。虽然Python内置的urllib模块，用于访问网络资源。但是，它用起来比较麻烦，而且，缺少很多实用的高级功能。更好的方案是使用。它是一个Python第三方库，处理URL资源特别方便。R

YENCSDN 2020-11-17

python 使用tkinter+you-get实现视频下载器

#获取屏幕尺寸以计算布局参数，使窗口居屏幕中央,其中width和height为界面宽和高。#阻止窗口调整大小

lsjweiyi 2020-11-17

python中requests模拟登录的三种方式(携带cookie/session进行请求网站)

session是在cookie的基础上，服务端设置session时会向浏览器发送设置一个设置cookie的请求，这个cookie包括session的id当访问服务端时带上这个session_id就可以获取到用户保存在服务端对应的session. 到此这篇关

houmenghu 2020-11-17

python开发一个解析protobuf文件的简单编译器

最近刚刚用python写完了一个解析protobuf文件的简单编译器，深感ply实现词法分析和语法分析的简洁方便。乘着余热未过，头脑清醒，记下一点总结和心得，方便各位pythoner参考使用。如果你不是从事编译器或者解析器的开发工作，你可能从未听说过ply

Erick 2020-11-17

python 下载文件的多种方法汇总

本文档介绍了 Python 下载文件的各种方式，从下载简单的小文件到用断点续传的方式下载大文件。使用 Requests 模块的 get 方法从一个 url 上下载文件，在 python 爬虫中经常使用它下载简单的网页内容。使用 python 内置的 url

HeyShHeyou 2020-11-17

Linux Shell 如何获取参数的方法

是显示最后命令的退出状态，0表示没有错误，其他表示有错误。不同点：$* 和 $@ 都表示传递给函数或脚本的所有参数，不被双引号(" ")包含时，都以"$1" "$2" …"$n"

以梦为马不负韶华 2020-10-20

python跨文件使用全局变量的实现

但是他的一大缺陷就是只能本module 中也就是本文件中使用，跳出这个module就不行。使用一个更宏观的思路，全局变量就用全局加载的模块解决，很遗憾也是不行，这样可以，但是如果再有一个module 想用呢？这样就会报错，因为import 加载就会执行一遍

lhtzbj 2020-11-17

Python爬虫破解登陆哔哩哔哩的方法

作为一名找不到工作的爬虫菜鸡人士来说，登陆这一块肯定是个比较大的难题。从今天开始准备一点点对大型网站进行逐个登陆破解。加深自己爬虫水平。if response_json['code'] == 0 and response_json['data']['sta

夜斗不是神 2020-11-17

python调用百度API实现人脸识别

# """ 你的 APPID AK SK """. # img = Image.fromarray #将每一帧转为Image. # output_buffer = BytesIO() #创

pythonjw 2020-11-17

Python调用ffmpeg开源视频处理库，批量处理视频

strcmd = r'ffprobe -print_format json -show_streams -i "{}"'.format. strcmd = 'ffmpeg -i "{}" -vcodec copy -

dingwun 2020-11-16

详解python os.path.exists判断文件或文件夹是否存在

os即operating system，Python 的 os 模块封装了常见的文件和目录操作。os.path模块主要用于文件的属性获取,exists是“存在”的意思，所以顾名思义，os.path.exists()就是判断括号里的文件是否存在的意思，括号内

lhxxhl 2020-11-16

python实现在列表中查找某个元素的下标示例

列表中字符和数字都有。使用python的内建函数enumerate

sunskyday 2020-11-16

python如何获得list或numpy数组中最大元素对应的索引

#表示最大值在第二行第二列

sizhixht 2020-11-16

Python实现列表索引批量删除的5种方法

开头，如果不仔细看好像没什么问题。但是结果却是错误的。将 listObj.remove() 改为listObj.pop结果也是相同的。Java用同样的编程思想，得到的结果也有相似性。这种错误，主要是初学者对于数据存储原理没有理解清楚，或者，没有意识到内存存

坚持是一种品质 2020-11-16

python 爬虫如何实现百度翻译

本文将会通过爬虫的方式实现简单的百度翻译。本文中的代码只供学习，不允许作为于商务作用。若有侵犯，立即删文！在网站文件中找到隐藏的免费api。传入api所需要的参数并对其发出请求。在返回的json结果里找到相应的翻译结果。进入百度翻译，随便输入一段需要翻译的

染血白衣 2020-11-16

致命错误！Python开发者的7个崩溃瞬间

本文转载自公众号“读芯术”。毫无疑问，Python是当今使用最为广泛的编程语言。但无论你经验多丰富，或是已使用过多少种语言，切换到Python时都不能保证非常顺利。具有面向对象编程背景的开发人员容易忽略Python的惯用特性，很可能会滥用编程结构，从而产生

huavhuahua 2020-11-20

针对Python开发人员的10个“疯狂”的项目构想

最棒的是，你可以通过这些有趣但也具有挑战性的项目来增强 Python 编程技能。你知道 Python 是被称为 全能编程语言 的吗？是的，它确实是，虽然不应该在每个项目中都使用它。你可以使用它来创建桌面应用程序、游戏、移动应用程序、网站和系统软件。它甚至是

meylovezn 2020-11-20

用Python内置模块处理ini配置文件

开发人员每天都在处理一些大型而复杂的项目， 而配置文件会帮到我们并节省不少时间。在处理配置文件过程中，无需更改源代码本身，只需要调整配置文件即可访问不同的API接口、更新基础URL信息或其它事情。尽管可以通过多种方式来支持软件中的配置文件，包括JSON，

逍遥友 2020-11-20

VS Code 中 Python 扩展的部分功能重构，支持 R 和 Julia

11 月 12 日，微软将 Jupyter Notebook 支持从 Python 扩展中独立出来，发布新的 Jupyter 扩展，支持智能感知，调试等功能的交互式编程和计算。Jupyter 扩展通过新的“ Native Notebooks Experi

weiiron 2020-11-16

Python五个隐藏的特性，你可能从未听说过

在本文中，我将向您展示Python中很常见的5个特性。有经验的Python开发人员可能认识其中一些。然而，这对其他人仍将是未知的。是的，你没看错，在Python中...是一个有效的构造。...是称为省略号的单例对象。如果你把它输入到Python解释器中，你

Yasin 2020-11-16
Kwong

Kwong

W3CSchool教程
HTML 教程
CSS 教程
Bootstrap 教程
Javascript 教程
jQuery 教程
后端教程
C 教程
Java 教程
PHP 教程
Python 教程
Go 教程
移动开发
Android 教程
Swift 教程
Kotlin 教程
jQuery Mobile 教程
ionic 教程
关于我们
新闻动态
联系方式
招聘英才
安科实验室
帮助与反馈

安科网(Ancii)，中国第一极客网

Copyright © 2013 - 2019 Ancii.com

京ICP备18063983号 京公网安备11010802014868号