GitPython/git/cmd.py at a5db3d3c49ebe559cb80983d7bb855d4adf1b887 · gitprime/GitPython · GitHub

Repository navigation

History

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

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

# cmd.py

# This module is part of GitPython and is released under

# the BSD License: http://www.opensource.org/licenses/bsd-license.php

import os

import sys

import select

import logging

import threading

import errno

import mmap

from git.odict import OrderedDict

from contextlib import contextmanager

import signal

import subprocess

from subprocess import (

call,

Popen,

PIPE

)

from .util import (

LazyMixin,

stream_copy,

)

from .exc import (

GitCommandError,

GitCommandNotFound

)

from git.compat import (

string_types,

defenc,

force_bytes,

PY3,

bchr,

# just to satisfy flake8 on py3

unicode,

safe_decode,

is_posix,

is_win,

)

import io

from _io import UnsupportedOperation

execute_kwargs = set(('istream', 'with_keep_cwd', 'with_extended_output',

'with_exceptions', 'as_process', 'stdout_as_string',

'output_stream', 'with_stdout', 'kill_after_timeout',

'universal_newlines'))

log = logging.getLogger('git.cmd')

log.addHandler(logging.NullHandler())

__all__ = ('Git',)

if is_win:

WindowsError = OSError # @ReservedAssignment

if PY3:

_bchr = bchr

else:

def _bchr(c):

return c

# get custom byte character handling

# ==============================================================================

## @name Utilities

# ------------------------------------------------------------------------------

# Documentation

## @{

def handle_process_output(process, stdout_handler, stderr_handler, finalizer,

decode_stdout=True, decode_stderr=True):

"""Registers for notifications to lean that process output is ready to read, and dispatches lines to

the respective line handlers. We are able to handle carriage returns in case progress is sent by that

mean. For performance reasons, we only apply this to stderr.

This function returns once the finalizer returns

:return: result of finalizer

:param process: subprocess.Popen instance

:param stdout_handler: f(stdout_line_string), or None

:param stderr_hanlder: f(stderr_line_string), or None

:param finalizer: f(proc) - wait for proc to finish"""

def _parse_lines_from_buffer(buf):

line = b''

bi = 0

lb = len(buf)

while bi < lb:

char = _bchr(buf[bi])

bi += 1

if char in (b'\r', b'\n') and line:

yield bi, line + b'\n'

line = b''

else:

line += char

# END process parsed line

# END while file is not done reading

# end

def _read_lines_from_fno(fno, last_buf_list):

buf = os.read(fno, mmap.PAGESIZE)

buf = last_buf_list[0] + buf

bi = 0

for bi, line in _parse_lines_from_buffer(buf):

yield line

# for each line to parse from the buffer

# keep remainder

last_buf_list[0] = buf[bi:]

def _dispatch_single_line(line, handler, decode):

if decode:

line = line.decode(defenc)

if line and handler:

handler(line)

# end dispatch helper

# end single line helper

def _dispatch_lines(fno, handler, buf_list, decode):

lc = 0

for line in _read_lines_from_fno(fno, buf_list):

_dispatch_single_line(line, handler, decode)

lc += 1

# for each line

return lc

# end

def _deplete_buffer(fno, handler, buf_list, decode):

lc = 0

while True:

line_count = _dispatch_lines(fno, handler, buf_list, decode)

lc += line_count

if line_count == 0:

break

# end deplete buffer

if buf_list[0]:

_dispatch_single_line(buf_list[0], handler, decode)

lc += 1

# end

return lc

# end

try:

outfn = process.stdout.fileno()

errfn = process.stderr.fileno()

poll = select.poll() # @UndefinedVariable

except (UnsupportedOperation, AttributeError):

# Oh ... probably we are on windows. or TC mockap provided for streams.

# Anyhow, select.select() can only handle sockets, we have files

# The only reliable way to do this now is to use threads and wait for both to finish

def _handle_lines(fd, handler, decode):

for line in fd:

if handler:

if decode:

line = line.decode(defenc)

handler(line)

threads = []

for fd, handler, decode in zip((process.stdout, process.stderr),

(stdout_handler, stderr_handler),

(decode_stdout, decode_stderr),):

