Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
GitPython/git/refs/headref.py at experiment-2012 · gitpython-developers/GitPython · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
gitpython-developers
/
GitPython
Public
Uh oh!
There was an error while loading.
Please reload this page
.
Notifications
You must be signed in to change notification settings
Fork
997
Star
5.2k
Code
Issues
7
Pull requests
1
Discussions
Actions
Security and quality
35
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Security and quality
Insights
Files
Expand file tree
experiment-2012
Breadcrumbs
GitPython
/
git
/
refs
/
headref.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
168 lines (130 loc) · 5.67 KB
experiment-2012
Breadcrumbs
GitPython
/
git
/
refs
/
headref.py
Copy path
Top
File metadata and controls
Code
Blame
168 lines (130 loc) · 5.67 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
from
reference
import
Reference
from
git
.
config
import
SectionConstraint
from
git
.
util
import
join_path
__all__
=
[
"Head"
]
class
Head
(
Reference
):
"""The GitPyhton Head implementation provides more git-command based features
A Head is a named reference to a Commit. Every Head instance contains a name
and a Commit object.
Examples::
>>> repo = Repo("/path/to/repo")
>>> head = repo.heads[0]
>>> head.name
'master'
>>> head.commit
<git.Commit "1c09f116cbc2cb4100fb6935bb162daa4723f455">
>>> head.commit.hexsha
'1c09f116cbc2cb4100fb6935bb162daa4723f455'"""
__slots__
=
tuple
()
_common_path_default
=
"refs/heads"
k_config_remote
=
"remote"
k_config_remote_ref
=
"merge"
# branch to merge from remote
# will be set by init method !
RemoteReferenceCls
=
None
#{ Configuration
def
set_tracking_branch
(
self
,
remote_reference
):
"""
Configure this branch to track the given remote reference. This will alter
this branch's configuration accordingly.
:param remote_reference: The remote reference to track or None to untrack
any references
:return: self"""
if
remote_reference
is
not
None
and
not
isinstance
(
remote_reference
,
self
.
RemoteReferenceCls
):
raise
ValueError
(
"Incorrect parameter type: %r"
%
remote_reference
)
# END handle type
writer
=
self
.
config_writer
()
if
remote_reference
is
None
:
writer
.
remove_option
(
self
.
k_config_remote
)
writer
.
remove_option
(
self
.
k_config_remote_ref
)
if
len
(
writer
.
options
())
==
0
:
writer
.
remove_section
()
# END handle remove section
else
:
writer
.
set_value
(
self
.
k_config_remote
,
remote_reference
.
remote_name
)
writer
.
set_value
(
self
.
k_config_remote_ref
,
Head
.
to_full_path
(
remote_reference
.
remote_head
))
# END handle ref value
return
self
def
tracking_branch
(
self
):
"""
:return: The remote_reference we are tracking, or None if we are
not a tracking branch"""
reader
=
self
.
config_reader
()
if
reader
.
has_option
(
self
.
k_config_remote
)
and
reader
.
has_option
(
self
.
k_config_remote_ref
):
ref
=
Head
(
self
.
repo
,
Head
.
to_full_path
(
reader
.
get_value
(
self
.
k_config_remote_ref
)))
remote_refpath
=
self
.
RemoteReferenceCls
.
to_full_path
(
join_path
(
reader
.
get_value
(
self
.
k_config_remote
),
ref
.
name
))
return
self
.
RemoteReferenceCls
(
self
.
repo
,
remote_refpath
)
# END handle have tracking branch
# we are not a tracking branch
return
None
#{ Configruation
def
_config_parser
(
self
,
read_only
):
if
read_only
:
parser
=
self
.
repo
.
config_reader
()
else
:
parser
=
self
.
repo
.
config_writer
()
# END handle parser instance
return
SectionConstraint
(
parser
,
'branch "%s"'
%
self
.
name
)
def
config_reader
(
self
):
"""
:return: A configuration parser instance constrained to only read
this instance's values"""
return
self
.
_config_parser
(
read_only
=
True
)
def
config_writer
(
self
):
"""
:return: A configuration writer instance with read-and write acccess
to options of this head"""
return
self
.
_config_parser
(
read_only
=
False
)
#} END configuration
@
classmethod
def
delete
(
cls
,
repo
,
*
heads
,
**
kwargs
):
"""Delete the given heads
:param force:
If True, the heads will be deleted even if they are not yet merged into
the main development stream.
Default False"""
force
=
kwargs
.
get
(
"force"
,
False
)
flag
=
"-d"
if
force
:
flag
=
"-D"
repo
.
git
.
branch
(
flag
,
*
heads
)
def
rename
(
self
,
new_path
,
force
=
False
):
"""Rename self to a new path
:param new_path:
Either a simple name or a path, i.e. new_name or features/new_name.
The prefix refs/heads is implied
:param force:
If True, the rename will succeed even if a head with the target name
already exists.
:return: self
:note: respects the ref log as git commands are used"""
flag
=
"-m"
if
force
:
flag
=
"-M"
self
.
repo
.
git
.
branch
(
flag
,
self
,
new_path
)
self
.
path
=
"%s/%s"
%
(
self
.
_common_path_default
,
new_path
)
return
self
def
checkout
(
self
,
force
=
False
,
**
kwargs
):
"""Checkout this head by setting the HEAD to this reference, by updating the index
to reflect the tree we point to and by updating the working tree to reflect
the latest index.
The command will fail if changed working tree files would be overwritten.
:param force:
If True, changes to the index and the working tree will be discarded.
If False, GitCommandError will be raised in that situation.
:param kwargs:
Additional keyword arguments to be passed to git checkout, i.e.
b='new_branch' to create a new branch at the given spot.
:return:
The active branch after the checkout operation, usually self unless
a new branch has been created.
:note:
By default it is only allowed to checkout heads - everything else
will leave the HEAD detached which is allowed and possible, but remains
a special state that some tools might not be able to handle."""
args
=
list
()
kwargs
[
'f'
]
=
force
if
kwargs
[
'f'
]
==
False
:
kwargs
.
pop
(
'f'
)
self
.
repo
.
git
.
checkout
(
self
,
**
kwargs
)
return
self
.
repo
.
active_branch
You can’t perform that action at this time.