python-progressbar/progressbar/utils.py at multibar · commit-0/python-progressbar · GitHub

History

459 lines (362 loc) · 12 KB

Raw

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

from __future__ import absolute_import

import distutils.util

import io

import os

import re

import sys

import logging

import datetime

import functools

from python_utils.time import timedelta_to_seconds, epoch, format_time

from python_utils.converters import scale_1024

from python_utils.terminal import get_terminal_size

import six

assert timedelta_to_seconds

assert get_terminal_size

assert format_time

assert scale_1024

assert epoch

def is_terminal(fd, is_terminal=None):

if is_terminal is None:

if 'JPY_PARENT_PID' in os.environ:

is_terminal = True

elif 'VIM' in os.environ:

is_terminal = True

else:

is_terminal = env_flag('PROGRESSBAR_IS_TERMINAL', None)

if is_terminal is None: # pragma: no cover

try:

is_terminal = fd.isatty()

except Exception:

is_terminal = False

return is_terminal

def ansi_esc(value, command):

return u'\u001B[{}{}'.format(value, command)

class ANSI:

# For more options:

# https://en.wikipedia.org/wiki/ANSI_escape_code#Terminal_output_sequences

def esc(command, default_value=None):

def _esc(value=default_value):

return u'\u001B[{}{}'.format(value, command)

return u'\u001B[{}{}{}{}'.format(value, command, value, command)

return _esc

def y(line, y0, y1=None):

a, b = ANSI.up, ANSI.down

if y0 < 0:

a, b = b, a

if y1 is None:

y1 = y0

return a(y0) + line + b(y1)

def x(line, x0, x1=None):

a, b = ANSI.left, ANSI.right

if x0 < 0:

a, b = b, a

if x1 is None:

x1 = x0

return a(x0) + line + b(x1)

up = esc('A')

up = esc('F')

down = esc('B')

down = esc('E')

right = esc('C')

left = esc('D')

begin_of_line = esc('G', 1)

clear = esc('K', 2)

# clear = esc('J', 1)

def add_ansi_offset(line, x0=0, y0=0, x1=None, y1=None):

line = '({x0},{y0})({x1},{y1}) {line}'.format(

x0=x0, y0=y0, x1=x1, y1=y0, line=line)

# line = ANSI.clear() + line

if x0 or x1:

line = ANSI.x(line, x0, x1)

if y0 or y1:

line = ANSI.y(line, y0, y1)

return line

def deltas_to_seconds(*deltas, **kwargs): # default=ValueError):

'''

Convert timedeltas and seconds as int to seconds as float while coalescing

>>> deltas_to_seconds(datetime.timedelta(seconds=1, milliseconds=234))

1.234

>>> deltas_to_seconds(123)

123.0

>>> deltas_to_seconds(1.234)

1.234

>>> deltas_to_seconds(None, 1.234)

1.234

>>> deltas_to_seconds(0, 1.234)

0.0

>>> deltas_to_seconds()

Traceback (most recent call last):

...

ValueError: No valid deltas passed to `deltas_to_seconds`

>>> deltas_to_seconds(None)

Traceback (most recent call last):

...

ValueError: No valid deltas passed to `deltas_to_seconds`

>>> deltas_to_seconds(default=0.0)

0.0

'''

default = kwargs.pop('default', ValueError)

assert not kwargs, 'Only the `default` keyword argument is supported'

for delta in deltas:

if delta is None:

continue

if isinstance(delta, datetime.timedelta):

return timedelta_to_seconds(delta)

elif not isinstance(delta, float):

return float(delta)

else:

return delta

if default is ValueError:

raise ValueError('No valid deltas passed to `deltas_to_seconds`')

else:

return default

def no_color(value):

'''

Return the `value` without ANSI escape codes

>>> no_color(b'\u001b[1234]abc') == b'abc'

True

>>> str(no_color(u'\u001b[1234]abc'))

'abc'

>>> str(no_color('\u001b[1234]abc'))

'abc'

'''

