Як надрукувати на stderr в Python?

Існує кілька способів написання на stderr:

# Note: this first one does not work in Python 3
print >> sys.stderr, "spam"

sys.stderr.write("spam\n")

os.write(2, b"spam\n")

from __future__ import print_function
print("spam", file=sys.stderr)

Це, здається, суперечить дзену Python # 13 ^† , тож яка різниця тут і чи є якісь переваги чи недоліки в той чи інший спосіб? Який спосіб слід використовувати?

^† _{Має бути один - і бажано лише один - очевидний спосіб зробити це.}

Я виявив, що це єдиний короткий + гнучкий + портативний + читабельний:

from __future__ import print_function
import sys

def eprint(*args, **kwargs):
    print(*args, file=sys.stderr, **kwargs)

Функцію eprintможна використовувати так само, як і стандартну printфункцію:

>>> print("Test")
Test
>>> eprint("Test")
Test
>>> eprint("foo", "bar", "baz", sep="---")
foo---bar---baz

import sys
sys.stderr.write()

Це мій вибір, просто більш читабельний і конкретно сказаний, що ви маєте намір зробити, і переноситься в різних версіях.

Редагувати: бути "пітонічним" - це третя думка для мене щодо читабельності та продуктивності ... з огляду на ці дві речі, якщо python 80% вашого коду буде пітонічним. розуміння списку - це «велика річ», яка використовується не так часто (читабельність).

print >> sys.stderr немає в Python3. http://docs.python.org/3.0/whatsnew/3.0.html говорить:

Old: print >> sys.stderr, "fatal error"
New: print("fatal error", file=sys.stderr)

Багатьом з нас здається дещо неприродно перенести призначення до кінця команди. Альтернатива

sys.stderr.write("fatal error\n")

виглядає більш об’єктно орієнтованим і елегантно переходить від загального до конкретного. Але зауважте, що writeце не заміна 1: 1 print.

Ніхто loggingще не згадував , але журнал був створений спеціально для передачі повідомлень про помилки. Основна конфігурація встановить запис обробника потоку в stderr.

Цей сценарій:

# foo.py
import logging

logging.basicConfig(format='%(message)s')
log = logging.getLogger(__name__)
log.warning('I print to stderr by default')
print('hello world')

має такий результат при запуску в командному рядку:

$ python3 foo.py > bar.txt
I print to stderr by default

і bar.txt буде містити "привіт світ", надрукований на stdout.

Для Python 2 мій вибір такий: print >> sys.stderr, 'spam' Тому що ви можете просто надрукувати списки / диски тощо, не перетворюючи їх у рядок. print >> sys.stderr, {'spam': 'spam'} замість: sys.stderr.write(str({'spam': 'spam'}))

Я зробив наступне за допомогою Python 3:

from sys import stderr

def print_err(*args, **kwargs):
    print(*args, file=stderr, **kwargs)

Тому тепер я можу додати аргументи ключових слів, наприклад, щоб уникнути повернення перевезення:

print_err("Error: end of the file reached. The word ", end='')
print_err(word, "was not found")

Я б сказав, що ваш перший підхід:

print >> sys.stderr, 'spam' 

це "Один. Очевидний спосіб зробити це". Інші не задовольняють правилу №1 ("Красиве краще, ніж потворне".)

Це буде імітувати стандартну функцію друку, але виводити на stderr

def print_err(*args):
    sys.stderr.write(' '.join(map(str,args)) + '\n')

У Python 3 можна просто використовувати print ():

print(*objects, sep=' ', end='\n', file=sys.stdout, flush=False)

майже поза коробкою:

import sys
print("Hello, world!", file=sys.stderr)

або:

from sys import stderr
print("Hello, world!", file=stderr)

Це прямо і не потрібно нічого включати sys.stderr.

EDIT В огляді я думаю, що потенційна плутанина із зміною sys.stderr та не бачення поведінки оновленою робить цю відповідь не такою вдалою, як просто використання простої функції, як вказували інші.

Використання часткового зберігає лише 1 рядок коду. Потенційна плутанина не варто зберігати 1 рядок коду.

оригінальний

Щоб зробити це ще простіше, ось версія, яка використовує "часткове", що є великою підмогою у функціях обгортання.

from __future__ import print_function
import sys
from functools import partial

error = partial(print, file=sys.stderr)

Потім ви використовуєте його так

error('An error occured!')

