จะจับเอาท์พุท stdout จากการเรียกฟังก์ชัน Python ได้อย่างไร

ฉันใช้ไลบรารี Python ที่ทำอะไรบางอย่างกับวัตถุ

do_something(my_object)

และเปลี่ยนแปลงมัน ในขณะที่ทำเช่นนั้นมันพิมพ์สถิติบางอย่างเพื่อ stdout และฉันต้องการที่จะเข้าใจข้อมูลนี้ วิธีแก้ปัญหาที่เหมาะสมคือการเปลี่ยนdo_something()เพื่อส่งคืนข้อมูลที่เกี่ยวข้อง

out = do_something(my_object)

แต่จะต้องใช้เวลาสักพักก่อนที่ผู้พัฒนาdo_something()จะเข้าสู่ปัญหานี้ เป็นวิธีแก้ปัญหาชั่วคราวฉันคิดถึงการแยกวิเคราะห์สิ่งที่do_something()เขียนถึง stdout

ฉันจะจับเอาท์พุท stdout ระหว่างสองจุดในโค้ดได้อย่างไรเช่น

start_capturing()
do_something(my_object)
out = end_capturing()

เหรอ?

ลองใช้ตัวจัดการบริบทนี้:

from io import StringIO 
import sys

class Capturing(list):
    def __enter__(self):
        self._stdout = sys.stdout
        sys.stdout = self._stringio = StringIO()
        return self
    def __exit__(self, *args):
        self.extend(self._stringio.getvalue().splitlines())
        del self._stringio    # free up some memory
        sys.stdout = self._stdout

การใช้งาน:

with Capturing() as output:
    do_something(my_object)

output ตอนนี้เป็นรายการที่มีบรรทัดที่พิมพ์โดยการเรียกใช้ฟังก์ชัน

การใช้งานขั้นสูง:

สิ่งที่อาจไม่ชัดเจนคือสามารถทำได้มากกว่าหนึ่งครั้งและผลลัพธ์ที่เชื่อมต่อกัน:

with Capturing() as output:
    print('hello world')

print('displays on screen')

with Capturing(output) as output:  # note the constructor argument
    print('hello world2')

print('done')
print('output:', output)

เอาท์พุต:

displays on screen                     
done                                   
output: ['hello world', 'hello world2']

ปรับปรุง : พวกเขาเพิ่มredirect_stdout()ไปcontextlibในหลาม 3.4 (พร้อมด้วยredirect_stderr()) ดังนั้นคุณสามารถใช้io.StringIOเพื่อให้ได้ผลลัพธ์ที่คล้ายกัน (แม้ว่าCapturingการเป็นรายการและตัวจัดการบริบทจะสะดวกกว่า)

ใน python> = 3.4 contextlib มีredirect_stdoutมัณฑนากร สามารถใช้เพื่อตอบคำถามของคุณดังนี้:

import io
from contextlib import redirect_stdout

f = io.StringIO()
with redirect_stdout(f):
    do_something(my_object)
out = f.getvalue()

จากเอกสาร :

ตัวจัดการบริบทสำหรับการเปลี่ยนทิศทาง sys.stdout ชั่วคราวไปยังไฟล์อื่นหรือวัตถุที่คล้ายไฟล์

เครื่องมือนี้เพิ่มความยืดหยุ่นให้กับฟังก์ชันหรือคลาสที่มีอยู่ซึ่งเอาต์พุตเป็นแบบเดินสายไปยัง stdout

ตัวอย่างเช่นผลลัพธ์ของ help () โดยปกติจะถูกส่งไปที่ sys.stdout คุณสามารถจับเอาท์พุทนั้นเป็นสตริงโดยเปลี่ยนทิศทางเอาต์พุตไปยังอ็อบเจ็กต์ io.StringIO:

  f = io.StringIO() 
  with redirect_stdout(f):
      help(pow) 
  s = f.getvalue()

ในการส่งผลลัพธ์ของ help () ไปยังไฟล์บนดิสก์ให้เปลี่ยนทิศทางผลลัพธ์ไปยังไฟล์ปกติ:

 with open('help.txt', 'w') as f:
     with redirect_stdout(f):
         help(pow)

ในการส่งผลลัพธ์ของ help () ไปยัง sys.stderr:

with redirect_stdout(sys.stderr):
    help(pow)

โปรดทราบว่าผลข้างเคียงทั่วโลกบน sys.stdout หมายความว่าตัวจัดการบริบทนี้ไม่เหมาะสำหรับใช้ในไลบรารีโค้ดและแอปพลิเคชันเธรดส่วนใหญ่ นอกจากนี้ยังไม่มีผลกับเอาต์พุตของกระบวนการย่อย อย่างไรก็ตามยังคงเป็นแนวทางที่มีประโยชน์สำหรับสคริปต์ยูทิลิตี้จำนวนมาก

ตัวจัดการบริบทนี้ reentrant

นี่คือโซลูชัน async โดยใช้ file ไปป์

import threading
import sys
import os

class Capturing():
    def __init__(self):
        self._stdout = None
        self._stderr = None
        self._r = None
        self._w = None
        self._thread = None
        self._on_readline_cb = None

    def _handler(self):
        while not self._w.closed:
            try:
                while True:
                    line = self._r.readline()
                    if len(line) == 0: break
                    if self._on_readline_cb: self._on_readline_cb(line)
            except:
                break

    def print(self, s, end=""):
        print(s, file=self._stdout, end=end)

    def on_readline(self, callback):
        self._on_readline_cb = callback

    def start(self):
        self._stdout = sys.stdout
        self._stderr = sys.stderr
        r, w = os.pipe()
        r, w = os.fdopen(r, 'r'), os.fdopen(w, 'w', 1)
        self._r = r
        self._w = w
        sys.stdout = self._w
        sys.stderr = self._w
        self._thread = threading.Thread(target=self._handler)
        self._thread.start()

    def stop(self):
        self._w.close()
        if self._thread: self._thread.join()
        self._r.close()
        sys.stdout = self._stdout
        sys.stderr = self._stderr

ตัวอย่างการใช้งาน:

from Capturing import *
import time

capturing = Capturing()

def on_read(line):
    # do something with the line
    capturing.print("got line: "+line)

capturing.on_readline(on_read)
capturing.start()
print("hello 1")
time.sleep(1)
print("hello 2")
time.sleep(1)
print("hello 3")
capturing.stop()