if isinstance(value, bytes):

pattern = '\\\u001b\\[.*?[@-~]'

pattern = pattern.encode()

replace = b''

assert isinstance(pattern, bytes)

else:

pattern = u'\x1b\\[.*?[@-~]'

replace = ''

return re.sub(pattern, replace, value)

def len_color(value):

'''

Return the length of `value` without ANSI escape codes

>>> len_color(b'\u001b[1234]abc')

>>> len_color(u'\u001b[1234]abc')

>>> len_color('\u001b[1234]abc')

'''

return len(no_color(value))

def env_flag(name, default=None):

'''

Accepts environt variables formatted as y/n, yes/no, 1/0, true/false,

on/off, and returns it as a boolean

If the environt variable is not defined, or has an unknown value, returns

`default`

'''

try:

return bool(distutils.util.strtobool(os.environ.get(name, '')))

except ValueError:

return default

class WrappingIO:

def __init__(self, target, capturing=False, listeners=None):

self.buffer = six.StringIO()

self.target = target

self.capturing = capturing

self.listeners = list(listeners or [])

self.needs_clear = False

self.update_offset()

def update_offset(self):

x = y = None

for listener in self.listeners:

if listener.offset:

x_new, y_new = listener.offset

x = max(x, x_new)

y = max(y, y_new)

if x is None and y is None:

offset = None

else:

offset = x or 0, y or 0

self.offset = offset

def write(self, value):

# value = ANSI.up(4) + value + ANSI.down(4)

if self.offset:

...

# value = ANSI.up(4) + value + ANSI.down(1)

# value = add_ansi_offset(value, *self.offset)

# print('writing %r\n\n\n\n\n' % value, file=sys.__stderr__)

if self.capturing:

# value = ANSI.y(value + '\n', 4, 1)

# if '\n' in value:

# value = value + 2 * '\n' + ANSI.up(2)

self.buffer.write(ANSI.up(4))

self.buffer.write(value + '\n' * 3)

if '\n' in value:

# self.buffer.write('\n')

# self.buffer.write(ANSI.up(3))

# self.buffer.write('\n' + ANSI.up(1))

self.needs_clear = not self.offset

self.needs_clear = True

for listener in self.listeners: # pragma: no branch

listener.update()

self.buffer.write(ANSI.down(4))

else:

self.target.write(value)

def flush(self):

self.needs_clear = False

self.buffer.flush()

def _flush(self):

value = self.buffer.getvalue()

if value:

self.flush()

self.target.write(value)

self.buffer.seek(0)

self.buffer.truncate(0)

class StreamWrapper(object):

'''Wrap stdout and stderr globally'''

def __init__(self):

self.stdout = self.original_stdout = sys.stdout

self.stderr = self.original_stderr = sys.stderr

self.original_excepthook = sys.excepthook

self.wrapped_stdout = 0

self.wrapped_stderr = 0

self.wrapped_excepthook = 0

self.capturing = 0

self.listeners = []

if env_flag('WRAP_STDOUT', default=False): # pragma: no cover

self.wrap_stdout()

if env_flag('WRAP_STDERR', default=False): # pragma: no cover

self.wrap_stderr()

def start_capturing(self, bar=None):

if bar: # pragma: no branch

self.listeners.append(bar)

self.capturing += 1

self.update_capturing()

def stop_capturing(self, bar=None):

if bar: # pragma: no branch

try:

self.listeners.remove(bar)

except KeyError:

pass

self.capturing -= 1

self.update_capturing()

def update_capturing(self): # pragma: no cover

if isinstance(self.stdout, WrappingIO):

self.stdout.capturing = self.capturing > 0

if isinstance(self.stderr, WrappingIO):

self.stderr.capturing = self.capturing > 0

if self.capturing <= 0:

self.flush()

