如何用 Python 制作 GitHub 消息助手

Posted on by

在互聯網2.0時代，工程師解決業務問題主要依賴的是自己掌握的各種工具和軟件伴隨著席卷全球的開源浪潮，開源工具和軟件也迅猛增長。工程師需要關註的技術和軟件也隨之越來越多，學習負擔越來越大，大腦也越來越不夠用。但工程師們也很無奈，因為誰掌握的技術和軟件越多，誰就能更高效的解決問題。於是工程師們開始借助互聯網外腦工具：尤其是搜索引擎、書簽、github、scihub等 而工程師們解決問題的能力就體現在瞭對外腦工具的利用上。
但是，隨著工程師們要解決的問題增長以及自身知識的積累，外腦工具也逐漸變得臃腫：書簽越來越多，github的訂閱越來越多，多到最後就約等於沒有書簽、沒有訂閱瞭。為瞭解決這些問題，我們需要更智能靈活的外腦工具，能讓我們從信息的海洋中解放出來，讓我們能更加專註自身業務。

GitHub 消息的問題

有沒有發現你的 Github 消息 Inbox 過幾天不處理，就會堆積成山呢？相信有的同學 Inbox 裡的數字比這個還要誇張，甚至有的同學已經絕望的放棄瞭 Inbox 這個功能。
為什麼會這樣？
因為每個Coder內心大多都會喜歡收藏喜愛的作品，而github的項目主頁右上角最醒目的位置總是擺著這三個按鈕：

相信工程師們看到喜愛的項目，就會毫不猶豫的一鍵三連：watch、start、fork。
悲劇也就從這裡開始瞭。
1、工程師喜歡的項目越來越多；
2、項目會有自己的生命周期，有的變得活躍，有的逐漸消亡；
3、工程師越來越忙，無暇顧及Inbox。
然後，Inbox就變這樣瞭：

看著滿是堆積的消息，是不是有種崩潰的感覺。那github的功能到底出瞭什麼問題？
我認為是 watch、star、fork 需要工程師投入的關註程度搞錯瞭。當然現在github也在積極改進，相比以前，我們可以發現有瞭更多的 watch 選項：

但是僅僅這些就夠瞭嗎？看著 Inbox 動輒上萬條的消息，難道要將自己關註的項目一個個的修改為 Ignore？
工程師的內心依然是崩潰的！
有沒有辦法拯救工程師的Inbox？
有！來吧，自己動手拯救我的收件箱。

解決方案

用 python 做一個 GitHub 消息助手，自動幫工程師關閉和刪除不必要的消息。這不也就是真正意義上的Watch嗎？你看它的時候，會接收它的信息，你不看瞭它就消失瞭。那麼仔細想想，到底哪些消息真正對工程師有用呢？
1、已經很久沒更新的項目，是不是就可以不關註瞭？
2、已經不是工作范圍和興趣點的項目，是不是也可以不關註瞭？
3、已經很久都沒人反饋問題的項目，是不是也可以不關註瞭？
而python有一個優勢就是可以很方便的實現用戶操作的自動化 嗯，看起來這些僵屍項目都可以用python自動化的方式清除掉 說幹就幹，讓我們開始吧！

代碼實現

我們知道Python有一款很棒的Web自動化測試框架：Selenium，但 Selenium 主要還是用於測試，調用還是略顯復雜。所以筆者在github上搜刮瞭一番，終於找到一款合適的Python包：PyChrome 項目地址：
https://github.com/siversalih/pyChrome-Web-Automation
下面我們就用這款非主流的自動化工具包，完成我們的小助手 看主頁，這個作者很懶，幾年前就沒有更新瞭，但幸好說明幫助還是挺全的：
https://pychrome.wordpress.com/usage/
所以我們就可以 happy 的按照說明書來組裝機器人瞭。

0.環境準備

首先需要準備Python 3.8環境，然後按照網上說明安裝 Selenium，接下來將PyChrome項目 clone到本地。ok，環境準備完成。

1、模擬登錄github

使用PyChrome訪問github有個小麻煩，每次都會啟動一個全新的Chrome瀏覽器實例。這就導致無法重復利用保存在本地的cookie信息，所以每次要模擬登陸下。github有一個特點，如果ip變更，需要輸入驗證碼，如果ip不變則不需要，所以第一次我們隻能先手工輸入一次。

不過github的登錄頁面相對簡單，隻需要找到Username和password對應的表單組件就可以瞭。所以登錄的代碼可以非常簡潔，如下所示：

