reflection: refine and accurately define the options for names
#54659
+85
−59
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aviatesk
force-pushed
the
avi/refactor-names
branch
3 times, most recently
from
1275a10 to
91f75bf
Compare
This commit refines the keyword arguments that `names` can accept,
allowing for more specific exclusions, such as excluding deprecated
names or implicitly `using`-ed names.
For the new behavior of `names`, please refer to the following docstring:
> names(x::Module; non_public::Bool=false, imported::Bool=false,
> usings_explicit::Bool=false, usings_implicit::Bool=false,
> generated::Bool=false, deprecated::Bool=false,
> [usings::Bool=false], [all::Bool=false]) -> Vector{Symbol}
>
> Return a vector of the sorted names of module `x`.
>
> By default, only public names defined within `x` are returned.
>
> By specifying the following keyword arguments, additional names can be included:
> - `non_public=true`: includes names defined within `x` that are not public.
> - `imported=true`: includes names explicitly imported from other modules via `import` statements.
> - `usings_explicit=true`: includes names explicitly imported from other modules via `using` statements.
> - `usings_implicit=true`: includes names implicitly imported from other modules via `using` statements
(i.e., names exported by modules that `x` has `using`-ed).
> - `generated=true`: includes names generated by the compiler frontend (specifically those starting with `#`).
> - `deprecated=true`: includes deprecated names.
Note that the previously existing options (`all` and `usings`) are
retained as alias arguments, ensuring that the previous behavior of
`names` is preserved.
> Additionally, the following keyword arguments can be used as aliases to conveniently specify these options:
> - `usings::Bool=true`: a shortcut to set both `usings_explicit` and `usings_implicit` to `true`.
> - `all::Bool=true`: a shortcut to set `non_public`, `generated`, and `deprecated` to `true`.
By utilizing these newly and accurately defined options, the
implementation of downstream applications like REPL completions can be
simplified.
aviatesk
force-pushed
the
avi/refactor-names
branch
from
91f75bf to
3620254
Compare
This was referenced Jun 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit refines the keyword arguments that
namescan accept, allowing for more specific exclusions, such as excluding deprecated names or implicitlyusing-ed names.For the new behavior of
names, please refer to the following docstring:Note that the previously existing options (
allandusings) are retained as alias arguments, ensuring that the previous behavior ofnamesis preserved.By utilizing these newly and accurately defined options, the implementation of downstream applications like REPL completions can be simplified.