cpython/Lib/subprocess.py at 65374c61215661de902343484b43a91f2afe67ff · python/cpython

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

# subprocess - Subprocesses with accessible I/O streams

# For more information about this module, see PEP 324.

# Licensed to PSF under a Contributor Agreement.

# See http://www.python.org/2.4/license for licensing details.

r"""Subprocesses with accessible I/O streams

This module allows you to spawn processes, connect to their

input/output/error pipes, and obtain their return codes.

For a complete description of this module see the Python documentation.

Main API

========

run(...): Runs a command, waits for it to complete, then returns a

CompletedProcess instance.

Popen(...): A class for flexibly executing a command in a new process

Constants

---------

DEVNULL: Special value that indicates that os.devnull should be used

PIPE: Special value that indicates a pipe should be created

STDOUT: Special value that indicates that stderr should go to stdout

Older API

=========

call(...): Runs a command, waits for it to complete, then returns

the return code.

check_call(...): Same as call() but raises CalledProcessError()

if return code is not 0

check_output(...): Same as check_call() but returns the contents of

stdout instead of a return code

getoutput(...): Runs a command in the shell, waits for it to complete,

then returns the output

getstatusoutput(...): Runs a command in the shell, waits for it to complete,

then returns a (exitcode, output) tuple

"""

import builtins

import errno

import io

import os

import time

import signal

import sys

import threading

import warnings

import contextlib

from time import monotonic as _time

__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",

"getoutput", "check_output", "run", "CalledProcessError", "DEVNULL",

"SubprocessError", "TimeoutExpired", "CompletedProcess"]

# NOTE: We intentionally exclude list2cmdline as it is

# considered an internal implementation detail. issue10838.

try:

import msvcrt

import _winapi

_mswindows = True

except ModuleNotFoundError:

_mswindows = False

import _posixsubprocess

import select

import selectors

else:

from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,

STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,

STD_ERROR_HANDLE, SW_HIDE,

STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW,

ABOVE_NORMAL_PRIORITY_CLASS, BELOW_NORMAL_PRIORITY_CLASS,

HIGH_PRIORITY_CLASS, IDLE_PRIORITY_CLASS,

NORMAL_PRIORITY_CLASS, REALTIME_PRIORITY_CLASS,

CREATE_NO_WINDOW, DETACHED_PROCESS,

CREATE_DEFAULT_ERROR_MODE, CREATE_BREAKAWAY_FROM_JOB)

__all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",

"STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",

"STD_ERROR_HANDLE", "SW_HIDE",

"STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW",

"STARTUPINFO",

"ABOVE_NORMAL_PRIORITY_CLASS", "BELOW_NORMAL_PRIORITY_CLASS",

"HIGH_PRIORITY_CLASS", "IDLE_PRIORITY_CLASS",

"NORMAL_PRIORITY_CLASS", "REALTIME_PRIORITY_CLASS",

"CREATE_NO_WINDOW", "DETACHED_PROCESS",

"CREATE_DEFAULT_ERROR_MODE", "CREATE_BREAKAWAY_FROM_JOB"])

# Exception classes used by this module.

class SubprocessError(Exception): pass

class CalledProcessError(SubprocessError):

"""Raised when run() is called with check=True and the process

returns a non-zero exit status.

Attributes:

cmd, returncode, stdout, stderr, output

"""

def __init__(self, returncode, cmd, output=None, stderr=None):

self.returncode = returncode

self.cmd = cmd

self.output = output

self.stderr = stderr

def __str__(self):

if self.returncode and self.returncode < 0:

try:

return "Command '%s' died with %r." % (

self.cmd, signal.Signals(-self.returncode))

except ValueError:

return "Command '%s' died with unknown signal %d." % (

self.cmd, -self.returncode)

else:

return "Command '%s' returned non-zero exit status %d." % (

self.cmd, self.returncode)

@property

def stdout(self):

"""Alias for output attribute, to match stderr"""

return self.output

@stdout.setter

def stdout(self, value):

# There's no obvious reason to set this, but allow it anyway so

# .stdout is a transparent alias for .output

self.output = value

class TimeoutExpired(SubprocessError):

"""This exception is raised when the timeout expires while waiting for a

child process.

Attributes:

cmd, output, stdout, stderr, timeout

"""

