Merge pull request #637 from uzlonewolf/bulb-rewrite

Make colorama optional

Author: jasonacox

README.md

@@ -42,6 +42,22 @@ pipx install tinytuya
 
 Pip will attempt to install `cryptography`, `requests` and `colorama` if not already installed.
 
+### Alternate Install on Space- or Dependency-Limited Systems
+
+On systems with limited space (such as an OpenWRT router), or if you would like to use a different cryptography library, you can install TinyTuya without automatic dependencies and manually install them yourself.
+
+First, install a cryptography library.  TinyTuya supports:
+* *cryptography* - Newest, requires OpenSSL - `python -m pip install cryptography`
+* *PyCryptodome* - Another good alternative, does not require OpenSSL, still actively developed - `python -m pip install pycryptodome` or `python -m pip install pycryptodomex`
+* *pyaes* - Pure Python, but is abandoned and does not support v3.5+ devices - `python -m pip install pyaes`
+* *PyCrypto* - Predecessor to PyCryptodome, is also abandoned and does not support v3.5+ devices - `python -m pip install pycrypto`
+
+Optional: install `colorama` for terminal color support: `python -m pip install colorama`
+
+Required for Wizard or Cloud functionality, Optional otherwise: install `requests` for Cloud functions to work: `python -m pip install requests`
+
+Finally, install TinyTuya without dependencies: `python -m pip install --no-deps tinytuya`
+
 ## Tuya Device Preparation
 
 Controlling and monitoring Tuya devices on your network requires the following:

RELEASE.md

@@ -1,5 +1,9 @@
 # RELEASE NOTES
 
+## v1.17.3 - Colorama Optional
+
+* This update makes the colorama dependency optional for the tinytuya library, allowing it to function without colorama while gracefully disabling color output. This will help with memory lor dependency limited platforms. Update by @uzlonewolf in https://github.com/jasonacox/tinytuya/pull/637. 
+
 ## v1.17.2 - BulbDevice Fix
 
 * Add Singapore datacenter, update BulbDevice for non-bulb devices again by @uzlonewolf in https://github.com/jasonacox/tinytuya/pull/625

tinytuya/core/core.py

@@ -79,7 +79,14 @@
 from __future__ import print_function  # python 2.7 support
 import logging
 import sys
-from colorama import init
+
+try:
+    from colorama import init
+    HAVE_COLORAMA = True
+except ImportError:
+    HAVE_COLORAMA = False
+
+HAVE_COLOR = HAVE_COLORAMA or not sys.platform.startswith('win')
 
 from .crypto_helper import AESCipher
 
@@ -91,9 +98,10 @@
 
 
 # Colorama terminal color capability for all platforms
-init()
+if HAVE_COLORAMA:
+    init()
 
-version_tuple = (1, 17, 2)  # Major, Minor, Patch
+version_tuple = (1, 17, 3)  # Major, Minor, Patch
 version = __version__ = "%d.%d.%d" % version_tuple
 __author__ = "jasonacox"
 
@@ -124,6 +132,7 @@ def hex2bin(x):
 
 def set_debug(toggle=True, color=True):
     """Enable tinytuya verbose logging"""
