Merge pull request #16563 from JuliaLang/jb/writemime_to_show

deprecate `writemime` to methods of `show`

Author: JeffBezanson

base/Enums.jl

@@ -99,10 +99,16 @@ macro enum(T,syms...)
                 print(io, x, "::", $(esc(typename)), " = ", Int(x))
             end
         end
-        function Base.writemime(io::IO,::MIME"text/plain",::Type{$(esc(typename))})
-            print(io, "Enum ", $(esc(typename)), ":")
-            for (sym, i) in $vals
-                print(io, "\n", sym, " = ", i)
+        function Base.show(io::IO,t::Type{$(esc(typename))})
+            if get(io, :multiline, false)
+                print(io, "Enum ")
+                Base.show_datatype(io, t)
+                print(io, ":")
+                for (sym, i) in $vals
+                    print(io, "\n", sym, " = ", i)
+                end
+            else
+                Base.show_datatype(io, t)
             end
         end
     end

base/REPL.jl

@@ -15,7 +15,7 @@ export
 import Base:
     Display,
     display,
-    writemime,
+    show,
     AnyDict,
     ==
 
@@ -111,7 +111,7 @@ end
 function display(d::REPLDisplay, ::MIME"text/plain", x)
     io = outstream(d.repl)
     Base.have_color && write(io, answer_color(d.repl))
-    writemime(IOContext(io, multiline=true, limit=true), MIME("text/plain"), x)
+    show(IOContext(io, multiline=true, limit=true), MIME("text/plain"), x)
     println(io)
 end
 display(d::REPLDisplay, x) = display(d, MIME("text/plain"), x)

base/Terminals.jl

@@ -31,8 +31,7 @@ import Base:
     pipe_reader,
     pipe_writer,
     read,
-    readuntil,
-    writemime
+    readuntil
 
 ## TextTerminal ##
 

base/datafmt.jl

@@ -4,7 +4,7 @@
 
 module DataFmt
 
-import Base: _default_delims, tryparse_internal, writemime
+import Base: _default_delims, tryparse_internal, show
 
 export countlines, readdlm, readcsv, writedlm, writecsv
 
@@ -623,7 +623,7 @@ end
 writedlm(io, a; opts...) = writedlm(io, a, '\t'; opts...)
 writecsv(io, a; opts...) = writedlm(io, a, ','; opts...)
 
-writemime(io::IO, ::MIME"text/csv", a) = writedlm(io, a, ',')
-writemime(io::IO, ::MIME"text/tab-separated-values", a) = writedlm(io, a, '\t')
+show(io::IO, ::MIME"text/csv", a) = writedlm(io, a, ',')
+show(io::IO, ::MIME"text/tab-separated-values", a) = writedlm(io, a, '\t')
 
 end # module DataFmt

base/deprecated.jl

@@ -1265,6 +1265,7 @@ end
 @deprecate_binding WORD_SIZE Sys.WORD_SIZE
 
 @deprecate showcompact_lim show
+@deprecate writemime show
 
 @deprecate blas_set_num_threads BLAS.set_num_threads
 

base/docs/helpdb/Base.jl

@@ -6628,28 +6628,32 @@ Return, but do not print, the time elapsed since the last [`tic`](:func:`tic`).
 toq
 
 """
-    writemime(stream, mime, x)
+    show(stream, mime, x)
 
-The `display` functions ultimately call `writemime` in order to write an object `x` as a
+The `display` functions ultimately call `show` in order to write an object `x` as a
 given `mime` type to a given I/O `stream` (usually a memory buffer), if possible. In order
 to provide a rich multimedia representation of a user-defined type `T`, it is only necessary
-to define a new `writemime` method for `T`, via: `writemime(stream, ::MIME"mime", x::T) = ...`,
+to define a new `show` method for `T`, via: `show(stream, ::MIME"mime", x::T) = ...`,
 where `mime` is a MIME-type string and the function body calls `write` (or similar) to write
 that representation of `x` to `stream`. (Note that the `MIME""` notation only supports
 literal strings; to construct `MIME` types in a more flexible manner use
 `MIME{Symbol("")}`.)
 
 For example, if you define a `MyImage` type and know how to write it to a PNG file, you
-could define a function `writemime(stream, ::MIME"image/png", x::MyImage) = ...` to allow
+could define a function `show(stream, ::MIME"image/png", x::MyImage) = ...` to allow
 your images to be displayed on any PNG-capable `Display` (such as IJulia). As usual, be sure
-to `import Base.writemime` in order to add new methods to the built-in Julia function
-`writemime`.
+to `import Base.show` in order to add new methods to the built-in Julia function
+`show`.
+
+The default MIME type is `MIME"text/plain"`. There is a fallback definition for `text/plain`
+output that calls `show` with 2 arguments. Therefore, this case should be handled by
+defining a 2-argument `show(stream::IO, x::MyType)` method.
 
 Technically, the `MIME"mime"` macro defines a singleton type for the given `mime` string,
 which allows us to exploit Julia's dispatch mechanisms in determining how to display objects
 of any given type.
 """