def __init__(self, cmd, timeout, output=None, stderr=None):

self.cmd = cmd

self.timeout = timeout

self.output = output

self.stderr = stderr

def __str__(self):

return ("Command '%s' timed out after %s seconds" %

(self.cmd, self.timeout))

@property

def stdout(self):

return self.output

@stdout.setter

def stdout(self, value):

# There's no obvious reason to set this, but allow it anyway so

# .stdout is a transparent alias for .output

self.output = value

if _mswindows:

class STARTUPINFO:

def __init__(self, *, dwFlags=0, hStdInput=None, hStdOutput=None,

hStdError=None, wShowWindow=0, lpAttributeList=None):

self.dwFlags = dwFlags

self.hStdInput = hStdInput

self.hStdOutput = hStdOutput

self.hStdError = hStdError

self.wShowWindow = wShowWindow

self.lpAttributeList = lpAttributeList or {"handle_list": []}

def copy(self):

attr_list = self.lpAttributeList.copy()

if 'handle_list' in attr_list:

attr_list['handle_list'] = list(attr_list['handle_list'])

return STARTUPINFO(dwFlags=self.dwFlags,

hStdInput=self.hStdInput,

hStdOutput=self.hStdOutput,

hStdError=self.hStdError,

wShowWindow=self.wShowWindow,

lpAttributeList=attr_list)

class Handle(int):

closed = False

def Close(self, CloseHandle=_winapi.CloseHandle):

if not self.closed:

self.closed = True

CloseHandle(self)

def Detach(self):

if not self.closed:

self.closed = True

return int(self)

raise ValueError("already closed")

def __repr__(self):

return "%s(%d)" % (self.__class__.__name__, int(self))

__del__ = Close

__str__ = __repr__

else:

# When select or poll has indicated that the file is writable,

# we can write up to _PIPE_BUF bytes without risk of blocking.

# POSIX defines PIPE_BUF as >= 512.

_PIPE_BUF = getattr(select, 'PIPE_BUF', 512)

# poll/select have the advantage of not requiring any extra file

# descriptor, contrarily to epoll/kqueue (also, they require a single

# syscall).

if hasattr(selectors, 'PollSelector'):

_PopenSelector = selectors.PollSelector

else:

_PopenSelector = selectors.SelectSelector

# This lists holds Popen instances for which the underlying process had not

# exited at the time its __del__ method got called: those processes are wait()ed

# for synchronously from _cleanup() when a new Popen object is created, to avoid

# zombie processes.

_active = []

def _cleanup():

for inst in _active[:]:

res = inst._internal_poll(_deadstate=sys.maxsize)

if res is not None:

try:

_active.remove(inst)

except ValueError:

# This can happen if two threads create a new Popen instance.

# It's harmless that it was already removed, so ignore.

pass

PIPE = -1

STDOUT = -2

DEVNULL = -3

# XXX This function is only used by multiprocessing and the test suite,

# but it's here so that it can be imported when Python is compiled without

# threads.

def _optim_args_from_interpreter_flags():

"""Return a list of command-line arguments reproducing the current

optimization settings in sys.flags."""

args = []

value = sys.flags.optimize

if value > 0:

args.append('-' + 'O' * value)

return args

def _args_from_interpreter_flags():

"""Return a list of command-line arguments reproducing the current

settings in sys.flags, sys.warnoptions and sys._xoptions."""

flag_opt_map = {

'debug': 'd',

# 'inspect': 'i',

# 'interactive': 'i',

'dont_write_bytecode': 'B',

'no_site': 'S',

'verbose': 'v',

'bytes_warning': 'b',

'quiet': 'q',

# -O is handled in _optim_args_from_interpreter_flags()

}

args = _optim_args_from_interpreter_flags()

for flag, opt in flag_opt_map.items():

v = getattr(sys.flags, flag)

if v > 0:

args.append('-' + opt * v)

if sys.flags.isolated:

args.append('-I')

else:

if sys.flags.ignore_environment:

args.append('-E')

if sys.flags.no_user_site:

args.append('-s')

# -W options

warnopts = sys.warnoptions[:]

bytes_warning = sys.flags.bytes_warning

xoptions = getattr(sys, '_xoptions', {})

