GitPython/git/cmd.py at 270c3d7d4bbe4c606049bfd8af53da1bc3df4ad4 · asteroidDavis/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

from contextlib import contextmanager

import io

import logging

import os

import signal

from subprocess import (

call,

Popen,

PIPE

)

import subprocess

import threading

from textwrap import dedent

from git.compat import (

defenc,

force_bytes,

safe_decode,

is_posix,

is_win,

)

from git.exc import CommandError

from git.util import is_cygwin_git, cygpath, expand_path, remove_password_if_present

from .exc import (

GitCommandError,

GitCommandNotFound

)

from .util import (

LazyMixin,

stream_copy,

)

# typing ---------------------------------------------------------------------------

from typing import (Any, AnyStr, BinaryIO, Callable, Dict, IO, Iterator, List, Mapping,

Sequence, TYPE_CHECKING, TextIO, Tuple, Union, cast, overload)

from git.types import PathLike, Literal, TBD

if TYPE_CHECKING:

from git.repo.base import Repo

from git.diff import DiffIndex

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

execute_kwargs = {'istream', 'with_extended_output',

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

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

'universal_newlines', 'shell', 'env', 'max_chunk_size'}

log = logging.getLogger(__name__)

log.addHandler(logging.NullHandler())

__all__ = ('Git',)

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

## @name Utilities

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

# Documentation

## @{

def handle_process_output(process: Union[subprocess.Popen, 'Git.AutoInterrupt'],

stdout_handler: Union[None,

Callable[[AnyStr], None],

Callable[[List[AnyStr]], None],

Callable[[bytes, 'Repo', 'DiffIndex'], None]],

stderr_handler: Union[None,

Callable[[AnyStr], None],

Callable[[List[AnyStr]], None]],

finalizer: Union[None,

Callable[[Union[subprocess.Popen, 'Git.AutoInterrupt']], None]] = None,

decode_streams: bool = True) -> None:

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

the respective line handlers.

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_handler: f(stderr_line_string), or None

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

:param decode_streams:

Assume stdout/stderr streams are binary and decode them before pushing \

their contents to handlers.

Set it to False if `universal_newline == True` (then streams are in text-mode)

or if decoding must happen later (i.e. for Diffs).

"""

# Use 2 "pump" threads and wait for both to finish.

def pump_stream(cmdline: str, name: str, stream: Union[BinaryIO, TextIO], is_decode: bool,

handler: Union[None, Callable[[Union[bytes, str]], None]]) -> None:

try:

for line in stream:

if handler:

if is_decode:

assert isinstance(line, bytes)

line_str = line.decode(defenc)

handler(line_str)

else:

handler(line)

except Exception as ex:

log.error("Pumping %r of cmd(%s) failed due to: %r", name, remove_password_if_present(cmdline), ex)

raise CommandError(['<%s-pump>' % name] + remove_password_if_present(cmdline), ex) from ex

finally:

stream.close()

cmdline = getattr(process, 'args', '') # PY3+ only

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

cmdline = cmdline.split()

pumps = []

if process.stdout:

pumps.append(('stdout', process.stdout, stdout_handler))

if process.stderr:

pumps.append(('stderr', process.stderr, stderr_handler))

threads = []

for name, stream, handler in pumps:

t = threading.Thread(target=pump_stream,

args=(cmdline, name, stream, decode_streams, handler))

t.daemon = True

t.start()

threads.append(t)

## FIXME: Why Join?? Will block if `stdin` needs feeding...

for t in threads:

t.join()

if finalizer:

return finalizer(process)

else:

return None

def dashify(string: str) -> str:

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

def slots_to_dict(self: object, exclude: Sequence[str] = ()) -> Dict[str, Any]:

return {s: getattr(self, s) for s in self.__slots__ if s not in exclude}

def dict_to_slots_and__excluded_are_none(self: object, d: Mapping[str, Any], excluded: Sequence[str] = ()) -> None:

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,

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

PROC_CREATIONFLAGS = (CREATE_NO_WINDOW | subprocess.CREATE_NEW_PROCESS_GROUP # type: ignore[attr-defined]

if is_win else 0) # mypy error if not windows

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", "_persistent_git_options", "_environment")

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

def __getstate__(self) -> Dict[str, Any]:

return slots_to_dict(self, exclude=self._excluded_)

def __setstate__(self, d: Dict[str, Any]) -> None:

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

# CONFIGURATION

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)

# 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

# and check `git/test_repo.py:TestRepo.test_untracked_files()` TC for an example where it is required.

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

USE_SHELL = 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"

_refresh_env_var = "GIT_PYTHON_REFRESH"

GIT_PYTHON_GIT_EXECUTABLE = None

# note that the git executable is actually found during the refresh step in

# the top level __init__

@classmethod

def refresh(cls, path: Union[None, PathLike] = None) -> bool:

"""This gets called by the refresh function (see the top level

__init__).

