Source.Python/addons/source-python/Python3/distutils/util.py at master · srpg/Source.Python · 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

"""distutils.util

Miscellaneous utility functions -- anything that doesn't fit into

one of the other *util.py modules.

"""

import os

import re

import importlib.util

import string

import sys

from distutils.errors import DistutilsPlatformError

from distutils.dep_util import newer

from distutils.spawn import spawn

from distutils import log

from distutils.errors import DistutilsByteCompileError

def get_platform ():

"""Return a string that identifies the current platform. This is used

mainly to distinguish platform-specific build directories and

platform-specific built distributions. Typically includes the OS name

and version and the architecture (as supplied by 'os.uname()'),

although the exact information included depends on the OS; eg. for IRIX

the architecture isn't particularly important (IRIX only runs on SGI

hardware), but for Linux the kernel version isn't particularly

important.

Examples of returned values:

linux-i586

linux-alpha (?)

solaris-2.6-sun4u

irix-5.3

irix64-6.2

Windows will return one of:

win-amd64 (64bit Windows on AMD64 (aka x86_64, Intel64, EM64T, etc)

win-ia64 (64bit Windows on Itanium)

win32 (all others - specifically, sys.platform is returned)

For other non-POSIX platforms, currently just returns 'sys.platform'.

"""

if os.name == 'nt':

# sniff sys.version for architecture.

prefix = " bit ("

i = sys.version.find(prefix)

if i == -1:

return sys.platform

j = sys.version.find(")", i)

look = sys.version[i+len(prefix):j].lower()

if look == 'amd64':

return 'win-amd64'

if look == 'itanium':

return 'win-ia64'

return sys.platform

# Set for cross builds explicitly

if "_PYTHON_HOST_PLATFORM" in os.environ:

return os.environ["_PYTHON_HOST_PLATFORM"]

if os.name != "posix" or not hasattr(os, 'uname'):

# XXX what about the architecture? NT is Intel or Alpha,

# Mac OS is M68k or PPC, etc.

return sys.platform

# Try to distinguish various flavours of Unix

(osname, host, release, version, machine) = os.uname()

# Convert the OS name to lowercase, remove '/' characters

# (to accommodate BSD/OS), and translate spaces (for "Power Macintosh")

osname = osname.lower().replace('/', '')

machine = machine.replace(' ', '_')

machine = machine.replace('/', '-')

if osname[:5] == "linux":

# At least on Linux/Intel, 'machine' is the processor --

# i386, etc.

# XXX what about Alpha, SPARC, etc?

return "%s-%s" % (osname, machine)

elif osname[:5] == "sunos":

if release[0] >= "5": # SunOS 5 == Solaris 2

osname = "solaris"

release = "%d.%s" % (int(release[0]) - 3, release[2:])

# We can't use "platform.architecture()[0]" because a

# bootstrap problem. We use a dict to get an error

# if some suspicious happens.

bitness = {2147483647:"32bit", 9223372036854775807:"64bit"}

machine += ".%s" % bitness[sys.maxsize]

# fall through to standard osname-release-machine representation

elif osname[:4] == "irix": # could be "irix64"!

return "%s-%s" % (osname, release)

elif osname[:3] == "aix":

return "%s-%s.%s" % (osname, version, release)

elif osname[:6] == "cygwin":

osname = "cygwin"

rel_re = re.compile (r'[\d.]+', re.ASCII)

m = rel_re.match(release)

if m:

release = m.group()

elif osname[:6] == "darwin":

import _osx_support, distutils.sysconfig

osname, release, machine = _osx_support.get_platform_osx(

distutils.sysconfig.get_config_vars(),

osname, release, machine)

return "%s-%s-%s" % (osname, release, machine)

# get_platform ()

def convert_path (pathname):

"""Return 'pathname' as a name that will work on the native filesystem,

i.e. split it on '/' and put it back together again using the current

directory separator. Needed because filenames in the setup script are

always supplied in Unix style, and have to be converted to the local

convention before we can actually use them in the filesystem. Raises

ValueError on non-Unix-ish systems if 'pathname' either starts or

ends with a slash.

"""

if os.sep == '/':

return pathname

if not pathname:

return pathname

if pathname[0] == '/':

raise ValueError("path '%s' cannot be absolute" % pathname)

if pathname[-1] == '/':

raise ValueError("path '%s' cannot end with '/'" % pathname)

paths = pathname.split('/')

while '.' in paths:

paths.remove('.')

if not paths:

return os.curdir

return os.path.join(*paths)

# convert_path ()

