파이썬 파일입출력과 filelock으로 단일 인스턴스 실행 보장하는 방법

📂 파이썬 파일입출력 기본 개념

파이썬에서 파일입출력은 데이터를 저장하거나 불러오는 가장 기본적인 작업입니다.
텍스트 파일, 로그 파일, 설정 파일 등 다양한 목적의 파일을 생성하고 수정할 수 있으며, 이러한 기능은 자동화 스크립트와 데이터 처리 과정에서 매우 중요한 역할을 합니다.

파일을 다루기 위해서는 먼저 open() 함수를 사용합니다.
이 함수는 파일을 열고, 파일 객체를 반환하여 읽기(read), 쓰기(write), 추가(append) 모드로 활용할 수 있게 합니다.
작업이 끝나면 close() 메서드를 호출해 파일을 닫아야 자원 누수를 방지할 수 있습니다.

📖 기본적인 파일 열기 모드

💻 with 문을 이용한 안전한 파일 처리

파일을 열고 닫는 과정을 자동으로 관리해주는 with 문을 사용하면 코드가 더욱 깔끔해지고 예외 발생 시에도 안전하게 파일이 닫힙니다.

# 텍스트 파일 쓰기
with open("example.txt", "w", encoding="utf-8") as f:
    f.write("Hello, Python!")

# 텍스트 파일 읽기
with open("example.txt", "r", encoding="utf-8") as f:
    content = f.read()
    print(content)

📝 파일입출력의 대표적인 활용 예제

파일입출력은 단순히 텍스트를 저장하는 용도에 그치지 않고, 프로그램의 실행 결과를 기록하거나 데이터 교환의 수단으로도 자주 사용됩니다.
특히 자동화된 환경에서는 로그 파일 기록, 사용자 데이터 저장, 설정 파일 관리 등 다양한 작업에서 활용됩니다.

📊 로그 파일 작성

프로그램이 실행되는 동안 발생하는 이벤트를 기록하기 위해 로그 파일을 작성합니다.
이를 통해 오류 추적이나 성능 분석이 가능하며, 유지보수 과정에서 중요한 자료로 활용됩니다.

import datetime

with open("log.txt", "a", encoding="utf-8") as f:
    f.write(f"[{datetime.datetime.now()}] 프로그램 실행\n")

⚙️ 설정 파일 다루기

프로그램 실행 환경에 따라 경로, 사용자 계정, API 키 등을 저장할 때 텍스트 기반의 설정 파일을 많이 사용합니다.
보통 JSON 형식을 이용해 직관적으로 데이터를 읽고 쓰도록 합니다.

import json

config = {
    "user": "admin",
    "api_key": "12345"
}

# 쓰기
with open("config.json", "w", encoding="utf-8") as f:
    json.dump(config, f, indent=4)

# 읽기
with open("config.json", "r", encoding="utf-8") as f:
    data = json.load(f)
    print(data)

📂 데이터 저장 및 불러오기

데이터 분석이나 머신러닝 같은 작업에서는 대량의 데이터를 주고받아야 하므로 CSV 파일 형태로 저장하고 불러오는 경우가 많습니다.
파이썬에서는 csv 모듈을 통해 손쉽게 처리할 수 있습니다.

import csv

# CSV 쓰기
with open("data.csv", "w", newline="", encoding="utf-8") as f:
    writer = csv.writer(f)
    writer.writerow(["이름", "나이"])
    writer.writerow(["홍길동", 30])

# CSV 읽기
with open("data.csv", "r", encoding="utf-8") as f:
    reader = csv.reader(f)
    for row in reader:
        print(row)

🔒 filelock 라이브러리 소개

파일입출력을 다룰 때 동시에 여러 인스턴스가 실행되면 동일한 파일을 동시에 접근하여 데이터가 손상되거나 예기치 못한 충돌이 발생할 수 있습니다.
이를 방지하기 위해 사용하는 대표적인 도구가 바로 filelock 라이브러리입니다.

filelock은 파이썬에서 간단히 파일 기반의 잠금(lock)을 구현할 수 있는 경량 라이브러리로, 멀티 프로세스 환경에서 단일 실행을 보장하는데 효과적입니다.
플랫폼 독립적으로 동작하며, Windows와 Linux, macOS 모두에서 안정적으로 사용할 수 있습니다.

