?(x, y)TAB completes methods accepting x, y #38791

timholy · 2020-12-09T14:37:48Z

A number of calls to change the language have been justified in part by arguments for better tab completion. It seems time to separate these issues by improving discoverability in a way that integrates with multiple dispatch. With this PR, ?(x, y)TAB completes methods that can be called with (x, y), and ?(x, yTAB (without the closing )) completes methods called with (x, y, ...). There is also limited module-scoping available (only one layer deep).

An alternative to ? would be to have the cursor positioned where the function name should be supplied.

I'm happy to discuss changes to this, but depending on whether a couple of other deadlines evaporate I might not have time to make any substantive changes here for a while...so let me say at the outset that I'd be just fine with someone taking this over if desired. Or, it can sit until I get time.

Demos:

julia> InteractiveUtils.?("hello")[TAB]
apropos(string) in REPL at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/REPL/src/docview.jl:727
clipboard(x) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/clipboard.jl:60
code_llvm(f) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/codeview.jl:178
code_native(f) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/codeview.jl:199
edit(path::AbstractString) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/editless.jl:195
edit(f) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/editless.jl:223
eval(x) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/InteractiveUtils.jl:3
include(x) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/InteractiveUtils.jl:3
less(file::AbstractString) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/editless.jl:256
less(f) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/editless.jl:264
report_bug(kind) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/InteractiveUtils.jl:385
separate_kwargs(args...; kwargs...) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/macros.jl:7

julia> InteractiveUtils.?("hello")[SHIFT-TAB]   # this excludes duck-typed methods
edit(path::AbstractString) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/editless.jl:195
less(file::AbstractString) in InteractiveUtils at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/InteractiveUtils/src/editless.jl:256

julia>  ?([1 2; 3 4], 1, 1)[SHIFT-TAB]
LinRange(start, stop, len::Integer) in Base at range.jl:427
StepRangeLen(ref::R, step::S, len::Integer) where {R, S} in Base at range.jl:366
broadcast(f, x::Number...) in Base.Broadcast at broadcast.jl:824
broadcast(f, avs::Union{Number, LinearAlgebra.Adjoint{T, var"#s828"} where var"#s828"<:(AbstractVector{T} where T) where T}...) in LinearAlgebra at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/LinearAlgebra/src/adjtrans.jl:281
broadcast(f, tvs::Union{Number, LinearAlgebra.Transpose{T, var"#s828"} where var"#s828"<:(AbstractVector{T} where T) where T}...) in LinearAlgebra at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/LinearAlgebra/src/adjtrans.jl:282
broadcast(f::Tf, As...) where Tf in Base.Broadcast at broadcast.jl:821
broadcast!(f::Tf, dest, As::Vararg{Any, N}) where {Tf, N} in Base.Broadcast at broadcast.jl:860
checkbounds(A::AbstractArray, I...) in Base at abstractarray.jl:608
circshift!(dest::AbstractArray, src, shiftamt) in Base at multidimensional.jl:1116
clamp(x::X, lo::L, hi::H) where {X, L, H} in Base.Math at math.jl:65
clamp!(x::AbstractArray, lo, hi) in Base.Math at math.jl:93
copyto!(dest::AbstractArray, dstart::Integer, src) in Base at abstractarray.jl:846
error(s::Vararg{Any, N}) where N in Base at error.jl:40
fill(v, dims::Union{Integer, AbstractUnitRange}...) in Base at array.jl:449
get(A::AbstractArray, i::Integer, default) in Base at abstractarray.jl:1411
getindex(A::Array, i1::Int64, i2::Int64, I::Int64...) in Base at array.jl:788
getindex(A::Array, i1::Integer, I::Integer...) in Base at abstractarray.jl:1167
getindex(A::Array, i1::Union{Integer, CartesianIndex}, I::Union{Integer, CartesianIndex}...) in Base at multidimensional.jl:637
getindex(A::AbstractArray, I...) in Base at abstractarray.jl:1161
isassigned(a::Array, i::Int64...) in Base at array.jl:201
isassigned(a::AbstractArray, i::Integer...) in Base at abstractarray.jl:505
map(f, x::Number, ys::Number...) in Base at number.jl:238
mapreduce(f, op, a::Number) in Base at reduce.jl:419
rand(X, d::Integer, dims::Integer...) in Random at /home/tim/src/julia-master/usr/share/julia/stdlib/v1.7/Random/src/Random.jl:283
repeat(A::AbstractArray, counts...) in Base at abstractarraymath.jl:223
reshape(parent::AbstractArray, dims::Int64...) in Base at reshapedarray.jl:116
reshape(parent::AbstractArray, dims::Union{Int64, AbstractUnitRange}...) in Base at reshapedarray.jl:110
reshape(parent::AbstractArray, dims::Union{Colon, Int64}...) in Base at reshapedarray.jl:117
selectdim(A::AbstractArray, d::Integer, i) in Base at abstractarraymath.jl:122
setindex!(A::Array{T, N} where N, x, i1::Int64) where T in Base at array.jl:825
setindex!(A::Array, v, i1::Union{Integer, CartesianIndex}, I::Union{Integer, CartesianIndex}...) in Base at multidimensional.jl:639
setindex!(A::AbstractArray, v, I...) in Base at abstractarray.jl:1258
similar(a::AbstractArray{T, N} where N, dims::Union{Integer, AbstractUnitRange}...) where T in Base at abstractarray.jl:735
view(A::AbstractArray, I::Vararg{Any, N}) where N in Base at subarray.jl:164