t = threading.Thread(target=_handle_lines, args=(fd, handler, decode))

t.setDaemon(True)

t.start()

threads.append(t)

for t in threads:

t.join()

else:

# poll is preferred, as select is limited to file handles up to 1024 ... . This could otherwise be

# an issue for us, as it matters how many handles our own process has

fdmap = {outfn: (stdout_handler, [b''], decode_stdout),

errfn: (stderr_handler, [b''], decode_stderr)}

READ_ONLY = select.POLLIN | select.POLLPRI | select.POLLHUP | select.POLLERR # @UndefinedVariable

CLOSED = select.POLLHUP | select.POLLERR # @UndefinedVariable

poll.register(process.stdout, READ_ONLY)

poll.register(process.stderr, READ_ONLY)

closed_streams = set()

while True:

# no timeout

try:

poll_result = poll.poll()

except select.error as e:

if e.args[0] == errno.EINTR:

continue

raise

# end handle poll exception

for fd, result in poll_result:

if result & CLOSED:

closed_streams.add(fd)

else:

_dispatch_lines(fd, *fdmap[fd])

# end handle closed stream

# end for each poll-result tuple

if len(closed_streams) == len(fdmap):

break

# end its all done

# end endless loop

# Depelete all remaining buffers

for fno, (handler, buf_list, decode) in fdmap.items():

_deplete_buffer(fno, handler, buf_list, decode)

# end for each file handle

for fno in fdmap.keys():

poll.unregister(fno)

# end don't forget to unregister !

return finalizer(process)

def dashify(string):

return string.replace('_', '-')

def slots_to_dict(self, exclude=()):

return dict((s, getattr(self, s)) for s in self.__slots__ if s not in exclude)

def dict_to_slots_and__excluded_are_none(self, d, excluded=()):

for k, v in d.items():

setattr(self, k, v)

for k in excluded:

setattr(self, k, None)

## -- End Utilities -- @}

# value of Windows process creation flag taken from MSDN

CREATE_NO_WINDOW = 0x08000000

## CREATE_NEW_PROCESS_GROUP is needed to allow killing it afterwards,

# seehttps://docs.python.org/3/library/subprocess.html#subprocess.Popen.send_signal

PROC_CREATIONFLAGS = (CREATE_NO_WINDOW | subprocess.CREATE_NEW_PROCESS_GROUP

if is_win

else 0)

class Git(LazyMixin):

"""

The Git class manages communication with the Git binary.

It provides a convenient interface to calling the Git binary, such as in::

g = Git( git_dir )

g.init() # calls 'git init' program

rval = g.ls_files() # calls 'git ls-files' program

``Debugging``

Set the GIT_PYTHON_TRACE environment variable print each invocation

of the command to stdout.

Set its value to 'full' to see details about the returned values.

"""

__slots__ = ("_working_dir", "cat_file_all", "cat_file_header", "_version_info",

"_git_options", "_environment")

_excluded_ = ('cat_file_all', 'cat_file_header', '_version_info')

def __getstate__(self):

return slots_to_dict(self, exclude=self._excluded_)

def __setstate__(self, d):

dict_to_slots_and__excluded_are_none(self, d, excluded=self._excluded_)

# CONFIGURATION

# The size in bytes read from stdout when copying git's output to another stream

max_chunk_size = io.DEFAULT_BUFFER_SIZE

git_exec_name = "git" # default that should work on linux and windows

# Enables debugging of GitPython's git commands

GIT_PYTHON_TRACE = os.environ.get("GIT_PYTHON_TRACE", False)

# Provide the full path to the git executable. Otherwise it assumes git is in the path

_git_exec_env_var = "GIT_PYTHON_GIT_EXECUTABLE"

GIT_PYTHON_GIT_EXECUTABLE = os.environ.get(_git_exec_env_var, git_exec_name)

# If True, a shell will be used when executing git commands.

# This should only be desirable on windows, see https://github.com/gitpython-developers/GitPython/pull/126

# for more information

# Override this value using `Git.USE_SHELL = True`

USE_SHELL = False

