Ben Scripts and Qualitative Analysis Code #279

cactusbranch01 · 2024-04-30T05:00:23Z

Changes:

diff3 analysis script
README
style fixes
repo.py cones repo to a specified path. Alternative to the clone_repo method since it takes a string for the path and returns a different git repo obj

fixed style fixed changes from old branch why do we keep changing everything in repo.py every month???

mernst · 2024-05-04T16:42:19Z

src/python/README.md

+
+
+
+- Python 3.x installed on your system.


Why doesn't this use the same setup as the rest of the project -- namely, the use of conda or mamba to set up an environment?

Yes, the setup is the same as the rest of the project, we still are using a conda or mamba environment. I think I will just delete this line since there is already another README that more thoroughly explains setup. Thanks!

mernst · 2024-05-04T16:42:40Z

src/python/diff3_analysis.py

@@ -0,0 +1,259 @@
+"""
+Recreates a merge and outputs the diff files for two algorithms for comparison on a given conflict.


For the merge recreation, why not use the existing src/python/replay_merge.py script? Then this script can be simplified to having a single purpose -- outputting the diff files. If that is not possible, please document why.

Thanks, just added a few points on this in the README:

It uses diff3 to show the base, conflicting branches, and the programmer merge which is useful to see the context around the conflict.

It automates everything making the workflow faster. You just give it a conflict, and it outputs the differences between a pair of merge algorithms in a .txt file.

This has not answered the question. Why can't this script either call replay_merge.py internally and then do the diff? That would make this script much shorter and simpler.

You should be able to do that, it allows you to delete all the setup code since replay_merge does everything. I would suggest maybe just remove this script and adding a flag -create_diffs to replay_merge.py that computes the diff as you do it here when this flag is used (by default set it to false though).

mernst · 2024-05-04T16:43:18Z

src/python/README.md

+
+Ex:
+
+python3 diff3_analysis.py "gitmerge_ort" "spork" 32 "./mixed_results_spork"


Shouldn't indexes contain a hyphen?

I think in Python, CLI arguments are usually passed in as strings and its up to the script to interpret them as numbers.

I meant that indexes are now (for example) "38-3" rather than a number.

Good point. Now my scripts also use the idx column instead of the index in the spreadsheet. I updated the README and docs as well.

mernst · 2024-05-04T16:44:55Z

src/python/repo.py

@@ -93,6 +93,36 @@ def clone_repo(repo_slug: str, repo_dir: Path) -> git.repo.Repo:
        ) from None


+# Alternative clone repo method that returns git repo object for diff3 scripts


How is it different? The documentation is identical.

…ing-Ben-Analysis into ben-main

style fixed on docs commit

mernst

"Ben Scripts and Qualitative Analysis Code" will not be a good commit message for the commit that results from this pull request. Can you please make it more descriptive?

It seems that the "style fixes", "diff3 analysis script", and "repo.py" mentioned in the pull request description can be broken into separate pull requests. Is there a reason that is impossible or undesirable?

mernst · 2024-05-15T22:30:50Z

src/python/README.md

@@ -0,0 +1,53 @@
+# Python Scripts for Merge Conflict Analysis
+
+


There is a lot of extraneous whitespace in this README file.

I believe this is standard. I think is designed to be seen from an end-users perspective like in the browser it looks normal.

https://github.com/cactusbranch01/AST-Merging-Ben-Analysis/blob/ben-main/src/python/README.md

If you think I should change this, though, I would be happy to.

mernst · 2024-05-15T22:33:24Z

src/python/README.md

+
+- It is different than the src/python/replay_merge, as it performs a 3 way diff between the base, conflicting branches, and the programmer merge.
+
+- Outputs the differences between a pair of merge algorithms in a .txt file.


How does one interpret those differences?

Added more details. Thanks!

mernst · 2024-05-15T22:34:28Z

src/python/README.md

+
+- `diff3_analysis.py`: This script analyzes merge conflicts for two merge tools on a given conflict.
+
+- It is different than the src/python/replay_merge, as it performs a 3 way diff between the base, conflicting branches, and the programmer merge.


Could it first call replay_merge.py, and then do its own unique work? That could make it much smaller and simpler. If that is impossible or undesirable, why?

Updated the readme.

It might be possible to use replay_merge.py for the underlying process of recreating the merge. However, this still wouldn't have the programmer merge. Moreover, the diff3_analysis method keeps the conflict and repos to diff3 everything and outputs a .txt file. Also, both methods use different systems for organizing the files (mine makes its own cloned repo folders), which would take some time to change.

Honestly, I think the functionality is different enough that I would prefer to leave both as separate methods. It would probably be a significant time investment refactoring, and looking at how different the actual code is, I'm sure where to begin. Both methods work successfully, and I don't this is worth the extra effort.

mernst · 2024-05-15T22:35:32Z

src/python/README.md

+
+
+
+- Necessary Python packages installed inside conda or mamba environment(`pandas`, `GitPython`).


Explain exactly how to do the setup, or cross-reference to other instructions, or leave it out entirely under the assumption that the user has already done the setup.

Fixed. Thanks!

mernst · 2024-05-15T22:36:53Z

src/python/diff3_analysis.py

@@ -0,0 +1,259 @@
+"""
+Recreates a merge and outputs the diff files for two algorithms for comparison on a given conflict.