Closes #30052
xref #38704
xref #37993

johnnychen94 · 2020-12-09T15:06:09Z

Any chance we formally make an API for the matched methods? Ask this because it allows other REPL tools to work smarter based on the results. For example, thefix.jl

rapus95 · 2020-12-09T15:21:20Z

does it work with keyword arguments?

EDIT: that following underscore usage doesn't make sense
How easy would it be to allow _ as placeholder for arguments that I don't care over? I.e. say I forgot the name of a certain function
julia>((x,y)->(x,y), _, init=5)TAB which in best case would show me reduce/foldr/foldl

timholy · 2020-12-09T15:30:06Z

Any chance we formally make an API for the matched methods? Ask this because it allows other REPL tools to work smarter based on the results. For example, thefix.jl

I'm not sure how TheFix works internally, but the matches come back as a list of MethodCompletions:

julia/stdlib/REPL/src/REPLCompletions.jl

Lines 39 to 44 in a1106b8

    
           struct MethodCompletion <: Completion 
        
               func 
        
               input_types::Type 
        
               method::Method 
        
               orig_method::Union{Nothing,Method} # if `method` is a keyword method, keep the original method for sensible printing 
        
           end

Does that address the concern?

johnnychen94 · 2020-12-09T15:46:47Z

Great, so basically we can call complete_any_methods and doing some additional REPL work (not just print it out) based on its results, am I understand it right? If so, we could make it an advanced version of methodswith.

julia> methodswith(String, InteractiveUtils; supertypes=true)
[1] edit(path::AbstractString) in InteractiveUtils at /Applications/Julia-1.5.app/Contents/Resources/julia/share/julia/stdlib/v1.5/InteractiveUtils/src/editless.jl:193
[2] edit(path::AbstractString, line::Integer) in InteractiveUtils at /Applications/Julia-1.5.app/Contents/Resources/julia/share/julia/stdlib/v1.5/InteractiveUtils/src/editless.jl:193
[3] less(file::AbstractString) in InteractiveUtils at /Applications/Julia-1.5.app/Contents/Resources/julia/share/julia/stdlib/v1.5/InteractiveUtils/src/editless.jl:255
[4] less(file::AbstractString, line::Integer) in InteractiveUtils at /Applications/Julia-1.5.app/Contents/Resources/julia/share/julia/stdlib/v1.5/InteractiveUtils/src/editless.jl:242

timholy · 2020-12-09T15:51:27Z

If so, we could make it an advanced version of methodswith.

Along those lines, see #33883. There didn't seem to be much interest, and after I developed MethodAnalysis I decided I was probably subverting the real purpose of methodswith.

codecov-io · 2020-12-09T22:17:05Z

Codecov Report

Merging #38791 (a1106b8) into master (ffc340c) will increase coverage by 6.00%.
The diff coverage is n/a.

❗ Current head a1106b8 differs from pull request most recent head c3c9540. Consider uploading reports for the commit c3c9540 to get more accurate results

@@            Coverage Diff             @@
##           master   #38791      +/-   ##
==========================================
+ Coverage   81.55%   87.55%   +6.00%     
==========================================
  Files         350      388      +38     
  Lines       73999    74498     +499     
==========================================
+ Hits        60351    65228    +4877     
+ Misses      13648     9270    -4378

