[MAINTENANCE] Use shortened dotted paths in api docs #6831
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
✅ Deploy Preview for niobium-lead-7998 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
👇 Click on the image for a new way to code review
Legend |
Comment on lines
+377
to
+379
| def get_shortest_dotted_path( | ||
| definition: Definition, repo_root_path: pathlib.Path | ||
| ) -> str: |
Comment on lines
+406
to
+423
| while path_parts: | ||
| # Keep traversing, shortening path if shorter path is found. | ||
| path_parts.pop() | ||
| # if __init__.py is found, ast parse and check for import of the class | ||
| init_path = repo_root_path / pathlib.Path(*path_parts, "__init__.py") | ||
| if init_path.is_file(): | ||
|
|
||
| import_names = [] | ||
| with open(init_path) as f: | ||
| file_contents: str = f.read() | ||
|
|
||
| import_names.extend(_get_import_names(file_contents)) | ||
|
|
||
| # If name is found in imports, shorten path to where __init__.py is found | ||
| if definition.name in import_names: | ||
| shortest_path_prefix = str(".".join(path_parts)) | ||
| shortest_path = f"{shortest_path_prefix}.{definition.name}" | ||
|
|
Shinnnyshinshin
approved these changes
Jan 18, 2023
anthonyburdi
deleted the
m/dx-218/use_shortened_dotted_paths_in_api_docs
branch
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.
Changes proposed in this pull request:
__init__.pyfile use that instead of the file with the class definition. For example,great_expectations.core.ExpectationSuiteinstead ofgreat_expectations.core.expectation_suite.ExpectationSuite. This appears in API docs in the class definitions.Definition of Done