Merge pull request #6 from python-tableformatter/unit_tests

Added set_color_library class method to TableColors

Author: tleonhardt

.appveyor.yml

@@ -0,0 +1,7 @@
+install:
+  - python -m pip install tox
+
+build: off
+
+test_script:
+  - python -m tox -e py35-win,py36-win

.coveragerc

@@ -0,0 +1,24 @@
+# .coveragerc to control coverage.py
+[run]
+# Source
+source = tableformatter.py
+# (boolean, default False): whether to measure branch coverage in addition to statement coverage.
+branch = False
+
+
+[report]
+# A list of regular expressions. Any line that matches one of these regexes is excluded from being reported as missing
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain if non-runnable code isn't run:
+    if __name__ == .__main__.:
+
+# (integer): the number of digits after the decimal point to display for reported coverage percentages.
+precision = 1
+
+
+[html]
+# (string, default “htmlcov”): where to write the HTML report files.
+directory = htmlcov

.travis.yml

@@ -0,0 +1,42 @@
+language: python
+
+sudo: false  # false enables container-based build for fast boot times on Linux
+
+matrix:
+    include:
+        - os: linux
+          python: 3.4
+          env: TOXENV=py34
+        - os: linux
+          python: 3.5
+          env: TOXENV=py35
+        - os: linux
+          python: 3.6
+          env: TOXENV=py36
+        - os: linux
+          python: 3.7-dev
+          env: TOXENV=py37
+#        # Warning: Don't try to use code coverage analysis with pypy as it is insanely slow
+#        - os: linux
+#          python: pypy3
+#          env: TOXENV=pypy3
+#        # Latest Python 3.x from Homebrew
+#        - os: osx
+#          language: generic
+#          env:
+#            - TOXENV=py36
+#            - BREW_INSTALL=python3
+
+install:
+  - pip install tox
+#  - |
+#    if [[ $TRAVIS_OS_NAME == 'osx' ]]; then
+#      if [[ -n "$BREW_INSTALL" ]]; then
+#        brew update
+#        brew install "$BREW_INSTALL"
+#      fi
+#    fi
+#    pip install tox
+
+script:
+  - tox

README.md

@@ -5,6 +5,10 @@ It converts your data into a string form suitable for pretty-printing as a table
 for developers to display tabular data in an aesthetically pleasing fashion.  It provides a simple public API, but allows
 fine-grained control over almost every aspect of how the data is formatted.
 
+Many other modules for formatting tabular data require the developer to create a transition layer to convert their
+objects/data into a structure the formatter can consume.  One relatively novel aspect of tableformatter is the ability to directly
+receive arbitrary Python objects.
+
 Main Features
 -------------
 - Easy to display simple tables with just one function call when you don't need the fine-grained control
@@ -25,11 +29,12 @@ pip install tableformatter
 
 Dependencies
 ------------
