python 單一程式例項實現

whatday發表於2020-10-01

一、說明

之前寫了“Linux shell指令碼單例項模式實現”，python也是日常需要使用的，所以也想來看python中如何實現。

一方面，shell中沒有類和類例項的概念，所以一般說“單例項”都是指“單程式例項”，沒有設計模式中“單例”的概念；另一方面，由於單程式例項和單例都是強調“唯一一份”所以在長時間裡以為他們是相同的一個東西，和shell一樣籠統地稱為單例項就好了。

但現在看來他們不是一回事，“單程式例項”討論的環境是整個記憶體、面向的物件是檔案、結果是要麼幹掉原來的程式新啟一個程式要麼結束當前的程式保留原來的程式。

“單例模式”討論的環境是一個程式內、面向的物件是類，結果是不管你在哪、呼叫多少次返回的都是同一個類例項。也就是說，如果是不同程式，那麼是可以返回不同的類例項的（應該說就沒法返回相同的類例項）。

二、單程式例項實現

2.1 Linux平臺實現--使用標準庫fcntl

linux平臺可以通過python標準庫fcntl來實現鎖

import os
import time
import fcntl

class Test():
    # 此函式用於獲取鎖
    def _get_lock(self):
        file_name = os.path.basename(__file__)
        # 為了統一按linux的習慣放到/var/run目錄去
        lock_file_name = f"/var/run/{file_name}.pid"
        # 是讀還是寫還是什麼模式並不重要，因為只是看能不能獲取檔案鎖而不一定要寫入內容
        # 但是這個一定要是成員變數self.fd而不能是區域性變數fd
        # 因為實際發現當python發現區域性變數fd不再使用時會將其回收，這就導致後邊再執行時都能獲取到鎖
        self.fd = open(lock_file_name, "w")
        try:
            # #define LOCK_SH 1 /* Shared lock.  */   共享鎖
            # #define LOCK_EX 2   /* Exclusive lock.  */ 互斥鎖
            # #define LOCK_UN 8 /* Unlock.  */ 解鎖
            # LOCK_NB--非阻塞模式。
            # 阻塞模式--獲取不到鎖時一直等待
            # 非阻塞模式--獲取不到鎖，直接丟擲異常
            fcntl.flock(self.fd, fcntl.LOCK_EX | fcntl.LOCK_NB)
            # 將當前程式號寫入檔案
            # 如果獲取不到鎖上一步就已經異常了，所以不用擔心覆蓋
            self.fd.writelines(str(os.getpid()))
            # 寫入的資料太少，預設會先被放在緩衝區，我們強制同步寫入到檔案
            self.fd.flush()
        except:
            print(f"{file_name} have another instance running.")
            exit(1)

    def __init__(self):
        self._get_lock()

    def hello_world(self):
        print("hello world!")
        time.sleep(30)

    # 從觀察到的現像看，佔用鎖的程式被關閉後，鎖也就自動釋放了
    # 也就是說，其實並不需要在最後自己主動釋放鎖
    def __del__(self):
        fcntl.flock(self.fd, fcntl.LOCK_UN)

if __name__ == "__main__":
    obj = Test()
    obj.hello_world()

2.2 通用平臺實現--使用第三方庫portalocker

安裝方法：pip install portalocker

pypi地址：https://pypi.org/project/portalocker/

github地址：https://github.com/WoLpH/portalocker

import os
import time
import portalocker

class Test():
    def _get_lock(self):
        file_name = os.path.basename(__file__)
        # linux等平臺依然使用標準的/var/run，其他nt等平臺使用當前目錄
        if os.name == "posix":
            lock_file_name = f"/var/run/{file_name}.pid"
        else:
            lock_file_name = f"{file_name}.pid"
        self.fd = open(lock_file_name, "w")
        try:
            portalocker.lock(self.fd, portalocker.LOCK_EX | portalocker.LOCK_NB)
            # 將當前程式號寫入檔案
            # 如果獲取不到鎖上一步就已經異常了，所以不用擔心覆蓋
            self.fd.writelines(str(os.getpid()))
            # 寫入的資料太少，預設會先被放在緩衝區，我們強制同步寫入到檔案
            self.fd.flush()
        except:
            print(f"{file_name} have another instance running.")
            exit(1)

    def __init__(self):
        self._get_lock()

    def hello_world(self):
        print("hello world!")
        time.sleep(30)
    
    # 和fcntl有點區別，portalocker釋放鎖直接有unlock()方法
    # 還是一樣，其實並不需要在最後自己主動釋放鎖
    def __del__(self):
        portalocker.unlock(self.fd)


if __name__ == "__main__":
    obj = Test()
    obj.hello_world()

三、單例模式實現

3.1 單例模式示例程式碼

import time
import threading
import datetime


class Singleton:
    _instance_lock = threading.Lock()

    def __init__(self):
        pass

    def __new__(cls, *args, **kwargs):
        if not hasattr(Singleton, "_instance"):
            with Singleton._instance_lock:
                if not hasattr(Singleton, "_instance"):
                    Singleton._instance = super(Singleton, cls).__new__(cls, *args, **kwargs)
        return Singleton._instance

    def main_logic(self):
        # 列印自己及當前時間
        print(f"instance--{self}\n"
              f"now time--{datetime.datetime.now().strftime('%H:%M:%S')}")
        time.sleep(10)

if __name__ == "__main__":
    obj1 = Singleton()
    obj2 = Singleton()
    obj1.main_logic()
    obj2.main_logic()