Impacted Files	Coverage Δ
base/download.jl	`0.00% <0.00%> (-80.00%)`	⬇️
stdlib/REPL/src/TerminalMenus/util.jl	`0.00% <0.00%> (-51.29%)`	⬇️
base/options.jl	`45.83% <0.00%> (-50.01%)`	⬇️
base/ttyhascolor.jl	`0.00% <0.00%> (-46.67%)`	⬇️
stdlib/SharedArrays/src/SharedArrays.jl	`38.92% <0.00%> (-43.25%)`	⬇️
base/hashing.jl	`52.94% <0.00%> (-33.34%)`	⬇️
base/c.jl	`55.17% <0.00%> (-31.67%)`	⬇️
base/deprecated.jl	`37.33% <0.00%> (-27.31%)`	⬇️
stdlib/REPL/src/TerminalMenus/AbstractMenu.jl	`42.48% <0.00%> (-26.80%)`	⬇️
base/idset.jl	`66.66% <0.00%> (-23.81%)`	⬇️
... and 328 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ffc340c...c3c9540. Read the comment docs.

stdlib/REPL/src/REPLCompletions.jl

stdlib/REPL/src/REPL.jl

miguelraz · 2020-12-22T00:22:54Z

I may be speaking out of turn here, but does this PR also hook into the pretty-printing stack-traces mechanism? Having a uniform display style for Tab completions, methodswith, (x, y)TAB and stacktraces would be great.

stdlib/REPL/src/REPL.jl

stdlib/REPL/src/REPLCompletions.jl

vtjnash · 2021-04-16T00:32:56Z

bump? I think this is nearly complete!

oscardssmith · 2021-05-29T19:30:02Z

Can we get this into 1.7?

Closes #30052 xref #38704 xref #37993

Co-authored-by: Jameson Nash <vtjnash@gmail.com>

timholy · 2021-07-25T20:00:00Z

This should be working again. I've incorporated the feedback above.

We might want to play with this a bit before merging; in 2-argument methods, I keep wanting a way to say that neither argument should be typed as ::Any, but it might be bad if we hard-wired that in. Likewise, we don't have a way of saying "this argument could go in any position."

rapus95 · 2021-07-26T05:38:24Z

This should be working again. I've incorporated the feedback above.

We might want to play with this a bit before merging; in 2-argument methods, I keep wanting a way to say that neither argument should be typed as ::Any, but it might be bad if we hard-wired that in. Likewise, we don't have a way of saying "this argument could go in any position."

How about introducing post- or pre-parenthesis modifiers/flags? we could even think about having both and making pre-fix for explicit inclusion and post-fix for explicit exclusion and omitting for some default. (or vice versa)
?a(4,2) a for all/any included

but given that it wouldn't be generic enough, we could either create new struct types which can encode these properties/flags or we could establish another syntax. Like for example a string macro since these support flags by default? Kinda like the var"name" macro.

new struct types: ?(Strict(objA), Arbitrary(objB), objC)
kinda like introducing new traits! (where Openness(o::Any) = AnythingButAny(o))

string macro: ?(arg"objA"s, arg"objB"a, objC)

timholy · 2021-08-04T07:36:27Z

I've been using this for a while now and it seems reasonable even if not as flexible as one might ideally want. While I see the good things about @rapus95's suggestions, I think it would add a lot of visual noise and complexity. If we really want to have fine-grained control, I think the right approach would be to introduce a TerminalMenus.MultiSelectMenu to control this interactively. But perhaps we should first merge this and see what people think of the simple version. We have the whole 1.8 cycle to change our mind.

carstenbauer · 2021-08-04T14:13:22Z