dev_mode = ('dev' in xoptions)

if bytes_warning > 1:

warnopts.remove("error::BytesWarning")

elif bytes_warning:

warnopts.remove("default::BytesWarning")

if dev_mode:

warnopts.remove('default')

for opt in warnopts:

args.append('-W' + opt)

# -X options

if dev_mode:

args.extend(('-X', 'dev'))

for opt in ('faulthandler', 'tracemalloc', 'importtime',

'showalloccount', 'showrefcount', 'utf8'):

if opt in xoptions:

value = xoptions[opt]

if value is True:

arg = opt

else:

arg = '%s=%s' % (opt, value)

args.extend(('-X', arg))

return args

def call(*popenargs, timeout=None, **kwargs):

"""Run command with arguments. Wait for command to complete or

timeout, then return the returncode attribute.

The arguments are the same as for the Popen constructor. Example:

retcode = call(["ls", "-l"])

"""

with Popen(*popenargs, **kwargs) as p:

try:

return p.wait(timeout=timeout)

except: # Including KeyboardInterrupt, wait handled that.

p.kill()

# We don't call p.wait() again as p.__exit__ does that for us.

raise

def check_call(*popenargs, **kwargs):

"""Run command with arguments. Wait for command to complete. If

the exit code was zero then return, otherwise raise

CalledProcessError. The CalledProcessError object will have the

return code in the returncode attribute.

The arguments are the same as for the call function. Example:

check_call(["ls", "-l"])

"""

retcode = call(*popenargs, **kwargs)

if retcode:

cmd = kwargs.get("args")

if cmd is None:

cmd = popenargs[0]

raise CalledProcessError(retcode, cmd)

return 0

def check_output(*popenargs, timeout=None, **kwargs):

r"""Run command with arguments and return its output.

If the exit code was non-zero it raises a CalledProcessError. The

CalledProcessError object will have the return code in the returncode

attribute and output in the output attribute.

The arguments are the same as for the Popen constructor. Example:

>>> check_output(["ls", "-l", "/dev/null"])

b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'

The stdout argument is not allowed as it is used internally.

To capture standard error in the result, use stderr=STDOUT.

>>> check_output(["/bin/sh", "-c",

... "ls -l non_existent_file ; exit 0"],

... stderr=STDOUT)

b'ls: non_existent_file: No such file or directory\n'

There is an additional optional argument, "input", allowing you to

pass a string to the subprocess's stdin. If you use this argument

you may not also use the Popen constructor's "stdin" argument, as

it too will be used internally. Example:

>>> check_output(["sed", "-e", "s/foo/bar/"],

... input=b"when in the course of fooman events\n")

b'when in the course of barman events\n'

By default, all communication is in bytes, and therefore any "input"

should be bytes, and the return value wil be bytes. If in text mode,

any "input" should be a string, and the return value will be a string

decoded according to locale encoding, or by "encoding" if set. Text mode

is triggered by setting any of text, encoding, errors or universal_newlines.

"""

if 'stdout' in kwargs:

raise ValueError('stdout argument not allowed, it will be overridden.')

if 'input' in kwargs and kwargs['input'] is None:

# Explicitly passing input=None was previously equivalent to passing an

# empty string. That is maintained here for backwards compatibility.

kwargs['input'] = '' if kwargs.get('universal_newlines', False) else b''

return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,

**kwargs).stdout

class CompletedProcess(object):

"""A process that has finished running.

This is returned by run().

Attributes:

args: The list or str args passed to run().

returncode: The exit code of the process, negative for signals.

stdout: The standard output (None if not captured).

stderr: The standard error (None if not captured).

"""

def __init__(self, args, returncode, stdout=None, stderr=None):

self.args = args

self.returncode = returncode

self.stdout = stdout

self.stderr = stderr

def __repr__(self):

args = ['args={!r}'.format(self.args),

'returncode={!r}'.format(self.returncode)]

if self.stdout is not None:

args.append('stdout={!r}'.format(self.stdout))

if self.stderr is not None:

args.append('stderr={!r}'.format(self.stderr))

return "{}({})".format(type(self).__name__, ', '.join(args))

def check_returncode(self):

"""Raise CalledProcessError if the exit code is non-zero."""

if self.returncode:

raise CalledProcessError(self.returncode, self.args, self.stdout,

self.stderr)

def run(*popenargs,

input=None, capture_output=False, timeout=None, check=False, **kwargs):

"""Run command with arguments and return a CompletedProcess instance.

The returned instance will have attributes args, returncode, stdout and

stderr. By default, stdout and stderr are not captured, and those attributes

will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them.

If check is True and the exit code was non-zero, it raises a

CalledProcessError. The CalledProcessError object will have the return code

in the returncode attribute, and output & stderr attributes if those streams

were captured.

If timeout is given, and the process takes too long, a TimeoutExpired

exception will be raised.

There is an optional argument "input", allowing you to

pass bytes or a string to the subprocess's stdin. If you use this argument

you may not also use the Popen constructor's "stdin" argument, as

it will be used internally.

By default, all communication is in bytes, and therefore any "input" should

be bytes, and the stdout and stderr will be bytes. If in text mode, any

"input" should be a string, and stdout and stderr will be strings decoded

according to locale encoding, or by "encoding" if set. Text mode is

triggered by setting any of text, encoding, errors or universal_newlines.

The other arguments are the same as for the Popen constructor.

"""

if input is not None:

if 'stdin' in kwargs:

raise ValueError('stdin and input arguments may not both be used.')

kwargs['stdin'] = PIPE

if capture_output:

if ('stdout' in kwargs) or ('stderr' in kwargs):

raise ValueError('stdout and stderr arguments may not be used '

'with capture_output.')

kwargs['stdout'] = PIPE

kwargs['stderr'] = PIPE

with Popen(*popenargs, **kwargs) as process:

try:

stdout, stderr = process.communicate(input, timeout=timeout)

except TimeoutExpired:

process.kill()

stdout, stderr = process.communicate()

raise TimeoutExpired(process.args, timeout, output=stdout,

stderr=stderr)

except: # Including KeyboardInterrupt, communicate handled that.

process.kill()

# We don't call process.wait() as .__exit__ does that for us.

raise

retcode = process.poll()

if check and retcode:

raise CalledProcessError(retcode, process.args,

output=stdout, stderr=stderr)

return CompletedProcess(process.args, retcode, stdout, stderr)

def list2cmdline(seq):

"""

Translate a sequence of arguments into a command line

string, using the same rules as the MS C runtime:

1) Arguments are delimited by white space, which is either a

space or a tab.

2) A string surrounded by double quotation marks is

interpreted as a single argument, regardless of white space

contained within. A quoted string can be embedded in an

argument.

3) A double quotation mark preceded by a backslash is

interpreted as a literal double quotation mark.

4) Backslashes are interpreted literally, unless they

immediately precede a double quotation mark.

5) If backslashes immediately precede a double quotation mark,

every pair of backslashes is interpreted as a literal

backslash. If the number of backslashes is odd, the last

backslash escapes the next double quotation mark as

described in rule 3.

"""

# See

# http://msdn.microsoft.com/en-us/library/17w5ykft.aspx

# or search http://msdn.microsoft.com for

# "Parsing C++ Command-Line Arguments"

result = []

needquote = False

for arg in seq:

bs_buf = []

# Add a space to separate this argument from the others

if result:

result.append(' ')

needquote = (" " in arg) or ("\t" in arg) or not arg

if needquote:

result.append('"')

for c in arg:

if c == '\\':

# Don't know if we need to double yet.

bs_buf.append(c)

elif c == '"':

# Double backslashes.

result.append('\\' * len(bs_buf)*2)

bs_buf = []

result.append('\\"')

else:

# Normal char

if bs_buf:

result.extend(bs_buf)

bs_buf = []

result.append(c)

# Add remaining backslashes, if any.

if bs_buf:

result.extend(bs_buf)

if needquote:

result.extend(bs_buf)

result.append('"')

return ''.join(result)

# Various tools for executing commands and looking at their output and status.

def getstatusoutput(cmd):