def change_root (new_root, pathname):

"""Return 'pathname' with 'new_root' prepended. If 'pathname' is

relative, this is equivalent to "os.path.join(new_root,pathname)".

Otherwise, it requires making 'pathname' relative and then joining the

two, which is tricky on DOS/Windows and Mac OS.

"""

if os.name == 'posix':

if not os.path.isabs(pathname):

return os.path.join(new_root, pathname)

else:

return os.path.join(new_root, pathname[1:])

elif os.name == 'nt':

(drive, path) = os.path.splitdrive(pathname)

if path[0] == '\\':

path = path[1:]

return os.path.join(new_root, path)

else:

raise DistutilsPlatformError("nothing known about platform '%s'" % os.name)

_environ_checked = 0

def check_environ ():

"""Ensure that 'os.environ' has all the environment variables we

guarantee that users can use in config files, command-line options,

etc. Currently this includes:

HOME - user's home directory (Unix only)

PLAT - description of the current platform, including hardware

and OS (see 'get_platform()')

"""

global _environ_checked

if _environ_checked:

return

if os.name == 'posix' and 'HOME' not in os.environ:

import pwd

os.environ['HOME'] = pwd.getpwuid(os.getuid())[5]

if 'PLAT' not in os.environ:

os.environ['PLAT'] = get_platform()

_environ_checked = 1

def subst_vars (s, local_vars):

"""Perform shell/Perl-style variable substitution on 'string'. Every

occurrence of '$' followed by a name is considered a variable, and

variable is substituted by the value found in the 'local_vars'

dictionary, or in 'os.environ' if it's not in 'local_vars'.

'os.environ' is first checked/augmented to guarantee that it contains

certain values: see 'check_environ()'. Raise ValueError for any

variables not found in either 'local_vars' or 'os.environ'.

"""

check_environ()

def _subst (match, local_vars=local_vars):

var_name = match.group(1)

if var_name in local_vars:

return str(local_vars[var_name])

else:

return os.environ[var_name]

try:

return re.sub(r'\$([a-zA-Z_][a-zA-Z_0-9]*)', _subst, s)

except KeyError as var:

raise ValueError("invalid variable '$%s'" % var)

# subst_vars ()

def grok_environment_error (exc, prefix="error: "):

# Function kept for backward compatibility.

# Used to try clever things with EnvironmentErrors,

# but nowadays str(exception) produces good messages.

return prefix + str(exc)

# Needed by 'split_quoted()'

_wordchars_re = _squote_re = _dquote_re = None

def _init_regex():

global _wordchars_re, _squote_re, _dquote_re

_wordchars_re = re.compile(r'[^\\\'\"%s ]*' % string.whitespace)

_squote_re = re.compile(r"'(?:[^'\\]|\\.)*'")

_dquote_re = re.compile(r'"(?:[^"\\]|\\.)*"')

def split_quoted (s):

"""Split a string up according to Unix shell-like rules for quotes and

backslashes. In short: words are delimited by spaces, as long as those

spaces are not escaped by a backslash, or inside a quoted string.

Single and double quotes are equivalent, and the quote characters can

be backslash-escaped. The backslash is stripped from any two-character

escape sequence, leaving only the escaped character. The quote

characters are stripped from any quoted string. Returns a list of

words.

"""

# This is a nice algorithm for splitting up a single string, since it

# doesn't require character-by-character examination. It was a little

# bit of a brain-bender to get it working right, though...

if _wordchars_re is None: _init_regex()

s = s.strip()

words = []

pos = 0

while s:

m = _wordchars_re.match(s, pos)

end = m.end()

if end == len(s):

words.append(s[:end])

break

if s[end] in string.whitespace: # unescaped, unquoted whitespace: now

words.append(s[:end]) # we definitely have a word delimiter

s = s[end:].lstrip()

pos = 0

elif s[end] == '\\': # preserve whatever is being escaped;

# will become part of the current word

s = s[:end] + s[end+1:]

pos = end+1

else:

if s[end] == "'": # slurp singly-quoted string

m = _squote_re.match(s, end)

elif s[end] == '"': # slurp doubly-quoted string

m = _dquote_re.match(s, end)

else:

raise RuntimeError("this can't happen (bad char '%c')" % s[end])

if m is None:

raise ValueError("bad string (mismatched %s quotes?)" % s[end])

(beg, end) = m.span()

s = s[:beg] + s[beg+1:end-1] + s[end:]

pos = m.end() - 2

if pos >= len(s):

words.append(s)

break

return words

# split_quoted ()