-``tableformatter`` does not have any required dependencies.
+``tableformatter`` depends on the [wcwidth](https://github.com/jquast/wcwidth) module for measuring the width of 
+unicode strings rendered to a terminal.
 
-However, if you wish to use the provided optional support for color, then at least one of the following two modules must be installed:
-* [colorama](https://github.com/tartley/colorama)
-* [colored](https://github.com/dslackw/colored)
+If you wish to use the optional support for color, then at least one of the following two modules must be installed:
+* [colorama](https://github.com/tartley/colorama) - simple cross-platform colored terminal text with about 16 colors
+* [colored](https://github.com/dslackw/colored) - library for color in terminal with 256 colors, macOS and Linux only
 
 If both ``colorama`` and ``colored`` are installed, then ``colored`` will take precedence.
 

setup.py

@@ -30,15 +30,14 @@
 Topic :: Software Development :: Libraries :: Python Modules
 """.splitlines())))
 
+INSTALL_REQUIRES = ['wcwidth']
+
 EXTRAS_REQUIRE = {
-    # POSIX OSes also require wcwidth for correctly estimating the displayed width of unicode chars
-    ":sys_platform!='win32'": ['wcwidth'],
-    # Python 3.4 and earlier the typing module backport for optional type hinting support
+    # Python 3.4 and earlier require the typing module backport for type hinting support
     ":python_version<'3.5'": ['typing'],
     # development only dependencies - install with 'pip install -e .[dev]'
     'dev': [
-        'pytest', 'pytest-cov', 'tox', 'pylint', 'sphinx', 'sphinx-rtd-theme',
-        'sphinx-autobuild', 'invoke', 'twine>=1.11',
+        'pytest', 'pytest-cov', 'tox', 'invoke', 'twine>=1.11', 'setuptools>=39.1', 'wheel>=0.31'
     ]
 }
 
@@ -56,5 +55,6 @@
     py_modules = ['tableformatter'],
     keywords='table tabular formatter',
     python_requires='>=3.4',
+    install_requires=INSTALL_REQUIRES,
     extras_require=EXTRAS_REQUIRE,
 )

tableformatter.py

@@ -14,43 +14,22 @@
     # Python 3.6+ should have Collection in the typing module
     from typing import Collection
 except ImportError:
-    from typing import Container, Sized
-    import sys
-
-    # Unfortunately need slightly different solutions for Python 3.4 vs 3.5
-    if sys.version_info < (3, 5):
-        # Python 3.4
-        # noinspection PyAbstractClass
-        class Collection(Container, Sized, Iterable):
-            """hack to enable Collection typing"""
-            __slots__ = ()
-
-            # noinspection PyPep8Naming
-            @classmethod
-            def __subclasshook__(cls, C):
-                if cls is Collection:
-                    if any("__len__" in B.__dict__ for B in C.__mro__) and \
-                            any("__iter__" in B.__dict__ for B in C.__mro__) and \
-                            any("__contains__" in B.__dict__ for B in C.__mro__):
-                        return True
-                return NotImplemented
-    else:
-        # Python 3.5
-        # noinspection PyAbstractClass
-        from typing import Generic, TypeVar
-        class Collection(Generic[TypeVar('T_co', covariant=True)], Container, Sized, Iterable):
-            """hack to enable Collection typing"""
-            __slots__ = ()
-
-            # noinspection PyPep8Naming
-            @classmethod
-            def __subclasshook__(cls, C):
-                if cls is Collection:
-                    if any("__len__" in B.__dict__ for B in C.__mro__) and \
-                            any("__iter__" in B.__dict__ for B in C.__mro__) and \
-                            any("__contains__" in B.__dict__ for B in C.__mro__):
-                        return True
-                return NotImplemented
+    from typing import Container, Generic, Sized, TypeVar
+    # Python 3.5
+    # noinspection PyAbstractClass
+    class Collection(Generic[TypeVar('T_co', covariant=True)], Container, Sized, Iterable):
+        """hack to enable Collection typing"""
+        __slots__ = ()
+
+        # noinspection PyPep8Naming
+        @classmethod
+        def __subclasshook__(cls, C):
+            if cls is Collection:
+                if any("__len__" in B.__dict__ for B in C.__mro__) and \
+                        any("__iter__" in B.__dict__ for B in C.__mro__) and \
+                        any("__contains__" in B.__dict__ for B in C.__mro__):
+                    return True
+            return NotImplemented
 
 
 ANSI_ESCAPE_RE = re.compile(r'\x1b[^m]*m')
@@ -303,6 +282,44 @@ class TableColors(object):
             BOLD = ''
             RESET = ''
 
+    @classmethod
+    def set_color_library(cls, library_name: str) -> None:
+        """Manually override the color library being used."""
+        if library_name == 'colored':
+            from colored import fg, bg, attr
+
+            cls.TEXT_COLOR_WHITE = fg('white')
+            cls.TEXT_COLOR_YELLOW = fg(226)
+            cls.TEXT_COLOR_RED = fg(196)
+            cls.TEXT_COLOR_GREEN = fg(119)
+            cls.TEXT_COLOR_BLUE = fg(27)
+            cls.BG_COLOR_ROW = bg(234)
+            cls.BG_RESET = bg(0)
+            cls.BOLD = attr('bold')
+            cls.RESET = attr('reset')
+        elif library_name == 'colorama':
+            from colorama import Fore, Back, Style
+
+            cls.TEXT_COLOR_WHITE = Fore.WHITE
+            cls.TEXT_COLOR_YELLOW = Fore.LIGHTYELLOW_EX
+            cls.TEXT_COLOR_RED = Fore.LIGHTRED_EX
+            cls.TEXT_COLOR_GREEN = Fore.LIGHTGREEN_EX
+            cls.TEXT_COLOR_BLUE = Fore.LIGHTBLUE_EX
+            cls.BG_COLOR_ROW = Back.LIGHTBLACK_EX
+            cls.BG_RESET = Back.RESET
+            cls.BOLD = Style.BRIGHT
+            cls.RESET = Fore.RESET + Back.RESET
+        else:
+            cls.TEXT_COLOR_WHITE = ''
+            cls.TEXT_COLOR_YELLOW = ''
+            cls.TEXT_COLOR_RED = ''
+            cls.TEXT_COLOR_GREEN = ''
+            cls.TEXT_COLOR_BLUE = ''
+            cls.BG_COLOR_ROW = ''
+            cls.BG_RESET = ''
+            cls.BOLD = ''
+            cls.RESET = ''
+
 
 class ColumnAlignment(enum.Enum):
     """Column alignment"""