"""

# discern which path to refresh with

if path is not None:

new_git = os.path.expanduser(path)

new_git = os.path.abspath(new_git)

else:

new_git = os.environ.get(cls._git_exec_env_var, cls.git_exec_name)

# keep track of the old and new git executable path

old_git = cls.GIT_PYTHON_GIT_EXECUTABLE

cls.GIT_PYTHON_GIT_EXECUTABLE = new_git

# test if the new git executable path is valid

# - a GitCommandNotFound error is spawned by ourselves

# - a PermissionError is spawned if the git executable provided

# cannot be executed for whatever reason

has_git = False

try:

cls().version()

has_git = True

except (GitCommandNotFound, PermissionError):

pass

# warn or raise exception if test failed

if not has_git:

err = dedent("""\

Bad git executable.

The git executable must be specified in one of the following ways:

- be included in your $PATH

- be set via $%s

- explicitly set via git.refresh()

""") % cls._git_exec_env_var

# revert to whatever the old_git was

cls.GIT_PYTHON_GIT_EXECUTABLE = old_git

if old_git is None:

# on the first refresh (when GIT_PYTHON_GIT_EXECUTABLE is

# None) we only are quiet, warn, or error depending on the

# GIT_PYTHON_REFRESH value

# determine what the user wants to happen during the initial

# refresh we expect GIT_PYTHON_REFRESH to either be unset or

# be one of the following values:

# 0|q|quiet|s|silence

# 1|w|warn|warning

# 2|r|raise|e|error

mode = os.environ.get(cls._refresh_env_var, "raise").lower()

quiet = ["quiet", "q", "silence", "s", "none", "n", "0"]

warn = ["warn", "w", "warning", "1"]

error = ["error", "e", "raise", "r", "2"]

if mode in quiet:

pass

elif mode in warn or mode in error:

err = dedent("""\

All git commands will error until this is rectified.

This initial warning can be silenced or aggravated in the future by setting the

$%s environment variable. Use one of the following values:

- %s: for no warning or exception

- %s: for a printed warning

- %s: for a raised exception

Example:

export %s=%s

""") % (

err,

cls._refresh_env_var,

"|".join(quiet),

"|".join(warn),

"|".join(error),

cls._refresh_env_var,

quiet[0])

if mode in warn:

print("WARNING: %s" % err)

else:

raise ImportError(err)

else:

err = dedent("""\

%s environment variable has been set but it has been set with an invalid value.

Use only the following values:

- %s: for no warning or exception

- %s: for a printed warning

- %s: for a raised exception

""") % (

cls._refresh_env_var,

"|".join(quiet),

"|".join(warn),

"|".join(error))

raise ImportError(err)

# we get here if this was the init refresh and the refresh mode

# was not error, go ahead and set the GIT_PYTHON_GIT_EXECUTABLE

# such that we discern the difference between a first import

# and a second import

cls.GIT_PYTHON_GIT_EXECUTABLE = cls.git_exec_name

else:

# after the first refresh (when GIT_PYTHON_GIT_EXECUTABLE

# is no longer None) we raise an exception

raise GitCommandNotFound("git", err)

return has_git

@classmethod

def is_cygwin(cls) -> bool:

return is_cygwin_git(cls.GIT_PYTHON_GIT_EXECUTABLE)

@overload

@classmethod

def polish_url(cls, url: str, is_cygwin: Literal[False] = ...) -> str:

...

@overload

@classmethod

def polish_url(cls, url: str, is_cygwin: Union[None, bool] = None) -> str:

...

@classmethod

def polish_url(cls, url: str, is_cygwin: Union[None, bool] = None) -> PathLike:

if is_cygwin is None:

is_cygwin = cls.is_cygwin()

if is_cygwin:

url = cygpath(url)

else:

"""Remove any backslahes from urls to be written in config files.