⚡ 설치 방법

filelock은 PyPI에 등록되어 있으므로 간단히 pip 명령어로 설치할 수 있습니다.

pip install filelock

📌 기본 사용 예제

filelock을 사용하면 특정 파일에 대해 잠금을 설정하여 동시에 여러 프로세스가 접근하는 것을 차단할 수 있습니다.

from filelock import FileLock

lock = FileLock("example.lock")

with lock:
    print("Lock이 걸린 상태에서 안전하게 실행됩니다.")
    # 파일에 쓰기 작업 등 안전한 작업 수행

⏱️ timeout 옵션 활용

timeout을 지정하면 일정 시간 동안만 lock을 기다린 후, 획득하지 못하면 예외를 발생시킵니다.

from filelock import Timeout, FileLock

lock = FileLock("example.lock", timeout=3)

try:
    with lock:
        print("단일 실행 성공")
except Timeout:
    print("이미 다른 인스턴스가 실행 중입니다.")

⚙️ filelock으로 단일 인스턴스 실행 보장하기

서버 관리 스크립트나 데이터 백업 프로그램처럼 동시에 여러 번 실행되면 문제가 생기는 작업은 반드시 단일 인스턴스 실행을 보장해야 합니다.
이때 filelock을 이용하면 손쉽게 충돌을 방지할 수 있습니다.

🔧 단일 인스턴스 실행 패턴

가장 기본적인 방법은 프로그램 시작 시 lock 파일을 생성하고, 해당 파일이 해제되기 전까지 다른 프로세스는 실행되지 못하게 하는 것입니다.

from filelock import Timeout, FileLock

lock = FileLock("script.lock", timeout=2)

try:
    with lock:
        print("이 스크립트는 단일 인스턴스로 실행됩니다.")
        # 실제 작업 실행
except Timeout:
    print("⚠️ 이미 다른 프로세스가 실행 중입니다.")

📌 실제 활용 예시

예를 들어, 로그 수집기(log collector)가 동시에 여러 개 실행되면 동일한 로그 파일을 덮어쓰거나 충돌을 일으킬 수 있습니다.
이때 filelock으로 실행을 제어하면 충돌을 방지할 수 있습니다.

import time
from filelock import Timeout, FileLock

lock = FileLock("collector.lock", timeout=3)

try:
    with lock:
        for i in range(5):
            print("로그 수집 중...")
            time.sleep(1)
except Timeout:
    print("다른 로그 수집기가 실행 중입니다.")

📌 lockfile 경로 설정과 주의사항

filelock을 사용할 때 가장 중요한 부분 중 하나는 lockfile 경로 설정입니다.
경로를 적절히 설정하지 않으면 잠금 파일이 올바르게 동작하지 않거나 권한 문제로 인해 에러가 발생할 수 있습니다.

📂 lockfile 위치 지정하기

보통 lock 파일은 프로젝트 디렉토리나 임시 디렉토리(/tmp 또는 C:\\Temp)에 생성합니다.
파일 이름은 명확하게 지정하는 것이 좋으며, 여러 스크립트가 동일한 이름의 lockfile을 사용할 경우 충돌이 발생할 수 있습니다.

from filelock import FileLock
import os
import tempfile

# 임시 디렉토리에 lockfile 생성
lock_path = os.path.join(tempfile.gettempdir(), "my_script.lock")
lock = FileLock(lock_path, timeout=2)

with lock:
    print(f"{lock_path} 경로에서 단일 인스턴스로 실행 중")

⚠️ 주의사항

• 🛠️공유 네트워크 드라이브에 lockfile을 두는 것은 피해야 합니다. 네트워크 지연으로 인해 올바르게 동작하지 않을 수 있습니다.
• ⚙️운영체제 권한 문제를 고려해, 일반 사용자 계정으로 접근 가능한 디렉토리에 lockfile을 두는 것이 안전합니다.
• 🔌lockfile이 예상치 못하게 삭제되면 다른 프로세스가 동시에 실행될 수 있으므로, 정리(clean-up) 로직을 고려하는 것이 좋습니다.

❓ 자주 묻는 질문 (FAQ)