+    color = color and HAVE_COLOR
     if toggle:
         if color:
             logging.basicConfig(
@@ -197,6 +206,7 @@ def appenddevice(newdevice, devices):
 
 # Terminal color helper
 def termcolor(color=True):
+    color = color and HAVE_COLOR
     if color is False:
         # Disable Terminal Color Formatting
         bold = subbold = normal = dim = alert = alertdim = cyan = red = yellow = ""

tinytuya/scanner.py

@@ -25,9 +25,16 @@
 import errno
 import base64
 import traceback
-from colorama import init
 import tinytuya
 
+try:
+    from colorama import init
+    HAVE_COLORAMA = True
+except ImportError:
+    HAVE_COLORAMA = False
+
+HAVE_COLOR = HAVE_COLORAMA or not sys.platform.startswith('win')
+
 # Optional libraries required for forced scanning
 #try:
 #    from getmac import get_mac_address
@@ -54,7 +61,8 @@
     PSULIBS = False
 
 # Colorama terminal color capability for all platforms
-init()
+if HAVE_COLORAMA:
+    init()
 
 # Configuration Files
 DEVICEFILE = tinytuya.DEVICEFILE
@@ -205,6 +213,10 @@ def get_ip_to_broadcast():
 def send_discovery_request( iface_list=None ):
     close_sockets = False
 
+    if not tinytuya.AESCipher.CRYPTOLIB_HAS_GCM:
+        # GCM is required for discovery requests
+        return False
+
     if not iface_list:
         close_sockets = True
         iface_list = {}
@@ -1146,6 +1158,7 @@ def devices(verbose=False, scantime=None, color=True, poll=True, forcescan=False
 
     """
     # Terminal formatting
+    color = color and HAVE_COLOR
     termcolors = tinytuya.termcolor(color)
     #(bold, subbold, normal, dim, alert, alertdim, cyan, red, yellow) = termcolors
     term = TermColors( *termcolors )
@@ -1920,6 +1933,7 @@ def snapshot(color=True, assume_yes=False, skip_poll=None):
         skip_poll = True or False, auto-answer 'no' to "Poll local devices?" (overrides assume_yes)
     """
     # Terminal formatting
+    color = color and HAVE_COLOR
     termcolors = tinytuya.termcolor(color)
     term = TermColors( *termcolors )
 
@@ -1992,6 +2006,7 @@ def alldevices(color=True, scantime=None, forcescan=False, discover=True, assume
         color = True or False, print output in color [Default: True]
     """
     # Terminal formatting
+    color = color and HAVE_COLOR
     #(bold, subbold, normal, dim, alert, alertdim, cyan, red, yellow) = tinytuya.termcolor(color)
     termcolors = tinytuya.termcolor(color)
     term = TermColors( *termcolors )
@@ -2031,6 +2046,7 @@ def alldevices(color=True, scantime=None, forcescan=False, discover=True, assume
     return
 
 def poll_and_display( tuyadevices, color=True, scantime=None, snapshot=False, forcescan=False, discover=True ): # pylint: disable=W0621
+    color = color and HAVE_COLOR
     termcolors = tinytuya.termcolor(color)
     term = TermColors( *termcolors )
 

tinytuya/wizard.py

@@ -24,9 +24,17 @@
 # Modules
 from __future__ import print_function
 import json
-from colorama import init
 from datetime import datetime
 import tinytuya
+import sys
+
+try:
+    from colorama import init
+    HAVE_COLORAMA = True
+except ImportError:
+    HAVE_COLORAMA = False
+
+HAVE_COLOR = HAVE_COLORAMA or not sys.platform.startswith('win')
 
 # Backward compatibility for python2
 try:
@@ -35,7 +43,8 @@
     pass
 
 # Colorama terminal color capability for all platforms
-init()
+if HAVE_COLORAMA:
+    init()
 
 # Configuration Files
 DEVICEFILE = tinytuya.DEVICEFILE
@@ -114,6 +123,7 @@ def wizard(color=True, retries=None, forcescan=False, nocloud=False, assume_yes=
     except:
         old_devices = {}
 
+    color = color and HAVE_COLOR
     (bold, subbold, normal, dim, alert, alertdim, cyan, red, yellow) = tinytuya.termcolor(color)
 
     print(bold + 'TinyTuya Setup Wizard' + dim + ' [%s]' % (tinytuya.version) + normal)
@@ -150,8 +160,8 @@ def wizard(color=True, retries=None, forcescan=False, nocloud=False, assume_yes=
               "\n        us-e\tUS - Eastern America Data Center (alias: UE)" +
               "\n        eu\tCentral Europe Data Center" +
               "\n        eu-w\tWestern Europe Data Center (alias: WE)" +
-              "\n        in\tIndia Data Center\n" +
-              "\n        sg\tSingapore Data Center")
+              "\n        in\tIndia Data Center" +
+              "\n        sg\tSingapore Data Center\n")
         config['apiRegion'] = input(subbold + "    Enter " + bold + "Your Region" + subbold +
                                     " (Options: cn, us, us-e, eu, eu-w, in, or sg): " + normal)
         # Write Config