def wrap(self, stdout=False, stderr=False):

if stdout:

self.wrap_stdout()

if stderr:

self.wrap_stderr()

def wrap_stdout(self):

self.wrap_excepthook()

if not self.wrapped_stdout:

self.stdout = sys.stdout = WrappingIO(self.original_stdout,

listeners=self.listeners)

self.wrapped_stdout += 1

return sys.stdout

def wrap_stderr(self):

self.wrap_excepthook()

if not self.wrapped_stderr:

self.stderr = sys.stderr = WrappingIO(self.original_stderr,

listeners=self.listeners)

self.wrapped_stderr += 1

return sys.stderr

def unwrap_excepthook(self):

if self.wrapped_excepthook:

self.wrapped_excepthook -= 1

sys.excepthook = self.original_excepthook

def wrap_excepthook(self):

if not self.wrapped_excepthook:

logger.debug('wrapping excepthook')

self.wrapped_excepthook += 1

sys.excepthook = self.excepthook

def unwrap(self, stdout=False, stderr=False):

if stdout:

self.unwrap_stdout()

if stderr:

self.unwrap_stderr()

def unwrap_stdout(self):

if self.wrapped_stdout > 1:

self.wrapped_stdout -= 1

else:

sys.stdout = self.original_stdout

self.wrapped_stdout = 0

def unwrap_stderr(self):

if self.wrapped_stderr > 1:

self.wrapped_stderr -= 1

else:

sys.stderr = self.original_stderr

self.wrapped_stderr = 0

def needs_clear(self): # pragma: no cover

stdout_needs_clear = getattr(self.stdout, 'needs_clear', False)

stderr_needs_clear = getattr(self.stderr, 'needs_clear', False)

return stderr_needs_clear or stdout_needs_clear

def flush(self):

if self.wrapped_stdout: # pragma: no branch

try:

self.stdout._flush()

except (io.UnsupportedOperation,

AttributeError): # pragma: no cover

self.wrapped_stdout = False

logger.warn('Disabling stdout redirection, %r is not seekable',

sys.stdout)

if self.wrapped_stderr: # pragma: no branch

try:

self.stderr._flush()

except (io.UnsupportedOperation,

AttributeError): # pragma: no cover

self.wrapped_stderr = False

logger.warn('Disabling stderr redirection, %r is not seekable',

sys.stderr)

def excepthook(self, exc_type, exc_value, exc_traceback):

self.original_excepthook(exc_type, exc_value, exc_traceback)

self.flush()

class AttributeDict(dict):

'''

A dict that can be accessed with .attribute

>>> attrs = AttributeDict(spam=123)

# Reading

>>> attrs['spam']

123

>>> attrs.spam

123

# Read after update using attribute

>>> attrs.spam = 456

>>> attrs['spam']

456

>>> attrs.spam

456

# Read after update using dict access

>>> attrs['spam'] = 123

>>> attrs['spam']

123

>>> attrs.spam

123

# Read after update using dict access

>>> del attrs.spam

>>> attrs['spam']

Traceback (most recent call last):

...

KeyError: 'spam'

>>> attrs.spam

Traceback (most recent call last):

...

AttributeError: No such attribute: spam

>>> del attrs.spam

Traceback (most recent call last):

...

AttributeError: No such attribute: spam

'''

def __getattr__(self, name):

if name in self:

return self[name]

else:

raise AttributeError("No such attribute: " + name)

def __setattr__(self, name, value):

self[name] = value

def __delattr__(self, name):

if name in self:

del self[name]

else:

raise AttributeError("No such attribute: " + name)

logger = logging.getLogger(__name__)

streams = StreamWrapper()

python-progressbar/progressbar/utils.py at multibar · commit-0/python-progressbar · GitHub

Uh oh!

Expand file tree

Breadcrumbs

utils.py

Latest commit

History

Breadcrumbs

utils.py

File metadata and controls