Apakah laporan kemajuan / informasi logging milik stderr atau stdout?

Apakah ada POSIX, GNU resmi, atau pedoman lain di mana laporan kemajuan dan informasi logging (hal-hal seperti "Melakukan foo; foo dilakukan") harus dicetak? Secara pribadi, saya cenderung menulisnya ke stderr sehingga saya bisa mengarahkan ulang stdout dan hanya mendapatkan output aktual program. Saya baru-baru ini diberitahu bahwa ini bukan praktik yang baik karena laporan kemajuan sebenarnya bukan kesalahan dan hanya pesan kesalahan yang harus dicetak ke stderr.

Kedua posisi tersebut masuk akal, dan tentu saja Anda dapat memilih satu atau yang lain tergantung pada rincian apa yang Anda lakukan, tetapi saya ingin tahu apakah ada standar yang berlaku umum untuk ini. Saya belum dapat menemukan aturan khusus dalam POSIX, standar pengkodean GNU, atau daftar praktik terbaik lainnya yang diterima secara luas.

Kami memiliki beberapa pertanyaan serupa, tetapi mereka tidak membahas masalah yang tepat ini:

• Kapan harus menggunakan pengalihan ke stderr dalam skrip shell : Jawaban yang diterima menyarankan apa yang saya cenderung lakukan, menjaga hasil akhir program pada stdout dan apa pun ke stderr. Namun, ini hanya disajikan sebagai pendapat pengguna, meskipun didukung oleh argumen.

• Haruskah pesan penggunaan pergi ke stderr atau stdout? : Ini khusus untuk membantu pesan tetapi mengutip standar pengkodean GNU. Ini adalah hal yang saya cari, hanya saja tidak terbatas untuk membantu pesan saja.

Jadi, apakah ada aturan resmi tentang di mana laporan kemajuan dan pesan informatif lainnya (yang bukan bagian dari hasil aktual program) harus dicetak?

Posix mendefinisikan stream standar sebagai berikut :

Pada awal program, tiga aliran harus ditentukan sebelumnya dan tidak perlu dibuka secara eksplisit: input standar (untuk membaca input konvensional), output standar (untuk penulisan output konvensional), dan standard error (untuk penulisan output diagnostik). Ketika dibuka, aliran kesalahan standar tidak sepenuhnya buffer; input standar dan output stream standar sepenuhnya buffered jika dan hanya jika aliran dapat ditentukan untuk tidak merujuk ke perangkat interaktif.

The GNU C Library menggambarkan aliran standar yang sama:

Variabel: FILE * stdout
Aliran keluaran standar, yang digunakan untuk keluaran normal dari program.

Variabel: FILE * stderr
Aliran kesalahan standar, yang digunakan untuk pesan kesalahan dan diagnostik yang dikeluarkan oleh program.

Dengan demikian, definisi standar memiliki sedikit panduan untuk penggunaan aliran di luar "keluaran konvensional / normal" dan "keluaran diagnostik / kesalahan." Dalam praktiknya, biasanya mengarahkan ulang salah satu atau kedua aliran ini ke file dan saluran pipa, di mana indikator kemajuan akan menjadi masalah . Beberapa sistem bahkan memantau stderr output dan menganggapnya sebagai tanda masalah. Oleh karena itu, informasi kemajuan yang bersifat tambahan murni bermasalah di kedua aliran.

Alih-alih mengirim indikator kemajuan tanpa syarat kepada salah aliran standar, penting untuk mengenali bahwa kemajuan output hanya sesuai untuk interaktif sungai. Dengan mengingat hal itu, saya merekomendasikan penulisan penghitung kemajuan hanya setelah memeriksa apakah aliran itu interaktif (misalnya, dengan isatty()) atau ketika diaktifkan secara eksplisit oleh opsi baris perintah. Itu sangat penting untuk pengukur kemajuan yang mengandalkan perilaku pembaruan terminal agar masuk akal, seperti% -complete bar.

Untuk pesan kemajuan tertentu yang sangat sederhana ("Memulai X" ... "Selesai dengan X") lebih masuk akal untuk memasukkan output bahkan untuk stream non-interaktif. Dalam hal itu, pertimbangkan bagaimana pengguna dapat berinteraksi dengan stream, seperti mencari dengan grepatau paging dengan lessatau memantau tail -f. Jika masuk akal untuk melihat pesan kemajuan dalam konteks itu, mereka akan lebih mudah untuk dikonsumsi stdout.

POSIX mendefinisikan kesalahan standar sebagai

untuk menulis keluaran diagnostik

Ini tidak membatasi penggunaannya untuk pesan kesalahan saja. Saya akan mempertimbangkan informasi kemajuan sebagai hasil diagnostik, jadi itu milik kesalahan standar.

POSIX sedikit lebih konkret tentang "informasi diagnostik" di Shell dan Utilities , 1.4: Default Deskripsi Utilitas (penekanan tambang):

STDERR