class AutoInterrupt(object):

"""Kill/Interrupt the stored process instance once this instance goes out of scope. It is

used to prevent processes piling up in case iterators stop reading.

Besides all attributes are wired through to the contained process object.

The wait method was overridden to perform automatic status code checking

and possibly raise."""

__slots__ = ("proc", "args")

def __init__(self, proc, args):

self.proc = proc

self.args = args

def __del__(self):

if self.proc is None:

return

proc = self.proc

self.proc = None

if proc.stdin:

proc.stdin.close()

if proc.stdout:

proc.stdout.close()

if proc.stderr:

proc.stderr.close()

# did the process finish already so we have a return code ?

if proc.poll() is not None:

return

# can be that nothing really exists anymore ...

if os is None or os.kill is None:

return

# try to kill it

try:

proc.terminate()

proc.wait() # ensure process goes away

except (OSError, WindowsError):

pass # ignore error when process already died

except AttributeError:

# try windows

# for some reason, providing None for stdout/stderr still prints something. This is why

# we simply use the shell and redirect to nul. Its slower than CreateProcess, question

# is whether we really want to see all these messages. Its annoying no matter what.

call(("TASKKILL /F /T /PID %s 2>nul 1>nul" % str(proc.pid)), shell=True)

# END exception handling

def __getattr__(self, attr):

return getattr(self.proc, attr)

def wait(self, stderr=b''):

"""Wait for the process and return its status code.

:param stderr: Previously read value of stderr, in case stderr is already closed.

:warn: may deadlock if output or error pipes are used and not handled separately.

:raise GitCommandError: if the return status is not 0"""

if stderr is None:

stderr = b''

stderr = force_bytes(stderr)

status = self.proc.wait()

def read_all_from_possibly_closed_stream(stream):

try:

return stderr + force_bytes(stream.read())

except ValueError:

return stderr or b''

if status != 0:

errstr = read_all_from_possibly_closed_stream(self.proc.stderr)

log.debug('AutoInterrupt wait stderr: %r' % (errstr,))

raise GitCommandError(self.args, status, errstr)

# END status handling

return status

# END auto interrupt

class CatFileContentStream(object):

"""Object representing a sized read-only stream returning the contents of

an object.

It behaves like a stream, but counts the data read and simulates an empty

stream once our sized content region is empty.

If not all data is read to the end of the objects's lifetime, we read the

rest to assure the underlying stream continues to work"""

__slots__ = ('_stream', '_nbr', '_size')

def __init__(self, size, stream):

self._stream = stream

self._size = size

self._nbr = 0 # num bytes read

# special case: if the object is empty, has null bytes, get the

# final newline right away.

if size == 0:

stream.read(1)

# END handle empty streams

def read(self, size=-1):

bytes_left = self._size - self._nbr

if bytes_left == 0:

return b''

if size > -1:

# assure we don't try to read past our limit

size = min(bytes_left, size)

else:

# they try to read all, make sure its not more than what remains

size = bytes_left

# END check early depletion

data = self._stream.read(size)

self._nbr += len(data)

# check for depletion, read our final byte to make the stream usable by others

if self._size - self._nbr == 0:

self._stream.read(1) # final newline

# END finish reading

return data

def readline(self, size=-1):

if self._nbr == self._size:

return b''

# clamp size to lowest allowed value

bytes_left = self._size - self._nbr

if size > -1:

size = min(bytes_left, size)

else:

size = bytes_left

# END handle size

data = self._stream.readline(size)

self._nbr += len(data)

# handle final byte

if self._size - self._nbr == 0:

self._stream.read(1)

# END finish reading

return data

def readlines(self, size=-1):

if self._nbr == self._size:

return list()

# leave all additional logic to our readline method, we just check the size

out = list()

nbr = 0

while True:

line = self.readline()

if not line:

break

out.append(line)

if size > -1:

nbr += len(line)

if nbr > size:

break

# END handle size constraint

# END readline loop

return out

def __iter__(self):

return self

def next(self):

line = self.readline()

if not line:

raise StopIteration

return line

def __del__(self):

bytes_left = self._size - self._nbr

if bytes_left:

# read and discard - seeking is impossible within a stream

# includes terminating newline

self._stream.read(bytes_left + 1)

# END handle incomplete read

def __init__(self, working_dir=None):

"""Initialize this instance with:

:param working_dir:

Git directory we should work in. If None, we always work in the current

directory as returned by os.getcwd().

It is meant to be the working tree directory if available, or the

.git directory in case of bare repositories."""

super(Git, self).__init__()

self._working_dir = working_dir

self._git_options = ()

# Extra environment variables to pass to git commands

self._environment = {}

# cached command slots

self.cat_file_header = None

self.cat_file_all = None

def __getattr__(self, name):

"""A convenience method as it allows to call the command as if it was

an object.

:return: Callable object that will execute call _call_process with your arguments."""

if name[0] == '_':

return LazyMixin.__getattr__(self, name)

return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)

def _set_cache_(self, attr):

if attr == '_version_info':

# We only use the first 4 numbers, as everthing else could be strings in fact (on windows)

version_numbers = self._call_process('version').split(' ')[2]

self._version_info = tuple(int(n) for n in version_numbers.split('.')[:4] if n.isdigit())

else:

super(Git, self)._set_cache_(attr)

# END handle version info

@property

def working_dir(self):

""":return: Git directory we are working on"""

return self._working_dir

@property

def version_info(self):

"""

:return: tuple(int, int, int, int) tuple with integers representing the major, minor

and additional version numbers as parsed from git version.

This value is generated on demand and is cached"""

return self._version_info