def execute (func, args, msg=None, verbose=0, dry_run=0):

"""Perform some action that affects the outside world (eg. by

writing to the filesystem). Such actions are special because they

are disabled by the 'dry_run' flag. This method takes care of all

that bureaucracy for you; all you have to do is supply the

function to call and an argument tuple for it (to embody the

"external action" being performed), and an optional message to

print.

"""

if msg is None:

msg = "%s%r" % (func.__name__, args)

if msg[-2:] == ',)': # correct for singleton tuple

msg = msg[0:-2] + ')'

log.info(msg)

if not dry_run:

func(*args)

def strtobool (val):

"""Convert a string representation of truth to true (1) or false (0).

True values are 'y', 'yes', 't', 'true', 'on', and '1'; false values

are 'n', 'no', 'f', 'false', 'off', and '0'. Raises ValueError if

'val' is anything else.

"""

val = val.lower()

if val in ('y', 'yes', 't', 'true', 'on', '1'):

return 1

elif val in ('n', 'no', 'f', 'false', 'off', '0'):

return 0

else:

raise ValueError("invalid truth value %r" % (val,))

def byte_compile (py_files,

optimize=0, force=0,

prefix=None, base_dir=None,

verbose=1, dry_run=0,

direct=None):

"""Byte-compile a collection of Python source files to .pyc

files in a __pycache__ subdirectory. 'py_files' is a list

of files to compile; any files that don't end in ".py" are silently

skipped. 'optimize' must be one of the following:

0 - don't optimize

1 - normal optimization (like "python -O")

2 - extra optimization (like "python -OO")

If 'force' is true, all files are recompiled regardless of

timestamps.

The source filename encoded in each bytecode file defaults to the

filenames listed in 'py_files'; you can modify these with 'prefix' and

'basedir'. 'prefix' is a string that will be stripped off of each

source filename, and 'base_dir' is a directory name that will be

prepended (after 'prefix' is stripped). You can supply either or both

(or neither) of 'prefix' and 'base_dir', as you wish.

If 'dry_run' is true, doesn't actually do anything that would

affect the filesystem.

Byte-compilation is either done directly in this interpreter process

with the standard py_compile module, or indirectly by writing a

temporary script and executing it. Normally, you should let

'byte_compile()' figure out to use direct compilation or not (see

the source for details). The 'direct' flag is used by the script

generated in indirect mode; unless you know what you're doing, leave

it set to None.

"""

# Late import to fix a bootstrap issue: _posixsubprocess is built by

# setup.py, but setup.py uses distutils.

import subprocess

# nothing is done if sys.dont_write_bytecode is True

if sys.dont_write_bytecode:

raise DistutilsByteCompileError('byte-compiling is disabled.')

# First, if the caller didn't force us into direct or indirect mode,

# figure out which mode we should be in. We take a conservative

# approach: choose direct mode *only* if the current interpreter is

# in debug mode and optimize is 0. If we're not in debug mode (-O

# or -OO), we don't know which level of optimization this

# interpreter is running with, so we can't do direct

# byte-compilation and be certain that it's the right thing. Thus,

# always compile indirectly if the current interpreter is in either

# optimize mode, or if either optimization level was requested by

# the caller.

if direct is None:

direct = (__debug__ and optimize == 0)

# "Indirect" byte-compilation: write a temporary script and then

# run it with the appropriate flags.

if not direct:

try:

from tempfile import mkstemp

(script_fd, script_name) = mkstemp(".py")

except ImportError:

from tempfile import mktemp

(script_fd, script_name) = None, mktemp(".py")

log.info("writing byte-compilation script '%s'", script_name)

if not dry_run:

if script_fd is not None:

script = os.fdopen(script_fd, "w")

else:

script = open(script_name, "w")

script.write("""\

from distutils.util import byte_compile

files = [

""")

# XXX would be nice to write absolute filenames, just for

# safety's sake (script should be more robust in the face of

# chdir'ing before running it). But this requires abspath'ing

# 'prefix' as well, and that breaks the hack in build_lib's

# 'byte_compile()' method that carefully tacks on a trailing

# slash (os.sep really) to make sure the prefix here is "just

# right". This whole prefix business is rather delicate -- the

# problem is that it's really a directory, but I'm treating it

# as a dumb string, so trailing slashes and so forth matter.

#py_files = map(os.path.abspath, py_files)

#if prefix:

# prefix = os.path.abspath(prefix)

script.write(",\n".join(map(repr, py_files)) + "]\n")

