Đảm bảo chỉ một phiên bản chương trình đang chạy

Có cách nào của Pythonic để chỉ có một phiên bản của chương trình đang chạy không?

Giải pháp hợp lý duy nhất mà tôi đưa ra là cố gắng chạy nó như một máy chủ trên một số cổng, sau đó chương trình thứ hai cố gắng liên kết với cùng một cổng - không thành công. Nhưng nó không thực sự là một ý tưởng tuyệt vời, có thể có thứ gì đó nhẹ hơn thế này?

(Hãy xem xét rằng chương trình dự kiến ​​sẽ bị lỗi đôi khi, tức là segfault - vì vậy những thứ như "tệp khóa" sẽ không hoạt động)

Đoạn mã sau sẽ thực hiện công việc, nó đa nền tảng và chạy trên Python 2.4-3.2. Tôi đã thử nghiệm nó trên Windows, OS X và Linux.

from tendo import singleton
me = singleton.SingleInstance() # will sys.exit(-1) if other instance is running

Phiên bản mã mới nhất có sẵn singleton.py . Vui lòng gửi lỗi ở đây .

Bạn có thể cài đặt xu hướng bằng một trong các phương pháp sau:

• easy_install tendo
• pip install tendo
• theo cách thủ công bằng cách tải xuống từ http://pypi.python.org/pypi/tendo

Giải pháp đơn giản, đa nền tảng , được tìm thấy trong một câu hỏi khác của zgoda :

import fcntl
import os
import sys

def instance_already_running(label="default"):
    """
    Detect if an an instance with the label is already running, globally
    at the operating system level.

    Using `os.open` ensures that the file pointer won't be closed
    by Python's garbage collector after the function's scope is exited.

    The lock will be released when the program exits, or could be
    released if the file pointer were closed.
    """

    lock_file_pointer = os.open(f"/tmp/instance_{label}.lock", os.O_WRONLY)

    try:
        fcntl.lockf(lock_file_pointer, fcntl.LOCK_EX | fcntl.LOCK_NB)
        already_running = False
    except IOError:
        already_running = True

    return already_running

Rất giống gợi ý của S.Lott, nhưng với mã.

Mã này dành riêng cho Linux. Nó sử dụng các ổ cắm miền UNIX 'trừu tượng', nhưng nó đơn giản và sẽ không để lại các tệp khóa cũ xung quanh. Tôi thích nó hơn giải pháp ở trên vì nó không yêu cầu một cổng TCP dành riêng.

try:
    import socket
    s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
    ## Create an abstract socket, by prefixing it with null. 
    s.bind( '\0postconnect_gateway_notify_lock') 
except socket.error as e:
    error_code = e.args[0]
    error_string = e.args[1]
    print "Process already running (%d:%s ). Exiting" % ( error_code, error_string) 
    sys.exit (0) 

Chuỗi duy nhất postconnect_gateway_notify_lockcó thể được thay đổi để cho phép nhiều chương trình cần một phiên bản duy nhất được thực thi.

Tôi không biết liệu nó có đủ khó hiểu hay không, nhưng trong thế giới Java, lắng nghe trên một cổng xác định là một giải pháp được sử dụng khá rộng rãi, vì nó hoạt động trên tất cả các nền tảng chính và không gặp bất kỳ vấn đề nào với các chương trình bị treo.