def execute(self, command,

istream=None,

with_keep_cwd=False,

with_extended_output=False,

with_exceptions=True,

as_process=False,

output_stream=None,

stdout_as_string=True,

kill_after_timeout=None,

with_stdout=True,

universal_newlines=False,

**subprocess_kwargs

"""Handles executing the command on the shell and consumes and returns

the returned information (stdout)

:param command:

The command argument list to execute.

It should be a string, or a sequence of program arguments. The

program to execute is the first item in the args sequence or string.

:param istream:

Standard input filehandle passed to subprocess.Popen.

:param with_keep_cwd:

Whether to use the current working directory from os.getcwd().

The cmd otherwise uses its own working_dir that it has been initialized

with if possible.

:param with_extended_output:

Whether to return a (status, stdout, stderr) tuple.

:param with_exceptions:

Whether to raise an exception when git returns a non-zero status.

:param as_process:

Whether to return the created process instance directly from which

streams can be read on demand. This will render with_extended_output and

with_exceptions ineffective - the caller will have

to deal with the details himself.

It is important to note that the process will be placed into an AutoInterrupt

wrapper that will interrupt the process once it goes out of scope. If you

use the command in iterators, you should pass the whole process instance

instead of a single stream.

:param output_stream:

If set to a file-like object, data produced by the git command will be

output to the given stream directly.

This feature only has any effect if as_process is False. Processes will

always be created with a pipe due to issues with subprocess.

This merely is a workaround as data will be copied from the

output pipe to the given output stream directly.

Judging from the implementation, you shouldn't use this flag !

:param stdout_as_string:

if False, the commands standard output will be bytes. Otherwise, it will be

decoded into a string using the default encoding (usually utf-8).

The latter can fail, if the output contains binary data.

:param subprocess_kwargs:

Keyword arguments to be passed to subprocess.Popen. Please note that

some of the valid kwargs are already set by this method, the ones you

specify may not be the same ones.

:param with_stdout: If True, default True, we open stdout on the created process

:param universal_newlines:

if True, pipes will be opened as text, and lines are split at

all known line endings.

:param kill_after_timeout:

To specify a timeout in seconds for the git command, after which the process

should be killed. This will have no effect if as_process is set to True. It is

set to None by default and will let the process run until the timeout is

explicitly specified. This feature is not supported on Windows. It's also worth

noting that kill_after_timeout uses SIGKILL, which can have negative side

effects on a repository. For example, stale locks in case of git gc could

render the repository incapable of accepting changes until the lock is manually

removed.

:return:

* str(output) if extended_output = False (Default)

* tuple(int(status), str(stdout), str(stderr)) if extended_output = True

if ouput_stream is True, the stdout value will be your output stream:

* output_stream if extended_output = False

* tuple(int(status), output_stream, str(stderr)) if extended_output = True

Note git is executed with LC_MESSAGES="C" to ensure consistent

output regardless of system language.

:raise GitCommandError:

:note:

If you add additional keyword arguments to the signature of this method,

you must update the execute_kwargs tuple housed in this module."""

if self.GIT_PYTHON_TRACE and (self.GIT_PYTHON_TRACE != 'full' or as_process):

log.info(' '.join(command))

# Allow the user to have the command executed in their working dir.

if with_keep_cwd or self._working_dir is None:

cwd = os.getcwd()

else:

cwd = self._working_dir

# Start the process

env = os.environ.copy()

# Attempt to force all output to plain ascii english, which is what some parsing code

# may expect.

# According to stackoverflow (http://goo.gl/l74GC8), we are setting LANGUAGE as well

# just to be sure.

env["LANGUAGE"] = "C"

env["LC_ALL"] = "C"

env.update(self._environment)

if is_win:

cmd_not_found_exception = WindowsError

if kill_after_timeout:

raise GitCommandError('"kill_after_timeout" feature is not supported on Windows.')

else:

if sys.version_info[0] > 2:

cmd_not_found_exception = FileNotFoundError # NOQA # this is defined, but flake8 doesn't know

else:

cmd_not_found_exception = OSError

# end handle

try:

proc = Popen(command,

env=env,

cwd=cwd,

bufsize=-1,

stdin=istream,

stderr=PIPE,

stdout=PIPE if with_stdout else open(os.devnull, 'wb'),

shell=self.USE_SHELL,

close_fds=(is_posix), # unsupported on windows

universal_newlines=universal_newlines,

creationflags=PROC_CREATIONFLAGS,

**subprocess_kwargs

)

except cmd_not_found_exception as err:

raise GitCommandNotFound('%s: %s' % (command[0], err))

if as_process:

return self.AutoInterrupt(proc, command)

def _kill_process(pid):

""" Callback method to kill a process. """

p = Popen(['ps', '--ppid', str(pid)], stdout=PIPE,

creationflags=PROC_CREATIONFLAGS)

child_pids = []

for line in p.stdout:

if len(line.split()) > 0:

local_pid = (line.split())[0]

if local_pid.isdigit():

child_pids.append(int(local_pid))

try:

# Windows does not have SIGKILL, so use SIGTERM instead

sig = getattr(signal, 'SIGKILL', signal.SIGTERM)

os.kill(pid, sig)

for child_pid in child_pids:

try:

os.kill(child_pid, sig)

except OSError:

pass

kill_check.set() # tell the main routine that the process was killed

except OSError:

# It is possible that the process gets completed in the duration after timeout

# happens and before we try to kill the process.

pass

return

# end

if kill_after_timeout:

kill_check = threading.Event()

watchdog = threading.Timer(kill_after_timeout, _kill_process, args=(proc.pid,))

# Wait for the process to return

status = 0

stdout_value = b''

stderr_value = b''

try:

if output_stream is None:

if kill_after_timeout:

watchdog.start()

stdout_value, stderr_value = proc.communicate()

if kill_after_timeout:

watchdog.cancel()

if kill_check.isSet():

stderr_value = 'Timeout: the command "%s" did not complete in %d ' \

'secs.' % (" ".join(command), kill_after_timeout)

# strip trailing "\n"

if stdout_value.endswith(b"\n"):

stdout_value = stdout_value[:-1]

if stderr_value.endswith(b"\n"):

stderr_value = stderr_value[:-1]

status = proc.returncode

else:

stream_copy(proc.stdout, output_stream, self.max_chunk_size)

stdout_value = output_stream

stderr_value = proc.stderr.read()

# strip trailing "\n"

if stderr_value.endswith(b"\n"):

stderr_value = stderr_value[:-1]

status = proc.wait()

# END stdout handling

finally:

proc.stdout.close()

proc.stderr.close()

if self.GIT_PYTHON_TRACE == 'full':

cmdstr = " ".join(command)

def as_text(stdout_value):

return not output_stream and safe_decode(stdout_value) or '<OUTPUT_STREAM>'

# end

if stderr_value:

log.info("%s -> %d; stdout: '%s'; stderr: '%s'",

cmdstr, status, as_text(stdout_value), safe_decode(stderr_value))

elif stdout_value:

log.info("%s -> %d; stdout: '%s'", cmdstr, status, as_text(stdout_value))

else:

log.info("%s -> %d", cmdstr, status)

# END handle debug printing

if with_exceptions and status != 0:

if with_extended_output:

raise GitCommandError(command, status, stderr_value, stdout_value)

else:

raise GitCommandError(command, status, stderr_value)

if isinstance(stdout_value, bytes) and stdout_as_string: # could also be output_stream

stdout_value = safe_decode(stdout_value)

# Allow access to the command's status code

if with_extended_output:

return (status, stdout_value, safe_decode(stderr_value))

else:

return stdout_value

def environment(self):

return self._environment

def update_environment(self, **kwargs):

"""

Set environment variables for future git invocations. Return all changed

values in a format that can be passed back into this function to revert

the changes:

``Examples``::

old_env = self.update_environment(PWD='/tmp')

self.update_environment(**old_env)

:param kwargs: environment variables to use for git processes

:return: dict that maps environment variables to their old values

"""

old_env = {}

for key, value in kwargs.items():

# set value if it is None

if value is not None:

old_env[key] = self._environment.get(key)

self._environment[key] = value

# remove key from environment if its value is None

elif key in self._environment:

old_env[key] = self._environment[key]

del self._environment[key]

return old_env

@contextmanager

def custom_environment(self, **kwargs):

"""

A context manager around the above ``update_environment`` method to restore the

environment back to its previous state after operation.

``Examples``::

with self.custom_environment(GIT_SSH='/bin/ssh_wrapper'):

repo.remotes.origin.fetch()

:param kwargs: see update_environment

"""

old_env = self.update_environment(**kwargs)

try:

yield

finally:

self.update_environment(**old_env)

def transform_kwarg(self, name, value, split_single_char_options):

if len(name) == 1:

if value is True:

return ["-%s" % name]

elif type(value) is not bool:

if split_single_char_options:

return ["-%s" % name, "%s" % value]

else:

return ["-%s%s" % (name, value)]

else:

if value is True:

return ["--%s" % dashify(name)]

elif type(value) is not bool:

return ["--%s=%s" % (dashify(name), value)]

return []

def transform_kwargs(self, split_single_char_options=True, **kwargs):

"""Transforms Python style kwargs into git command line options."""

args = list()

kwargs = OrderedDict(sorted(kwargs.items(), key=lambda x: x[0]))

for k, v in kwargs.items():

if isinstance(v, (list, tuple)):

for value in v:

args += self.transform_kwarg(k, value, split_single_char_options)

else:

args += self.transform_kwarg(k, v, split_single_char_options)

return args

@classmethod

def __unpack_args(cls, arg_list):

if not isinstance(arg_list, (list, tuple)):

# This is just required for unicode conversion, as subprocess can't handle it

# However, in any other case, passing strings (usually utf-8 encoded) is totally fine

if not PY3 and isinstance(arg_list, unicode):

return [arg_list.encode(defenc)]

return [str(arg_list)]

outlist = list()

for arg in arg_list:

if isinstance(arg_list, (list, tuple)):

outlist.extend(cls.__unpack_args(arg))

elif not PY3 and isinstance(arg_list, unicode):

outlist.append(arg_list.encode(defenc))

# END recursion

else:

outlist.append(str(arg))

# END for each arg

return outlist

def __call__(self, **kwargs):

"""Specify command line options to the git executable

for a subcommand call

:param kwargs:

is a dict of keyword arguments.

these arguments are passed as in _call_process

but will be passed to the git command rather than

the subcommand.

``Examples``::

git(work_tree='/tmp').difftool()"""

self._git_options = self.transform_kwargs(

split_single_char_options=True, **kwargs)

return self

def _call_process(self, method, *args, **kwargs):

"""Run the given git command with the specified arguments and return

the result as a String

:param method:

is the command. Contained "_" characters will be converted to dashes,

such as in 'ls_files' to call 'ls-files'.

:param args:

is the list of arguments. If None is included, it will be pruned.

This allows your commands to call git more conveniently as None

is realized as non-existent

:param kwargs:

is a dict of keyword arguments.

This function accepts the same optional keyword arguments

as execute().

``Examples``::

git.rev_list('master', max_count=10, header=True)

:return: Same as ``execute``"""

# Handle optional arguments prior to calling transform_kwargs

# otherwise these'll end up in args, which is bad.

_kwargs = {k: v for k, v in kwargs.items() if k in execute_kwargs}

kwargs = {k: v for k, v in kwargs.items() if k not in execute_kwargs}

insert_after_this_arg = kwargs.pop('insert_kwargs_after', None)

# Prepare the argument list

opt_args = self.transform_kwargs(**kwargs)

ext_args = self.__unpack_args([a for a in args if a is not None])

if insert_after_this_arg is None:

args = opt_args + ext_args

else:

try:

index = ext_args.index(insert_after_this_arg)

except ValueError:

raise ValueError("Couldn't find argument '%s' in args %s to insert kwargs after"

% (insert_after_this_arg, str(ext_args)))

# end handle error

args = ext_args[:index + 1] + opt_args + ext_args[index + 1:]

# end handle kwargs

call = [self.GIT_PYTHON_GIT_EXECUTABLE]

# add the git options, the reset to empty

# to avoid side_effects

call.extend(self._git_options)

self._git_options = ()

call.append(dashify(method))

call.extend(args)

return self.execute(call, **_kwargs)

def _parse_object_header(self, header_line):

"""

:param header_line:

<hex_sha> type_string size_as_int

:return: (hex_sha, type_string, size_as_int)

:raise ValueError: if the header contains indication for an error due to

incorrect input sha"""

tokens = header_line.split()

if len(tokens) != 3:

if not tokens:

raise ValueError("SHA could not be resolved, git returned: %r" % (header_line.strip()))

else:

raise ValueError("SHA %s could not be resolved, git returned: %r" % (tokens[0], header_line.strip()))

# END handle actual return value

# END error handling

if len(tokens[0]) != 40:

raise ValueError("Failed to parse header: %r" % header_line)

return (tokens[0], tokens[1], int(tokens[2]))

def _prepare_ref(self, ref):

# required for command to separate refs on stdin, as bytes

refstr = ref

if isinstance(ref, bytes):

# Assume 40 bytes hexsha - bin-to-ascii for some reason returns bytes, not text

refstr = ref.decode('ascii')

elif not isinstance(ref, string_types):

refstr = str(ref) # could be ref-object

if not refstr.endswith("\n"):

refstr += "\n"

return refstr.encode(defenc)

def _get_persistent_cmd(self, attr_name, cmd_name, *args, **kwargs):

cur_val = getattr(self, attr_name)

if cur_val is not None:

return cur_val

options = {"istream": PIPE, "as_process": True}

options.update(kwargs)

cmd = self._call_process(cmd_name, *args, **options)

setattr(self, attr_name, cmd)

return cmd

def __get_object_header(self, cmd, ref):

cmd.stdin.write(self._prepare_ref(ref))

cmd.stdin.flush()

return self._parse_object_header(cmd.stdout.readline())

def get_object_header(self, ref):

""" Use this method to quickly examine the type and size of the object behind

the given ref.

:note: The method will only suffer from the costs of command invocation

once and reuses the command in subsequent calls.

:return: (hexsha, type_string, size_as_int)"""

cmd = self._get_persistent_cmd("cat_file_header", "cat_file", batch_check=True)

return self.__get_object_header(cmd, ref)

def get_object_data(self, ref):

""" As get_object_header, but returns object data as well

View remainder of file in raw view

GitPython/git/cmd.py at a5db3d3c49ebe559cb80983d7bb855d4adf1b887 · gitprime/GitPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

cmd.py

Latest commit

History

Breadcrumbs

cmd.py

File metadata and controls