-writemime
+show(stream, mime, x)
 
 """
     mean!(r, v)
@@ -7262,7 +7266,7 @@ Write an informative text representation of a value to the current output stream
 should overload `show(io, x)` where the first argument is a stream. The representation used
 by `show` generally includes Julia-specific formatting and type information.
 """
-show
+show(x)
 
 """
     @allocated
@@ -7909,8 +7913,8 @@ rethrow
     reprmime(mime, x)
 
 Returns an `AbstractString` or `Vector{UInt8}` containing the representation of `x` in the
-requested `mime` type, as written by `writemime` (throwing a `MethodError` if no appropriate
-`writemime` is available). An `AbstractString` is returned for MIME types with textual
+requested `mime` type, as written by `show` (throwing a `MethodError` if no appropriate
+`show` is available). An `AbstractString` is returned for MIME types with textual
 representations (such as `"text/html"` or `"application/postscript"`), whereas binary data
 is returned as `Vector{UInt8}`. (The function `istextmime(mime)` returns whether or not Julia
 treats a given `mime` type as text.)
@@ -8303,7 +8307,7 @@ showall
 
 Returns a boolean value indicating whether or not the object `x` can be written as the given
 `mime` type. (By default, this is determined automatically by the existence of the
-corresponding `writemime` function for `typeof(x)`.)
+corresponding `show` function for `typeof(x)`.)
 """
 mimewritable
 

base/docs/utils.jl

@@ -2,7 +2,7 @@
 
 # Text / HTML objects
 
-import Base: print, writemime
+import Base: print, show
 
 export HTML, @html_str
 
@@ -26,13 +26,13 @@ end
 function HTML(xs...)
     HTML() do io
         for x in xs
-            writemime(io, MIME"text/html"(), x)
+            show(io, MIME"text/html"(), x)
         end
     end
 end
 
-writemime(io::IO, ::MIME"text/html", h::HTML) = print(io, h.content)
-writemime{F <: Function}(io::IO, ::MIME"text/html", h::HTML{F}) = h.content(io)
+show(io::IO, ::MIME"text/html", h::HTML) = print(io, h.content)
+show{F <: Function}(io::IO, ::MIME"text/html", h::HTML{F}) = h.content(io)
 
 """
     @html_str -> Docs.HTML
@@ -46,7 +46,7 @@ end
 function catdoc(xs::HTML...)
     HTML() do io
         for x in xs
-            writemime(io, MIME"text/html"(), x)
+            show(io, MIME"text/html"(), x)
         end
     end
 end
@@ -70,7 +70,7 @@ end
 
 print(io::IO, t::Text) = print(io, t.content)
 print{F <: Function}(io::IO, t::Text{F}) = t.content(io)
-writemime(io::IO, ::MIME"text/plain", t::Text) = print(io, t)
+show(io::IO, t::Text) = print(io, t)
 
 """
     @text_str -> Docs.Text
@@ -84,7 +84,7 @@ end
 function catdoc(xs::Text...)
     Text() do io
         for x in xs
-            writemime(io, MIME"text/plain"(), x)
+            show(io, MIME"text/plain"(), x)
         end
     end
 end

base/exports.jl

@@ -1224,7 +1224,6 @@ export
     @MIME_str,
     reprmime,
     stringmime,
-    writemime,
     mimewritable,
     popdisplay,
     pushdisplay,

base/markdown/IPython/IPython.jl

@@ -22,7 +22,7 @@ function blocktex(stream::IO, md::MD)
     end
 end
 
-writemime(io::IO, ::MIME"text/plain", tex::LaTeX) =
+show(io::IO, tex::LaTeX) =
     print(io, '$', tex.formula, '$')
 
 latex(io::IO, tex::LaTeX) =

base/markdown/Markdown.jl

@@ -2,7 +2,7 @@
 
 module Markdown
 
-import Base: writemime, ==
+import Base: show, ==
 import Core: @doc_str
 
 include("parse/config.jl")