Windows might create config-files containing paths with backslashed,

but git stops liking them as it will escape the backslashes.

Hence we undo the escaping just to be sure.

"""

url = os.path.expandvars(url)

if url.startswith('~'):

url = os.path.expanduser(url)

url = url.replace("\\\\", "\\").replace("\\", "/")

return url

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: Union[None, subprocess.Popen], args: Any) -> None:

self.proc = proc

self.args = args

def __del__(self) -> None:

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 ?

try:

if proc.poll() is not None:

return None

except OSError as ex:

log.info("Ignored error after process had died: %r", ex)

# can be that nothing really exists anymore ...

if os is None or getattr(os, 'kill', None) is None:

return None

# try to kill it

try:

proc.terminate()

proc.wait() # ensure process goes away

except OSError as ex:

log.info("Ignored error after process had died: %r", ex)

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.

if is_win:

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

# END exception handling

def __getattr__(self, attr: str) -> Any:

return getattr(self.proc, attr)

# TODO: Bad choice to mimic `proc.wait()` but with different args.

def wait(self, stderr: Union[None, str, bytes] = b'') -> int:

"""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 = b''

stderr_b = force_bytes(data=stderr, encoding='utf-8')

if self.proc is not None:

status = self.proc.wait()

def read_all_from_possibly_closed_stream(stream: Union[IO[bytes], None]) -> bytes:

if stream:

try:

return stderr_b + force_bytes(stream.read())

except ValueError:

return stderr_b or b''

else:

return stderr_b or b''

if status != 0:

errstr = read_all_from_possibly_closed_stream(self.proc.stderr)

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

raise GitCommandError(remove_password_if_present(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__: Tuple[str, ...] = ('_stream', '_nbr', '_size')

def __init__(self, size: int, stream: IO[bytes]) -> None:

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: int = -1) -> bytes:

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: int = -1) -> bytes:

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: int = -1) -> List[bytes]:

if self._nbr == self._size:

return []

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

out = []

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

# skipcq: PYL-E0301

def __iter__(self) -> 'Git.CatFileContentStream':

return self

def __next__(self) -> bytes:

return next(self)

def next(self) -> bytes:

line = self.readline()

if not line:

raise StopIteration

return line

def __del__(self) -> None:

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: Union[None, PathLike] = 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 = expand_path(working_dir)

self._git_options: Union[List[str], Tuple[str, ...]] = ()

self._persistent_git_options: List[str] = []

# Extra environment variables to pass to git commands

self._environment: Dict[str, str] = {}

# cached command slots

self.cat_file_header: Union[None, TBD] = None

self.cat_file_all: Union[None, TBD] = None

def __getattr__(self, name: str) -> Any:

"""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_persistent_git_options(self, **kwargs: Any) -> None:

"""Specify command line options to the git executable

for subsequent subcommand calls

: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.

"""

self._persistent_git_options = self.transform_kwargs(

split_single_char_options=True, **kwargs)

def _set_cache_(self, attr: str) -> None:

if attr == '_version_info':

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

process_version = self._call_process('version') # should be as default *args and **kwargs used

version_numbers = process_version.split(' ')[2]

self._version_info = cast(Tuple[int, int, int, int],

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) -> Union[None, PathLike]:

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

return self._working_dir

@ property

def version_info(self) -> Tuple[int, int, int, int]:

"""

: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

@ overload

def execute(self,

command: Union[str, Sequence[Any]],

as_process: Literal[True]

) -> 'AutoInterrupt':

...

@ overload

def execute(self,

command: Union[str, Sequence[Any]],

as_process: Literal[False] = False,

stdout_as_string: Literal[True]

) -> Union[str, Tuple[int, str, str]]:

...

@ overload

def execute(self,

command: Union[str, Sequence[Any]],

as_process: Literal[False] = False,

stdout_as_string: Literal[False] = False

) -> Union[bytes, Tuple[int, bytes, str]]:

...

@ overload

def execute(self,

command: Union[str, Sequence[Any]],

with_extended_output: Literal[False],

as_process: Literal[False],

stdout_as_string: Literal[True]

) -> str:

...

@ overload

def execute(self,

command: Union[str, Sequence[Any]],

with_extended_output: Literal[False],

as_process: Literal[False],

stdout_as_string: Literal[False]

) -> bytes:

...

def execute(self,

command: Union[str, Sequence[Any]],

istream: Union[None, BinaryIO] = None,

with_extended_output: bool = False,

with_exceptions: bool = True,

as_process: bool = False,

output_stream: Union[None, BinaryIO] = None,

stdout_as_string: bool = True,

kill_after_timeout: Union[None, int] = None,

with_stdout: bool = True,

universal_newlines: bool = False,

shell: Union[None, bool] = None,

env: Union[None, Mapping[str, str]] = None,

max_chunk_size: int = io.DEFAULT_BUFFER_SIZE,

**subprocess_kwargs: Any

) -> Union[str, bytes, Tuple[int, Union[str, bytes], str], AutoInterrupt]:

"""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_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 env:

A dictionary of environment variables to be passed to `subprocess.Popen`.

:param max_chunk_size:

Maximum number of bytes in one chunk of data passed to the output_stream in

one invocation of write() method. If the given number is not positive then

the default value is used.

: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 shell:

Whether to invoke commands through a shell (see `Popen(..., shell=True)`).

It overrides :attr:`USE_SHELL` if it is not `None`.

: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 output_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."""

# Remove password for the command if present

redacted_command = remove_password_if_present(command)

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

log.info(' '.join(redacted_command))

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

cwd = self._working_dir or os.getcwd()

# Start the process

inline_env = env

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 inline_env is not None:

env.update(inline_env)

if is_win:

cmd_not_found_exception = OSError

if kill_after_timeout:

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

else:

cmd_not_found_exception = FileNotFoundError # NOQA # exists, flake8 unknown @UndefinedVariable

# end handle

stdout_sink = (PIPE

if with_stdout

else getattr(subprocess, 'DEVNULL', None) or open(os.devnull, 'wb'))

istream_ok = "None"

if istream:

istream_ok = "<valid stream>"

log.debug("Popen(%s, cwd=%s, universal_newlines=%s, shell=%s, istream=%s)",

redacted_command, cwd, universal_newlines, shell, istream_ok)

try:

proc = Popen(command,

env=env,

cwd=cwd,

bufsize=-1,

stdin=istream,

stderr=PIPE,

stdout=stdout_sink,

shell=shell is not None and shell or 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(redacted_command, err) from err

else:

# replace with a typeguard for Popen[bytes]?

proc.stdout = cast(BinaryIO, proc.stdout)

proc.stderr = cast(BinaryIO, proc.stderr)

if as_process:

return self.AutoInterrupt(proc, command)

def _kill_process(pid: int) -> None:

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

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

creationflags=PROC_CREATIONFLAGS)

child_pids = []

if p.stdout is not None:

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: Union[str, bytes] = b''

stderr_value: Union[str, bytes] = b''

newline = "\n" if universal_newlines else b"\n"

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.is_set():

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

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

if not universal_newlines:

stderr_value = stderr_value.encode(defenc)

# strip trailing "\n"

if stdout_value.endswith(newline): # type: ignore

stdout_value = stdout_value[:-1]

if stderr_value.endswith(newline): # type: ignore

stderr_value = stderr_value[:-1]

status = proc.returncode

else:

max_chunk_size = max_chunk_size if max_chunk_size and max_chunk_size > 0 else io.DEFAULT_BUFFER_SIZE

stream_copy(proc.stdout, output_stream, max_chunk_size)

stdout_value = proc.stdout.read()

stderr_value = proc.stderr.read()

# strip trailing "\n"

if stderr_value.endswith(newline): # type: ignore

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(redacted_command)

def as_text(stdout_value: Union[bytes, str]) -> str:

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:

raise GitCommandError(redacted_command, status, stderr_value, stdout_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) -> Dict[str, str]:

return self._environment

def update_environment(self, **kwargs: Any) -> Dict[str, Union[str, None]]:

"""

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: Any) -> Iterator[None]:

"""

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: str, value: Any, split_single_char_options: bool) -> List[str]:

if len(name) == 1:

if value is True:

return ["-%s" % name]

elif value not in (False, None):

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 value is not False and value is not None:

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

return []

View remainder of file in raw view

GitPython/git/cmd.py at 270c3d7d4bbe4c606049bfd8af53da1bc3df4ad4 · asteroidDavis/GitPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

cmd.py

Latest commit

History

Breadcrumbs

cmd.py

File metadata and controls