allow passing a module to methods #33403

rfourquet · 2019-09-27T14:38:47Z

I often wish to see methods implemented by a specific module. Of course I can do collect(Iterators.filter(x -> x.module == MyModule, methods(eltype))) (collect is quite necessary as otherwise all the methods are printed, because the iterator itself is printed).
But it's cumbersome and I'm not even sure method.module is documented.

This PR implements the API methods(f, [types], [module::Module]), a possible added convenience could be to also allow passing a list of modules.

base/reflection.jl

rfourquet · 2019-10-24T09:35:13Z

Bump! I need this all the time (I come back to this PR today because I wrote in the OP the incantation to a work-around).

StefanKarpinski · 2019-10-28T13:59:37Z

If there's no review of this in the next couple of days, I'm just going to merge it.

vtjnash

Yep, Jeff and I wanted this too recently. Seems like we can always change it later if we want it to behave differently (e.g. looking into submodules, etc.)

rfourquet · 2019-10-28T15:43:34Z

Cool, I will add the tests and news. Actually, are you fine that instead of only m::Module, we allow m::Union{Module,AbstractArray{Module},Tuple{Module,...}) ? More often than not, I'm interested in passing 2 modules (which as a matter of fact are often nested modules...)

vtjnash · 2019-10-28T16:08:30Z

Perhaps it should be default m=() and check m isa Module ? _ === m : (isempty(m) || in(_, m)) in that case?

KristofferC · 2019-10-28T16:27:42Z

base/reflection.jl

 if isa(f, Core.Builtin)
 throw(ArgumentError("argument is not a generic function"))
 end
 t = to_tuple_type(t)
 world = typemax(UInt)
