mrprajesh / blog

Rajesh's Blog
https://mrprajesh.github.io/blog
MIT License
0 stars 0 forks source link

blog/terminal-and-shell-prompt-customization #9

Open utterances-bot opened 1 year ago

utterances-bot commented 1 year ago

Terminal and shell prompt customization - Rajesh's Blog

Do you want your terminal prompt to look like a pro?

https://mrprajesh.co.in/blog/terminal-and-shell-prompt-customization.html

mrprajesh commented 1 year ago

File: /usr/local/lib/python<x.y>/dist-packages/powerline_shell/__init__.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-
from __future__ import print_function
import argparse
import os
import sys
import importlib
import json
from .utils import warn, py3, import_file
import re

def _current_dir():
    """Returns the full current working directory as the user would have used
    in their shell (ie. without following symbolic links).

    With the introduction of Bash for Windows, we can't use the PWD environment
    variable very easily. `os.sep` for windows is `\` but the PWD variable will
    use `/`. So just always use the `os` functions for dealing with paths. This
    also is fine because the use of PWD below is done to avoid following
    symlinks, which Windows doesn't have.

    For non-Windows systems, prefer the PWD environment variable. Python's
    `os.getcwd` function follows symbolic links, which is undesirable."""
    if os.name == "nt":
        return os.getcwd()
    return os.getenv("PWD") or os.getcwd()

def get_valid_cwd():
    """Determine and check the current working directory for validity.

    Typically, an directory arises when you checkout a different branch on git
    that doesn't have this directory. When an invalid directory is found, a
    warning is printed to the screen, but the directory is still returned
    as-is, since this is what the shell considers to be the cwd."""
    try:
        cwd = _current_dir()
    except:
        warn("Your current directory is invalid. If you open a ticket at " +
            "https://github.com/milkbikis/powerline-shell/issues/new " +
            "we would love to help fix the issue.")
        sys.stdout.write("> ")
        sys.exit(1)

    parts = cwd.split(os.sep)
    up = cwd
    while parts and not os.path.exists(up):
        parts.pop()
        up = os.sep.join(parts)
    if cwd != up:
        warn("Your current directory is invalid. Lowest valid directory: "
             + up)
    return cwd

DEFAULT_SYMBOLS = {
    'compatible': {
        'lock': 'RO',
        'network': 'SSH',
        'separator': u'\u25B6',
        'separator_thin': u'\u276F'
    },
    'patched': {
            'lock': u'\uE0A2',
            'network': 'SSH',
            'separator': u'\uE0B0',
            'separator_thin': u'\uE0B1'
    },
    'flat': {
        'lock': u'\uE0A2',
        'network': 'SSH',
        'separator': '',
        'separator_thin': ''
    }
}

class Powerline(object):

    color_templates = {
        'bash': r'\[\e%s\]',
        'tcsh': r'%%{\e%s%%}',
        'zsh': '%%{%s%%}',
        'bare': '%s',
    }

    def __init__(self, args, config, theme):
        self.args = args
        self.config = config
        self.theme = theme
        self.cwd = get_valid_cwd()
        mode = config.get("mode", "patched")

        template_symbols = getattr(theme, 'SYMBOLS', DEFAULT_SYMBOLS)
        symbols = template_symbols.get(mode, DEFAULT_SYMBOLS.get(mode, DEFAULT_SYMBOLS['patched']))

        self.color_template = self.color_templates[args.shell]
        self.reset = self.color_template % '[0m'
        self.lock = symbols['lock']
        self.network = symbols['network']
        self.separator = symbols['separator']
        self.separator_thin = symbols['separator_thin']
        self.segments = []

    def segment_conf(self, seg_name, key, default=None):
        return self.config.get(seg_name, {}).get(key, default)

    def color(self, prefix, code):
        if code is None:
            return ''
        elif code == self.theme.RESET:
            return self.reset
        else:
            return self.color_template % ('[%s;5;%sm' % (prefix, code))

    def fgcolor(self, code):
        return self.color('38', code)

    def bgcolor(self, code):
        return self.color('48', code)

    def append(self, content, fg, bg, separator=None, separator_fg=None, sanitize=True):
        if self.args.shell == "bash" and sanitize:
            content = re.sub(r"([`$])", r"\\\1", content)
        self.segments.append((content, fg, bg,
            separator if separator is not None else self.separator,
            separator_fg if separator_fg is not None else bg))

    def draw(self):
        text = (''.join(self.draw_segment(i) for i in range(len(self.segments)))
                + self.reset) + ' '
        if py3:
            return text
        else:
            return text.encode('utf-8')

    def draw_segment(self, idx):
        segment = self.segments[idx]
        next_segment = self.segments[idx + 1] if idx < len(self.segments)-1 else None

        return ''.join((
            self.fgcolor(segment[1]),
            self.bgcolor(segment[2]),
            segment[0],
            self.bgcolor(next_segment[2]) if next_segment else self.reset,
            self.fgcolor(segment[4]),
            segment[3]))

