Auto Report Generation #19
Draft
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
nivcertora
requested changes
Nov 24, 2024
Comment on lines
+24
to
+37
| def main(): | ||
| args = parse_args() | ||
|
|
||
| with open(args.template) as f: | ||
| template = f.read() | ||
|
|
||
| report = ReportGenerator(template, AaveTags(args.proposal_id).tag_mappings).report | ||
|
|
||
| with open(f'v3-{args.proposal_id}-<title>.md', 'w') as f: | ||
| f.write(report) | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| main() |
There was a problem hiding this comment.
Must have Docs both here and in the general readme file.
Comment on lines
+32
to
+33
| with open(f'v3-{args.proposal_id}-<title>.md', 'w') as f: | ||
| f.write(report) |
There was a problem hiding this comment.
It shouldnt be the proposal_title field instead of -<title>.md?
Comment on lines
+24
to
+37
| def main(): | ||
| args = parse_args() | ||
|
|
||
| with open(args.template) as f: | ||
| template = f.read() | ||
|
|
||
| report = ReportGenerator(template, AaveTags(args.proposal_id).tag_mappings).report | ||
|
|
||
| with open(f'v3-{args.proposal_id}-<title>.md', 'w') as f: | ||
| f.write(report) | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| main() |
There was a problem hiding this comment.
Use the project logger here.
Comment on lines
+4
to
+63
| class ReportGenerator: | ||
| LOOP_COMMAND = 'loop' | ||
|
|
||
| def __init__(self, template: str, tag_mappings: dict[str, str | list[str]]) -> None: | ||
| self.report = self.__generate_report(template, tag_mappings) | ||
|
|
||
| @staticmethod | ||
| def __generate_report(template: str, tag_mappings: dict[str, str | list[str]]) -> str: | ||
| res = ReportGenerator.__replace_loops(template, tag_mappings) | ||
| res = ReportGenerator.__fill_tags(res, tag_mappings) | ||
| return res | ||
|
|
||
| @staticmethod | ||
| def __fill_tags(template: str, tag_mappings: dict[str, str | list[str]]) -> str: | ||
| res = template | ||
| for tag, value in tag_mappings.items(): | ||
| if isinstance(value, str): | ||
| res = res.replace(f'<{tag}>', value) | ||
| return res | ||
|
|
||
| @staticmethod | ||
| def __replace_loops(template: str, tag_mappings: dict[str, str | list[str]]) -> str: | ||
| pattern = rf'<{ReportGenerator.LOOP_COMMAND}:([^>]+)>' | ||
| matches = re.findall(pattern, template) | ||
| res = template | ||
| for m in matches: | ||
| loop_tag_mapping = {tag: tag_mappings[tag] for tag in m.split(',')} | ||
| res = ReportGenerator.__unroll_loop(res, m, loop_tag_mapping) | ||
| return res | ||
|
|
||
| @staticmethod | ||
| def __unroll_loop(template: str, looping_tags: str, loop_tag_mappings: dict[str, list[str]]) -> str: | ||
| start_tag = f'<{ReportGenerator.LOOP_COMMAND}:{looping_tags}>' | ||
| end_tag = f'</{ReportGenerator.LOOP_COMMAND}>' | ||
|
|
||
| start_index = template.index(start_tag) + len(start_tag) | ||
| end_index = template.index(end_tag) | ||
|
|
||
| loop_template = template[start_index:end_index].strip() | ||
|
|
||
| loop_result = ReportGenerator.__build_loop_content(loop_template, loop_tag_mappings) | ||
|
|
||
| return template[:template.index(start_tag)] + loop_result + template[end_index + len(end_tag):] | ||
|
|
||
| @staticmethod | ||
| def extract_loop_values_lengths(values: list[list[str]]) -> int: | ||
| expected_length = len(values[0]) | ||
| for v in values: | ||
| if len(v) != expected_length: | ||
| raise ValueError('lengths not equal') | ||
| return expected_length | ||
|
|
||
| @staticmethod | ||
| def __build_loop_content(loop_template: str, loop_tag_mappings: dict[str, list[str]]) -> str: | ||
| loop_count = ReportGenerator.extract_loop_values_lengths(list(loop_tag_mappings.values())) | ||
| res = '' | ||
| for i in range(loop_count): | ||
| res += ReportGenerator.__fill_tags(loop_template, | ||
| {tag: values[i] for tag, values in loop_tag_mappings.items()}) + '\n' | ||
| return res.strip() |
There was a problem hiding this comment.
Add Docs to all methods in the class
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.
No description provided.