Một lợi thế khác của việc lắng nghe một cổng là bạn có thể gửi một lệnh đến phiên bản đang chạy. Ví dụ: khi người dùng khởi động chương trình lần thứ hai, bạn có thể gửi cho phiên bản đang chạy một lệnh để yêu cầu nó mở một cửa sổ khác (ví dụ như đó là những gì Firefox làm. Tôi không biết liệu họ có sử dụng cổng TCP hay các đường ống được đặt tên hay không một cái gì đó tương tự, 'mặc dù).

Chưa bao giờ viết python trước đây, nhưng đây là những gì tôi vừa triển khai trong mycheckpoint, để ngăn nó được khởi động hai lần hoặc nhiều hơn bởi crond:

import os
import sys
import fcntl
fh=0
def run_once():
    global fh
    fh=open(os.path.realpath(__file__),'r')
    try:
        fcntl.flock(fh,fcntl.LOCK_EX|fcntl.LOCK_NB)
    except:
        os._exit(0)

run_once()

Tìm thấy đề xuất của Slava-N sau khi đăng đề xuất này trong một số báo khác (http://stackoverflow.com/questions/2959474). Cái này được gọi là một hàm, khóa tệp kịch bản đang thực thi (không phải tệp pid) và duy trì khóa cho đến khi tập lệnh kết thúc (bình thường hoặc lỗi).

Sử dụng tệp pid. Bạn có một số vị trí đã biết, "/ path / to / pidfile" và khi khởi động, bạn làm điều gì đó như thế này (một phần là mã giả vì tôi là người chuẩn bị cà phê và không muốn làm việc chăm chỉ):

import os, os.path
pidfilePath = """/path/to/pidfile"""
if os.path.exists(pidfilePath):
   pidfile = open(pidfilePath,"r")
   pidString = pidfile.read()
   if <pidString is equal to os.getpid()>:
      # something is real weird
      Sys.exit(BADCODE)
   else:
      <use ps or pidof to see if the process with pid pidString is still running>
      if  <process with pid == 'pidString' is still running>:
          Sys.exit(ALREADAYRUNNING)
      else:
          # the previous server must have crashed
          <log server had crashed>
          <reopen pidfilePath for writing>
          pidfile.write(os.getpid())
else:
    <open pidfilePath for writing>
    pidfile.write(os.getpid())

Vì vậy, nói cách khác, bạn đang kiểm tra xem pidfile có tồn tại hay không; nếu không, hãy ghi pid của bạn vào tệp đó. Nếu pidfile tồn tại, hãy kiểm tra xem pid có phải là pid của một tiến trình đang chạy hay không; nếu vậy, thì bạn có một tiến trình trực tiếp khác đang chạy, vì vậy chỉ cần tắt. Nếu không, thì quá trình trước đó đã bị lỗi, vì vậy hãy ghi lại nó, sau đó ghi pid của riêng bạn vào tệp thay cho tệp cũ. Sau đó tiếp tục.

Bạn đã tìm thấy câu trả lời cho câu hỏi tương tự trong một chuỗi khác, vì vậy, vì lợi ích của sự đầy đủ, hãy xem cách đạt được điều tương tự trên Windows uning có tên mutex.

http://code.activestate.com/recipes/474070/

Điều này có thể hoạt động.

1. Cố gắng tạo tệp PID đến một vị trí đã biết. Nếu bạn thất bại, ai đó đã khóa tệp, bạn đã hoàn tất.

2. Khi bạn hoàn tất bình thường, hãy đóng và xóa tệp PID để người khác có thể ghi đè lên.

Bạn có thể bọc chương trình của mình trong một tập lệnh shell loại bỏ tệp PID ngay cả khi chương trình của bạn bị lỗi.

Bạn cũng có thể sử dụng tệp PID để giết chương trình nếu nó bị treo.

Sử dụng tệp khóa là một cách tiếp cận khá phổ biến trên unix. Nếu nó bị treo, bạn phải dọn dẹp thủ công. Bạn có thể đánh dấu PID trong tệp và khi khởi động, hãy kiểm tra xem có quá trình nào xảy ra với PID này hay không, ghi đè tệp khóa nếu không. (Tuy nhiên, bạn cũng cần có một khóa xung quanh read-file-check-pid-rewrite-file). Bạn sẽ tìm thấy những gì bạn cần để nhận và kiểm tra pid trong os -package. Cách phổ biến để kiểm tra xem có tồn tại một quá trình với một pid nhất định hay không là gửi cho nó một tín hiệu không gây tử vong.

Các lựa chọn thay thế khác có thể là kết hợp điều này với các bán kết đàn hoặc posix.

Mở một ổ cắm mạng, như saua đã đề xuất, có lẽ sẽ là cách dễ nhất và dễ di chuyển nhất.

Đối với bất kỳ ai sử dụng wxPython cho ứng dụng của họ, bạn có thể sử dụng chức năng được wx.SingleInstanceChecker ghi ở đây .

Cá nhân tôi sử dụng một lớp con wx.Appsử dụng wx.SingleInstanceCheckervà trả về Falsetừ OnInit()đó nếu có một phiên bản hiện tại của ứng dụng đã thực thi như vậy:

import wx

class SingleApp(wx.App):
    """
    class that extends wx.App and only permits a single running instance.
    """

    def OnInit(self):
        """
        wx.App init function that returns False if the app is already running.
        """
        self.name = "SingleApp-%s".format(wx.GetUserId())
        self.instance = wx.SingleInstanceChecker(self.name)
        if self.instance.IsAnotherRunning():
            wx.MessageBox(
                "An instance of the application is already running", 
                "Error", 
                 wx.OK | wx.ICON_WARNING
            )
            return False
        return True

Đây là một thay thế đơn giản để wx.Appcấm nhiều trường hợp. Để sử dụng nó, chỉ cần thay thế wx.Appbằng SingleApptrong mã của bạn như sau:

app = SingleApp(redirect=False)
frame = wx.Frame(None, wx.ID_ANY, "Hello World")
frame.Show(True)
app.MainLoop()

Đây là giải pháp cuối cùng chỉ dành cho Windows của tôi. Đặt phần sau vào một mô-đun, có thể được gọi là 'onlyone.py', hoặc bất cứ thứ gì. Đưa mô-đun đó trực tiếp vào tệp tập lệnh python __ main __ của bạn.

import win32event, win32api, winerror, time, sys, os
main_path = os.path.abspath(sys.modules['__main__'].__file__).replace("\\", "/")

first = True
while True:
        mutex = win32event.CreateMutex(None, False, main_path + "_{<paste YOUR GUID HERE>}")
        if win32api.GetLastError() == 0:
            break
        win32api.CloseHandle(mutex)
        if first:
            print "Another instance of %s running, please wait for completion" % main_path
            first = False
        time.sleep(1)

Giải trình

Mã cố gắng tạo mutex với tên bắt nguồn từ đường dẫn đầy đủ đến tập lệnh. Chúng tôi sử dụng dấu gạch chéo về phía trước để tránh sự nhầm lẫn tiềm ẩn với hệ thống tệp thực.

Ưu điểm

• Không cần cấu hình hoặc mã định danh 'ma thuật', sử dụng nó trong nhiều tập lệnh khác nhau nếu cần.
• Không còn tệp cũ nào, mutex sẽ chết theo bạn.
• In một tin nhắn hữu ích khi chờ đợi

Giải pháp tốt nhất cho việc này trên windows là sử dụng mutexes theo đề xuất của @zgoda.

import win32event
import win32api
from winerror import ERROR_ALREADY_EXISTS

mutex = win32event.CreateMutex(None, False, 'name')
last_error = win32api.GetLastError()

if last_error == ERROR_ALREADY_EXISTS:
   print("App instance already running")

Một số câu trả lời sử dụng fctnl(cũng được bao gồm trong gói @sorin tenso) không có sẵn trên windows và nếu bạn cố gắng đóng băng ứng dụng python của mình bằng cách sử dụng một gói giống như pyinstallerthực hiện nhập tĩnh, nó sẽ gây ra lỗi.

Ngoài ra, bằng cách sử dụng phương pháp tệp khóa, sẽ tạo ra sự read-onlycố với tệp cơ sở dữ liệu (gặp phải vấn đề này với sqlite3).

Tôi đăng bài này như một câu trả lời vì tôi là người dùng mới và Stack Overflow sẽ không cho phép tôi bỏ phiếu.

Giải pháp của Sorin Sbarnea phù hợp với tôi trên OS X, Linux và Windows, và tôi rất biết ơn vì nó.

Tuy nhiên, tempfile.gettempdir () hoạt động theo một cách trong OS X và Windows và một cách khác trong một số / nhiều / tất cả (?) * Nixes khác (bỏ qua thực tế rằng OS X cũng là Unix!). Sự khác biệt là quan trọng đối với mã này.

OS X và Windows có các thư mục tạm thời dành riêng cho người dùng, vì vậy tệp tạm thời do một người dùng tạo sẽ không hiển thị với người dùng khác. Ngược lại, trong nhiều phiên bản * nix (tôi đã thử nghiệm Ubuntu 9, RHEL 5, OpenSolaris 2008 và FreeBSD 8), dir tạm thời là / tmp cho tất cả người dùng.

Điều đó có nghĩa là khi tệp khóa được tạo trên máy nhiều người dùng, tệp này được tạo trong / tmp và chỉ người dùng tạo tệp khóa lần đầu tiên mới có thể chạy ứng dụng.

Một giải pháp khả thi là nhúng tên người dùng hiện tại vào tên của tệp khóa.

Cần lưu ý rằng giải pháp lấy cổng của OP cũng sẽ hoạt động sai trên máy nhiều người dùng.

Tôi sử dụng single_processtrên gentoo của mình;

pip install single_process

ví dụ :

from single_process import single_process

@single_process
def main():
    print 1

if __name__ == "__main__":
    main()   

tham khảo: https://pypi.python.org/pypi/single_process/1.0

Tôi tiếp tục nghi ngờ rằng phải có một giải pháp POSIXy tốt bằng cách sử dụng các nhóm quy trình, mà không cần phải nhấn vào hệ thống tệp, nhưng tôi không thể hoàn thành nó. Cái gì đó như:

Khi khởi động, quy trình của bạn sẽ gửi 'kill -0' đến tất cả các quy trình trong một nhóm cụ thể. Nếu bất kỳ quá trình nào như vậy tồn tại, nó sẽ thoát. Sau đó, nó tham gia vào nhóm. Không có quy trình nào khác sử dụng nhóm đó.

Tuy nhiên, điều này có một điều kiện về cuộc đua - nhiều quy trình có thể thực hiện điều này chính xác cùng một lúc và tất cả đều kết thúc tham gia nhóm và chạy đồng thời. Khi bạn đã thêm một số loại mutex để làm cho nó kín nước, bạn không cần các nhóm quy trình nữa.

Điều này có thể chấp nhận được nếu quy trình của bạn chỉ được bắt đầu bằng cron, một lần mỗi phút hoặc mỗi giờ, nhưng điều đó khiến tôi hơi lo lắng rằng nó sẽ sai chính xác vào ngày mà bạn không muốn.

Tôi đoán rằng đây không phải là một giải pháp rất tốt, trừ khi ai đó có thể cải thiện nó?

Tôi đã gặp phải vấn đề chính xác này vào tuần trước và mặc dù tôi đã tìm thấy một số giải pháp tốt, tôi quyết định tạo một gói python rất đơn giản và sạch sẽ và tải nó lên PyPI. Nó khác với tenso ở chỗ nó có thể khóa bất kỳ tên tài nguyên chuỗi nào. Mặc dù bạn chắc chắn có thể khóa__file__ để đạt được hiệu quả tương tự.

Cài đặt bằng: pip install quicklock

Sử dụng nó rất đơn giản:

[nate@Nates-MacBook-Pro-3 ~/live] python
Python 2.7.6 (default, Sep  9 2014, 15:04:36)
[GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.39)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from quicklock import singleton
>>> # Let's create a lock so that only one instance of a script will run
...
>>> singleton('hello world')
>>>
>>> # Let's try to do that again, this should fail
...
>>> singleton('hello world')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/nate/live/gallery/env/lib/python2.7/site-packages/quicklock/quicklock.py", line 47, in singleton
    raise RuntimeError('Resource <{}> is currently locked by <Process {}: "{}">'.format(resource, other_process.pid, other_process.name()))
RuntimeError: Resource <hello world> is currently locked by <Process 24801: "python">
>>>
>>> # But if we quit this process, we release the lock automatically
...
>>> ^D
[nate@Nates-MacBook-Pro-3 ~/live] python
Python 2.7.6 (default, Sep  9 2014, 15:04:36)
[GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.39)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from quicklock import singleton
>>> singleton('hello world')
>>>
>>> # No exception was thrown, we own 'hello world'!

Hãy xem: https://pypi.python.org/pypi/quicklock

Dựa trên câu trả lời của Roberto Rosario, tôi đưa ra chức năng sau:

SOCKET = None
def run_single_instance(uniq_name):
    try:
        import socket
        global SOCKET
        SOCKET = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
        ## Create an abstract socket, by prefixing it with null.
        # this relies on a feature only in linux, when current process quits, the
        # socket will be deleted.
        SOCKET.bind('\0' + uniq_name)
        return True
    except socket.error as e:
        return False

Chúng ta cần xác định toàn cục SOCKETcó thể có được vì nó sẽ chỉ được thu thập rác khi toàn bộ quá trình thoát. Nếu chúng ta khai báo một biến cục bộ trong hàm, nó sẽ vượt ra khỏi phạm vi sau khi hàm thoát ra, do đó socket sẽ bị xóa.

Tất cả tín dụng sẽ thuộc về Roberto Rosario, vì tôi chỉ làm rõ và chi tiết về mã của anh ấy. Và mã này sẽ chỉ hoạt động trên Linux, như văn bản được trích dẫn sau đây từ https://troydhanson.github.io/network/Unix_domain_sockets.html giải thích:

Linux có một tính năng đặc biệt: nếu tên đường dẫn cho ổ cắm miền UNIX bắt đầu bằng byte rỗng \ 0, tên của nó sẽ không được ánh xạ vào hệ thống tệp. Vì vậy, nó sẽ không va chạm với các tên khác trong hệ thống tệp. Ngoài ra, khi máy chủ đóng ổ cắm lắng nghe miền UNIX của nó trong không gian tên trừu tượng, tệp của nó sẽ bị xóa; với các ổ cắm miền UNIX thông thường, tệp vẫn tồn tại sau khi máy chủ đóng nó.

ví dụ linux

Phương pháp này dựa trên việc tạo một tệp tạm thời tự động bị xóa sau khi bạn đóng ứng dụng. chương trình khởi chạy chúng tôi xác minh sự tồn tại của tệp; nếu tệp tồn tại (có một thực thi đang chờ xử lý), chương trình bị đóng; nếu không, nó sẽ tạo tệp và tiếp tục thực hiện chương trình.

from tempfile import *
import time
import os
import sys


f = NamedTemporaryFile( prefix='lock01_', delete=True) if not [f  for f in     os.listdir('/tmp') if f.find('lock01_')!=-1] else sys.exit()

YOUR CODE COMES HERE

Trên hệ thống Linux, người ta cũng có thể yêu cầu pgrep -asố lượng phiên bản, tập lệnh được tìm thấy trong danh sách quy trình (tùy chọn -a hiển thị chuỗi dòng lệnh đầy đủ). Ví dụ

import os
import sys
import subprocess

procOut = subprocess.check_output( "/bin/pgrep -u $UID -a python", shell=True, 
                                   executable="/bin/bash", universal_newlines=True)

if procOut.count( os.path.basename(__file__)) > 1 :        
    sys.exit( ("found another instance of >{}<, quitting."
              ).format( os.path.basename(__file__)))

Xóa -u $UIDnếu hạn chế áp dụng cho tất cả người dùng. Tuyên bố từ chối trách nhiệm: a) giả định rằng tên (cơ sở) của tập lệnh là duy nhất, b) có thể có các điều kiện chủng tộc.

import sys,os

# start program
try:  # (1)
    os.unlink('lock')  # (2)
    fd=os.open("lock", os.O_CREAT|os.O_EXCL) # (3)  
except: 
    try: fd=os.open("lock", os.O_CREAT|os.O_EXCL) # (4) 
    except:  
        print "Another Program running !.."  # (5)
        sys.exit()  

# your program  ...
# ...

# exit program
try: os.close(fd)  # (6)
except: pass
try: os.unlink('lock')  
except: pass
sys.exit()