- return MethodList(Method[m[3] for m in _methods(f, t, -1, world)], typeof(f).name.mt)
+ MethodList(Method[m[3] for m in _methods(f, t, -1, world) if mod === nothing || m[3].module == mod],


Could arguably be parentmodule(m[3].module).

Why? If I want methods defined in a submodule S of P, then methods(f, S) will give nothing and methods(f, P) will give all methods of f whether they are in S or P...

Yeah, I think I meant m[3].module == mod || parentmodule(m[3].module) == mod.

Basically, if you are asking for the methods in Pkg you probably want the methods in Pkg.API as well? Anyway, doesn't have to be done now.

Yes a "recursive" option would be useful, maybe as a keyword.

rfourquet · 2019-10-28T16:50:32Z

Perhaps it should be default m=() and check m isa Module ? _ === m : (isempty(m) || in(_, m)) in that case?

Yes I had something like that in mind. I will add a commit.

rfourquet · 2019-10-28T18:07:47Z

Is there a bug with CI not being triggered? No indication of CI status here, and I see the same happening in other PRs too...

ararslan · 2019-10-28T19:23:11Z

No indication of CI status here, and I see the same happening in other PRs too...

The status doesn't show up until the build starts, so if there's a backlog of builds, they may not show up for a bit. Looks like many of the checks have run now, but there are still more to go.

StefanKarpinski · 2019-10-30T13:46:14Z

What about allowing passing a collection of modules and then having a function for iterating a module and all of its children? Then this would be done as methods(f, types, m) for just the module m or as methods(f, types, submodules(m)) for the recursive version.

rfourquet · 2019-10-30T14:29:51Z

Yes that seems like a good idea, more orthogonal.

rfourquet · 2019-11-16T09:02:05Z

Bump: would be great to have that in version 1.4!

Co-Authored-By: Alex Arslan <[email protected]>

rfourquet · 2019-11-16T09:09:29Z

base/reflection.jl

 """
-function methods(@nospecialize(f), @nospecialize(t))
+function methods(@nospecialize(f), @nospecialize(t),
+ @nospecialize(mod::Union{Module,AbstractArray{Module},Tuple{Vararg{Module}}}=()))


I realize that by passing () explicitly, like in methods(f, (Int,), ()), the user would expect an empty result, whereas here we consider it means no filtering on the module... should we change the default to nothing? This use-case is very contrived, but it might happen programmatically... Hm, I think I will use nothing, it's more correct.

rfourquet · 2019-12-11T18:17:56Z

Bump :)

* allow passing a module to methods * add missing `=nothing` (ararslan) Co-Authored-By: Alex Arslan <[email protected]> * allow specifying multiple modules * add NEWS and compat annotations * use `nothing` instead of `()` as a default value

rfourquet added the needs docs Documentation for this change is required label Sep 27, 2019

ararslan reviewed Sep 29, 2019

View reviewed changes

base/reflection.jl Outdated Show resolved Hide resolved

ararslan added needs news A NEWS entry is required for this change needs tests Unit tests are required for this change labels Sep 29, 2019

ararslan requested a review from JeffBezanson September 29, 2019 21:34

vtjnash approved these changes Oct 28, 2019

View reviewed changes

KristofferC reviewed Oct 28, 2019

View reviewed changes

rfourquet force-pushed the rf/method-module branch from 1ece4b7 to d2c97d6 Compare October 28, 2019 17:50

rfourquet removed needs docs Documentation for this change is required needs news A NEWS entry is required for this change needs tests Unit tests are required for this change labels Oct 28, 2019

rfourquet and others added 4 commits November 16, 2019 10:02

allow passing a module to methods

4b0c3e4

add missing =nothing (ararslan)

38527a8

Co-Authored-By: Alex Arslan <[email protected]>

allow specifying multiple modules

2583ccb

add NEWS and compat annotations

69d9c04

rfourquet force-pushed the rf/method-module branch from d2c97d6 to 69d9c04 Compare November 16, 2019 09:03

rfourquet commented Nov 16, 2019

View reviewed changes

use nothing instead of () as a default value

fe3bc37

StefanKarpinski merged commit cb8e1cf into master Dec 11, 2019

StefanKarpinski deleted the rf/method-module branch December 11, 2019 18:42

JeffBezanson mentioned this pull request Jan 6, 2020

Regression using methods with empty tuple for types #34286

Closed

davidanthoff mentioned this pull request Mar 22, 2020

Look at new Julia 1.4 method julia-vscode/SymbolServer.jl#121

Closed

omus mentioned this pull request Oct 1, 2020

Update methods to specialize on mod argument #37838

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

allow passing a module to methods #33403

allow passing a module to methods #33403

rfourquet commented Sep 27, 2019

rfourquet commented Oct 24, 2019

StefanKarpinski commented Oct 28, 2019

vtjnash left a comment

rfourquet commented Oct 28, 2019

vtjnash commented Oct 28, 2019

KristofferC Oct 28, 2019

rfourquet Oct 28, 2019

KristofferC Oct 29, 2019 •

edited

Loading

rfourquet Oct 29, 2019

rfourquet commented Oct 28, 2019

rfourquet commented Oct 28, 2019

ararslan commented Oct 28, 2019

StefanKarpinski commented Oct 30, 2019

rfourquet commented Oct 30, 2019 •

edited

Loading

rfourquet commented Nov 16, 2019

rfourquet Nov 16, 2019

rfourquet commented Dec 11, 2019

allow passing a module to methods #33403

allow passing a module to methods #33403

Conversation

rfourquet commented Sep 27, 2019

rfourquet commented Oct 24, 2019

StefanKarpinski commented Oct 28, 2019

vtjnash left a comment

Choose a reason for hiding this comment

rfourquet commented Oct 28, 2019

vtjnash commented Oct 28, 2019

KristofferC Oct 28, 2019

Choose a reason for hiding this comment

rfourquet Oct 28, 2019

Choose a reason for hiding this comment

KristofferC Oct 29, 2019 • edited Loading

Choose a reason for hiding this comment

rfourquet Oct 29, 2019

Choose a reason for hiding this comment

rfourquet commented Oct 28, 2019

rfourquet commented Oct 28, 2019

ararslan commented Oct 28, 2019

StefanKarpinski commented Oct 30, 2019

rfourquet commented Oct 30, 2019 • edited Loading

rfourquet commented Nov 16, 2019

rfourquet Nov 16, 2019

Choose a reason for hiding this comment

rfourquet commented Dec 11, 2019

KristofferC Oct 29, 2019 •

edited

Loading

rfourquet commented Oct 30, 2019 •

edited

Loading