# SPDX-License-Identifier: Apache-2.0
# Copyright Contributors to the Rez Project
"""
SH shell
"""
import os
import os.path
import pipes
import subprocess
from rez.config import config
from rez.utils.execution import Popen
from rez.utils.platform_ import platform_
from rez.shells import UnixShell
from rez.rex import EscapedString
[docs]class SH(UnixShell):
norc_arg = '--noprofile'
histfile = "~/.bash_history"
histvar = "HISTFILE"
[docs] @classmethod
def name(cls):
return 'sh'
[docs] @classmethod
def file_extension(cls):
return 'sh'
[docs] @classmethod
def get_syspaths(cls):
if cls.syspaths is not None:
return cls.syspaths
if config.standard_system_paths:
cls.syspaths = config.standard_system_paths
return cls.syspaths
# detect system paths using registry
cmd = "cmd=`which %s`; unset PATH; $cmd %s %s 'echo __PATHS_ $PATH'" \
% (cls.name(), cls.norc_arg, cls.command_arg)
p = Popen(cmd, stdout=subprocess.PIPE,
stderr=subprocess.PIPE, shell=True, text=True)
out_, err_ = p.communicate()
if p.returncode:
paths = []
else:
lines = out_.split('\n')
line = [x for x in lines if "__PATHS_" in x.split()][0]
paths = line.strip().split()[-1].split(os.pathsep)
for path in os.defpath.split(os.path.pathsep):
if path not in paths:
paths.append(path)
cls.syspaths = [x for x in paths if x]
return cls.syspaths
[docs] @classmethod
def startup_capabilities(cls, rcfile=False, norc=False, stdin=False,
command=False):
cls._unsupported_option('rcfile', rcfile)
rcfile = False
if command is not None:
cls._overruled_option('stdin', 'command', stdin)
stdin = False
return (rcfile, norc, stdin, command)
[docs] @classmethod
def get_startup_sequence(cls, rcfile, norc, stdin, command):
_, norc, stdin, command = \
cls.startup_capabilities(rcfile, norc, stdin, command)
envvar = None
files = []
if not ((command is not None) or stdin):
if not norc:
for file in ("~/.profile",):
if os.path.exists(os.path.expanduser(file)):
files.append(file)
envvar = 'ENV'
path = os.getenv(envvar)
if path and os.path.isfile(os.path.expanduser(path)):
files.append(path)
return dict(
stdin=stdin,
command=command,
do_rcfile=False,
envvar=envvar,
files=files,
bind_files=[],
source_bind_files=False)
def _bind_interactive_rez(self):
if config.set_prompt and self.settings.prompt:
self._addline(r'if [ -z "$REZ_STORED_PROMPT_SH" ]; then export REZ_STORED_PROMPT_SH="$PS1"; fi')
if config.prefix_prompt:
cmd = 'export PS1="%s $REZ_STORED_PROMPT_SH"'
else:
cmd = 'export PS1="$REZ_STORED_PROMPT_SH %s"'
self._addline(cmd % r"\[\e[1m\]$REZ_ENV_PROMPT\[\e[0m\]")
[docs] def setenv(self, key, value):
value = self.escape_string(value, is_path=self._is_pathed_key(key))
self._addline('export %s=%s' % (key, value))
[docs] def unsetenv(self, key):
self._addline("unset %s" % key)
[docs] def alias(self, key, value):
value = EscapedString.disallow(value)
cmd = '{key}() {{ {value} "$@"; }};'
self._addline(cmd.format(key=key, value=value))
[docs] def source(self, value):
value = self.escape_string(value)
self._addline('. %s' % value)
[docs] def escape_string(self, value, is_path=False):
value = EscapedString.promote(value)
value = value.expanduser()
result = ''
for is_literal, txt in value.strings:
if is_literal:
txt = pipes.quote(txt)
if not txt.startswith("'"):
txt = "'%s'" % txt
else:
if is_path:
txt = self.normalize_paths(txt)
txt = txt.replace('\\', '\\\\')
txt = txt.replace('"', '\\"')
txt = '"%s"' % txt
result += txt
return result
def _saferefenv(self, key):
pass
[docs]def register_plugin():
if platform_.name != "windows":
return SH