ENH : NumpyDocString subclass collections.Mapping #29
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
Sub-classing `collections.Mapping` and providing a __iter__ and __len__ methods (completely delegated to _parsed_data) makes NumpyDocString behave as a dictionary with fixed keys.
|
Can't hurt I'd think. Any specific benefits that this brings? |
|
Mostly discoverability/to play nice with interactive tools. We are working on a project at my day-job to parse docstrings to auto-generate wrappers for higher-level tools (https://github.com/tacaswell/VTTools/blob/wrap_extension/vttools/scrape.py is the current state) and the first pass was using |
|
makes sense, thanks. |
pv
added a commit
that referenced
this pull request
Feb 14, 2015
ENH : NumpyDocString subclass collections.Mapping
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.
Sub-classing
collections.Mappingand providing a iter and lenmethods (completely delegated to _parsed_data) makes NumpyDocString
behave as a dictionary with fixed keys.