Ви можете перевірити, чи друкується на stderr, а не stdout, виконавши наступне (код надмірної версії від http://coreygoldberg.blogspot.com.au/2009/05/python-redirect-or-turn-off-stdout-and .html ):

# over-ride stderr to prove that this function works.
class NullDevice():
    def write(self, s):
        pass
sys.stderr = NullDevice()

# we must import print error AFTER we've removed the null device because
# it has been assigned and will not be re-evaluated.
# assume error function is in print_error.py
from print_error import error

# no message should be printed
error("You won't see this error!")

Мінусом цього є часткове присвоєння функції sys.stderr оберненій функції під час створення. Що означає, якщо пізніше перенаправити stderr, це не вплине на цю функцію. Якщо ви плануєте перенаправляти stderr, то використовуйте метод ** kwargs, згаданий aaguirre на цій сторінці.

Те саме стосується stdout:

print 'spam'
sys.stdout.write('spam\n')

Як зазначено в інших відповідях, друк пропонує досить інтерфейс, який часто зручніший (наприклад, для друку інформації про налагодження), в той час як запис швидше, а також може бути зручнішим, коли ви повинні форматувати вихід точно певним чином. Я б також розглядав можливість ремонту:

1. Пізніше ви можете вирішити переключитися між stdout / stderr та звичайним файлом.

2. синтаксис print () змінився в Python 3, тому, якщо вам потрібно підтримати обидві версії, write () може бути краще.

Я працюю в python 3.4.3. Я вирізаю невеликий текст, який показує, як я потрапив сюди:

[18:19 jsilverman@JSILVERMAN-LT7 pexpect]$ python3
>>> import sys
>>> print("testing", file=sys.stderr)
testing
>>>
[18:19 jsilverman@JSILVERMAN-LT7 pexpect]$ 

Це спрацювало? Спробуйте перенаправити stderr на файл і подивіться, що станеться:

[18:22 jsilverman@JSILVERMAN-LT7 pexpect]$ python3 2> /tmp/test.txt
>>> import sys
>>> print("testing", file=sys.stderr)
>>> [18:22 jsilverman@JSILVERMAN-LT7 pexpect]$
[18:22 jsilverman@JSILVERMAN-LT7 pexpect]$ cat /tmp/test.txt
Python 3.4.3 (default, May  5 2015, 17:58:45)
[GCC 4.9.2] on cygwin
Type "help", "copyright", "credits" or "license" for more information.
testing

[18:22 jsilverman@JSILVERMAN-LT7 pexpect]$

Ну, окрім того, що маленьке введення, яке дає вам питон, було розбито на stderr (куди б інакше він пішов?), Воно працює.

Якщо ви робите простий тест:

import time
import sys

def run1(runs):
    x = 0
    cur = time.time()
    while x < runs:
        x += 1
        print >> sys.stderr, 'X'
    elapsed = (time.time()-cur)
    return elapsed

def run2(runs):
    x = 0
    cur = time.time()
    while x < runs:
        x += 1
        sys.stderr.write('X\n')
        sys.stderr.flush()
    elapsed = (time.time()-cur)
    return elapsed

def compare(runs):
    sum1, sum2 = 0, 0
    x = 0
    while x < runs:
        x += 1
        sum1 += run1(runs)
        sum2 += run2(runs)
    return sum1, sum2

if __name__ == '__main__':
    s1, s2 = compare(1000)
    print "Using (print >> sys.stderr, 'X'): %s" %(s1)
    print "Using (sys.stderr.write('X'),sys.stderr.flush()):%s" %(s2)
    print "Ratio: %f" %(float(s1) / float(s2))

Ви побачите, що sys.stderr.write () стабільно в 1,81 рази швидше!

Якщо ви хочете вийти з програми через фатальну помилку, скористайтеся:

sys.exit("Your program caused a fatal error. ... description ...")

і import sysв заголовку.

Відповідь на питання: Існує різний спосіб друкувати stderr в python, але це залежить від 1.) яку версію python ми використовуємо 2.) який точний вихід ми хочемо.

Різниця між функцією запису друку та stderr: stderr : stderr (стандартна помилка) - це труба, яка вбудовується в кожну систему UNIX / Linux, коли ваша програма виходить з ладу і виводить інформацію про налагодження (як трекбек у Python), вона переходить до stderr труба.

print : print - це обгортка, яка форматує вхідні дані (вхід - це пробіл між аргументом та новим рядком в кінці), а потім викликає функцію запису заданого об'єкта, даний об'єкт за замовчуванням - sys.stdout, але ми можемо передайте файл, тобто ми також можемо надрукувати вхід у файл.

Python2: Якщо ми використовуємо python2, то

>>> import sys
>>> print "hi"
hi
>>> print("hi")
hi
>>> print >> sys.stderr.write("hi")
hi

Кінцева кома Python2 має в Python3 стати параметром, тому якщо ми використовуємо трейлісні коми, щоб уникнути нового рядка після друку, це в Python3 буде виглядати як print ('Текст для друку', end = ''), що є синтаксичною помилкою під Python2 .

http://python3porting.com/noconv.html

Якщо ми перевіримо той же сценарій вище в python3:

>>> import sys
>>> print("hi")
hi

Під Python 2.6 є майбутній імпорт, щоб зробити друк у функції. Отже, щоб уникнути помилок синтаксису та інших відмінностей, ми повинні запустити будь-який файл, у якому ми використовуємо print () з майбутнього імпорту print_function. Майбутнє імпорту працює тільки в Python 2.6 і пізніше, тому для Python 2.5 і вище у вас є два варіанти. Ви можете або перетворити більш складний друк на щось простіше, або ви можете використовувати окрему функцію друку, яка працює як під Python2, так і з Python3.

>>> from __future__ import print_function
>>> 
>>> def printex(*args, **kwargs):
...     print(*args, file=sys.stderr, **kwargs)
... 
>>> printex("hii")
hii
>>>

Випадок: зауважте, що sys.stderr.write () або sys.stdout.write () (stdout (стандартний вихід) - це труба, яка вбудована в кожну систему UNIX / Linux) - це не заміна друку, але так ми можемо використовувати його як альтернативу в деяких випадках. Друк - це обгортка, яка обертає вхід пробілом та новою лінією в кінці та використовує функцію запису для запису. Це причина sys.stderr.write () швидше.

Примітка: ми також можемо відстежувати та налагоджувати за допомогою журналу

#test.py
import logging
logging.info('This is the existing protocol.')
FORMAT = "%(asctime)-15s %(clientip)s %(user)-8s %(message)s"
logging.basicConfig(format=FORMAT)
d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}
logging.warning("Protocol problem: %s", "connection reset", extra=d)

https://docs.python.org/2/library/logging.html#logger-objects