"""Return (exitcode, output) of executing cmd in a shell.

Execute the string 'cmd' in a shell with 'check_output' and

return a 2-tuple (status, output). The locale encoding is used

to decode the output and process newlines.

A trailing newline is stripped from the output.

The exit status for the command can be interpreted

according to the rules for the function 'wait'. Example:

>>> import subprocess

>>> subprocess.getstatusoutput('ls /bin/ls')

(0, '/bin/ls')

>>> subprocess.getstatusoutput('cat /bin/junk')

(1, 'cat: /bin/junk: No such file or directory')

>>> subprocess.getstatusoutput('/bin/junk')

(127, 'sh: /bin/junk: not found')

>>> subprocess.getstatusoutput('/bin/kill $$')

(-15, '')

"""

try:

data = check_output(cmd, shell=True, text=True, stderr=STDOUT)

exitcode = 0

except CalledProcessError as ex:

data = ex.output

exitcode = ex.returncode

if data[-1:] == '\n':

data = data[:-1]

return exitcode, data

def getoutput(cmd):

"""Return output (stdout or stderr) of executing cmd in a shell.

Like getstatusoutput(), except the exit status is ignored and the return

value is a string containing the command's output. Example:

>>> import subprocess

>>> subprocess.getoutput('ls /bin/ls')

'/bin/ls'

"""

return getstatusoutput(cmd)[1]

def _use_posix_spawn():

"""Check if posix_spawn() can be used for subprocess.

subprocess requires a posix_spawn() implementation that properly reports

errors to the parent process, & sets errno on the following failures:

* Process attribute actions failed.

* File actions failed.

* exec() failed.

Prefer an implementation which can use vfork() in some cases for best

performance.

"""

if _mswindows or not hasattr(os, 'posix_spawn'):

# os.posix_spawn() is not available

return False

if sys.platform == 'darwin':

# posix_spawn() is a syscall on macOS and properly reports errors

return True

# Check libc name and runtime libc version

try:

ver = os.confstr('CS_GNU_LIBC_VERSION')

# parse 'glibc 2.28' as ('glibc', (2, 28))

parts = ver.split(maxsplit=1)

if len(parts) != 2:

# reject unknown format

raise ValueError

libc = parts[0]

version = tuple(map(int, parts[1].split('.')))

if sys.platform == 'linux' and libc == 'glibc' and version >= (2, 24):

# glibc 2.24 has a new Linux posix_spawn implementation using vfork

# which properly reports errors to the parent process.

return True

# Note: Don't use the implementation in earlier glibc because it doesn't

# use vfork (even if glibc 2.26 added a pipe to properly report errors

# to the parent process).

except (AttributeError, ValueError, OSError):

# os.confstr() or CS_GNU_LIBC_VERSION value not available

pass

# By default, assume that posix_spawn() does not properly report errors.

return False

_USE_POSIX_SPAWN = _use_posix_spawn()

class Popen(object):

""" Execute a child program in a new process.

For a complete description of the arguments see the Python documentation.

Arguments:

args: A string, or a sequence of program arguments.

bufsize: supplied as the buffering argument to the open() function when

creating the stdin/stdout/stderr pipe file objects

executable: A replacement program to execute.

stdin, stdout and stderr: These specify the executed programs' standard

input, standard output and standard error file handles, respectively.

preexec_fn: (POSIX only) An object to be called in the child process

just before the child is executed.

close_fds: Controls closing or inheriting of file descriptors.

shell: If true, the command will be executed through the shell.

cwd: Sets the current directory before the child is executed.

env: Defines the environment variables for the new process.

text: If true, decode stdin, stdout and stderr using the given encoding

(if set) or the system default otherwise.

universal_newlines: Alias of text, provided for backwards compatibility.

startupinfo and creationflags (Windows only)

restore_signals (POSIX only)

start_new_session (POSIX only)

pass_fds (POSIX only)

encoding and errors: Text mode encoding and error handling to use for

file objects stdin, stdout and stderr.

Attributes:

stdin, stdout, stderr, pid, returncode

"""

_child_created = False # Set here since __del__ checks it

def __init__(self, args, bufsize=-1, executable=None,

stdin=None, stdout=None, stderr=None,

preexec_fn=None, close_fds=True,

shell=False, cwd=None, env=None, universal_newlines=None,

startupinfo=None, creationflags=0,

restore_signals=True, start_new_session=False,

pass_fds=(), *, encoding=None, errors=None, text=None):

"""Create new Popen instance."""

_cleanup()

# Held while anything is calling waitpid before returncode has been

