Include conversion ratios used on invoice

Author: pjkundert

slip39/invoice/artifact.py

@@ -99,23 +99,29 @@ def net( self ):
         return amount, taxes, taxinf  # denominated in self.currencies
 
 
-def conversions_table( conversions, symbols=None ):
+def conversions_table( conversions, symbols=None, greater=None ):
     if symbols is None:
         symbols			= sorted( set( sum( conversions.keys(), () )))
+    if greater is None:
+        greater			= .001
+
     symbols			= list( symbols )
 
     # The columns are typed according to the least generic type that *all* rows are convertible
     # into.  So, if any row is a string, it'll cause the entire column to be formatted as strings.
     return tabulate(
         [
             [ r ] + list(
-                1 if r == c else '' if (r,c) not in conversions else conversions.get( (r,c) )
+                ( '' if r == c or (r,c) not in conversions
+                  else '' if ( greater and conversions.get( (r,c) ) and conversions.get( (c,r) )
+                               and ( conversions[r,c] < ( greater if isinstance( greater, (float,int) ) else conversions[c,r] )))
+                  else conversions[(r,c)] )
                 for c in symbols
             )
             for r in symbols
         ],
-        headers		= [ 'Coin' ] + list( symbols ),
-        floatfmt	= ',.6g',
+        headers		= [ 'Coin' ] + [ f"in {s}" for s in symbols ],
+        floatfmt	= ',.7g',
         intfmt		= ',',
         missingval	= '?',
         tablefmt	= 'orgtbl',
@@ -524,6 +530,7 @@ def tables(
         columns		= None,		# list (ordered) set/predicate (unordered)
         totalfmt	= None,
         totalize	= None,		# Final page includes totalization
+        description_max	= None,		# Default to some reasonable max
         **kwds				# page, rows, ...
     ):
         """Tabulate columns into textual tables.  Each page yields 3 items:
@@ -659,7 +666,8 @@ def fmt( val, hdr, coin  ):
                     return round( val, deci( coin ))  # f"{float( val ):,.{deci( coin )}f}"  # rounds to designated decimal places, inserts comma
                 return val
 
-            # Produce the page line-items.  TODO: This may now include per-Coin totals on the final page.
+            # Produce the page line-items.  We must round each line-item's numeric price values
+            # according to the target coin.
             table_rows		= [
                 [
                     fmt( line[i], h, line[headers_can.index( can( 'Coin' ))] )
@@ -695,12 +703,25 @@ def fmt( val, hdr, coin  ):
                             row.append( None )
                     table_rows.append( row )
 
+            # Presently, the Description column is the only one likely to have a width issue...
+            maxcolwidths		= None
+            if description_max is None:
+                description_max		= 48
+            if description_max:
+                desc_i			= headers_can.index( can( "Description" ))
+                maxcolwidths	= [
+                    description_max if i == desc_i else None
+                    for i in selected
+                ]
+                log.info( f"Maximum col widths {commas( ( f'{h}: {w}' for h,w in zip( table_headers, maxcolwidths ) ), final='and' )}" )
+
             table		= tabulate(
                 table_rows,
                 headers		= table_headers,
                 intfmt		= ',',   # intfmt,
                 floatfmt	= ',g',  # floatfmt,
                 tablefmt	= tablefmt or 'orgtbl',
+                maxcolwidths	= maxcolwidths,
             )
 
             yield page, table, subtotal, total
@@ -1108,13 +1129,15 @@ def produce_invoice(
         inv_tpl['inv-client-info'] = '\n'.join( client.info )
         inv_tpl['inv-client-info-bg'] = layout / '1x1-ffffffbf.png'
 
-        det			= tabulate( [
+        dets			= tabulate( [
             [ 'Invoice #', metadata.number ],
             [ 'Date:', metadata.date.strftime( INVOICE_STRFTIME ) ],
             [ 'Due:', metadata.date.strftime( INVOICE_STRFTIME ) ],
         ], colalign=( 'right', 'left' ), tablefmt='plain' )
 
-        inv_tpl['inv-table']	= '\n\n'.join( (det, tbl ) )  # f"{tbl}\n\n{80 * ( '=' if last else '-' )}\n{tot if last else sub}"
+        exch			= conversions_table( invoice.conversions )
+
+        inv_tpl['inv-table']	= '\n\n'.join( (dets, tbl, f"Conversion ratios used:\n{exch}" ) )  # f"{tbl}\n\n{80 * ( '=' if last else '-' )}\n{tot if last else sub}"
         inv_tpl['inv-table-bg']	= layout / '1x1-ffffffbf.png'
 
         inv_tpl.render( offsetx=offsetx, offsety=offsety )

slip39/invoice/artifact_test.py

@@ -32,11 +32,11 @@ def test_conversions():
     c1_tbl			= conversions_table( c1 )
     print( '\n' + c1_tbl )
     assert c1_tbl == """\
-| Coin   |   BTC |   ETH |       USD |
-|--------+-------+-------+-----------|
-| BTC    |     1 |     ? | 23,456.8  |
-| ETH    |       |     1 |  1,234.56 |
-| USD    |       |       |      1    |"""
+| Coin   | in BTC   | in ETH   |    in USD |
+|--------+----------+----------+-----------|
+| BTC    |          | ?        | 23,456.78 |
+| ETH    |          |          |  1,234.56 |
+| USD    |          |          |           |"""
 
     c_simple			= dict( c1 )
     c_simple_i			= 0
@@ -46,11 +46,11 @@ def test_conversions():
     c_simple_tbl		= conversions_table( c_simple )
     print( c_simple_tbl )
     assert c_simple_tbl == """\
-| Coin   |         BTC |          ETH |       USD |
-|--------+-------------+--------------+-----------|
-| BTC    | 1           | 19.0001      | 23,456.8  |
-| ETH    | 0.0526313   |  1           |  1,234.56 |
-| USD    | 4.26316e-05 |  0.000810005 |      1    |"""
+| Coin   |      in BTC |    in ETH |    in USD |
+|--------+-------------+-----------+-----------|
+| BTC    |             | 19.000113 | 23,456.78 |
+| ETH    | 0.052631265 |           |  1,234.56 |
+| USD    |             |           |           |"""
 
     c_w_doge			= dict( c1, ) | { ('DOGE','BTC'): .00000385, ('DOGE','USD'): None }
     c_w_doge_i			= 0
@@ -74,12 +74,22 @@ def test_conversions():
     c_w_doge_tbl		= conversions_table( c_w_doge )
     print( c_w_doge_tbl )
     assert c_w_doge_tbl == """\
-| Coin   |         BTC |         DOGE |          ETH |            USD |
-|--------+-------------+--------------+--------------+----------------|
-| BTC    | 1           | 259,740      | 19.0001      | 23,456.8       |
-| DOGE   | 3.85e-06    |       1      |  7.31504e-05 |      0.0903086 |
-| ETH    | 0.0526313   |  13,670.5    |  1           |  1,234.56      |
-| USD    | 4.26316e-05 |      11.0731 |  0.000810005 |      1         |"""
+| Coin   | in BTC   |        in DOGE |    in ETH |    in USD |
+|--------+----------+----------------+-----------+-----------|
+| BTC    |          | 259,740.26     | 19.000113 | 23,456.78 |
+| DOGE   |          |                |           |           |
+| ETH    |          |  13,670.458    |           |  1,234.56 |
+| USD    |          |      11.073142 |           |           |"""
+
+    c_w_doge_all		= conversions_table( c_w_doge, greater=False )
+    print( c_w_doge_all )
+    assert c_w_doge_all == """\
+| Coin   |        in BTC |        in DOGE |         in ETH |           in USD |
+|--------+---------------+----------------+----------------+------------------|
+| BTC    |               | 259,740.26     | 19.000113      | 23,456.78        |
+| DOGE   | 3.85e-06      |                |  7.3150437e-05 |      0.090308603 |
+| ETH    | 0.052631265   |  13,670.458    |                |  1,234.56        |
+| USD    | 4.2631597e-05 |      11.073142 |  0.00081000518 |                  |"""
 
     c_bad			= dict( c1, ) | { ('DOGE','USD'): None }
     with pytest.raises( Exception ) as c_bad_exc:
@@ -107,7 +117,7 @@ def test_conversions():
         LineItem(
             description	= "More Widgets",
             units	= 2500,
-            price	= Fraction( 201, 1000 ),
+            price	= Fraction( 201, 100000 ),
             tax		= Fraction( 5, 100 ),  # exclusive
             currency	= 'ETH',
         ),
@@ -116,7 +126,7 @@ def test_conversions():
         LineItem(
             description	= "Something else, very detailed and elaborate to explain",
             units	= 100,
-            price	= Fraction( 201, 10000 ),
+            price	= Fraction( 201, 100000 ),
             tax		= Fraction( 105, 100 ),  # inclusive
             decimals	= 8,
             currency	= 'Bitcoin',
@@ -126,7 +136,7 @@ def test_conversions():
         LineItem(
             description	= "Buy some Holo hosting",
             units	= 12,
-            price	= 10000,
+            price	= 12345.6,
             tax		= Fraction( 5, 100 ),  # inclusive
             currency	= 'HoloToken',
         ),
@@ -294,41 +304,74 @@ def test_tabulate( tmp_path ):
 
     inv_date			= parse_datetime( "2021-01-01 00:00:00.1 Canada/Pacific" )
 
-    (paper_format,orientation),pdf,metadata = produce_invoice(
-        invoice		= shorter_invoice,
-        inv_date	= inv_date,
-        vendor		= Contact(
-            name	= "Dominion Research & Development Corp.",
-            contact	= "Perry Kundert <[email protected]>",
-            phone	= "+1-780-970-8148",
-            address	= """\
+    vendor			= Contact(
+        name	= "Dominion Research & Development Corp.",
+        contact	= "Perry Kundert <[email protected]>",
+        phone	= "+1-780-970-8148",
+        address	= """\
 275040 HWY 604
 Lacombe, AB  T4L 2N3
 CANADA
 """,
-            billing	= """\
+        billing	= """\
 RR#3, Site 1, Box 13
 Lacombe, AB  T4L 2N3
 CANADA
 """,
-        ),
-        client		= Contact(
-            name	= "Awesome, Inc.",
-            contact	= "Great Guy <[email protected]>",
-            address	= """\
+    )
+    client			= Contact(
+        name	= "Awesome, Inc.",
+        contact	= "Great Guy <[email protected]>",
+        address	= """\
 123 Awesome Ave.
 Schenectady, NY  12345
 USA
 """,
-        ),
+    )
+
+    (paper_format,orientation),pdf,metadata = produce_invoice(
+        invoice		= shorter_invoice,
+        inv_date	= inv_date,
+        vendor		= vendor,
+        client		= client,
         directory	= test,
-        inv_image	= 'dominionrnd-invoice.png',    # Full page background image
+        #inv_image	= 'dominionrnd-invoice.png',    # Full page background image
         inv_logo	= 'dominionrnd-logo.png',       # Logo 16/9 in bottom right of header
         inv_label	= 'Quote',
     )
 
     print( f"Invoice metadata: {metadata}" )
     temp		= Path( tmp_path )
-    path		= temp / 'invoice.pdf'
+    path		= temp / 'invoice-shorter.pdf'
+    pdf.output( path )
+    print( f"Invoice saved: {path}" )
+
+    # Finally, generate invoice with all rows, and all conversions from blockchain Oracle (except
+    # XRP, for which we do not have an oracle, so must provide an estimate from another source...)
+    complete_invoice		= Invoice(
+        [
+            line
+            for line,_ in line_amounts
+        ],
+        currencies	= ["HOT", "ETH", "BTC", "USD"],
+        accounts	= accounts,
+        conversions	= {
+            ("BTC","XRP"): 60000,
+        }
+    )
+
+    (paper_format,orientation),pdf,metadata = produce_invoice(
+        invoice		= complete_invoice,
+        inv_date	= inv_date,
+        vendor		= vendor,
+        client		= client,
+        directory	= test,
+        #inv_image	= 'dominionrnd-invoice.png',    # Full page background image
+        inv_logo	= 'dominionrnd-logo.png',       # Logo 16/9 in bottom right of header
+    )
+
+    print( f"Invoice metadata: {metadata}" )
+    temp		= Path( tmp_path )
+    path		= temp / 'invoice-complete.pdf'
     pdf.output( path )
     print( f"Invoice saved: {path}" )