def find_config():
    for location in [
        "powerline-shell.json",
        "~/.powerline-shell.json",
        os.path.join(os.environ.get("XDG_CONFIG_HOME", "~/.config"), "powerline-shell", "config.json"),
    ]:
        full = os.path.expanduser(location)
        if os.path.exists(full):
            return full

DEFAULT_CONFIG = {
    "segments": [
        'virtual_env',
        'username',
        'hostname',
        'ssh',
        'cwd',
        'git',
        'hg',
        'jobs',
        'root',
    ]
}

class ModuleNotFoundException(Exception):
    pass

class CustomImporter(object):
    def __init__(self):
        self.file_import_count = 0

    def import_(self, module_prefix, module_or_file, description):
        try:
            mod = importlib.import_module(module_prefix + module_or_file)
        except ImportError:
            try:
                module_name = "_custom_mod_{0}".format(self.file_import_count)
                mod = import_file(module_name, os.path.expanduser(module_or_file))
                self.file_import_count += 1
            except (ImportError, IOError):
                msg = "{0} {1} cannot be found".format(description, module_or_file)
                raise ModuleNotFoundException( msg)
        return mod

def main():
    arg_parser = argparse.ArgumentParser()
    arg_parser.add_argument('--generate-config', action='store_true',
                            help='Generate the default config and print it to stdout')
    arg_parser.add_argument('--shell', action='store', default='bash',
                            help='Set this to your shell type',
                            choices=['bash', 'tcsh', 'zsh', 'bare'])
    arg_parser.add_argument('prev_error', nargs='?', type=int, default=0,
                            help='Error code returned by the last command')
    args = arg_parser.parse_args()

    if args.generate_config:
        print(json.dumps(DEFAULT_CONFIG, indent=2))
        return 0

    config_path = find_config()
    if config_path:
        with open(config_path) as f:
            try:
                config = json.loads(f.read())
            except Exception as e:
                warn("Config file ({0}) could not be decoded! Error: {1}"
                     .format(config_path, e))
                config = DEFAULT_CONFIG
    else:
        config = DEFAULT_CONFIG

    custom_importer = CustomImporter()
    theme_mod = custom_importer.import_(
        "powerline_shell.themes.",
        config.get("theme", "default"),
        "Theme")
    theme = getattr(theme_mod, "Color")

    powerline = Powerline(args, config, theme)
    segments = []
    for seg_conf in config["segments"]:
        if not isinstance(seg_conf, dict):
            seg_conf = {"type": seg_conf}
        seg_name = seg_conf["type"]
        seg_mod = custom_importer.import_(
            "powerline_shell.segments.",
            seg_name,
            "Segment")
        segment = getattr(seg_mod, "Segment")(powerline, seg_conf)
        segment.start()
        segments.append(segment)
    for segment in segments:
        segment.add_to_powerline()
    sys.stdout.write(powerline.draw())
    return 0

config.json

{
  "segments": [
    "virtual_env",
    "username",
    "hostname",
    "ssh",
    "cwd",
    "git",
    "hg",
    "jobs",
    "newline",
    "time",
    "root"
  ],
  "cwd": {
    "mode": "dironly",
    "max_depth": 2,
    "full_cwd": "true"
  },
  "vcs": {
    "show_symbol": "true"
  },
  "time": {
    "format": "%H:%M"
  },
  "mode": "flames",
  "theme": "~/.config/powerline-shell/themes/rajz-flames.py"
}

file: rajz-flames.py

from powerline_shell.themes.default import DefaultColor