# updated to prevent clobbering returncode if wait() or poll() are

# called from multiple threads at once. After acquiring the lock,

# code must re-check self.returncode to see if another thread just

# finished a waitpid() call.

self._waitpid_lock = threading.Lock()

self._input = None

self._communication_started = False

if bufsize is None:

bufsize = -1 # Restore default

if not isinstance(bufsize, int):

raise TypeError("bufsize must be an integer")

if _mswindows:

if preexec_fn is not None:

raise ValueError("preexec_fn is not supported on Windows "

"platforms")

else:

# POSIX

if pass_fds and not close_fds:

warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)

close_fds = True

if startupinfo is not None:

raise ValueError("startupinfo is only supported on Windows "

"platforms")

if creationflags != 0:

raise ValueError("creationflags is only supported on Windows "

"platforms")

self.args = args

self.stdin = None

self.stdout = None

self.stderr = None

self.pid = None

self.returncode = None

self.encoding = encoding

self.errors = errors

# Validate the combinations of text and universal_newlines

if (text is not None and universal_newlines is not None

and bool(universal_newlines) != bool(text)):

raise SubprocessError('Cannot disambiguate when both text '

'and universal_newlines are supplied but '

'different. Pass one or the other.')

# Input and output objects. The general principle is like

# this:

# Parent Child

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

# p2cwrite ---stdin---> p2cread

# c2pread <--stdout--- c2pwrite

# errread <--stderr--- errwrite

# On POSIX, the child objects are file descriptors. On

# Windows, these are Windows file handles. The parent objects

# are file descriptors on both platforms. The parent objects

# are -1 when not using PIPEs. The child objects are -1

# when not redirecting.

(p2cread, p2cwrite,

c2pread, c2pwrite,

errread, errwrite) = self._get_handles(stdin, stdout, stderr)

# We wrap OS handles *before* launching the child, otherwise a

# quickly terminating child could make our fds unwrappable

# (see #8458).

if _mswindows:

if p2cwrite != -1:

p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)

if c2pread != -1:

c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)

if errread != -1:

errread = msvcrt.open_osfhandle(errread.Detach(), 0)

self.text_mode = encoding or errors or text or universal_newlines

# How long to resume waiting on a child after the first ^C.

# There is no right value for this. The purpose is to be polite

# yet remain good for interactive users trying to exit a tool.

self._sigint_wait_secs = 0.25 # 1/xkcd221.getRandomNumber()

self._closed_child_pipe_fds = False

if self.text_mode:

if bufsize == 1:

line_buffering = True

# Use the default buffer size for the underlying binary streams

# since they don't support line buffering.

bufsize = -1

else:

line_buffering = False

try:

if p2cwrite != -1:

self.stdin = io.open(p2cwrite, 'wb', bufsize)

if self.text_mode:

self.stdin = io.TextIOWrapper(self.stdin, write_through=True,

line_buffering=line_buffering,

encoding=encoding, errors=errors)

if c2pread != -1:

self.stdout = io.open(c2pread, 'rb', bufsize)

if self.text_mode:

self.stdout = io.TextIOWrapper(self.stdout,

encoding=encoding, errors=errors)

if errread != -1:

self.stderr = io.open(errread, 'rb', bufsize)

if self.text_mode:

self.stderr = io.TextIOWrapper(self.stderr,

encoding=encoding, errors=errors)

self._execute_child(args, executable, preexec_fn, close_fds,

pass_fds, cwd, env,

startupinfo, creationflags, shell,

p2cread, p2cwrite,

c2pread, c2pwrite,

errread, errwrite,

restore_signals, start_new_session)

except:

# Cleanup if the child failed starting.

for f in filter(None, (self.stdin, self.stdout, self.stderr)):

try:

f.close()

except OSError:

pass # Ignore EBADF or other errors.

if not self._closed_child_pipe_fds:

to_close = []

if stdin == PIPE:

to_close.append(p2cread)

if stdout == PIPE:

to_close.append(c2pwrite)

if stderr == PIPE:

to_close.append(errwrite)

if hasattr(self, '_devnull'):

to_close.append(self._devnull)

for fd in to_close:

try:

if _mswindows and isinstance(fd, Handle):

fd.Close()

else:

os.close(fd)

except OSError:

pass

raise

@property

def universal_newlines(self):

# universal_newlines as retained as an alias of text_mode for API

# compatibility. bpo-31756

return self.text_mode

@universal_newlines.setter

def universal_newlines(self, universal_newlines):

self.text_mode = bool(universal_newlines)

def _translate_newlines(self, data, encoding, errors):

data = data.decode(encoding, errors)

return data.replace("\r\n", "\n").replace("\r", "\n")

def __enter__(self):

return self

def __exit__(self, exc_type, value, traceback):

if self.stdout:

self.stdout.close()

if self.stderr:

self.stderr.close()

try: # Flushing a BufferedWriter may raise an error

if self.stdin:

self.stdin.close()

finally:

if exc_type == KeyboardInterrupt:

# https://bugs.python.org/issue25942

# In the case of a KeyboardInterrupt we assume the SIGINT

# was also already sent to our child processes. We can't

# block indefinitely as that is not user friendly.

# If we have not already waited a brief amount of time in

# an interrupted .wait() or .communicate() call, do so here

# for consistency.

if self._sigint_wait_secs > 0:

try:

self._wait(timeout=self._sigint_wait_secs)

except TimeoutExpired:

pass

self._sigint_wait_secs = 0 # Note that this has been done.

return # resume the KeyboardInterrupt

# Wait for the process to terminate, to avoid zombies.

self.wait()

def __del__(self, _maxsize=sys.maxsize, _warn=warnings.warn):

if not self._child_created:

# We didn't get to successfully create a child process.

return

if self.returncode is None:

# Not reading subprocess exit status creates a zombie process which

# is only destroyed at the parent python process exit

_warn("subprocess %s is still running" % self.pid,

ResourceWarning, source=self)

# In case the child hasn't been waited on, check if it's done.

self._internal_poll(_deadstate=_maxsize)

if self.returncode is None and _active is not None:

# Child is still running, keep us alive until we can wait on it.

_active.append(self)

def _get_devnull(self):

if not hasattr(self, '_devnull'):

self._devnull = os.open(os.devnull, os.O_RDWR)

return self._devnull

def _stdin_write(self, input):

if input:

try:

self.stdin.write(input)

except BrokenPipeError:

pass # communicate() must ignore broken pipe errors.

except OSError as exc:

if exc.errno == errno.EINVAL:

# bpo-19612, bpo-30418: On Windows, stdin.write() fails

# with EINVAL if the child process exited or if the child

# process is still running but closed the pipe.

pass

else:

raise

try:

self.stdin.close()

except BrokenPipeError:

pass # communicate() must ignore broken pipe errors.

except OSError as exc:

if exc.errno == errno.EINVAL:

pass

else:

raise

def communicate(self, input=None, timeout=None):

"""Interact with process: Send data to stdin and close it.

Read data from stdout and stderr, until end-of-file is

reached. Wait for process to terminate.

The optional "input" argument should be data to be sent to the

child process, or None, if no data should be sent to the child.

communicate() returns a tuple (stdout, stderr).

By default, all communication is in bytes, and therefore any

"input" should be bytes, and the (stdout, stderr) will be bytes.

If in text mode (indicated by self.text_mode), any "input" should

be a string, and (stdout, stderr) will be strings decoded

according to locale encoding, or by "encoding" if set. Text mode

is triggered by setting any of text, encoding, errors or

universal_newlines.

"""

if self._communication_started and input:

raise ValueError("Cannot send input after starting communication")

# Optimization: If we are not worried about timeouts, we haven't

# started communicating, and we have one or zero pipes, using select()

# or threads is unnecessary.

if (timeout is None and not self._communication_started and

[self.stdin, self.stdout, self.stderr].count(None) >= 2):

stdout = None

stderr = None

if self.stdin:

self._stdin_write(input)

elif self.stdout:

stdout = self.stdout.read()

self.stdout.close()

elif self.stderr:

stderr = self.stderr.read()

self.stderr.close()

self.wait()

else:

if timeout is not None:

endtime = _time() + timeout

else:

endtime = None

try:

stdout, stderr = self._communicate(input, endtime, timeout)

View remainder of file in raw view

FilesExpand file tree

subprocess.py

Latest commit

History

subprocess.py

File metadata and controls