/usr/share/pyshared/dulwich/porcelain.py is in python-dulwich 0.9.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | # porcelain.py -- Porcelain-like layer on top of Dulwich
# Copyright (C) 2013 Jelmer Vernooij <jelmer@samba.org>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# or (at your option) a later version of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
import os
import sys
from dulwich import index
from dulwich.client import get_transport_and_path
from dulwich.patch import write_tree_diff
from dulwich.repo import (BaseRepo, Repo)
from dulwich.server import update_server_info as server_update_server_info
"""Simple wrapper that provides porcelain-like functions on top of Dulwich.
Currently implemented:
* archive
* add
* clone
* commit
* commit-tree
* diff-tree
* init
* remove
* rev-list
* update-server-info
* symbolic-ref
These functions are meant to behave similarly to the git subcommands.
Differences in behaviour are considered bugs.
"""
__docformat__ = 'restructuredText'
def open_repo(path_or_repo):
"""Open an argument that can be a repository or a path for a repository."""
if isinstance(path_or_repo, BaseRepo):
return path_or_repo
return Repo(path_or_repo)
def archive(location, committish=None, outstream=sys.stdout,
errstream=sys.stderr):
"""Create an archive.
:param location: Location of repository for which to generate an archive.
:param committish: Commit SHA1 or ref to use
:param outstream: Output stream (defaults to stdout)
:param errstream: Error stream (defaults to stderr)
"""
client, path = get_transport_and_path(location)
if committish is None:
committish = "HEAD"
client.archive(path, committish, outstream.write, errstream.write)
def update_server_info(repo="."):
"""Update server info files for a repository.
:param repo: path to the repository
"""
r = open_repo(repo)
server_update_server_info(r)
def symbolic_ref(repo, ref_name, force=False):
"""Set git symbolic ref into HEAD.
:param repo: path to the repository
:param ref_name: short name of the new ref
:param force: force settings without checking if it exists in refs/heads
"""
repo_obj = open_repo(repo)
ref_path = 'refs/heads/%s' % ref_name
if not force and ref_path not in repo_obj.refs.keys():
raise ValueError('fatal: ref `%s` is not a ref' % ref_name)
repo_obj.refs.set_symbolic_ref('HEAD', ref_path)
def commit(repo=".", message=None, author=None, committer=None):
"""Create a new commit.
:param repo: Path to repository
:param message: Optional commit message
:param author: Optional author name and email
:param committer: Optional committer name and email
:return: SHA1 of the new commit
"""
# FIXME: Support --all argument
# FIXME: Support --signoff argument
r = open_repo(repo)
return r.do_commit(message=message, author=author,
committer=committer)
def commit_tree(repo, tree, message=None, author=None, committer=None):
"""Create a new commit object.
:param repo: Path to repository
:param tree: An existing tree object
:param author: Optional author name and email
:param committer: Optional committer name and email
"""
r = open_repo(repo)
return r.do_commit(message=message, tree=tree, committer=committer,
author=author)
def init(path=".", bare=False):
"""Create a new git repository.
:param path: Path to repository.
:param bare: Whether to create a bare repository.
:return: A Repo instance
"""
if not os.path.exists(path):
os.mkdir(path)
if bare:
return Repo.init_bare(path)
else:
return Repo.init(path)
def clone(source, target=None, bare=False, checkout=None, outstream=sys.stdout):
"""Clone a local or remote git repository.
:param source: Path or URL for source repository
:param target: Path to target repository (optional)
:param bare: Whether or not to create a bare repository
:param outstream: Optional stream to write progress to
:return: The new repository
"""
if checkout is None:
checkout = (not bare)
if checkout and bare:
raise ValueError("checkout and bare are incompatible")
client, host_path = get_transport_and_path(source)
if target is None:
target = host_path.split("/")[-1]
if not os.path.exists(target):
os.mkdir(target)
if bare:
r = Repo.init_bare(target)
else:
r = Repo.init(target)
remote_refs = client.fetch(host_path, r,
determine_wants=r.object_store.determine_wants_all,
progress=outstream.write)
r["HEAD"] = remote_refs["HEAD"]
if checkout:
outstream.write('Checking out HEAD')
index.build_index_from_tree(r.path, r.index_path(),
r.object_store, r["HEAD"].tree)
return r
def add(repo=".", paths=None):
"""Add files to the staging area.
:param repo: Repository for the files
:param paths: Paths to add
"""
# FIXME: Support patterns, directories, no argument.
r = open_repo(repo)
r.stage(paths)
def rm(repo=".", paths=None):
"""Remove files from the staging area.
:param repo: Repository for the files
:param paths: Paths to remove
"""
r = open_repo(repo)
index = r.open_index()
for p in paths:
del index[p]
index.write()
def print_commit(commit, outstream):
"""Write a human-readable commit log entry.
:param commit: A `Commit` object
:param outstream: A stream file to write to
"""
outstream.write("-" * 50 + "\n")
outstream.write("commit: %s\n" % commit.id)
if len(commit.parents) > 1:
outstream.write("merge: %s\n" % "...".join(commit.parents[1:]))
outstream.write("author: %s\n" % commit.author)
outstream.write("committer: %s\n" % commit.committer)
outstream.write("\n")
outstream.write(commit.message + "\n")
outstream.write("\n")
def log(repo=".", outstream=sys.stdout):
"""Write commit logs.
:param repo: Path to repository
:param outstream: Stream to write log output to
"""
r = open_repo(repo)
walker = r.get_walker()
for entry in walker:
print_commit(entry.commit, outstream)
def show(repo=".", committish=None, outstream=sys.stdout):
"""Print the changes in a commit.
:param repo: Path to repository
:param committish: Commit to write
:param outstream: Stream to write to
"""
if committish is None:
committish = "HEAD"
r = open_repo(repo)
commit = r[committish]
parent_commit = r[commit.parents[0]]
print_commit(commit, outstream)
write_tree_diff(outstream, r.object_store, parent_commit.tree, commit.tree)
def diff_tree(repo, old_tree, new_tree, outstream=sys.stdout):
"""Compares the content and mode of blobs found via two tree objects.
:param repo: Path to repository
:param old_tree: Id of old tree
:param new_tree: Id of new tree
:param outstream: Stream to write to
"""
r = open_repo(repo)
write_tree_diff(outstream, r.object_store, old_tree, new_tree)
def rev_list(repo, commits, outstream=sys.stdout):
"""Lists commit objects in reverse chronological order.
:param repo: Path to repository
:param commits: Commits over which to iterate
:param outstream: Stream to write to
"""
r = open_repo(repo)
for entry in r.get_walker(include=[r[c].id for c in commits]):
outstream.write("%s\n" % entry.commit.id)
|