This has not answered the question. Why can't this script either call replay_merge.py internally and then do the diff? That would make this script much shorter and simpler.

mernst · 2024-05-15T22:38:59Z

src/python/repo.py

+@timeout(10 * 60)
+def clone_repo_to_path(repo_name: str, path: str) -> git.repo.Repo:
+    """Clones a repository to a specified path. Alternative to the clone_repo
+    method since it takes a string path and returns a git repo Repo obj.


clone_repo also returns a git repo Repo object, according to its signature on line 61. So, is the only difference taking a string versus a Path? If so, then can this method be a two-liner that creates a Path from a string and then calls clone_repo?

Yes just wrap the string you use into Path(str) that will give you the Path object directly and you can call the original function with that.

mernst · 2024-05-16T14:20:04Z

src/python/README.md

+
+
+
+- `diff3_analysis.py`: This script analyzes merge conflicts for two merge tools on a given conflict.


The scripts in this directory are already described in the top-level README. Why have you chosen to create a new one rather than locating this information with the existing information?

benedikt-schesch · 2024-06-07T20:23:16Z

I will close this PR for now

cactusbranch01 and others added 5 commits April 29, 2024 21:59

ben-main

45d5818

fixed style fixed changes from old branch why do we keep changing everything in repo.py every month???

style, readme, and cli updates

96a4262

updated readme + other changes

5802ef8

Update README.md

6cd60d4

Update README.md

e36ccfe

mernst requested changes May 4, 2024

View reviewed changes

mernst assigned cactusbranch01 May 4, 2024

cactusbranch01 added 6 commits May 4, 2024 13:36

Updates to README

b33ecb1

Merge branch 'ben-main' of https://github.com/cactusbranch01/AST-Merg…

2e07556

…ing-Ben-Analysis into ben-main

repo.py docs

e0084e5

Updated clone_repo docs

ca10ec7

Style fixed

48af99c

style fixed on docs commit

Scripts using idx update

c1b0289

cactusbranch01 changed the title ~~ben-main new patch~~ Ben Scripts and Qualitative Analysis Code May 13, 2024

Merge ../AST-Merging-Evaluation-branch-master into ben-main

785dd3c

mernst requested changes May 15, 2024

View reviewed changes

mernst reviewed May 16, 2024

View reviewed changes

cactusbranch01 added 4 commits May 20, 2024 19:38

Delete jupyter nbs

34a89a0

Merge remote-tracking branch 'upstream/main' into ben-main

3f10535

updated README

4cc20d4

Merge remote-tracking branch 'upstream/main' into ben-main

35125e9

benedikt-schesch closed this Jun 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ben Scripts and Qualitative Analysis Code #279

Ben Scripts and Qualitative Analysis Code #279

cactusbranch01 commented Apr 30, 2024 •

edited

Loading

mernst May 4, 2024

cactusbranch01 May 4, 2024

mernst May 4, 2024

cactusbranch01 May 4, 2024 •

edited

Loading

mernst May 15, 2024

benedikt-schesch May 16, 2024

mernst May 4, 2024

cactusbranch01 May 4, 2024

mernst May 5, 2024

cactusbranch01 May 8, 2024

mernst May 4, 2024

cactusbranch01 May 6, 2024

mernst left a comment

mernst May 15, 2024

cactusbranch01 May 27, 2024

mernst May 15, 2024

cactusbranch01 May 27, 2024

mernst May 15, 2024

cactusbranch01 May 27, 2024

mernst May 15, 2024

cactusbranch01 May 27, 2024

mernst May 15, 2024

mernst May 15, 2024

benedikt-schesch May 16, 2024

mernst May 16, 2024

benedikt-schesch commented Jun 7, 2024

		@@ -0,0 +1,259 @@
		"""
		Recreates a merge and outputs the diff files for two algorithms for comparison on a given conflict.


		Ex:

		python3 diff3_analysis.py "gitmerge_ort" "spork" 32 "./mixed_results_spork"

		@@ -93,6 +93,36 @@ def clone_repo(repo_slug: str, repo_dir: Path) -> git.repo.Repo:
		) from None


		# Alternative clone repo method that returns git repo object for diff3 scripts

		@@ -0,0 +1,53 @@
		# Python Scripts for Merge Conflict Analysis


		- It is different than the src/python/replay_merge, as it performs a 3 way diff between the base, conflicting branches, and the programmer merge.

		- Outputs the differences between a pair of merge algorithms in a .txt file.


		- `diff3_analysis.py`: This script analyzes merge conflicts for two merge tools on a given conflict.

		- It is different than the src/python/replay_merge, as it performs a 3 way diff between the base, conflicting branches, and the programmer merge.




		- Necessary Python packages installed inside conda or mamba environment(`pandas`, `GitPython`).

Ben Scripts and Qualitative Analysis Code #279

Ben Scripts and Qualitative Analysis Code #279

Conversation

cactusbranch01 commented Apr 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cactusbranch01 May 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mernst left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benedikt-schesch commented Jun 7, 2024

cactusbranch01 commented Apr 30, 2024 •

edited

Loading

cactusbranch01 May 4, 2024 •

edited

Loading