browser.open("https://github.com/login")
# name="login"
name_locator = "//*[@name='login']"
el_name = browser.findElementByXPath(name_locator) 
browser.sendTextToElement(username, el_name) 
# name="password"
pass_locator = "//*[@name='password']"
el_pass = browser.findElementByXPath(pass_locator) 
browser.sendTextToElement(password,el_pass) 
login_locator = "//*[@name='commit']"
el_login = browser.findElementByXPath(login_locator) 
browser.clickElement(el_login)

2.模擬進入Inbox

登錄完成後，我們需要進入收件箱，查看到底有哪些未讀消息。收件箱有點小復雜，不過也還能很方便的區分。

找到瞭正確的xpath，相信定位也不是難事。這裡我又取瞭個巧，我們被困擾的其實是有消息的項目，如果一個項目不發消息，我們其實也不會被騷擾到。所以直接選取左下角的 Repositories 區域似乎效率更高一些。
代碼如下：

browser.open("https://github.com/notifications")
# 獲取有消息的Repositories列表
locator = "js-notification-sidebar-repositories"
el_repos = browser.findElementByClass(locator) 
repos_list = browser.findElementsByTag("li", el_repos)

3.檢查僵屍項目

我選用第三條策略，已經很久沒人反饋問題的項目作為判斷僵屍項目的標準（純粹隻是因為方便實現），首先訪問issue，然後判斷issue裡的更新日期，恰好有一個詳細的日期字段。下面代碼目的很簡單，就是獲取最後一條issue更新瞭多久。

    browser.newTab("https://github.com/" + repos_name + "/pulls?q=")
    # 判斷最近的 pull request
    locator = "//div[@aria-label='Issues']"
    el_pulls = browser.findElementByXPath(locator) 
    pull_list = browser.findElementsByTag("relative-time", el_pulls)
    timedelta = 0
    if type(pull_list)==list and len(pull_list)>0:
        # 2020-11-10T00:55:39Z
        # last_pull_time_str = pull_list[0].getAttribute("datetime")
        last_pull_time_str = pull_list[0].get_attribute("datetime")
        last_time = datetime.strptime(last_pull_time_str, "%Y-%m-%dT%H:%M:%SZ")
        timedelta = (datetime.now() - last_time).days 
    logger.debug(repos_name + " timedelta: " + str(timedelta) + " days")

4.取消關註僵屍項目

如果issue已經超過瞭1年，自然就應該取消關註瞭，畢竟目前信息更新的速度太快瞭。

# 取消不活躍項目的訂閱(1年以上沒有pull request)
if unsubscribe and timedelta > 366:
    el_notify_button =browser.findElementsByTag("notifications-list-subscription-form")
    browser.clickElement(el_notify_button) 
    time.sleep(1)
    # data-target="notifications-list-subscription-form.menu"
    locator = "//*[@data-target='notifications-list-subscription-form.menu']"
    el_notify_menus = browser.findElementByXPath(locator) 
    # value="ignore"
    sub_locator = "//*[@value='ignore']"
    el_ignore_button =browser.findElementByXPath(sub_locator, el_notify_menus) 
    browser.clickElement(el_ignore_button) 
    logger.debug(repos_name + " cancel subscribed")

5.刪除僵屍項目消息

最後，該是解除困擾的時候瞭，這種不再更新的項目，工程師自然也不要再被它的消息騷擾。

    el_repos_link = browser.findElementByTag("a", repos)
    browser.clickElement(el_repos_link) 
    # mr-1 js-notifications-mark-all-prompt
    time.sleep(1)
    el_sel_all =browser.findElementByClass("js-notifications-mark-all-prompt")
    browser.clickElement(el_sel_all) 
    time.sleep(1)
    # title="Done"
    done_locator = "//*[@title='Done']"
    el_done = browser.findElementByXPath(done_locator) 
    browser.clickElement(el_done) 
    logger.debug(repos_name + " remove notifiy")

以上代碼就是模擬 Done 按鈕的操作：

到這裡就完成瞭GitHub消息助手的全部邏輯，整個Inbox終於清靜瞭，是不是可以喝杯咖啡愜意一下瞭。

後記

Python自動化工具的確是給工程師們帶來瞭便捷，使得工程師能應對各種日常不同的挑戰。為方便各位工程師小夥伴們早日解脫、得償所願，以上代碼已開源，完整的代碼地址：
https://gitee.com/knifecms/puppetry/blob/master/github-agent/resp_notify.py
另外，該項目下，還有幾個其他有意思的自動化助手和工具喲，大傢感興趣的話也可以研究研究。
希望得到你的更多好點子！

以上就是如何用 Python 制作 GitHub 消息助手的詳細內容，更多關於Python 制作 GitHub 消息助手的資料請關註WalkonNet其它相關文章！

推薦閱讀：