Bagian STDERR menjelaskan output kesalahan standar dari utilitas. Hanya pesan-pesan yang sengaja dikirim oleh utilitas yang dijelaskan. Penggunaan terminal untuk kesalahan standar dapat menyebabkan utilitas standar yang menulis output kesalahan standar berhenti saat digunakan di latar belakang. Untuk alasan ini, aplikasi tidak boleh menggunakan fitur interaktif dalam skrip untuk ditempatkan di latar belakang.

Format pesan diagnostik untuk sebagian besar utilitas tidak ditentukan, tetapi konvensi bahasa dan budaya pesan diagnostik dan informatif yang formatnya tidak ditentukan oleh volume POSIX.1-2008 ini harus dipengaruhi oleh pengaturan LC_MESSAGES dan [XSI] [Opsi Mulai ] NLSPATH. [Opsi Berakhir]

Keluaran kesalahan standar yang ditentukan dari utilitas standar tidak akan bergantung pada keberadaan atau nilai variabel lingkungan yang didefinisikan dalam volume POSIX.1-2008 ini, kecuali sebagaimana ditentukan oleh volume POSIX.1-2008 ini.

Perilaku Default : Ketika bagian ini terdaftar sebagai "Kesalahan standar hanya akan digunakan untuk pesan diagnostik.", Itu berarti bahwa, kecuali dinyatakan lain, pesan diagnostik harus dikirim ke kesalahan standar hanya ketika status keluar menunjukkan bahwa kesalahan terjadi dan utilitas digunakan seperti yang dijelaskan oleh volume POSIX.1-2008 ini.

Ketika bagian ini terdaftar sebagai "Tidak digunakan.", Itu berarti bahwa kesalahan standar tidak akan digunakan ketika utilitas digunakan seperti yang dijelaskan dalam volume POSIX.1-2008 ini.

IANASL, tetapi saya menafsirkan bahwa itu berarti stderr akan memiliki output hanya jika utilitas akan mengembalikan kode keluar kesalahan. Karena ini seharusnya bukan jalannya peristiwa yang normal untuk eksekusi yang sukses, tidak ada informasi kemajuan yang harus dicetak oleh utilitas POSIX kecuali ada kesalahan (kecuali, tentu saja, ditentukan lain, dll.).

Dengan prinsip pengecualian, itu hanya bisa pergi ke stderr. Ya, saya tahu Anda bertanya tentang spesifikasi resmi, yang tidak dapat saya tampilkan di luar tautan ke spesifikasi POSIX, yang diberikan oleh Stephen Kitt, yang menyatakan bahwa stderr adalah untuk tujuan diagnostik.

Poin yang lebih penting adalah stdin dan stdout memiliki fungsi yang melarang pencetakan laporan kemajuan menjadi stdout - mereka tentu saja membentuk urutan pipa yang dalam perintah shell Unix bukan hanya efek samping, tetapi inti dari pendekatan perpipaan yang kuat .

Begitu. Tidak ada yang lain kecuali "payload" nyata dari program Anda yang dimiliki stdout. Jika program Anda tidak memiliki output, maka tidak ada yang harus dilakukan untuk stdout. Ini menyisakan stderr untuk yang lainnya , termasuk laporan kemajuan.

Memang, ini meninggalkan lubang - mungkin akan menyenangkan untuk memiliki "stdfluff" atau sesuatu seperti itu yang bukan untuk output atau kesalahan tetapi laporan kemajuan, debugging dan semacamnya. Bahkan, tidak ada yang menghalangi Anda untuk melakukan itu, yaitu, Anda bisa mencetak kemajuan Anda ke file descriptor 3. Contoh:

$ perl -e 'open($fd, ">", "/dev/fd/3"); print $fd "hello\n"'

Ini tidak menghasilkan keluaran. (*)

$ perl -e 'open($fd, ">", "/dev/fd/3"); print $fd "hello\n"'  3>&1
hello

Ini mencetak ke fd-3, yang diarahkan ke stdout.

(*) Contoh pertama tidak menghasilkan output tetapi masih agak dibuat-buat; yang opengagal dan $!akan mengandung no such file or directory; ambil saja ini sebagai contoh, tentu saja tidak boleh digunakan seperti ini dengan sungguh-sungguh. Dalam program yang sebenarnya, jika Anda ingin menempuh rute ini, Anda dapat menguji apakah /dev/fd/3dapat digunakan dan menganggap ini sebagai petunjuk apakah akan mengaktifkan laporan kemajuan Anda; Anda harus melakukannya cukup awal sehingga Anda tidak bingung dengan openfile Anda yang asli dan semacamnya ...

Pesan penggunaan harus pergi ke stdout jika pengguna telah memanggilnya dengan --helpdan ke stderr jika mereka telah melakukan kesalahan. Mencetaknya ke stderr tanpa syarat adalah menjengkelkan karena membuatnya lebih sulit untuk melihatnya dengan pager / grep / etc.

Juga, izinkan saya menyarankan cara ketiga: buka / dev / tty untuk laporan kemajuan / pemintal / dll.