Merge pull request #10 from TankerApp/dm/symbol

Add ui.Symbol class

Author: dmerejkowsky

docs/changelog.rst

@@ -1,6 +1,12 @@
 Changelog
 ==========
 
+v0.4.1
+------
+
+* Export a ``Symbol`` class, to use when you do not want to force
+  color as  with ``UnicodeSequence``
+
 v0.4.0
 ------
 

docs/usage.rst

@@ -74,7 +74,7 @@ You can use any of these constants as a ``token`` in the following functions:
   * ``cross``: ❌ (red, replaced by 'ko' on Windows)
   * ``ellipsis``:  … (no color, replaced by '...' on Windows)
 
-  You can create your own sequences using :class:`UnicodeSequence`:
+  You can create your own colored sequences using :class:`UnicodeSequence`:
 
 .. autoclass:: UnicodeSequence
 
@@ -85,6 +85,18 @@ You can use any of these constants as a ``token`` in the following functions:
       ↑ 2 commits # on Linux
       + 2 commits # on Windows
 
+  Alternatively, if you do not wont to force a color, you can use
+  :class:`Symbol`:
+
+.. autoclass:: Symbol
+
+  ::
+
+      >>> heart = ui.Symbol("❤", "<3")
+      >>> ui.info("Thanks for using python-cli-ui", heart)
+      Thanks for using python-cli-ui ❤  # on Linux
+      Thanks for using python-cli-ui <3  # on Windows
+
 
 
 Informative messages

ui/__init__.py

@@ -117,6 +117,14 @@ def tuple(self):
 cross    = UnicodeSequence(red,   "❌","ko")
 
 
+class Symbol(UnicodeSequence):
+    def __init__(self, as_unicode, as_ascii):
+        super().__init__(reset, as_unicode, as_ascii)
+
+    def tuple(self):
+        return (self.as_string,)
+
+
 def using_colorama():
     if os.name == "nt":
         if "TERM" not in os.environ:
@@ -544,6 +552,9 @@ def did_you_mean(message, user_input, choices):
 
 
 if __name__ == "__main__":
+    info("OK", check)
+    up = Symbol("👍", "+1")
+    info("I like it", blue, up)
     info_section(bold, "python-cli demo")
     # Monkey-patch message() so that we sleep after
     # each call