FEAT(CodeChurn): Add method to return lines added and removed per file #299
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
added 3 commits
September 20, 2024 13:14
- Implemented `get_added_and_removed_lines()` method in the CodeChurn class. - The new method returns a dictionary with file paths as keys and a tuple (added_lines, removed_lines) as values. - Refactored `_initialize()` to store added and removed lines for each modified file. - Enhanced the class to support easier access to detailed code churn metrics, allowing users to directly retrieve the number of lines added and removed in each commit.
|
LGTM! Sorry it took me so long to get to this, I missed the notification. There's an error with MyPy, could you fix that? |
…in CodeChurn Metric
|
Hi @ishepard, no worries about the delay! |
…_lines()' function definition
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #299 +/- ##
==========================================
+ Coverage 97.25% 97.26% +0.01%
==========================================
Files 17 17
Lines 1091 1097 +6
==========================================
+ Hits 1061 1067 +6
Misses 30 30
|
|
LGTM! Thanks for the work and the PR! |
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 introduces a new method,
get_added_and_removed_lines(), in theCodeChurnclass that provides the number of lines added and removed per file across commits in a repository. The new method returns a dictionary where each key is the file path, and the value is a tuple(added_lines, removed_lines)representing the total added and removed lines for that file.Changes made:
get_added_and_removed_lines():(added_lines, removed_lines)as values._initialize()method to store both added and removed lines for each modified file.get_added_and_removed_lines()method, ensuring correct results across multiple commits.Impact:
This change enhances the
CodeChurnmetric class by allowing users to directly retrieve detailed information on code churn, specifically the number of lines added and removed for each file.Linked Issue:
This PR is related to and resolves Issue #298, which requested a feature to provide a way to access the number of lines added and removed per file in a commit.