Deprecate readstring in favor of read(io, String) #22864

jpfairbanks · 2017-07-19T05:03:12Z

Here is a a pull request for Deprecating readstring in favor of read(io, String) closes #22793.

jpfairbanks · 2017-07-19T05:27:51Z

This looks like CI is failing outside of the main Base.runtests(). This PR should only affect Base so I don't know what is going on in the travis logs.

0.05s$ du -sk /tmp/julia/*
du: cannot access ‘/tmp/julia/*’: No such file or directory
The command "du -sk /tmp/julia/*" exited with 1.
0.01s$ if [ `uname` = "Darwin" ]; then for name in suitesparseconfig spqr umfpack colamd cholmod amd suitesparse_wrapper; do install -pm755 usr/lib/lib${name}*.dylib* /tmp/julia/lib/julia/; done; fi
The command "if [ `uname` = "Darwin" ]; then for name in suitesparseconfig spqr umfpack colamd cholmod amd suitesparse_wrapper; do install -pm755 usr/lib/lib${name}*.dylib* /tmp/julia/lib/julia/; done; fi" exited with 0.
0.01s$ cd .. && mv julia julia2
The command "cd .. && mv julia julia2" exited with 0.
0.01s$ /tmp/julia/bin/julia --precompiled=no -e 'true' && /tmp/julia/bin/julia-debug --precompiled=no -e 'true'
/home/travis/.travis/job_stages: line 57: /tmp/julia/bin/julia: No such file or directory
The command "/tmp/julia/bin/julia --precompiled=no -e 'true' && /tmp/julia/bin/julia-debug --precompiled=no -e 'true'" exited with 127.
0.01s$ /tmp/julia/bin/julia -e 'versioninfo()'
/home/travis/.travis/job_stages: line 57: /tmp/julia/bin/julia: No such file or directory

ararslan · 2017-07-19T05:48:01Z

base/io.jl

-The text is assumed to be encoded in UTF-8.
-"""
-readstring(s::IO) = String(read(s))
-readstring(filename::AbstractString) = open(readstring, filename)


This method is still relevant, isn't it? I didn't see it redefined elsewhere in the diff but maybe I missed it. In this case it'd just be

read(filename::AbstractString, ::Type{String}) = open(io -> read(io, String), filename)

I responded to this below

jpfairbanks · 2017-07-19T05:58:36Z

base/io.jl L 167 https://github.com/JuliaLang/julia/pull/22864/files#diff-775ff60d66216b33269fc5fcb6be714fR167

read on a filename lifts that for you right?

"""
    read(filename::AbstractString, args...)

Open a file and read its contents. `args` is passed to `read`: this is equivalent to
`open(io->read(io, args...), filename)`.
"""
read(filename::AbstractString, args...) = open(io->read(io, args...), filename)

ararslan · 2017-07-19T06:01:40Z

Oh yeah, you're right, it should indeed go through that method.

jpfairbanks · 2017-07-19T13:13:08Z

The problem with the build had something to do with a ref in the manual it was failing the documentation build step.

jpfairbanks · 2017-07-19T13:26:02Z

There is a problem finding references to code I didn't deprecate:
https://travis-ci.org/JuliaLang/julia/jobs/255254663#L1076
For example dropzeros!

tkelman · 2017-07-19T14:05:13Z

yeah that's been happening in a few places. something is buggy, not sure what.

jpfairbanks · 2017-07-19T14:41:55Z

Works on FreeBSD!
What do I do about the docs failures?

Sacha0 · 2017-07-19T18:13:41Z

base/deprecated.jl

+
+@deprecate readstring(s::IO) read(s, String)
+@deprecate readstring(filename::String) read(filename, String)
+@deprecate readstring(cmd::AbstractCmd) read(cmd, String)


Perhaps nix the extra empty line above these definitions and restore the empty line before # END ...?

Sacha0 · 2017-07-19T18:22:06Z

base/iostream.jl

@@ -144,7 +144,7 @@ end
 Apply the function `f` to the result of `open(args...)` and close the resulting file
 descriptor upon completion.

-**Example**: `open(readstring, "file.txt")`
+**Example**: `open(f->read(f, String), "file.txt")`


Tangentially, perhaps change this line to match the emerging convention for examples?

# Examples ```julia-repl ... [example] ...

Like this?

"""
open(f::Function, args...)

Apply the function f to the result of open(args...) and close the resulting file
descriptor upon completion.

Examples

open(f->read(f, String), "file.txt")

"""

Sacha0

julia> print(longmeeting(longpr))
lgtm! :)

fredrikekre · 2017-07-19T21:08:28Z

base/deprecated.jl

@@ -1581,6 +1581,10 @@ end

 @deprecate String(io::GenericIOBuffer) String(take!(copy(io)))

+
+@deprecate readstring(s::IO) read(s, String)
+@deprecate readstring(filename::String) read(filename, String)


This seems to be tighter than the removed method, should be AbstractString?

tkelman · 2017-07-19T21:30:48Z

base/io.jl

-    readstring(stream::IO)
-    readstring(filename::AbstractString)
-
-Read the entire contents of an I/O stream or a file as a string.


the new method's signature should be added to the read docstring

tkelman · 2017-07-19T22:19:55Z

I see one more occurrence at examples/wordcount.jl:78: text *= readstring(file)

jpfairbanks · 2017-07-20T03:32:08Z

All review comments are handled and the tests pass

JeffBezanson · 2017-07-20T03:38:53Z

Thanks for working on this, James.

ararslan

Looks good to me, just two super minor things. You could put those in a separate commit with [ci skip] in the commit message, which will keep the CI builds from running again for two tiny doc changes.

ararslan · 2017-07-20T03:40:40Z

base/iostream.jl

@@ -144,7 +144,10 @@ end
 Apply the function `f` to the result of `open(args...)` and close the resulting file
 descriptor upon completion.

-**Example**: `open(readstring, "file.txt")`
+# Examples
+```julia-repl


julia-repl blocks are for things that look like REPL sessions, i.e. have julia> input lines and lines of output. Since this doesn't have a "prompt" in front of it, I think it should just be julia instead of julia-repl.

ararslan · 2017-07-20T03:41:40Z

base/docs/helpdb/Base.jl

+
+    read(stream::IO, String)
+
+Read the entirety of `stream`, as a String.


For consistency with the other docstring you added, I'd remove the comma and lowercase string. If you leave it uppercase as in the type, it should have code formatting.

ararslan · 2017-07-20T03:45:10Z

Whoops. Too slow. Never mind. 😛 Nice work here!

deprecate readstring for read(io, String). fixes JuliaLang#22793.

jpfairbanks added 12 commits July 19, 2017 01:06

deprecate readstring for read(io, String)

488e9ed

deprecate readstring for AbstractCmd

8d72514

update tests for readstring to read(io, String)

8e46f14

updating Base uses of readstring to read(io, String)

73914d5

AbstractCmd is not an IO

1d74e33

update more tests with readstring -> read(io, String)

be26f77

updating more tests for readstring -> read(io, String)

e1fa192

purging readstring from the docs

b8f2ac2

remove readstring from precompile list

7386766

add News.md entry

0f1e6aa

more purging of readstring from tests

ddbfed7

remove readstring from docs/manual/interacting with julia.

0872f95

jpfairbanks force-pushed the jpfairbanks/#22793 branch from 8b0603a to 0872f95 Compare July 19, 2017 05:07

ararslan reviewed Jul 19, 2017

View reviewed changes

ararslan changed the title ~~Jpfairbanks/#22793~~ Deprecate readstring in favor of read(io, String) Jul 19, 2017

ararslan added kind:deprecation This change introduces or involves a deprecation domain:io Involving the I/O subsystem: libuv, read, write, etc. domain:strings "Strings!" labels Jul 19, 2017

remove readstring from manual for running externel programs

fcc9f7b

Sacha0 reviewed Jul 19, 2017

View reviewed changes

Sacha0 approved these changes Jul 19, 2017

View reviewed changes

JeffBezanson approved these changes Jul 19, 2017

View reviewed changes

fredrikekre reviewed Jul 19, 2017

View reviewed changes

tkelman reviewed Jul 19, 2017

View reviewed changes

address reviewer comments on JuliaLang#22864

3b4d98c

JeffBezanson merged commit 876294d into JuliaLang:master Jul 20, 2017

ararslan reviewed Jul 20, 2017

View reviewed changes

jeffwong pushed a commit to jeffwong/julia that referenced this pull request Jul 24, 2017

Deprecate readstring in favor of read(io, String) (JuliaLang#22864)

fffb707

deprecate readstring for read(io, String). fixes JuliaLang#22793.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate readstring in favor of read(io, String) #22864

Deprecate readstring in favor of read(io, String) #22864

jpfairbanks commented Jul 19, 2017

jpfairbanks commented Jul 19, 2017

ararslan Jul 19, 2017

jpfairbanks Jul 19, 2017

jpfairbanks commented Jul 19, 2017

ararslan commented Jul 19, 2017

jpfairbanks commented Jul 19, 2017

jpfairbanks commented Jul 19, 2017

tkelman commented Jul 19, 2017

jpfairbanks commented Jul 19, 2017

Sacha0 Jul 19, 2017

Sacha0 Jul 19, 2017

jpfairbanks Jul 20, 2017

Sacha0 left a comment

fredrikekre Jul 19, 2017

tkelman Jul 19, 2017

tkelman commented Jul 19, 2017

jpfairbanks commented Jul 20, 2017

JeffBezanson commented Jul 20, 2017

ararslan left a comment

ararslan Jul 20, 2017

ararslan Jul 20, 2017

ararslan commented Jul 20, 2017


		read(stream::IO, String)

		Read the entirety of `stream`, as a String.

Deprecate readstring in favor of read(io, String) #22864

Deprecate readstring in favor of read(io, String) #22864

Conversation

jpfairbanks commented Jul 19, 2017

jpfairbanks commented Jul 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jpfairbanks commented Jul 19, 2017

ararslan commented Jul 19, 2017

jpfairbanks commented Jul 19, 2017

jpfairbanks commented Jul 19, 2017

tkelman commented Jul 19, 2017

jpfairbanks commented Jul 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Examples

Sacha0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tkelman commented Jul 19, 2017

jpfairbanks commented Jul 20, 2017

JeffBezanson commented Jul 20, 2017

ararslan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ararslan commented Jul 20, 2017