Sorry if this has been mentioned before (I didn't read everything), but can we / do we want to support partial autocompletion, i.e. isapp?(x, y) which, for example, would suggest isapprox(x,y)?

timholy · 2021-08-04T17:00:57Z

can we / do we want to support partial autocompletion, i.e. isapp?(x, y) which, for example, would suggest isapprox(x,y)?

Certainly feasible, but don't we essentially have that already?

julia> apropos("isapp")
Base.@static
Base.isapprox
Base.:≉
Base.SimdLoop.@simd
Base.Sys.isbsd
Base.Sys.isapple

This is more about searching-by-types than searching-by-name. I guess one could combine them, but I'm not sure if that really would add enough value to compensate.

update to JuliaLang/julia#38791

dpinol · 2021-11-02T10:31:58Z

I don't see this in 1.7rc2
Do we have to wait until 1.8?

timholy · 2021-11-02T10:46:16Z

Yes.

dpinol · 2022-02-24T08:06:46Z

How's the UX?
If I copy-paste the "?" character, it works fine.
But if I press "?", it enters into help mode and I can't get the autocomplete to work.

timholy · 2022-02-24T11:28:12Z

From the julia> prompt, type exactly these characters:

??(3, "hello")TAB

dpinol · 2022-02-24T12:13:50Z

@timholy thanks!

Fix #52551. This PR ensures that a `SomeModule.?(...#TAB` completion can only suggests method `foo` such that `SomeModule.foo` exists (by checking `isdefined(SomeModule, :foo)`). This is equivalent, I believe, to the initial implementation of #38791, less the bug. Now that we have #51345, we may want to relax the above condition somewhat to include public names present in modules loaded into `SomeModule`, so that, for instance, a direct completion of `?(` would include `@assume_effects`. This could be good for method exploration because even though typing `@assume_effects` with no qualification in `Main` will error, the error now includes the helpful message ``` Hint: a global variable of this name also exists in Base. ``` But that can wait for a later PR anyway, this one is just the bugfix. The bug mentioned at #52551 (comment) dates from the initial #38791 so this could be backported as far back as v1.8. --------- Co-authored-by: Shuhei Kadowaki <aviatesk@gmail.com>

Fix #52551. This PR ensures that a `SomeModule.?(...#TAB` completion can only suggests method `foo` such that `SomeModule.foo` exists (by checking `isdefined(SomeModule, :foo)`). This is equivalent, I believe, to the initial implementation of #38791, less the bug. Now that we have #51345, we may want to relax the above condition somewhat to include public names present in modules loaded into `SomeModule`, so that, for instance, a direct completion of `?(` would include `@assume_effects`. This could be good for method exploration because even though typing `@assume_effects` with no qualification in `Main` will error, the error now includes the helpful message ``` Hint: a global variable of this name also exists in Base. ``` But that can wait for a later PR anyway, this one is just the bugfix. The bug mentioned at #52551 (comment) dates from the initial #38791 so this could be backported as far back as v1.8. --------- Co-authored-by: Shuhei Kadowaki <aviatesk@gmail.com> (cherry picked from commit a987f56)

timholy added the REPL Julia's REPL (Read Eval Print Loop) label Dec 9, 2020

stevengj reviewed Dec 21, 2020

View reviewed changes

stdlib/REPL/src/REPLCompletions.jl Outdated Show resolved Hide resolved

stevengj reviewed Dec 21, 2020

View reviewed changes

stdlib/REPL/src/REPLCompletions.jl Show resolved Hide resolved

stevengj reviewed Dec 21, 2020

View reviewed changes

stdlib/REPL/src/REPL.jl Show resolved Hide resolved

KristofferC mentioned this pull request Mar 4, 2021

Better live docs fonsp/Pluto.jl#111

Open

14 tasks

vtjnash reviewed Apr 3, 2021

View reviewed changes

stdlib/REPL/src/REPL.jl Outdated Show resolved Hide resolved

vtjnash reviewed Apr 3, 2021

View reviewed changes

stdlib/REPL/src/REPLCompletions.jl Outdated Show resolved Hide resolved

vtjnash reviewed Apr 3, 2021

View reviewed changes

stdlib/REPL/src/REPLCompletions.jl Outdated Show resolved Hide resolved

vtjnash reviewed Apr 3, 2021

View reviewed changes

stdlib/REPL/src/REPLCompletions.jl Outdated Show resolved Hide resolved

vtjnash mentioned this pull request Apr 3, 2021

Parenthesis Postfix Function Syntax Allowing (x,y)f #38704

Closed

vtjnash added the forget me not PRs that one wants to make sure aren't forgotten label May 4, 2021

oscardssmith assigned timholy May 29, 2021

timholy and others added 3 commits July 25, 2021 11:45

?(x, y)TAB completes methods accepting x, y

b215082

Closes #30052 xref #38704 xref #37993

Apply suggestions from code review

0aab0dc

Co-authored-by: Jameson Nash <vtjnash@gmail.com>

Support future generalization with Modifiers type

594c9f8

timholy force-pushed the teh/tab_methsearch branch from 41dfcd5 to 594c9f8 Compare July 25, 2021 18:38

Fix docs & tests

ed2f00e

Fix NEWS and comment

c3c9540

timholy merged commit e87e30c into master Aug 9, 2021

timholy deleted the teh/tab_methsearch branch August 9, 2021 11:16

aviatesk added a commit to JunoLab/FuzzyCompletions.jl that referenced this pull request Aug 9, 2021

update to JuliaLang/julia#38791

29b8d7f

aviatesk added a commit to JunoLab/Atom.jl that referenced this pull request Aug 9, 2021

update to JuliaLang/julia#38791

b86d1a5

aviatesk added a commit to JunoLab/FuzzyCompletions.jl that referenced this pull request Aug 9, 2021

Merge pull request #10 from JunoLab/avi/update

d4c59d1

update to JuliaLang/julia#38791

aviatesk added a commit to JunoLab/Atom.jl that referenced this pull request Aug 9, 2021

Merge pull request #371 from JunoLab/avi/update

dc60387

update to JuliaLang/julia#38791

krystophny mentioned this pull request Aug 9, 2021

Autocomplete of methods for given variables julia-vscode/LanguageServer.jl#979

Open

This was referenced Dec 27, 2021

Restrict REPL method completion to ignore strictly less specific ones #43572

Closed

Add REPL-completion for keyword arguments #43536

Merged

Make TAB-completion behave as SHIFT-TAB in REPL except for ?(x,y) syntax #43577

Merged

simeonschaub mentioned this pull request Jan 19, 2022

Feature: show methods applicable to object (methodswith) JuliaLang/IJulia.jl#1033

Closed

tfiers mentioned this pull request Jan 19, 2022

Feature: show methods applicable to object (methodswith) julia-vscode/julia-vscode#2679

Closed

gcv mentioned this pull request Mar 14, 2022

Check or implement ?(x, y) completion gcv/julia-snail#80

Open

IlyaOrson mentioned this pull request Apr 21, 2022

sciml_train output API documentation SciML/DiffEqFlux.jl#702

Closed

DilumAluthge removed the forget me not PRs that one wants to make sure aren't forgotten label Sep 6, 2022

KristofferC mentioned this pull request Sep 16, 2022

Recommend a workflow for methodswith in the REPL #46746

Closed

gbaraldi mentioned this pull request Aug 7, 2023

Add default method for setmodifiers! #50822

Merged

Pangoraw mentioned this pull request Aug 13, 2023

object.<TAB> should list methods anyway fonsp/Pluto.jl#2609

Open

This was referenced Dec 15, 2023

Typing ?( in REPL help mode causes exception #52551

Closed

Fix ?(#TAB method search name exploration #52555

Merged

mbauman mentioned this pull request Oct 21, 2024

The string ?( bogs down REPL input to a crawl #56272

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

?(x, y)TAB completes methods accepting x, y #38791

?(x, y)TAB completes methods accepting x, y #38791

timholy commented Dec 9, 2020 •

edited

Loading

johnnychen94 commented Dec 9, 2020

rapus95 commented Dec 9, 2020 •

edited

Loading

timholy commented Dec 9, 2020

johnnychen94 commented Dec 9, 2020 •

edited

Loading

timholy commented Dec 9, 2020

codecov-io commented Dec 9, 2020 •

edited by codecov bot

Loading

miguelraz commented Dec 22, 2020

vtjnash commented Apr 16, 2021

oscardssmith commented May 29, 2021

timholy commented Jul 25, 2021

rapus95 commented Jul 26, 2021 •

edited

Loading

timholy commented Aug 4, 2021

carstenbauer commented Aug 4, 2021

timholy commented Aug 4, 2021

dpinol commented Nov 2, 2021

timholy commented Nov 2, 2021

dpinol commented Feb 24, 2022

timholy commented Feb 24, 2022

dpinol commented Feb 24, 2022

?(x, y)TAB completes methods accepting x, y #38791

?(x, y)TAB completes methods accepting x, y #38791

Conversation

timholy commented Dec 9, 2020 • edited Loading

johnnychen94 commented Dec 9, 2020

rapus95 commented Dec 9, 2020 • edited Loading

timholy commented Dec 9, 2020

johnnychen94 commented Dec 9, 2020 • edited Loading

timholy commented Dec 9, 2020

codecov-io commented Dec 9, 2020 • edited by codecov bot Loading

Codecov Report

miguelraz commented Dec 22, 2020

vtjnash commented Apr 16, 2021

oscardssmith commented May 29, 2021

timholy commented Jul 25, 2021

rapus95 commented Jul 26, 2021 • edited Loading

timholy commented Aug 4, 2021

carstenbauer commented Aug 4, 2021

timholy commented Aug 4, 2021

dpinol commented Nov 2, 2021

timholy commented Nov 2, 2021

dpinol commented Feb 24, 2022

timholy commented Feb 24, 2022

dpinol commented Feb 24, 2022

timholy commented Dec 9, 2020 •

edited

Loading

rapus95 commented Dec 9, 2020 •

edited

Loading

johnnychen94 commented Dec 9, 2020 •

edited

Loading

codecov-io commented Dec 9, 2020 •

edited by codecov bot

Loading

rapus95 commented Jul 26, 2021 •

edited

Loading