Feature/8 refactoring oop data containers #16
Conversation
…ng README file for correct executing scripts locally.
…h better documentation, structure, having more atomic functions, importing OOP with dataclasses etc.
MobiTikula
added
the
refactoring
There was a problem hiding this comment.
- pulled
- code review
- run - failed
`
Error running consolidate_feature_data.py:
Environment variables:
PROJECT_STATE_MINING: True
REPOSITORIES: [{'orgName': 'absa-group', 'repoName': 'living-doc-example-project', 'queryLabels': ['feature', 'enhancement']}]
Starting the consolidation process.
Processing project with repository: living-doc-example-project...
Traceback (most recent call last):
File "/Users/ab024ll/repos/absa/develop/living-doc-generator/src/consolidate_feature_data.py", line 221, in
consolidated_features_with_project, set_of_used_repos = consolidate_features_with_project()
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/ab024ll/repos/absa/develop/living-doc-generator/src/consolidate_feature_data.py", line 141, in consolidate_features_with_project
merged_features = merge_feature_and_project_data(feature_data, project_data_dict, project_title)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/ab024ll/repos/absa/develop/living-doc-generator/src/consolidate_feature_data.py", line 75, in merge_feature_and_project_data
owner = feature['Owner']
~~~~~~~^^^^^^^^^
KeyError: 'Owner'
`
…ull implement of the data containers.
- github_query_issues.py - failing on saving Issue class to json. - script mostly refactored - several TODO inserted
- Using objects: Repository, Issue and Milestone
issues with new implementation of OOP.
…project_state.py` script logic fully adopted.
…ving config_repositories.
… label `for issue in project["issues"]`.
…ll has some minor problems, with better script/code engineering.
… renamed and github_query_project_state.py is now fully converted into OOP world.
There was a problem hiding this comment.
- pulled
- run
- code review - skipped main scripts as so many changes noted in inner logic classes.
Notes to this review:
- See comments calling for method renaming first.
- There are so many load_from... types - I saw 3
- See comments mentioning GithubManager.
- In one of them is a link to a data example.
- I would propose adopting this solution (later, we can create a commons repo)
- Then, look for the rest of the comments.
Final note: Let's clean up a comment in this PR.
- Create comment in issue parent Epic.
- For all comments that are not OOP-related, create TODO notes with a short description.
- Then, we can mark them as Resolved in this PR.
Used same pattern as in release-notes-generator. First github_query_issues.py fully transformed into OOP.
…roject_state.py logic.
|
Release notes
|
Script refactoring for better readability and efficiency using OOP.
Used dataclasses containers, for better working with well known structures.
Solves #8