PyCharm插件開發(fā)實(shí)踐之PyGetterAndSetter詳解
背景需求
在面向?qū)ο蟮脑O(shè)計(jì)中,典型如Java語言,為了控制對象屬性的修改入口,我們常用的做法是把屬性設(shè)置為private,然后通過getter和setter方法訪問、修改該屬性。
但是在Python語言中,并沒有Java的訪問控制符,對象的屬性可以直接訪問、修改。
為了良好的設(shè)計(jì)規(guī)范,我們可以規(guī)定,在Python類中,所有的對象屬性均以下劃線"_"前綴開頭,同時(shí)編寫該屬性的getter和setter方法,在其他地方引用的時(shí)候,禁止出現(xiàn)直接引用。
在IDEA等IDE中,可以對Java的對象屬性直接生成getter和setter方法,但是針對Python沒有這樣的功能。大量的getter和setter方法,很耗費(fèi)精力,所以需要一款插件來輔助自動(dòng)化生成Python對象屬性的getter和setter方法。
搭建環(huán)境
編寫IDEA系列的插件開發(fā)環(huán)境,可以看我之前的一篇文章:《IntelliJ IDEA/Android Studio插件開發(fā)指南》
官方開發(fā)文檔:IntelliJ Platform SDK
過程拆解
Python文件例子:
class Test(object): def __init__(self): self._var1 = "" self._var2 = 0
明確了需求、輸入(python對象屬性定義代碼)、輸出(PyCharm插件自動(dòng)生成getter和setter)后,我們針對這個(gè)插件的流程進(jìn)行拆解:
- 首先,用戶選中了對應(yīng)行的文本內(nèi)容,插件獲取到該內(nèi)容文本
- 在內(nèi)容文本中過濾出變量,在本例中,就是過濾出_var1, _var2
- 拼裝變量的getter和setter方法
- 計(jì)算出要插入的位置
- 回寫到編輯器中
1. 獲取文本
在PyCharm插件中,Editor對象是編輯器的總覽,其中包含很多Model,比如
CaretModel caretModel=editor.getCaretModel(); // 用于描述插入光標(biāo) SelectionModel selectionModel = editor.getSelectionModel(); // 用于描述選中的文本 FoldingModel foldingModel = editor.getFoldingModel(); // 用于描述代碼折疊區(qū)域 IndentsModel indentModel = editor.getIndentsModel(); // 用于描述縮進(jìn) ……
在這里,我們只需要SelectionModel。
// 獲取光標(biāo)選中文本段對象 SelectionModel selectionModel = editor.getSelectionModel(); // 拿到選中部分字符串 String selectedText = selectionModel.getSelectedText();
2. 正則匹配
拿到選中文本后,有可能選擇了多行,里面包含多個(gè)變量,所以我們需要獲取到變量列表。
觀察到所有的變量都是self.abc=xxx
的模式,我們可以考慮用正則匹配把其中的abc
獲取到。
Java中負(fù)責(zé)正則匹配并獲取匹配字符串的類是Pattern
和Matcher
。
/** * 獲取選中文本中所有的self.value中的value <br> * e.g. self.value = xxx,or self._value = xxx, <br> * 可以獲取到其中的value * * @param selectedText 選中文本 * @return 變量字符串列表 */ public ArrayList<String> getFieldList(String selectedText) { ArrayList<String> list = new ArrayList<>(); // 刪除所有空格 selectedText = selectedText.replaceAll(" ", ""); // 正則匹配獲得變量字符串 String reg = "self.(.*?)="; Pattern pattern = Pattern.compile(reg); Matcher matcher = pattern.matcher(selectedText); while (matcher.find()) { list.add(matcher.group(1)); } return list; }
3. 拼裝方法
Python中的getter和setter方法都非常簡單,我們可以先創(chuàng)造一個(gè)模板:
// 定義Getter和Setter的模板 String getterTemplate = " def get_word(self):\n return self.field\n "; String setterTemplate = " def set_word(self, word):\n self.field = word\n ";
之所以存在空格,是為了匹配PyCharm的縮進(jìn),我這里使用的4個(gè)空格做縮進(jìn),如果你使用兩個(gè)空格的話,在這里修改成兩個(gè)空格即可。
在這里不能使用\t
,我嘗試了\t
,在PyCharm中無法自動(dòng)轉(zhuǎn)換為4個(gè)空格,會報(bào)錯(cuò)。
上一步獲取到的變量,有可能不存在下?lián)Q線前綴,也有可能存在1個(gè)或者2個(gè)下劃線前綴,比如var
,_var
,__var
,他們對應(yīng)的gett和setter如下:
# 假如變量為_var def get_var(self): return self._var; def set_var(self, var): self._var = var;
可以看到在self.xxx
中需要使用變量,而在get_xxx
和setter的參數(shù)中,需要?jiǎng)h除對應(yīng)的下劃線。所以有:
…… // 對于 “_value” 類型的變量,在set方法參數(shù)中,只需要“value” for (String field : fieldList) { String tmp = field; int i = 0; while (tmp.charAt(i) == '_') { tmp = tmp.substring(1); } // 替換掉模板中的變量 String customGetter = getterTemplate.replaceAll("word", tmp).replaceAll("field", field); String customSetter = setterTemplate.replaceAll("word", tmp).replaceAll("field", field); stringBuilder.append("\n").append(customGetter).append("\n").append(customSetter); } ……
4. 計(jì)算位置
首先需要獲取到Document對象,這是負(fù)責(zé)描述文檔的,里面有很多負(fù)責(zé)文檔的方法,比如在文件中插入字符串,計(jì)算文件行數(shù),計(jì)算文檔長度,刪除相應(yīng)內(nèi)容等等。
Document document = editor.getDocument();
為了方便簡單,我們設(shè)定在選中文本的下一行生成getter和setter。
// 得到選中字符串的結(jié)束位置 int endOffset = selectionModel.getSelectionEnd(); // 得到最大插入字符串(生成的Getter和Setter函數(shù)字符串)的位置 int maxOffset = document.getTextLength(); // 計(jì)算選中字符串所在的行號,通過行號得到下一行的第一個(gè)字符的起始偏移量 int curLineNumber = document.getLineNumber(endOffset); int docLineCount = document.getLineCount(); // 如果目前文件行數(shù)不足以支持選中文本的下一行,也就是選中文本包含最后一行,就插入一個(gè)空行 if (docLineCount - 1 < curLineNumber + 1) { Runnable runnable = () -> document.insertString(maxOffset,"\n"); WriteCommandAction.runWriteCommandAction(project, runnable); } int nextLineStartOffset = document.getLineStartOffset(curLineNumber + 1);
5. 回寫
將字符串插入文檔中,不能直接使用document.insertString
,會error: Assertion failed: Write access is allowed inside write-action only (see com.intellij.openapi.application.Application.runWriteAction())
需要把這個(gè)任務(wù)放入一個(gè)Runnable中,然后由WriteCommandAction
來調(diào)度。
參考:Write access is allowed inside write-action only
// 對文檔進(jìn)行操作部分代碼,需要放入runnable,不然IDEA會卡住 Runnable runnable = () -> document.insertString(nextLineStartOffset, genGetterAndGetter(fieldList)); // 加入任務(wù),由IDE調(diào)度任務(wù) WriteCommandAction.runWriteCommandAction(project, runnable);
效果
目前來看效果還不錯(cuò),關(guān)于安裝方法、使用方法,見github的README。
資源
github鏈接:https://github.com/mybichu/PyGetterAndSetter
到此這篇關(guān)于PyCharm插件開發(fā)實(shí)踐之PyGetterAndSetter詳解的文章就介紹到這了,更多相關(guān)PyCharm插件開發(fā)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
python中Pycharm 輸出中文或打印中文亂碼現(xiàn)象的解決辦法
本篇文章主要介紹了python中Pycharm 輸出中文或打印中文亂碼現(xiàn)象的解決辦法 ,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-06-06Python實(shí)現(xiàn)的數(shù)據(jù)結(jié)構(gòu)與算法之隊(duì)列詳解
這篇文章主要介紹了Python實(shí)現(xiàn)的數(shù)據(jù)結(jié)構(gòu)與算法之隊(duì)列,詳細(xì)分析了隊(duì)列的定義、功能與Python實(shí)現(xiàn)隊(duì)列的相關(guān)技巧,以及具體的用法,需要的朋友可以參考下2015-04-04基于Python_腳本CGI、特點(diǎn)、應(yīng)用、開發(fā)環(huán)境(詳解)
下面小編就為大家?guī)硪黄赑ython_腳本CGI、特點(diǎn)、應(yīng)用、開發(fā)環(huán)境(詳解)。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-05-05Python學(xué)習(xí)之內(nèi)置函數(shù)總結(jié)
這篇文章主要為大家總結(jié)一下python?中常用的是個(gè)內(nèi)置函數(shù)的使用方法,文中的示例代碼講解詳細(xì),對我們學(xué)習(xí)Python有一定的幫助,需要的可以參考一下2022-03-03python密碼學(xué)列置換密碼學(xué)習(xí)
這篇文章主要為大家介紹了python密碼學(xué)列置換密碼學(xué)習(xí)的示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-05-05Python實(shí)現(xiàn)監(jiān)視程序的內(nèi)存使用情況
我們使用Python和它的數(shù)據(jù)處理庫套件進(jìn)行大量數(shù)據(jù)處理時(shí)候,可能使用了大量的計(jì)算資源,那么如何監(jiān)視程序的內(nèi)存使用情況就顯得尤為重要,下面我們就來了解一下具體實(shí)現(xiàn)方法吧2023-12-12Python Tornado框架輕松寫一個(gè)Web應(yīng)用的全過程
Tornado全稱Tornado Web Server,是一個(gè)用Python語言寫成的Web服務(wù)器兼Web應(yīng)用框架,Tornado走的是少而精的方向,注重的是性能優(yōu)越,它最出名的是異步非阻塞的服務(wù)器方式,這篇文章主要給大家介紹了關(guān)于Python Tornado框架輕松寫一個(gè)Web應(yīng)用的相關(guān)資料,需要的朋友可以參考下2021-08-08python性能檢測工具函數(shù)運(yùn)行內(nèi)存及運(yùn)行時(shí)間
這篇文章主要介紹了python性能檢測工具函數(shù)運(yùn)行內(nèi)存及運(yùn)行時(shí)間,python雖然是一門慢語言,但是也有著比較多的性能檢測工具來幫助我們優(yōu)化程序的運(yùn)行效率,下文小編給大家分享五個(gè)性能檢測工具,需要的朋友可以參考一下2022-05-05