change powerline>powerline2, add available sample

Author: vaaaaanquish

README.md

@@ -8,46 +8,127 @@ xontrib-powerline fork by [santagada/xontrib-powerline](https://github.com/santa
 # Install
 
 ```
-pip install git+https://github.com/6syun9/xontrib-powerline2
+pip install xontrib-powerline2
 ```
 
 And them load it on your ``.xonshrc``
 
 ```
-xontrib load powerline
+xontrib load powerline2
 ```
 
 
 # Configuration
 
-There are two variables that can be set, ``PL_PROMPT`` for the right prompt and ``PL_TOOLBAR`` for the bottom toolbar.
+There are two variables that can be set, ``$PROMPT`` for main prompt, ``$PL_PROMPT`` for the right prompt and ``$PL_TOOLBAR`` for the bottom toolbar.
 They contain a list of sections that can be used separated by ``>``. The value ``!`` means not to use that prompt.
 
 Examples:
 
 ```
+$PL_PROMPT='cwd>branch'
+$PL_RPROMPT = '!'  # for no toolbar
 $PL_TOOLBAR = 'who>virtualenv>branch>cwd>full_proc'
-$PL_TOOLBAR = '!'  # for no toolbar
 xontrib load powerline
 ```
 
-To see all available sections type ``pl_available_sections``, and to commit changes to your prompt execute ``pl_build_prompt``.
+## Bulid prompt
 
-# Customize
+If you want to override the settings after `xontrib load`, so commit changes to your prompt execute ``pl_build_prompt`` command.
 
-- customize color: $PL_COLORS
-- customize origin section: $PL_EXTRA_SEC
+## Check config
 
-Examples:
+To see all available sections type ``pl_available_sections`` command.
+
+<img src="https://github.com/6syun9/xontrib-powerline2/raw/master/img/example_available.png" alt="example" title="example_available">
+
+## Default sections
+
+|section|description|
+|---|---|
+|who| {user}@{hostname} |
+|virtualenv| {env_name} |
+|branch| {curr_branch} |
+|cwd| $pwd using $pl_colors['cwd', 'git_root', 'git_sub_dir'] and $pl_parts |
+|short_cwd| {short_cwd} |
+|full_proc| run time of the previous command from history |
+|timing| diff from previous command's executed time |
+|time| strftime(' %h:%m ') |
+|history| len(\_\_xonsh\_\_.history) |
+|rtns| '!' if \_\_xonsh\_\_.history.rtns else none |
+|full_rtns| rtns[-1] if \_\_xonsh\_\_.history.rtns else none |
+
+
+If you want to know about `{}` sections, please look [xonsh document](https://xon.sh/tutorial.html#customizing-the-prompt).
 
+
+## Custom sections
+
+We can add customize origin section by `$PL_EXTRA_SEC`.
 ```
-$PL_COLORS = {"cwd": ("BLACK", "#a6e22e")}
-$PL_EXTRA_SEC = {"user": lambda: [' {user} ', 'BLACK', '#fd971f']}
+# func return [format string, text color, background color]
+$PL_EXTRA_SEC = {"user": lambda: [' I'm {user} ', 'BLACK', '#fd971f']}
 $PL_PROMPT='user>cwd>branch'
 $PL_TOOLBAR='!'
 $PL_RPROMPT='!'
 xontrib load powerline
 ```
+<img src="https://github.com/6syun9/xontrib-powerline2/raw/master/img/example_custom_sec.png" alt="example" title="custom_sec">
+
+
+## Section's color
+
+We can change section color by `$PL_COLORS`.
+
+`$PL_COLORS` is `dict`. Basically, the value is `(text_color, background_color)`.
+|key|default value|description|
+|---|---|---|
+|who| ("BLACK", "#a6e22e") ||
+|venv| ("BLACK", "INTENSE_GREEN") ||
+|branch| ("#333") | background color from $PROMPT_FIELDS['branch_bg_color'] |
+|cwd| ("WHITE", "#444") ||
+|git_root| ("BLACK", "#00adee") | used by cwd |
+|git_sub_dir| ("WHITE", "#00adee") | used by cwd |
+|short_cwd| ("WHITE", "#444") ||
+|full_proc| ("WHITE", "RED", "#444") |There are two types of background depending on the situation|
+|timing| ("WHITE", "#444") ||
+|time| ("BLACK", "#00adee") ||
+|history| ("WHITE", "#333333") ||
+|rtns| ("WHITE", "RED") ||
+|full_rtns| ("WHITE", "RED", "#444") |There are two types of background depending on the situation|
+
+
+## Separate mode
+
+We can change the way of separation mode by `$PL_SEP_MODE`.
+
+|mode|separate char|
+|---|---|
+|powerline| , , , |
+|round| , , ,  |
+|down| , , ,  |
+|up| , , ,  |
+|flame| , , ,  |
+|squares| , , ,  |
+|ruiny| , , ,  |
+|lego| ,  |
+
+For example
+```
+# set $PL_SEP_MODE or using pl_set_mode alias
+$PL_SEP_MODE='round'
+pl_set_mode round
+```
+<img src="https://github.com/6syun9/xontrib-powerline2/raw/master/img/example_round.png" alt="example" title="round">
+
+If you want to use original separeter, you can use `$PL_ORG_SEP`, `$PL_ORG_SEP_THIN`, `$PL_ORG_RSEP`.
+```
+$PL_ORG_SEP = '■'
+$PL_ORG_SEP_THIN = '□'
+$PL_ORG_RSEP = '■'
+xontrib load xontrib-powerline2
+```
+<img src="https://github.com/6syun9/xontrib-powerline2/raw/master/img/example_origin_sep.png" alt="example" title="origin_sep">
 
 # Credits
 

img/example_available.png

@@ -8,8 +8,8 @@
     long_description = f.read()
 
 setup(
-    name='xontrib-powerline',
-    version='0.1.1',
+    name='xontrib-powerline2',
+    version='1.0.0',
     description='Powerline for Xonsh shell',
     long_description=open('README.md').read(),
     long_description_content_type="text/markdown",

img/example_custom_sec.png

@@ -15,19 +15,19 @@ $PL_DEFAULT_RPROMPT = 'history>time'
 $PL_DEFAULT_TOOLBAR = 'who>cwd>branch>virtualenv>full_proc'
 $PL_DEFAULT_EXTRA_SEC = {'user': lambda: [' {user} ', 'WHITE', '#555']}
 $PL_DEFAULT_COLORS = {
-                "time": ("BLACK", "#00adee"),
                 "who": ("BLACK", "#a6e22e"),
-                "short_cwd": ("WHITE", "#444"),
+                "venv": ("BLACK", "INTENSE_GREEN"),
+                "branch": ("#333"),
                 "cwd": ("WHITE", "#444"),
                 "git_root": ("BLACK", "#00adee"),
                 "git_sub_dir": ("WHITE", "#00adee"),
-                "history": ("WHITE", "#333333"),
-                "venv": ("BLACK", "INTENSE_GREEN"),
+                "short_cwd": ("WHITE", "#444"),
+                "full_proc": ("WHITE", "RED", "#444"),
                 "timing": ("WHITE", "#444"),
+                "time": ("BLACK", "#00adee"),
+                "history": ("WHITE", "#333333"),
                 "rtns": ("WHITE", "RED"),
                 "full_rtns": ("WHITE", "RED", "#444"),
-                "full_proc": ("WHITE", "RED", "#444"),
-                "branch": ("#333")
             }
 
 if ptk_shell_type() == 'prompt_toolkit2':
@@ -59,17 +59,21 @@ def register_sec(f):
 
 
 @register_sec
-def history():
+def history(sample=False):
+    if sample:
+        return Section(' 100 ', *$PL_COLORS["history"])
     return Section(' %d ' % len(__xonsh__.history), *$PL_COLORS["history"])
 
 
 @register_sec
-def time():
+def time(sample=False):
     return Section(strftime(' %H:%M '), *$PL_COLORS["time"])
 
 
 @register_sec
-def short_cwd():
+def short_cwd(sample=False):
+    if sample:
+        return Section(' ~/e/h/p/fuga ', *$PL_COLORS["short_cwd"])
     return Section(' {short_cwd} ', *$PL_COLORS["short_cwd"])
 
 
@@ -80,11 +84,15 @@ def compress_home(path):
 
 
 @register_sec
-def cwd():
+def cwd(sample=False):
     ps = compress_home($PWD).strip(os.sep).split(os.sep)
+    if sample:
+        ps = ['~','example','hoge','piyo','fuga']
 
     if $PROMPT_FIELDS['curr_branch']():
         prefix = $(git rev-parse --show-prefix).strip()
+        if sample:
+            prefix = ['hoge', 'piyo', 'fuga']
         ni = -1
         if prefix != '':
             subs = prefix.rstrip(os.sep).split(os.sep)
@@ -107,40 +115,56 @@ def cwd():
 
 
 @register_sec
-def branch():
+def branch(sample=False):
+    if sample:
+        return [
+                Section('   hoge ', $PL_COLORS['branch'], 'YELLOW'),
+                Section('   piyo ', $PL_COLORS['branch'], 'GREEN'),
+                Section('   fuga ', $PL_COLORS['branch'], 'RED')]
     if $PROMPT_FIELDS['curr_branch']():
         return Section('  {curr_branch} ', $PL_COLORS['branch'], $PROMPT_FIELDS['branch_bg_color']()[1+len('background_'):-1])
 
 
 @register_sec
-def virtualenv():
+def virtualenv(sample=False):
+    if sample:
+        return Section(' 🐍 example env', *$PL_COLORS["venv"])
     if $PROMPT_FIELDS['env_name']():
         return Section(' 🐍 {env_name} ', *$PL_COLORS["venv"])
 
 
 @register_sec
-def rtns():
+def rtns(sample=False):
+    if sample:
+        return Section(' ! ', *$PL_COLORS['rtns'])
     if __xonsh__.history.rtns and __xonsh__.history.rtns[-1] != 0:
         return Section(' ! ', *$PL_COLORS['rtns'])
 
-
 @register_sec
-def full_rtns():
+def full_rtns(sample=False):
+    if sample:
+        return [Section(' hoge ', $PL_COLORS['full_rtns'][0], $PL_COLORS['full_rtns'][1]),
+                Section(' piyo ', $PL_COLORS['full_rtns'][0], $PL_COLORS['full_rtns'][2])]
     if __xonsh__.history.rtns:
         rtn = __xonsh__.history.rtns[-1]
         color = $PL_COLORS['full_rtns'][1] if rtn != 0 else $PL_COLORS['full_rtns'][2]
         return Section(' ' + str(rtn) + ' ', $PL_COLORS['full_rtns'][0], color)
 
 
 @register_sec
-def timing():
+def timing(sample=False):
+    if sample:
+        return Section(' 0.01s ', *$PL_COLORS['timing'])
     if __xonsh__.history.tss:
         tss = __xonsh__.history.tss[-1]
         return Section(' %.2fs ' % (tss[1] - tss[0]), *$PL_COLORS['timing'])
 
 
 @register_sec
-def full_proc():
+def full_proc(sample=False):
+    if sample:
+        return [Section(' rtn: 1 ts: 0.01s ', $PL_COLORS['full_proc'][0], $PL_COLORS['full_proc'][1]),
+                Section(' rtn: 2 ts: 0.02s ', $PL_COLORS['full_proc'][0], $PL_COLORS['full_proc'][2])]
     if __xonsh__.history.buffer:
         lst = __xonsh__.history.buffer[-1]
         color = $PL_COLORS['full_proc'][1] if lst['rtn'] != 0 else $PL_COLORS['full_proc'][2]
@@ -149,11 +173,11 @@ def full_proc():
 
 
 @register_sec
-def who():
+def who(sample=False):
     return Section(' {user}@{hostname} ', *$PL_COLORS["who"])
 
 
-def prompt_builder(var, right=False):
+def prompt_builder(var, right=False, sample=False):
     if var == '!':
         return ''
 
@@ -173,9 +197,12 @@ def prompt_builder(var, right=False):
             if isinstance(s, Section):
                 sections.append(s)
             else:
-                r = s()
+                r = s(sample)
                 if r is not None:
-                    sections.append(r)
+                    if type(r) == list:
+                        sections += r
+                    else:
+                        sections.append(r)
 
         size = len(sections)
         for i, sec in enumerate(sections):
@@ -211,21 +238,32 @@ def pl_set_mode(args):
         for mode, seps in modes.items():
             print('%s: %s' % (mode, ', '.join(seps)))
         return
+    $PL_SEP_MODE = args[0]
     seps = modes[args[0]]
     $PL_SEP, $PL_SEP_THIN, $PL_RSEP, _ = seps
+    if 'PL_ORG_SEP' in ${...}:
+        $PL_SEP = $PL_ORG_SEP
+    if 'PL_ORG_SEP_THIN' in ${...}:
+        $PL_SEP_THIN = $PL_ORG_SEP_THIN
+    if 'PL_ORG_RSEP' in ${...}:
+        $PL_RSEP = $PL_ORG_RSEP
 
 
 @alias
 def pl_available_sections():
     for name in available_sections.keys():
-        r = prompt_builder(name)()
+        if name in ['branch', 'virtualenv', 'rtns', 'full_rtns', 'timing', 'full_proc', 'cwd', 'short_cwd']:
+            r = prompt_builder(name, sample=True)()
+        else:
+            r = prompt_builder(name)()
         f = __xonsh__.shell.prompt_formatter(r)
         __xonsh__.shell.print_color('%s: %s' % (name, f))
 
 
 @alias
 def pl_build_prompt():
-    pl_set_mode(['powerline'])
+    $PL_SEP_MODE = 'powerline' if 'PL_SEP_MODE' not in ${...} else $PL_SEP_MODE
+    pl_set_mode([$PL_SEP_MODE])
     for var in 'PROMPT RPROMPT TOOLBAR'.split():
         varname = 'PL_' + var
         defname = 'PL_DEFAULT_' + var