Merge pull request #365 from b-ryan/stdout-segment

Generic stdout and environment variable segments

Author: b-ryan

Dockerfile

@@ -1,6 +1,6 @@
-FROM aa8y/core:python2
+FROM python:2-alpine
 
-MAINTAINER github.com/banga/powerline-shell
+MAINTAINER github.com/b-ryan/powerline-shell
 
 USER root
 RUN apk add --no-cache --update \
@@ -12,22 +12,17 @@ RUN apk add --no-cache --update \
       subversion && \
     rm -rf /var/cache/apk/*
 
-# Cache the dev requirements. Directory is set in the base image.
-WORKDIR $APP_DIR
+RUN mkdir /code
+WORKDIR /code
 COPY requirements-dev.txt .
 RUN pip install -r requirements-dev.txt && \
-    rm -rf requirements-dev.txt
+    rm requirements-dev.txt
 
-# 'USER' is set in the base image. It points to a non-root user called 'docker'.
-USER $USER
-RUN bzr whoami "$USERNAME <$USER@example.com>" && \
-    git config --global user.email "$USER@example.com" && \
-    git config --global user.name "$USERNAME"
+RUN bzr whoami "root <root@example.com>" && \
+    git config --global user.email "root@example.com" && \
+    git config --global user.name "root"
 
 COPY . ./
-USER root
-RUN ./setup.py install && \
-    chown -R $USER:$USER .
+RUN ./setup.py install
 
-USER $USER
-ENTRYPOINT ["/bin/bash"]
+ENV USER root

README.md

@@ -23,9 +23,11 @@ has no relation to powerline.
   - [Bash](#bash)
   - [ZSH](#zsh)
   - [Fish](#fish)
+  - [tcsh](#tcsh)
 - [Customization](#customization)
   - [Config File](#config-file)
   - [Adding, Removing and Re-arranging segments](#adding-removing-and-re-arranging-segments)
+  - [Generic Segments](#generic-segments)
   - [Segment Separator](#segment-separator)
   - [Themes](#themes)
   - [Segment Configuration](#segment-configuration)
@@ -200,6 +202,32 @@ the segments section, like:
 ]
 ```
 
+### Generic Segments
+
+There are two special segments available. `stdout` accepts an arbitrary command
+and the output of the command will be put into your prompt. `env` takes an
+environment variable and the value of the variable will be set in your prompt.
+For example, your config could look like this:
+
+```
+{
+  "segments": [
+    "cwd",
+    "git",
+    {
+      "type": "stdout",
+      "command": ["echo", "hi"],
+      "fg_color": 22,
+      "bg_color": 161
+    },
+    {
+      "type": "env",
+      "var": "DOCKER_MACHINE_NAME",
+    },
+  ]
+}
+```
+
 ### Segment Separator
 
 By default, a unicode character (resembling the > symbol) is used to separate

powerline_shell/__init__.py

@@ -225,12 +225,15 @@ def main():
 
     powerline = Powerline(args, config, theme)
     segments = []
-    for seg_name in config["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)
+        segment = getattr(seg_mod, "Segment")(powerline, seg_conf)
         segment.start()
         segments.append(segment)
     for segment in segments:

powerline_shell/segments/env.py

@@ -0,0 +1,10 @@
+import os
+from ..utils import BasicSegment
+
+
+class Segment(BasicSegment):
+    def add_to_powerline(self):
+        self.powerline.append(
+            " %s " % os.getenv(self.segment_def["var"]),
+            self.segment_def.get("fg_color", self.powerline.theme.PATH_FG),
+            self.segment_def.get("bg_color", self.powerline.theme.PATH_BG))

powerline_shell/segments/stdout.py

@@ -0,0 +1,17 @@
+import subprocess
+from ..utils import ThreadedSegment
+
+
+class Segment(ThreadedSegment):
+    def run(self):
+        cmd = self.segment_def["command"]
+        self.output = subprocess.check_output(cmd).decode("utf-8").strip()
+        # TODO handle OSError
+        # TODO handle no command defined or malformed
+
+    def add_to_powerline(self):
+        self.join()
+        self.powerline.append(
+            " %s " % self.output,
+            self.segment_def.get("fg_color", self.powerline.theme.PATH_FG),
+            self.segment_def.get("bg_color", self.powerline.theme.PATH_BG))

powerline_shell/segments/svn.py

@@ -50,11 +50,6 @@ def build_stats():
 
 
 class Segment(ThreadedSegment):
-    def __init__(self, powerline):
-        super(Segment, self).__init__(powerline)
-        self.stats = None
-        self.revision = ""
-
     def run(self):
         self.stats, self.revision = build_stats()
 

powerline_shell/themes/default.py

@@ -75,6 +75,7 @@ class DefaultColor(object):
     TIME_FG = 250
     TIME_BG = 238
 
+
 class Color(DefaultColor):
     """
     This subclass is required when the user chooses to use 'default' theme.

powerline_shell/utils.py

@@ -94,17 +94,19 @@ def warn(msg):
 
 
 class BasicSegment(object):
-    def __init__(self, powerline):
+    def __init__(self, powerline, segment_def):
         self.powerline = powerline
+        self.segment_def = segment_def  # type: dict
 
     def start(self):
         pass
 
 
 class ThreadedSegment(threading.Thread):
-    def __init__(self, powerline):
+    def __init__(self, powerline, segment_def):
         super(ThreadedSegment, self).__init__()
         self.powerline = powerline
+        self.segment_def = segment_def  # type: dict
 
 
 def import_file(module_name, path):

test.sh

@@ -1,4 +1,4 @@
 #!/bin/sh
-
+set -eu
 docker build -t powerline-shell .
-docker run --rm -it powerline-shell -c nosetests
+docker run --rm -it powerline-shell nosetests "$@"

test/segments_test/bzr_test.py

@@ -34,7 +34,7 @@ def setUp(self):
         sh.cd("trunk")
         sh.bzr("init")
 
-        self.segment = bzr.Segment(self.powerline)
+        self.segment = bzr.Segment(self.powerline, {})
 
     def tearDown(self):
         shutil.rmtree(self.dirname)