/usr/lib/python3/dist-packages/pbs.py is in python3-pbs 0.95-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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 | #===============================================================================
# Copyright (C) 2011-2012 by Andrew Moffat
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#===============================================================================
import subprocess as subp
import sys
import traceback
import os
import re
from glob import glob
import shlex
from types import ModuleType
from functools import partial
__version__ = "0.95"
__project_url__ = "https://github.com/amoffat/pbs"
IS_PY3 = sys.version_info[0] == 3
if IS_PY3: raw_input = input
class ErrorReturnCode(Exception):
truncate_cap = 200
def __init__(self, full_cmd, stdout, stderr):
self.full_cmd = full_cmd
self.stdout = stdout
self.stderr = stderr
if self.stdout is None: tstdout = "<redirected>"
else:
tstdout = self.stdout[:self.truncate_cap]
out_delta = len(self.stdout) - len(tstdout)
if out_delta:
tstdout += "... (%d more, please see e.stdout)" % out_delta
if self.stderr is None: tstderr = "<redirected>"
else:
tstderr = self.stderr[:self.truncate_cap]
err_delta = len(self.stderr) - len(tstderr)
if err_delta:
tstderr += "... (%d more, please see e.stderr)" % err_delta
msg = "\n\nRan: %r\n\nSTDOUT:\n\n %s\n\nSTDERR:\n\n %s" %\
(full_cmd, tstdout, tstderr)
super(ErrorReturnCode, self).__init__(msg)
class CommandNotFound(Exception): pass
rc_exc_regex = re.compile("ErrorReturnCode_(\d+)")
rc_exc_cache = {}
def get_rc_exc(rc):
try: return rc_exc_cache[rc]
except KeyError: pass
name = "ErrorReturnCode_%d" % rc
exc = type(name, (ErrorReturnCode,), {})
rc_exc_cache[name] = exc
return exc
def which(program):
def is_exe(fpath):
return os.path.exists(fpath) and os.access(fpath, os.X_OK)
fpath, fname = os.path.split(program)
if fpath:
if is_exe(program): return program
else:
for path in os.environ["PATH"].split(os.pathsep):
exe_file = os.path.join(path, program)
if is_exe(exe_file):
return exe_file
return None
def resolve_program(program):
path = which(program)
if not path:
# our actual command might have a dash in it, but we can't call
# that from python (we have to use underscores), so we'll check
# if a dash version of our underscore command exists and use that
# if it does
if "_" in program: path = which(program.replace("_", "-"))
if not path: return None
return path
class RunningCommand(object):
def __init__(self, command_ran, process, call_args, stdin=None):
self.command_ran = command_ran
self.process = process
self._stdout = None
self._stderr = None
self.call_args = call_args
# we're running in the background, return self and let us lazily
# evaluate
if self.call_args["bg"]: return
# we're running this command as a with context, don't do anything
# because nothing was started to run from Command.__call__
if self.call_args["with"]: return
# run and block
self._stdout, self._stderr = self.process.communicate(stdin)
rc = self.process.wait()
if rc != 0: raise get_rc_exc(rc)(self.command_ran, self._stdout, self._stderr)
def __enter__(self):
# we don't actually do anything here because anything that should
# have been done would have been done in the Command.__call__ call.
# essentially all that has to happen is the comand be pushed on
# the prepend stack.
pass
def __exit__(self, typ, value, traceback):
if self.call_args["with"] and Command._prepend_stack:
Command._prepend_stack.pop()
def __str__(self):
if IS_PY3: return self.__unicode__()
else: return unicode(self).encode("utf-8")
def __unicode__(self):
if self.process:
if self.stdout: return self.stdout.decode("utf-8") # byte string
else: return ""
def __eq__(self, other):
return str(self) == str(other)
def __contains__(self, item):
return item in str(self)
def __getattr__(self, p):
return getattr(str(self), p)
def __repr__(self):
return str(self)
def __long__(self):
return long(str(self).strip())
def __float__(self):
return float(str(self).strip())
def __int__(self):
return int(str(self).strip())
@property
def stdout(self):
if self.call_args["bg"]: self.wait()
return self._stdout
@property
def stderr(self):
if self.call_args["bg"]: self.wait()
return self._stderr
def wait(self):
if self.process.returncode is not None: return
self._stdout, self._stderr = self.process.communicate()
rc = self.process.wait()
if rc != 0: raise get_rc_exc(rc)(self.stdout, self.stderr)
return self
def __len__(self):
return len(str(self))
class BakedCommand(object):
def __init__(self, cmd, attr):
self._cmd = cmd
self._attr = attr
self._partial = partial(cmd, attr)
def __call__(self, *args, **kwargs):
return self._partial(*args, **kwargs)
def __str__(self):
if IS_PY3: return self.__unicode__()
else: return unicode(self).encode("utf-8")
def __repr__(self):
return str(self)
def __unicode__(self):
return "%s %s" % (self._cmd, self._attr)
class Command(object):
_prepend_stack = []
call_args = {
"fg": False, # run command in foreground
"bg": False, # run command in background
"with": False, # prepend the command to every command after it
"out": None, # redirect STDOUT
"err": None, # redirect STDERR
"err_to_out": None, # redirect STDERR to STDOUT
}
@classmethod
def _create(cls, program):
path = resolve_program(program)
if not path: raise CommandNotFound(program)
return cls(path)
def __init__(self, path):
self._path = path
self._partial = False
self._partial_baked_args = []
self._partial_call_args = {}
def __getattribute__(self, name):
# convenience
getattr = partial(object.__getattribute__, self)
# the logic here is, if an attribute starts with an
# underscore, always try to find it, because it's very unlikely
# that a first command will start with an underscore, example:
# "git _command" will probably never exist.
# after that, we check to see if the attribute actually exists
# on the Command object, but only return that if we're not
# a baked object.
if name.startswith("_"): return getattr(name)
try: attr = getattr(name)
except AttributeError: return BakedCommand(self, name)
if self._partial: return BakedCommand(self, name)
return attr
@staticmethod
def _extract_call_args(kwargs):
kwargs = kwargs.copy()
call_args = Command.call_args.copy()
for parg, default in call_args.items():
key = "_" + parg
if key in kwargs:
call_args[parg] = kwargs[key]
del kwargs[key]
return call_args, kwargs
@staticmethod
def _compile_args(args, kwargs):
processed_args = []
# aggregate positional args
for arg in args:
if isinstance(arg, (list, tuple)):
for sub_arg in arg: processed_args.append(repr(sub_arg))
else: processed_args.append(repr(arg))
# aggregate the keyword arguments
for k,v in kwargs.items():
# we're passing a short arg as a kwarg, example:
# cut(d="\t")
if len(k) == 1:
if v is True: arg = "-"+k
else: arg = "-%s %r" % (k, v)
# we're doing a long arg
else:
k = k.replace("_", "-")
if v is True: arg = "--"+k
else: arg = "--%s=%r" % (k, v)
processed_args.append(arg)
processed_args = shlex.split(" ".join(processed_args))
return processed_args
def bake(self, *args, **kwargs):
fn = Command(self._path)
fn._partial = True
fn._partial_call_args, kwargs = self._extract_call_args(kwargs)
processed_args = self._compile_args(args, kwargs)
fn._partial_baked_args = processed_args
return fn
def __str__(self):
if IS_PY3: return self.__unicode__()
else: return unicode(self).encode("utf-8")
def __repr__(self):
return str(self)
def __unicode__(self):
baked_args = " ".join(self._partial_baked_args)
if baked_args: baked_args = " " + baked_args
return self._path + baked_args
def __enter__(self):
Command._prepend_stack.append([self._path])
def __exit__(self, typ, value, traceback):
Command._prepend_stack.pop()
def __call__(self, *args, **kwargs):
kwargs = kwargs.copy()
args = list(args)
cmd = []
# aggregate any with contexts
for prepend in self._prepend_stack: cmd.extend(prepend)
cmd.append(self._path)
call_args, kwargs = self._extract_call_args(kwargs)
call_args.update(self._partial_call_args)
# set pipe to None if we're outputting straight to CLI
pipe = None if call_args["fg"] else subp.PIPE
# check if we're piping via composition
stdin = pipe
actual_stdin = None
if args:
first_arg = args.pop(0)
if isinstance(first_arg, RunningCommand):
# it makes sense that if the input pipe of a command is running
# in the background, then this command should run in the
# background as well
if first_arg.call_args["bg"]:
call_args["bg"] = True
stdin = first_arg.process.stdout
else:
actual_stdin = first_arg.stdout
else: args.insert(0, first_arg)
processed_args = self._compile_args(args, kwargs)
# makes sure our arguments are broken up correctly
split_args = self._partial_baked_args + processed_args
# we used to glob, but now we don't. the reason being, escaping globs
# doesn't work. also, adding a _noglob attribute doesn't allow the
# flexibility to glob some args and not others. so we have to leave
# the globbing up to the user entirely
#=======================================================================
# # now glob-expand each arg and compose the final list
# final_args = []
# for arg in split_args:
# expanded = glob(arg)
# if expanded: final_args.extend(expanded)
# else: final_args.append(arg)
#=======================================================================
final_args = split_args
cmd.extend(final_args)
command_ran = " ".join(cmd)
# with contexts shouldn't run at all yet, they prepend
# to every command in the context
if call_args["with"]:
Command._prepend_stack.append(cmd)
return RunningCommand(command_ran, None, call_args)
# stdout redirection
stdout = pipe
out = call_args["out"]
if out:
if isinstance(out, file): stdout = out
else: stdout = file(str(out), "w")
# stderr redirection
stderr = pipe
err = call_args["err"]
if err:
if isinstance(err, file): stderr = err
else: stderr = file(str(err), "w")
if call_args["err_to_out"]: stderr = subp.STDOUT
# leave shell=False
process = subp.Popen(cmd, shell=False, env=os.environ,
stdin=stdin, stdout=stdout, stderr=stderr)
return RunningCommand(command_ran, process, call_args, actual_stdin)
# this class is used directly when we do a "from pbs import *". it allows
# lookups to names that aren't found in the global scope to be searched
# for as a program. for example, if "ls" isn't found in the program's
# scope, we consider it a system program and try to find it.
class Environment(dict):
def __init__(self, *args, **kwargs):
dict.__init__(self, *args, **kwargs)
self["Command"] = Command
self["CommandNotFound"] = CommandNotFound
self["ErrorReturnCode"] = ErrorReturnCode
self["ARGV"] = sys.argv[1:]
for i, arg in enumerate(sys.argv):
self["ARG%d" % i] = arg
# this needs to be last
self["env"] = os.environ
def __setitem__(self, k, v):
# are we altering an environment variable?
if "env" in self and k in self["env"]: self["env"][k] = v
# no? just setting a regular name
else: dict.__setitem__(self, k, v)
def __missing__(self, k):
# the only way we'd get to here is if we've tried to
# import * from a repl. so, raise an exception, since
# that's really the only sensible thing to do
if k == "__all__":
raise ImportError("Cannot import * from pbs. \
Please import pbs or import programs individually.")
# if we end with "_" just go ahead and skip searching
# our namespace for python stuff. this was mainly for the
# command "id", which is a popular program for finding
# if a user exists, but also a python function for getting
# the address of an object. so can call the python
# version by "id" and the program version with "id_"
if not k.endswith("_"):
# check if we're naming a dynamically generated ReturnCode exception
try: return rc_exc_cache[k]
except KeyError:
m = rc_exc_regex.match(k)
if m: return get_rc_exc(int(m.group(1)))
# are we naming a commandline argument?
if k.startswith("ARG"):
return None
# is it a builtin?
try: return getattr(self["__builtins__"], k)
except AttributeError: pass
elif not k.startswith("_"): k = k.rstrip("_")
# how about an environment variable?
try: return os.environ[k]
except KeyError: pass
# is it a custom builtin?
builtin = getattr(self, "b_"+k, None)
if builtin: return builtin
# it must be a command then
return Command._create(k)
def b_cd(self, path):
os.chdir(path)
def b_which(self, program):
return which(program)
def run_repl(env):
banner = "\n>> PBS v{version}\n>> https://github.com/amoffat/pbs\n"
print(banner.format(version=__version__))
while True:
try: line = raw_input("pbs> ")
except (ValueError, EOFError): break
try: exec(compile(line, "<dummy>", "single"), env, env)
except SystemExit: break
except: print(traceback.format_exc())
# cleans up our last line
print("")
# this is a thin wrapper around THIS module (we patch sys.modules[__name__]).
# this is in the case that the user does a "from pbs import whatever"
# in other words, they only want to import certain programs, not the whole
# system PATH worth of commands. in this case, we just proxy the
# import lookup to our Environment class
class SelfWrapper(ModuleType):
def __init__(self, self_module):
# this is super ugly to have to copy attributes like this,
# but it seems to be the only way to make reload() behave
# nicely. if i make these attributes dynamic lookups in
# __getattr__, reload sometimes chokes in weird ways...
for attr in ["__builtins__", "__doc__", "__name__", "__package__"]:
setattr(self, attr, getattr(self_module, attr))
self.self_module = self_module
self.env = Environment(globals())
def __getattr__(self, name):
return self.env[name]
# we're being run as a stand-alone script, fire up a REPL
if __name__ == "__main__":
globs = globals()
f_globals = {}
for k in ["__builtins__", "__doc__", "__name__", "__package__"]:
f_globals[k] = globs[k]
env = Environment(f_globals)
run_repl(env)
# we're being imported from somewhere
else:
self = sys.modules[__name__]
sys.modules[__name__] = SelfWrapper(self)
|