Comparing the difference between 2 RemoteReferences #1113

Activity

1. dclong commented on Jan 24, 2021

   

   dclong

   on Jan 24, 2021

   Author

   More actions

   I tried git command and it does show difference when I run git diff origin/main..origin/debian. This makes me believe that there's a bug in GitPython.

   The repository I'm using is https://github.com/dclong/docker-ubuntu_b.
2. Byron

   added

   waiting for feedback

   Q&A

   on Jan 25, 2021
3. Byron commented on Jan 25, 2021

   

   Byron

   on Jan 25, 2021

   Member

   More actions

   Could you show the code involving GitPython so I get an idea how you are trying to do it?
   Diffing can be tricky, but is believed to be working. In the meantime, you can debug GitPython to learn which git commands are actually invoked.
4. dclong commented on Jan 25, 2021

   

   dclong

   on Jan 25, 2021

   Author

   More actions

   @Byron Please refer to https://github.com/dclong/reproduce_GitPython_issue/blob/master/GitPython.ipynb.
5. Byron commented on Jan 25, 2021

   

   Byron

   on Jan 25, 2021

   Member

   More actions

   Would you mind finding all the pieces in the referenced file and put it here in a single code block? Ideally that would be executable while in the repository mentioned in the issue itself.
6. dclong commented on Jan 25, 2021

   

   dclong

   on Jan 25, 2021

   Last edited by dclong

   Author

   More actions

   The referenced file is a Jupyter/Lab notebook which is executable if you have Jupyter/Lab (a Python library) installed. It has code (both Python and Shell commands), output and comments all in one place so that it is easy to understand. Please let me know if you are unfamiliar with Jupyter/Lab notebook and still prefer a single code block here.
7. Byron commented on Jan 26, 2021

   

   Byron

   on Jan 26, 2021

   Member

   More actions

   I can't execute and won't get into executing Jupyter Notebooks, but will take a look at code posted here. If that's not possible, Stackoverflow might be a better place to ask for help.
8. dclong commented on Jan 26, 2021

   

   dclong

   on Jan 26, 2021

   Last edited by dclong

   Author

   More actions

   #!/usr/bin/env python3
   import tempfile
   import subprocess as sp
   import git
   from git import Repo
   
   url = "https://github.com/dclong/docker-ubuntu_b.git"
   dir_local = tempfile.mkdtemp()
   repo = git.Repo.clone_from(url, dir_local, branch="main")
   ref_main = next(ref for ref in repo.refs if ref.name == "origin/main")
   ref_debian = next(ref for ref in repo.refs if ref.name == "origin/debian")
   diffs = ref_main.commit.diff(ref_debian.commit)
   # check whether there are any diff 
   print("origin/main vs origin/debian using GitPython:") 
   for diff in diffs:
       print(diff.diff)
   print("origin/main vs origin/debian using git diff:")
   sp.run(f"git -C {dir_local} diff origin/main..origin/debian", shell=True, check=True)
   
9. dclong commented on Jan 26, 2021

   

   dclong

   on Jan 26, 2021

   Author

   More actions

   The above Python code reproduces the issue. Coping and paste the code into a Python script, run it and you will see the issue. Basically, GitPython doesn't detect any difference between origin/main and origin/debian of the repo while git diff does.
10. Byron

    removed

    waiting for feedback

    on Jan 27, 2021
11. Byron commented on Jan 27, 2021

    

    Byron

    on Jan 27, 2021

    Member

    More actions

    Thanks for posting - I can reproduce the issue now.

    Here is a 'fixed' version of the script above, note the lack of .diff when printing.

    #!/usr/bin/env python3
    import tempfile
    import subprocess as sp
    import git
    from git import Repo
    
    url = "https://github.com/dclong/docker-ubuntu_b.git"
    dir_local = tempfile.mkdtemp()
    repo = git.Repo.clone_from(url, dir_local, branch="main")
    ref_main = next(ref for ref in repo.refs if ref.name == "origin/main")
    ref_debian = next(ref for ref in repo.refs if ref.name == "origin/debian")
    diffs = ref_main.commit.diff(ref_debian.commit)
    # check whether there are any diff 
    print("origin/main vs origin/debian using GitPython:") 
    print(diffs) # ⬅ also shows that there is indeed a diff as expected.
    for diff in diffs:
        print(diff) # ⬅ note the lack of '.diff' - where was that coming from?
    print("origin/main vs origin/debian using git diff:")
    sp.run(f"git -C {dir_local} diff origin/main..origin/debian", shell=True, check=True)

    And the (cleaned) output is…

    Dockerfile
    =======================================================
    lhs: 100644 | 8ae5c7650a8c031a8e176d896a3665bbe7e2aae8
    rhs: 100644 | 9f2304d9a97aa1279ad1938b3bb74790172c9d8b
    

    …which is indeed the file in question.

    Even though I am closing this issue, please feel free to post follow-up questions in the comments if there is a need.
12. Byron

    closed this as completedon Jan 27, 2021
13. Byron

    reopened this on Feb 26, 2021
14. Byron

    closed this as completedon Feb 26, 2021
15. gitpython-developers

    locked and limited conversation to collaborators on Feb 26, 2021