script.write("""

byte_compile(files, optimize=%r, force=%r,

prefix=%r, base_dir=%r,

verbose=%r, dry_run=0,

direct=1)

""" % (optimize, force, prefix, base_dir, verbose))

script.close()

cmd = [sys.executable]

cmd.extend(subprocess._optim_args_from_interpreter_flags())

cmd.append(script_name)

spawn(cmd, dry_run=dry_run)

execute(os.remove, (script_name,), "removing %s" % script_name,

dry_run=dry_run)

# "Direct" byte-compilation: use the py_compile module to compile

# right here, right now. Note that the script generated in indirect

# mode simply calls 'byte_compile()' in direct mode, a weird sort of

# cross-process recursion. Hey, it works!

else:

from py_compile import compile

for file in py_files:

if file[-3:] != ".py":

# This lets us be lazy and not filter filenames in

# the "install_lib" command.

continue

# Terminology from the py_compile module:

# cfile - byte-compiled file

# dfile - purported source filename (same as 'file' by default)

if optimize >= 0:

opt = '' if optimize == 0 else optimize

cfile = importlib.util.cache_from_source(

file, optimization=opt)

else:

cfile = importlib.util.cache_from_source(file)

dfile = file

if prefix:

if file[:len(prefix)] != prefix:

raise ValueError("invalid prefix: filename %r doesn't start with %r"

% (file, prefix))

dfile = dfile[len(prefix):]

if base_dir:

dfile = os.path.join(base_dir, dfile)

cfile_base = os.path.basename(cfile)

if direct:

if force or newer(file, cfile):

log.info("byte-compiling %s to %s", file, cfile_base)

if not dry_run:

compile(file, cfile, dfile)

else:

log.debug("skipping byte-compilation of %s to %s",

file, cfile_base)

# byte_compile ()

def rfc822_escape (header):

"""Return a version of the string escaped for inclusion in an

RFC-822 header, by ensuring there are 8 spaces space after each newline.

"""

lines = header.split('\n')

sep = '\n' + 8 * ' '

return sep.join(lines)

# 2to3 support

def run_2to3(files, fixer_names=None, options=None, explicit=None):

"""Invoke 2to3 on a list of Python files.

The files should all come from the build area, as the

modification is done in-place. To reduce the build time,

only files modified since the last invocation of this

function should be passed in the files argument."""

if not files:

return

# Make this class local, to delay import of 2to3

from lib2to3.refactor import RefactoringTool, get_fixers_from_package

class DistutilsRefactoringTool(RefactoringTool):

def log_error(self, msg, *args, **kw):

log.error(msg, *args)

def log_message(self, msg, *args):

log.info(msg, *args)

def log_debug(self, msg, *args):

log.debug(msg, *args)

if fixer_names is None:

fixer_names = get_fixers_from_package('lib2to3.fixes')

r = DistutilsRefactoringTool(fixer_names, options=options)

r.refactor(files, write=True)

def copydir_run_2to3(src, dest, template=None, fixer_names=None,

options=None, explicit=None):

"""Recursively copy a directory, only copying new and changed files,

running run_2to3 over all newly copied Python modules afterward.

If you give a template string, it's parsed like a MANIFEST.in.

"""

from distutils.dir_util import mkpath

from distutils.file_util import copy_file

from distutils.filelist import FileList

filelist = FileList()

curdir = os.getcwd()

os.chdir(src)

try:

filelist.findall()

finally:

os.chdir(curdir)

filelist.files[:] = filelist.allfiles

if template:

for line in template.splitlines():

line = line.strip()

if not line: continue

filelist.process_template_line(line)

copied = []

for filename in filelist.files:

outname = os.path.join(dest, filename)

mkpath(os.path.dirname(outname))

res = copy_file(os.path.join(src, filename), outname, update=1)

if res[1]: copied.append(outname)

run_2to3([fn for fn in copied if fn.lower().endswith('.py')],

fixer_names=fixer_names, options=options, explicit=explicit)

return copied

class Mixin2to3:

'''Mixin class for commands that run 2to3.

To configure 2to3, setup scripts may either change

the class variables, or inherit from individual commands

to override how 2to3 is invoked.'''

# provide list of fixers to run;

# defaults to all from lib2to3.fixers

fixer_names = None

# options dictionary

options = None

# list of fixers to invoke even though they are marked as explicit

explicit = None

def run_2to3(self, files):

return run_2to3(files, self.fixer_names, self.options, self.explicit)

Source.Python/addons/source-python/Python3/distutils/util.py at master · srpg/Source.Python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

util.py

Latest commit

History

Breadcrumbs

util.py

File metadata and controls