IRB initialization changes global `$stdout` encoding, causing `Encoding::UndefinedConversionError`
Los mantenedores suelen responder en 2 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 45/100
Línea de trabajo
Comience en lib/irb/init.rb, en set_encoding, y luego siga sus llamadores a través de IRB::Context y IRB::RelineInputMethod. Asegúrese de que IRB mantenga el comportamiento de encoding requerido sin cambiar los streams estándar globales, y verifique que tanto IRB.setup/IRB::Irb.new como binding.irb ya no hagan que falle el ejemplo de salida con ASCII-8BIT.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Related Issue
This issue is related to #1048 (IRB leaking out Reline changes globally). In addition to Reline settings, IRB also leaks $stdout, $stdin, and $stderr encoding changes globally.
Description
When IRB is initialized, it calls $stdout.set_encoding('UTF-8') (and similarly for $stdin and $stderr). This affects all code that runs after IRB initialization, not just IRB itself.
This causes Encoding::UndefinedConversionError when code tries to output ASCII-8BIT strings to $stdout.
Minimal Reproducible Example
Example 1: Using IRB.setup and IRB::Irb.new
require 'irb'
puts "Before: $stdout.external_encoding = #{$stdout.external_encoding.inspect}"
# IRB initialization
IRB.setup(nil)
IRB::Irb.new
puts "After: $stdout.external_encoding = #{$stdout.external_encoding.inspect}"
# This raises Encoding::UndefinedConversionError
ascii_str = "日本語".force_encoding('ASCII-8BIT')
puts ascii_str
Output
Before: $stdout.external_encoding = nil
After: $stdout.external_encoding = #<Encoding:UTF-8>
-e:12:in 'IO#write': "\xE3" from ASCII-8BIT to UTF-8 (Encoding::UndefinedConversionError)
Example 2: Using binding.irb
This is a more common scenario that affects everyday debugging:
puts "Before: $stdout.external_encoding = #{$stdout.external_encoding.inspect}"
binding.irb # Enter IRB session, then type 'exit' to continue
puts "After: $stdout.external_encoding = #{$stdout.external_encoding.inspect}"
ascii_str = "日本語".force_encoding('ASCII-8BIT')
puts ascii_str
Output
Before: $stdout.external_encoding = nil
irb(main):001> exit
After: $stdout.external_encoding = #<Encoding:UTF-8>
-e:8:in 'IO#write': "\xE6" from ASCII-8BIT to UTF-8 (Encoding::UndefinedConversionError)
This means any code that runs after binding.irb is affected. Users debugging their applications with binding.irb may encounter unexpected encoding errors in code that worked fine before the IRB session.
Real-World Impact
This issue affects users of the debug gem with irb_console true setting.
Scenario
- User has
~/.rdbgrcwithconfig set irb_console true - User runs
rails notes(or any Rails command) debuggem loads and initializes IRB due to the setting- IRB changes
$stdout.external_encodingto UTF-8 rails notesreads files withEncoding::BINARYand tries to outputEncoding::UndefinedConversionErroris raised for non-ASCII content
Stack Trace
IRB::Irb#initialize (irb.rb:91)
↓
IRB::Context#initialize (context.rb:95)
↓
IRB::RelineInputMethod#initialize (input-method.rb:261)
↓
IRB.set_encoding (init.rb:528)
↓
$stdout.set_encoding (init.rb:529) ← Global change!
Root Cause
In lib/irb/init.rb, the set_encoding method changes global I/O streams:
def set_encoding(extern, intern = nil, override: true)
Encoding.default_external = extern
Encoding.default_internal = intern
[$stdin, $stdout, $stderr].each do |io|
io.set_encoding(extern, intern) # ← This affects all code, not just IRB
end
# ...
end
Proposed Solution
Instead of modifying global $stdin, $stdout, $stderr, IRB could use duplicated I/O streams for its own operations:
def set_encoding(extern, intern = nil, override: true)
Encoding.default_external = extern
Encoding.default_internal = intern
# Use duplicated streams for IRB, don't modify global ones
@irb_stdin = $stdin.dup.tap { |io| io.set_encoding(extern, intern) }
@irb_stdout = $stdout.dup.tap { |io| io.set_encoding(extern, intern) }
@irb_stderr = $stderr.dup.tap { |io| io.set_encoding(extern, intern) }
# ...
end
This way, IRB maintains its encoding consistency without affecting other code.
Environment
- Ruby: 3.3.6 / 3.4.7
- IRB: 1.16.0
- OS: macOS (LANG=ja_JP.UTF-8)
- Lenguaje dominante
- Ruby
- Estrellas
- 477
- Forks
- 165
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 5
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de ruby/irb
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
ruby/irb#1267 · 1 comentario ·
Los mantenedores suelen responder en 2 días
-
Proposal: public hook for external documentation providers in show_doc and the completion doc dialogPosiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 38/100
Los mantenedores suelen responder en 2 días
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Los mantenedores suelen responder en 2 días
Issues similares
-
bug f:request-creation professional
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
mysociety/alaveteli#9733 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
needs verification
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
Los mantenedores suelen responder en 13 días
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
betagouv/conseillers-entreprises#4808 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100