8000 Adding setup for git executable by kenodegard · Pull Request #640 · gitpython-developers/GitPython · GitHub
[go: up one dir, main page]
Skip to content

Adding setup for git executable #640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Sep 28, 2017
Merged

Adding setup for git executable #640

merged 11 commits into from
Sep 28, 2017

Conversation

kenodegard
Copy link
Contributor

Added a convenience function called refresh. This functions accomplishes 2 things.

The first is that now the user can dynamically set the git path AFTER importing GitPython. In the following example git is neither on the user's $PATH nor is $GIT_PYTHON_GIT_EXECUTABLE defined:

>>> import git
WARNING: Bad git executable. The git executable must be specified in one of the following ways:
    (1) be included in your $PATH, or
    (2) be set via $GIT_PYTHON_GIT_EXECUTABLE, or
    (3) explicitly set via git.setup (or git.refresh).

All git commands will error until this is rectified.

>>> git.refresh("/usr/bin/git")
>>> git.Git().version()
'git version 2.11.0 (Apple Git-81)'
>>>

The second is that this also means that the git executable can be dynamically refreshed at any time by simply calling refresh:

>>> import git
>>> git.Git.GIT_PYTHON_GIT_EXECUTABLE
'git'
>>> git.refresh("/usr/bin/git")
>>> git.Git.GIT_PYTHON_GIT_EXECUTABLE
'/usr/bin/git'

kenodegard added 5 commits July 9, 2017 18:35
@kenodegard
Preliminary implementation of setup/refresh functions
a962464 
Added one function (setup) and an alias (refresh simply calls setup).
These functions give the developer one more way to configure the git
executable path. This also allows the user to interactively adjust the
git executable configured during runtime as these functions dynamically
update the executable path for the entire git module.
@kenodegard
Moved setup function into top level __init__
feed81e 
Discovered that the remote module also relies on the git executable as
such it also needs to be “refreshed” anytime the git executable is
updated or changed. This was best solved by moving the setup function
into the top level __init__ where the setup simply calls
git.cmd.Git.refresh and git.remote.FetchInfo.refresh.
@kenodegard
Renamed refresh to setup and removed alias function & added unittest
aba0494 
Renamed to simplify and avoid issue with nose tests trying to use
`setup` as a setup for testing. Unittest implements basic test for
refreshing with a bad git path versus a good git path.
@kenodegard
Modified AUTHORS file
e8cb31d 
Added my name to list.
@kenodegard
Added ability to silence initial warning
b56d677 
Added the ability to silence the first refresh warning upon import by
setting an environment variable.
@codecov-io
Copy link
codecov-io commented Jul 9, 2017 •
edited
Loading

Codecov Report

❗ No coverage uploaded for pull request base (master@2af601d). Click here to learn what that means.
The diff coverage is 68.88%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #640   +/-   ##
=========================================
  Coverage          ?   92.65%           
=========================================
  Files             ?       61           
  Lines             ?    10029           
  Branches          ?        0           
=========================================
  Hits              ?     9292           
  Misses            ?      737           
  Partials          ?        0
Impacted Files Coverage Δ
git/test/test_git.py 98.73% <100%> (ø)
git/cmd.py 83.29% <65.85%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2af601d...a56136f. Read the comment docs.

@kenodegard kenodegard mentioned this pull request Jul 13, 2017
Closed
@kenodegard
Expanded ability of import
3430bde 
Renamed GIT_PYTHON_NOWARN to GIT_PYTHON_INITERR and added values for
quiet import, warning import, and raise import. These respectively mean
that no message or error is printed if git is non-existent, a plain
warning is printed but the import succeeds, and an ImportError
exception is raised.
@kenodegard
Removed remaining references to git.setup function
4aa750a 
Removed few remaining references to git.setup function (as it was
renamed to refresh).
@kenodegard
Renamed GIT_PYTHON_INITERR to GIT_PYTHON_REFRESH
2b3e769 
Renamed and cleaned up variable names.
@kenodegard
Minor additional cleanup
79a36a5 
Added additional information in the import warning/error that tells the
user how to silence the warning/error. Also added a GIT_OK variable
that allows for a quick check whether the refresh has succeeded instead
of needing to test an actual git command.
@kenodegard
Copy link
Contributor Author

@Byron what else would you need from me for this to be considered?

@kenodegard
Minor bug fixes
90dc03d 
Added tilde expansion as part of the refresh function. Added python
version check such that we properly capture PermissionError in Python
>=3 and OSError in Python <3.
@kenodegard kenodegard mentioned this pull request Aug 14, 2017
Closed
@Byron Byron merged commit 2eb6cf0 into gitpython-developers:master Sep 28, 2017
@Byron
Copy link
Member
Byron commented Sep 28, 2017

Thanks a ton for your contribution, and my apologies for getting to this PR that late!

riley-martine pushed a commit to riley-martine/GitPython that referenced this pull request Dec 7, 2023
@Byron
Merge pull request gitpython-developers#640 from njalerikson/adding_s…
93e0938 
…etup_for_git_executable

Adding setup for git executable
@EliahKagan EliahKagan mentioned this pull request Jan 17, 2024
Closed
@EliahKagan EliahKagan mentioned this pull request Jan 24, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kenodegard @codecov-io @Byron
0