在 PyCharm 里用 Local History

前面已經(jīng)介紹了版本工具可以記錄整個(gè)文件更新歷史，對(duì)于記錄文件的變化還有一個(gè)比較重要的功能，就是Local History(本地歷史記錄)，它與版本控制是無關(guān)的，本地歷史記錄會(huì)自動(dòng)維護(hù)所有有意義的更改的修訂，無論是來自 IDE 還是外部的， 這將生成項(xiàng)目結(jié)構(gòu)和源代碼更改的詳細(xì)時(shí)間線，當(dāng)有必要時(shí)可以 Rollback 到任意時(shí)間點(diǎn)代碼狀態(tài)。本節(jié)將講解 Local History 相關(guān)功能。

1. 查看本地歷史

在 PyCharm 內(nèi)，不僅可以查看文件的更新歷史，還可以查看某個(gè)類、方法或者代碼片斷及項(xiàng)目節(jié)點(diǎn)等不同范圍的歷史記錄。

1.1 查看文件本地歷史

主菜單 VCS -> Local History -> Show History 或者在編輯器內(nèi)右鍵菜單 Local History -> Show History，這將彈出一個(gè)對(duì)話框，其中顯示左側(cè)文件的更改列表和右側(cè)選定更改的差異查看器。

1.2 查看項(xiàng)目本地歷史

在 Project 工具窗口內(nèi)，選擇項(xiàng)目節(jié)點(diǎn)， 主菜單 VCS -> Local History -> Show History 或者右鍵菜單 Local History -> Show History，這將彈出一個(gè)對(duì)話框，其中顯示左側(cè)所選節(jié)點(diǎn)的更改列表以及右側(cè)更改、刪除或添加的文件列表。要研究特定文件中的更改，右鍵單擊，然后選擇"顯示差異"。

1.3 查看類、方法、字段及代碼片斷本地歷史

在編輯器內(nèi)，右鍵點(diǎn)擊類、方法名， Local History -> Show History for Class 或者 Show History for Selection：

2. 給特定狀態(tài)本地歷史記錄加標(biāo)簽

本地歷史記錄修訂通常標(biāo)有時(shí)間戳，不容易導(dǎo)航。可以添加新標(biāo)簽來標(biāo)記本地歷史記錄的當(dāng)前狀態(tài)，例如，在開始大規(guī)模重構(gòu)之前。

主菜單 VCS -> Local History -> Put Label 或者在編輯器內(nèi)右鍵菜單 Local History -> Put Label, 在打開對(duì)話框內(nèi)輸入一個(gè)意義的名字標(biāo)記當(dāng)前代碼狀點(diǎn)，然后點(diǎn)擊 OK 。再次查看該文件歷史，創(chuàng)建標(biāo)簽是被顯示在當(dāng)前狀態(tài)行上。

3. 將代碼從歷史記錄還原到特定狀態(tài)

本地歷史記錄對(duì)話框中，可以根據(jù)時(shí)間軸上的時(shí)間與右側(cè)的文件對(duì)比，在左側(cè)選擇要恢復(fù)的版本，右鍵從上下文菜單中選擇 Revert 或者單擊工具欄上的 Revert 圖標(biāo), 代碼將恢復(fù)選擇的狀態(tài)。同時(shí)將為本地歷史記錄添加新修訂版記錄。

4. 共享本地歷史

本地歷史記錄不支持共享訪問，它存儲(chǔ)在本地，僅供個(gè)人使用。但是，我們還是可以創(chuàng)建一個(gè) Patch 文件，該文件包含相對(duì)于特定修訂版的更改，這樣就可以與他人共享這些更改。

本地歷史記錄對(duì)話框中選擇修訂版，然后右鍵上下文菜單選擇 Create Patch 或者點(diǎn)擊工具欄上對(duì)應(yīng)按鈕。

.Patch 修補(bǔ)程序是用于共享更改，無需將它們簽入 VCS 存儲(chǔ)庫, 然后通過其它方式，比如電子郵件發(fā)送給其它人實(shí)現(xiàn)共享，在實(shí)際工作并不是經(jīng)常用，有興趣的話請(qǐng)看相關(guān)文檔。

5. 更新本地歷史記錄的保留期

默認(rèn)情況下，本地歷史記錄配置為存儲(chǔ)過去 5 個(gè)工作日, 這個(gè)值可以被更新。

主菜單 Help -> Find -> Action, 查找并打開 Registry, 修改localHistory.daysToKeep參數(shù)的值。單擊關(guān)閉并重新啟動(dòng) PyCharm 以使更改生效。

6. 小結(jié)

本小節(jié)講述了如何通過本地歷史功能對(duì)文件進(jìn)行跟蹤與管理，隨時(shí)都可以把代碼恢復(fù)到特定的狀態(tài)。因?yàn)楸镜貧v史功能的存在，即使我們?cè)趯?shí)際工作中由于一些誤操作也不用擔(dān)心代碼找不回來。
但要注意，本地歷史記錄不能替代長期版本控制的正確版本控制。安裝新版本的 PyCharm 時(shí)，將清除本地歷史記錄，另外，它還具有保留期期限的限制等等。