class Color(DefaultColor):
    USERNAME_FG = 0
    USERNAME_BG = 226
    USERNAME_ROOT_BG = 1

    HOSTNAME_FG = 250 #15
    HOSTNAME_BG = 238 #208

    HOME_SPECIAL_DISPLAY = True

    PATH_FG = 15
    PATH_BG = 166

    CWD_FG = 15

    SEPARATOR_FG = 14

    READONLY_BG = 1
    READONLY_FG = 7

    REPO_CLEAN_FG = 0
    REPO_CLEAN_BG = 226
    REPO_DIRTY_FG = 0
    REPO_DIRTY_BG = 160

    JOBS_FG = 4
    JOBS_BG = 8

    CMD_PASSED_FG = 0
    CMD_PASSED_BG = 10
    CMD_FAILED_FG = 15
    CMD_FAILED_BG = 160

    SVN_CHANGES_FG = REPO_DIRTY_FG
    SVN_CHANGES_BG = REPO_DIRTY_BG

    VIRTUAL_ENV_BG = 15
    VIRTUAL_ENV_FG = 2

    AWS_PROFILE_FG = 7
    AWS_PROFILE_BG = 2

    TIME_FG = 250
    TIME_BG = 238

    BATTERY_LOW_FG = 15
    BATTERY_LOW_BG = 160

    BATTERY_NORMAL_FG = 0
    BATTERY_NORMAL_BG = 2

    # https://github.com/ryanoasis/powerline-extra-symbols

    SYMBOLS = {
        "flames": {
            "lock": u"\uE0A2",
            "network": "SSH",
            "separator": u"\uE0C0 ",
            "separator_thin": u"\uE0C1"
        },
        "blocks": {
            "lock': u'\uE0A2",
            "network': u'\uE0A2",
            "separator': u'\uE0cc",
            "separator_thin': u'\uE0cd"
        },
        # angly 1
        "angly": {
                "lock": u"\uE0A2",
                "network": u"\uE0A2",
                "separator": u"\uE0B8",
                "separator_thin": u"\uE0B9"
        },
        # angly 2
        "angly2": {
          "lock": u"\uE0A2",
          "network": u"\uE0A2",
          "separator": u"\uE0BC",
          "separator_thin": u"\uE0BD"
        },
        # curvy
        "curvy": {
          "lock": u"\uE0A2",
          "network": u"\uE0A2",
          "separator": u"\uE0B4",
          "separator_thin": u"\uE0B5"
        },
        # lego (blocky)
        "blocky": {
          "lock": u"\uE0A2",
          "network": u"\uE0A2",
          "separator": u"\uE0CE",
          "separator_thin": u"\uE0CF"
        },
        # pixelated blocks 2 (large) random fade (pixey)
        "pixey": {
          "lock": u"\uE0A2",
          "network": u"\uE0A2",
          "separator": u"\uE0C6",
          "separator_thin": u"\uE0C6"
        }
        #/usr/local/lib/python3.6/dist-packages/powerline-shell
    }
mrprajesh commented 1 year ago

File: /usr/local/lib/python<x.y>/dist-packages/powerline_shell/themes/flames.py

class DefaultColor(object):
    """ from powerline extra theme folder NOT WORKING
    This class should have the default colors for every segment.
    Please test every new segment with this theme first.
    """
    # RESET is not a real color code. It is used as in indicator
    # within the code that any foreground / background color should
    # be cleared
    RESET = -1

    USERNAME_FG = 250
    USERNAME_BG = 240
    USERNAME_ROOT_BG = 160

    HOSTNAME_FG = 250
    HOSTNAME_BG = 238

    HOME_SPECIAL_DISPLAY = True
    HOME_BG = 208  
    HOME_FG = 15  
    PATH_BG = 166   
    PATH_FG = 15  
    CWD_FG = 15  
    SEPARATOR_FG = 15

    READONLY_BG = 160
    READONLY_FG = 254

    SSH_BG = 166  # medium orange
    SSH_FG = 254

    REPO_CLEAN_BG = 148  # a light green color
    REPO_CLEAN_FG = 0  # black
    REPO_DIRTY_BG = 161  # pink/red
    REPO_DIRTY_FG = 15  # white

    JOBS_FG = 39
    JOBS_BG = 238

    CMD_PASSED_BG = 160
    CMD_PASSED_FG = 15
    CMD_FAILED_BG = 160
    CMD_FAILED_FG = 15

    SVN_CHANGES_BG = 148
    SVN_CHANGES_FG = 22  # dark green

    GIT_AHEAD_BG = 240
    GIT_AHEAD_FG = 250
    GIT_BEHIND_BG = 240
    GIT_BEHIND_FG = 250
    GIT_STAGED_BG = 22
    GIT_STAGED_FG = 15
    GIT_NOTSTAGED_BG = 130
    GIT_NOTSTAGED_FG = 15
    GIT_UNTRACKED_BG = 52
    GIT_UNTRACKED_FG = 15
    GIT_CONFLICTED_BG = 9
    GIT_CONFLICTED_FG = 15

    GIT_STASH_BG = 221
    GIT_STASH_FG = 0

    VIRTUAL_ENV_BG = 35  # a mid-tone green
    VIRTUAL_ENV_FG = 00

    BATTERY_NORMAL_BG = 106
    BATTERY_NORMAL_FG = 239
    BATTERY_LOW_BG = 196
    BATTERY_LOW_FG = 7

    AWS_PROFILE_FG = 39
    AWS_PROFILE_BG = 238

    TIME_FG = 250
    TIME_BG = 238

class Color(DefaultColor):
    """
    This subclass is required when the user chooses to use 'default' theme.
    Because the segments require a 'Color' class for every theme.
    """
    pass