-
Notifications
You must be signed in to change notification settings - Fork 68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[GH-142]: Parse attribute annotations for test cases #148
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
Merged
dobbersc
requested changes
Apr 10, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've condensed my comments into the function below, as well as some more type hints and docstring.
# noinspection PyUnresolvedReferences
@lru_cache(maxsize=1)
def parse_attribute_annotations() -> Dict[str, object]:
"""Returns a dictionary of the parser's attribute type guidelines mapping from the attribute's name to its type."""
# We import the attribute annotations types locally to make them accessible in the local namespace,
# such that eval() can evaluate the type annotations.
# Therefore, these imports are not unused and manageable more easily than defining them in the global namespace.
from datetime import datetime
from typing import Optional
from src.parser.html_parser import ArticleBody
with Path("doc/attribute_guidelines.md").open("rb") as file:
attribute_guidelines: bytes = file.read()
root = lxml.html.fromstring(attribute_guidelines)
row_nodes: List[lxml.html.HtmlElement] = root.xpath("//table[@class='annotations']/tr[position() > 1]")
rows: List[Tuple[str, ...]] = [tuple(child.text_content() for child in node.iterchildren()) for node in row_nodes]
assert rows and len(rows[0]) == 3, (
"The annotation guideline table is expected to have exactly three columns: " "'Name', 'Description' and 'Type'."
)
local_ns: Dict[str, Any] = locals()
return {name: eval(annotation, globals(), local_ns) for name, _, annotation in rows}
…otations # Conflicts: # tests/test_parser.py
dobbersc
reviewed
Apr 11, 2023
Co-authored-by: Conrad Dobberstein <29147025+dobbersc@users.noreply.github.com>
dobbersc
approved these changes
Apr 12, 2023
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 PR implements a parsing mechanism based on
eval()
to get the attribute type hints used in the unit tests directly from theattribute_guidelines.md
. See #142 for further info.Closes #142