tradedangerous 10.16.10__py3-none-any.whl → 10.16.11__py3-none-any.whl

tradedangerous/cache.py

@@ -919,7 +919,7 @@ def buildCache(tdb, tdenv):
     
     tdenv.NOTE(
         "Rebuilding cache file: this may take a few moments.",
-        file = sys.stderr
+        stderr=True,
     )
     
     dbPath = tdb.dbPath
@@ -963,7 +963,7 @@ def buildCache(tdb, tdenv):
         tdenv.NOTE(
                 "Missing \"{}\" file - no price data.",
                     pricesPath,
-                    file = sys.stderr,
+                    stderr=True,
         )
     
     tempDB.commit()

tradedangerous/plugins/spansh_plug.py

@@ -218,7 +218,7 @@ class ImportPlugin(plugins.ImportPluginBase):
             self.execute('COMMIT')
             self.tdb.close()
             # Need to make sure cached tables are updated
-            for table in [ "Item", "Station", "System", "StationItem" ]:
+            for table in [ "Item", "Station", "System" ]:
                 _, path = csvexport.exportTableToFile( self.tdb, self.tdenv, table )
                         
             self.print(

tradedangerous/tradeenv.py

@@ -1,18 +1,44 @@
-from __future__ import absolute_import, with_statement, print_function, division, unicode_literals
+# The runtime environment TD tools are expected to run with is encapsulated
+# into a single object, the TradeEnv. See TradeEnv docstring for more.
+from __future__ import annotations
 
 import os
-import traceback
 import sys
+import traceback
+import typing
+from contextlib import contextmanager
+
+# Import some utilities from the 'rich' library that provide ways to colorize and animate
+# the console output, along with other useful features.
+# If the user has 'EXCEPTIONS' defined to something in the environment, then we can
+# immediately benefit from beautified stacktraces.
+from rich.console import Console
+from rich.traceback import install as install_rich_traces
+
+
+if typing.TYPE_CHECKING:
+    from typing import Any, Dict, Iterator
+
+
 _ROOT = os.path.abspath(os.path.dirname(__file__))
 
 
-class TradeEnv(object):
+# Create a single instance of the console for everyone to use, unless they really
+# want to do something unusual.
+CONSOLE = Console()
+STDERR  = Console(stderr=True)
+
+if os.getenv("EXCEPTIONS"):
+    # This makes call stacks show additional context and do syntax highlighting
+    # that can turn reading a callstack from hours into seconds.
+    install_rich_traces(console=STDERR, show_locals=False, extra_lines=1)
+
+
+class TradeEnv:
     """
-        Container for a TradeDangerous "environment", which is a
-        collection of operational parameters.
+        Container for a TradeDangerous "environment", which is a collection of operational parameters.
         
-        To print debug lines, use DEBUG<N>, e.g. DEBUG0, which
-        takes a format() string and parameters, e.g.
+        To print debug lines, use DEBUG<N>, e.g. DEBUG0, which takes a format() string and parameters, e.g.
             
             DEBUG1("hello, {world}{}", "!", world="world")
         
@@ -35,51 +61,90 @@ class TradeEnv(object):
         'csvDir': os.environ.get('TD_CSV') or os.environ.get('TD_DATA') or os.path.join(os.getcwd(), 'data'),
         'tmpDir': os.environ.get('TD_TMP') or os.path.join(os.getcwd(), 'tmp'),
         'templateDir': os.path.join(_ROOT, 'templates'),
-        'cwDir': os.getcwd()
+        'cwDir': os.getcwd(),
+        'console': CONSOLE,
+        'stderr':  STDERR,
     }
     
     encoding = sys.stdout.encoding
+
     if str(sys.stdout.encoding).upper() != 'UTF-8':
-        
-        def uprint(self, *args, **kwargs):
+        def uprint(self, *args, stderr: bool = False, style: str = None, **kwargs) -> None:
+            """ unicode-handling print: when the stdout stream is not utf-8 supporting,
+                we do a little extra io work to ensure users don't get confusing unicode
+                errors. When the output stream *is* utf-8, tradeenv replaces this method
+                with a less expensive method.
+                :param stderr: report to stderr instead of stdout
+                :param style: specify a 'rich' console style to use when the stream supports it
+            """
+            console = self.stderr if stderr else self.console
             try:
-                print(*args, **kwargs)
+                # Attempt to print; the 'file' argument isn't spuported by rich, so we'll
+                # need to fall-back on old print when someone specifies it.
+                console.print(*args, style=style, **kwargs)
+
             except UnicodeEncodeError as e:
+                # Characters in the output couldn't be translated to unicode.
                 if not self.quiet:
-                    print(
-                        "CAUTION: Your terminal/console couldn't handle some "
+                    self.stderr.print(
+                        "[orange3][bold]CAUTION: Your terminal/console couldn't handle some "
                         "text I tried to print."
                     )
                     if 'EXCEPTIONS' in os.environ:
                         traceback.print_exc()
                     else:
-                        print(str(e))
+                        self.stderr.print(e)
+
+                # Try to translate each ary into a viable stirng using utf error-replacement.
                 strs = [
-                    str(arg).
-                        encode(TradeEnv.encoding, errors = 'replace').
-                        decode(TradeEnv.encoding)
+                    str(arg)
+                        .encode(TradeEnv.encoding, errors="replace")
+                        .decode(TradeEnv.encoding)
                     for arg in args
                 ]
-                print(*strs, **kwargs)
+                console.print(*strs, style=style, **kwargs)
     
     else:
-        uprint = print
+        def uprint(self, *args, stderr: bool = False, style: str = None, **kwargs) -> None:
+            """ unicode-handling print: when the stdout stream is not utf-8 supporting,
+                this method is replaced with one that tries to provide users better support
+                when a unicode error appears in the wild.
+
+                :param file: [optional] stream to write to (disables styles/rich support)
+                :param style: [optional] specify a rich style for the output text
+            """
+            console = self.stderr if stderr else self.console
+            console.print(*args, style=style, **kwargs)
     
-    def __init__(self, properties = None, **kwargs):
-        properties = properties or dict()
+
+    def __init__(self, properties: Optional[Union[argparse.Namespace, Dict]] = None, **kwargs) -> None:
+        # Inject the defaults into ourselves in a dict-like way
         self.__dict__.update(self.defaults)
-        if properties:
-            self.__dict__.update(properties.__dict__)
-        if kwargs:
-            self.__dict__.update(kwargs)
-    
-    def __getattr__(self, key):
+
+        # If properties is a namespace, extract the dictionary; otherwise use it as-is
+        if properties and hasattr(properties, '__dict__'):  # which arparse.Namespace has
+            properties = properties.__dict__
+        # Merge into our dictionary
+        self.__dict__.update(properties or {})
+
+        # Merge the kwargs dictionary
+        self.__dict__.update(kwargs or {})
+
+        # When debugging has been enabled on startup, enable slightly more
+        # verbose rich backtraces.
+        if self.__dict__['debug']:
+            install_rich_traces(console=STDERR, show_locals=True, extra_lines=2)
+
+    def __getattr__(self, key: str) -> Any:
         """ Return the default for attributes we don't have """
+
+        # The first time the DEBUG attribute is referenced, register a method for it.
         if key.startswith("DEBUG"):
             
             # Self-assembling DEBUGN functions
             def __DEBUG_ENABLED(outText, *args, **kwargs):
-                print('#', outText.format(*args, **kwargs))
+                # Give debug output a less contrasted color.
+                self.console.print(f"[dim]#{outText.format(*args, **kwargs)}[/dim]")
             
             def __DEBUG_DISABLED(*args, **kwargs):
                 pass
@@ -96,10 +161,11 @@ class TradeEnv(object):
         
         if key == "NOTE":
             
-            def __NOTE_ENABLED(outText, *args, file = None, **kwargs):
+            def __NOTE_ENABLED(outText, *args, stderr: bool = False, **kwargs):
                 self.uprint(
                     "NOTE:", str(outText).format(*args, **kwargs),
-                    file = file,
+                    style="bold",
+                    stderr=stderr,
                 )
             
             def __NOTE_DISABLED(*args, **kwargs):
@@ -115,10 +181,11 @@ class TradeEnv(object):
         
         if key == "WARN":
             
-            def _WARN_ENABLED(outText, *args, file = None, **kwargs):
+            def _WARN_ENABLED(outText, *args, stderr: bool = False, **kwargs):
                 self.uprint(
                     "WARNING:", str(outText).format(*args, **kwargs),
-                    file = file
+                    style="orange3",
+                    stderr=stderr,
                 )
             
             def _WARN_DISABLED(*args, **kwargs):

tradedangerous/version.py

@@ -12,5 +12,5 @@
 """just keeper of current version"""
 
 # TODO: remember to update tests when version changes
-__version__ = '10.16.10'
+__version__ = '10.16.11'
 

{tradedangerous-10.16.10.dist-info → tradedangerous-10.16.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tradedangerous
-Version: 10.16.10
+Version: 10.16.11
 Summary: Trade-Dangerous is a set of powerful trading tools for Elite Dangerous, organized around one of the most powerful trade run optimizers available.
 Home-page: https://github.com/eyeonus/Trade-Dangerous
 Author: eyeonus

{tradedangerous-10.16.10.dist-info → tradedangerous-10.16.11.dist-info}/RECORD

@@ -1,5 +1,5 @@
 tradedangerous/__init__.py,sha256=5ZeypoZaM8hlh6c-yTkD8x5hZYP8q3Q8a3bVeicHr90,1122
-tradedangerous/cache.py,sha256=MIoNCWE3AJohhx0r4m5xgf4C_4YkynWgfJyUokhuG98,33859
+tradedangerous/cache.py,sha256=PvXo4EaKVUcU-h5akCFQpClK_zVxNu0BzGEIJf5ffB0,33848
 tradedangerous/cli.py,sha256=ycGkzMszwpP9OrngFIyhQbYoZ2wzRhJMTDCW1YhLrNI,4727
 tradedangerous/corrections.py,sha256=QMs-7MKLw2imFgIHthnwcpqWT1yJTb3CrABJw9LaKLA,1441
 tradedangerous/csvexport.py,sha256=OcOKe_VIgafw6rCvG3k5tM11KwwoYXMNY5DSSfCC0mU,8705
@@ -16,12 +16,12 @@ tradedangerous/tools.py,sha256=pp-4WtA12SVaaQHFJFOMTF7EDFRCU2mQeOhC4xoXmEk,1331
 tradedangerous/trade.py,sha256=vBEJZR3Bybesw9FMelcHOTRA7KqKeH-4_wqbJ4VMB_E,1779
 tradedangerous/tradecalc.py,sha256=GyuYZNuyfn0y0eoPbxDEI7dxTJtHmRXAKFMpiR0Z1iU,42004
 tradedangerous/tradedb.py,sha256=6JzoSAiW1WJjkWxeGMJkN63GHTBp9RA0dkfRviuEHeM,73515
-tradedangerous/tradeenv.py,sha256=FeeSvDI4Zpi5hJk2UAwrR_0Y7Y_gtYH0ofPEHKHLEBY,4412
+tradedangerous/tradeenv.py,sha256=8uByR4m-xzZxNSBLQnDHS4uJMPohf3mP5R_rsXnhmds,7887
 tradedangerous/tradeexcept.py,sha256=aZ-Y31MbkjF7lmAzBAbaMsPPE7FEEfuf4gaX2GvriDk,368
 tradedangerous/tradegui.py,sha256=JbGFnsWupgesk6hrcUgKSdD9NNDyo0U9gh6m3DccAwU,782
 tradedangerous/transfers.py,sha256=NmXXk2aF88YkAvYqc9Syt_aO6d2jJjC-OxoRFoOyQH4,9923
 tradedangerous/utils.py,sha256=PUPvAEqUyxYGqqQa0b_yfLAvq8YVUxK6HfdS-CxM-Lo,5186
-tradedangerous/version.py,sha256=ObElDg8HjFIYhjl7ct9SkBNKb_o4DpsNomg_3x-kGK0,648
+tradedangerous/version.py,sha256=BV5It3d62BF5GhEeSfIzL1rZ7TJs5UsvyfMfrDKf4lc,648
 tradedangerous/commands/TEMPLATE.py,sha256=7oXL124aqxGHwnb0h9yRylUiwc6M5QrRrGVrubwI1gg,2124
 tradedangerous/commands/__init__.py,sha256=6B0WuqkFBOll5Hj67yKDAnhmyr5ZAnHc6nzUNEUh384,9640
 tradedangerous/commands/buildcache_cmd.py,sha256=oJvP06fA8svnHrfrpWkHKR16cba8GIhHdMOyZqds18Y,2332
@@ -66,14 +66,14 @@ tradedangerous/plugins/eddblink_plug.py,sha256=7lqUjXQrZFuEBsXZNNmX6lQvGuqZeWrVS
 tradedangerous/plugins/edmc_batch_plug.py,sha256=3Ptr-SZqaZFR8ViIIrp9Ak7rvfU3zl11AZYBhIceN7s,4224
 tradedangerous/plugins/journal_plug.py,sha256=K1oIeI7E3mb04fvYLXyoAh7fOTyM9NBelibTI88MIDQ,23696
 tradedangerous/plugins/netlog_plug.py,sha256=Gw_HSZWpN17D--OIYEM3Vo8y9SvDOv9UwAUfY24kz28,13460
-tradedangerous/plugins/spansh_plug.py,sha256=FSdmBAxpLxud2tmEvY3zhCPXwMRi66DCb0HYhC_up2w,21807
+tradedangerous/plugins/spansh_plug.py,sha256=WOpTm9C4oXPfFeEaSQtcu82OqX1uAuNGNy8wVY4iw_I,21792
 tradedangerous/templates/Added.csv,sha256=8o54civQCcS9y7_DBo0GX196XWRbbREQqKDYTKibsgQ,649
 tradedangerous/templates/Category.csv,sha256=8xwUDcBZE25T6x6dZGlRUMTCqeDLt3a9LXU5h6hRHV8,250
 tradedangerous/templates/RareItem.csv,sha256=F1RhRnTD82PiwrVUO-ai2ErGH2PTqNnQaDw5mcgljXs,10483
 tradedangerous/templates/TradeDangerous.sql,sha256=kHZ7JBSY5lh2DnqayAxoO-apvXKB510SqhAzkT21YHY,8138
-tradedangerous-10.16.10.dist-info/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-tradedangerous-10.16.10.dist-info/METADATA,sha256=2kJbWwMymuIntaUaWk5rqDlROeVr1lFB2CiEwbHAvTo,4422
-tradedangerous-10.16.10.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-tradedangerous-10.16.10.dist-info/entry_points.txt,sha256=pSwa-q0ob443uiKux7xFKYQl8uen66iDTnjdrQhNLx8,92
-tradedangerous-10.16.10.dist-info/top_level.txt,sha256=bF29i-oEltmNICgElEKxNsg83oahJvxg3a7YrxZi9Rk,15
-tradedangerous-10.16.10.dist-info/RECORD,,
+tradedangerous-10.16.11.dist-info/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+tradedangerous-10.16.11.dist-info/METADATA,sha256=3ABvfKWRpcrTpz8weaPffXQJ5eTllqRD1R6XkzPUFb0,4422
+tradedangerous-10.16.11.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+tradedangerous-10.16.11.dist-info/entry_points.txt,sha256=pSwa-q0ob443uiKux7xFKYQl8uen66iDTnjdrQhNLx8,92
+tradedangerous-10.16.11.dist-info/top_level.txt,sha256=bF29i-oEltmNICgElEKxNsg83oahJvxg3a7YrxZi9Rk,15
+tradedangerous-10.16.11.dist-info/RECORD,,