fix: retrieve keyword arguments for docstrings #389
Merged
Conversation
This file contains 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
tbpg
reviewed
Aug 9, 2024
docfx_yaml/extension.py
Outdated
|
|
||
| # Retrieve arguments from various source,s like `argspec.args`, | ||
| # `argspec.kwonlyargs` for positional/keyword arguments. | ||
| args_to_iterate = argspec.args |
| arg_map['var_type'] = type_map[arg] | ||
| args.append(arg_map) | ||
|
|
||
| annotations = getattr(argspec, 'annotations', []) |
There was a problem hiding this comment.
Normally the test would involve updating the goldens as this function is called directly from Sphinx and can't be mocked easily.
I could refactor the logic out and add unit tests separately as a followup, and release only when the refactoring of this method is done.
Co-authored-by: Tyler Bui-Palsulich <26876514+tbpg@users.noreply.github.com>
dandhlee
commented
Aug 9, 2024
docfx_yaml/extension.py
Outdated
|
|
||
| # Retrieve arguments from various source,s like `argspec.args`, | ||
| # `argspec.kwonlyargs` for positional/keyword arguments. | ||
| args_to_iterate = argspec.args |
| arg_map['var_type'] = type_map[arg] | ||
| args.append(arg_map) | ||
|
|
||
| annotations = getattr(argspec, 'annotations', []) |
There was a problem hiding this comment.
Normally the test would involve updating the goldens as this function is called directly from Sphinx and can't be mocked easily.
I could refactor the logic out and add unit tests separately as a followup, and release only when the refactoring of this method is done.
dansaadati
reviewed
Sep 6, 2024
|
Ran tests over several libraries locally. |
dansaadati
approved these changes
Sep 6, 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.
From
inspect.getfullargspec, keyword arguments were stored as different attributes, underkwonlyargsandkwonlydefaults.kwonlyargskwonlydefaultsas well, for default values stored for keyword arguments. Interestingly,defaultsare stored as tuples of values butkwonlydefaultsis stored as name & value KVP, so I've directly addressed this. Since dictionaries retain order, this won't mess up the order for existing defaults algorithm.Fixes #313. See b/358448617 for context and staging to verify the fixes.