Add get_output_filename helper function

Author: dimkarakostas

tests/test_helper.py

@@ -395,63 +395,53 @@ def test_get_output_row(mocker):
     assert csv_row == ['bitcoin', '2010-01-01', False, True, 'absolute', 1, False, True, 1, 0]
 
 
-def test_write_csv_output(mocker):
-    get_metrics_mock = mocker.patch('tokenomics_decentralization.helper.get_metrics')
-    get_metrics_mock.return_value = ['hhi']
-
+def test_get_output_filename(mocker):
     get_output_directories_mock = mocker.patch('tokenomics_decentralization.helper.get_output_directories')
     get_output_directories_mock.return_value = [pathlib.Path(__file__).resolve().parent]
-
-    get_clustering_mock = mocker.patch('tokenomics_decentralization.helper.get_clustering_flag')
     get_exclude_contracts_mock = mocker.patch('tokenomics_decentralization.helper.get_exclude_contracts_flag')
-    get_exclude_below_fees_mock = mocker.patch('tokenomics_decentralization.helper.get_exclude_below_fees_flag')
-    get_exclude_below_usd_cent_mock = mocker.patch('tokenomics_decentralization.helper.get_exclude_below_usd_cent_flag')
-    get_top_limit_type_mock = mocker.patch('tokenomics_decentralization.helper.get_top_limit_type')
-    get_top_limit_value_mock = mocker.patch('tokenomics_decentralization.helper.get_top_limit_value')
-
-    get_clustering_mock.return_value = True
     get_exclude_contracts_mock.return_value = False
+    get_exclude_below_fees_mock = mocker.patch('tokenomics_decentralization.helper.get_exclude_below_fees_flag')
     get_exclude_below_fees_mock.return_value = False
+    get_exclude_below_usd_cent_mock = mocker.patch('tokenomics_decentralization.helper.get_exclude_below_usd_cent_flag')
     get_exclude_below_usd_cent_mock.return_value = False
+    get_top_limit_type_mock = mocker.patch('tokenomics_decentralization.helper.get_top_limit_type')
     get_top_limit_type_mock.return_value = 'absolute'
+    get_top_limit_value_mock = mocker.patch('tokenomics_decentralization.helper.get_top_limit_value')
     get_top_limit_value_mock.return_value = 0
 
-    hlp.write_csv_output([
-        ['bitcoin', '2010-01-01', True, False, 'absolute', 0, False, False, 100],
-        ['ethereum', '2010-01-01', True, False, 'absolute', 0, False, False, 200],
-        ])
-    with open(pathlib.Path(__file__).resolve().parent / 'output.csv') as f:
-        lines = f.readlines()
-        assert lines[0] == ','.join(['ledger', 'snapshot_date', 'clustering', 'exclude_contract_addresses',
-                                     'top_limit_type', 'top_limit_value', 'exclude_below_fees',
-                                     'exclude_below_usd_cent', 'hhi']) + '\n'
-        assert lines[1] == ','.join(['bitcoin', '2010-01-01', 'True', 'False', 'absolute', '0', 'False', 'False',
-                                     '100']) + '\n'
-        assert lines[2] == ','.join(['ethereum', '2010-01-01', 'True', 'False', 'absolute', '0', 'False', 'False',
-                                     '200']) + '\n'
-    os.remove(pathlib.Path(__file__).resolve().parent / 'output.csv')
+    output_filename = hlp.get_output_filename()
+    assert output_filename == pathlib.Path(__file__).resolve().parent / 'output.csv'
 
-    get_clustering_mock.return_value = False
     get_exclude_contracts_mock.return_value = True
     get_exclude_below_fees_mock.return_value = True
     get_exclude_below_usd_cent_mock.return_value = True
-    get_top_limit_type_mock.return_value = 'absolute'
     get_top_limit_value_mock.return_value = 10
 
+    output_filename = hlp.get_output_filename()
+    assert output_filename == pathlib.Path(__file__).resolve().parent / 'output-exclude_contract_addresses-absolute_10-exclude_below_fees-exclude_below_usd_cent.csv'
+
+
+def test_write_csv_output(mocker):
+    get_metrics_mock = mocker.patch('tokenomics_decentralization.helper.get_metrics')
+    get_metrics_mock.return_value = ['hhi']
+
+    get_output_filename_mock = mocker.patch('tokenomics_decentralization.helper.get_output_filename')
+    get_output_filename_mock.return_value = pathlib.Path(__file__).resolve().parent / 'output.csv'
+
     hlp.write_csv_output([
-        ['bitcoin', '2010-01-01', False, False, 'absolute', 0, False, False, 100],
-        ['ethereum', '2010-01-01', False, False, 'absolute', 0, False, False, 200],
+        ['bitcoin', '2010-01-01', True, False, 'absolute', 0, False, False, 100],
+        ['ethereum', '2010-01-01', True, False, 'absolute', 0, False, False, 200],
     ])
-    with open(pathlib.Path(__file__).resolve().parent / 'output-no_clustering-exclude_contract_addresses-absolute_10-exclude_below_fees-exclude_below_usd_cent.csv') as f:
+    with open(pathlib.Path(__file__).resolve().parent / 'output.csv') as f:
         lines = f.readlines()
         assert lines[0] == ','.join(['ledger', 'snapshot_date', 'clustering', 'exclude_contract_addresses',
                                      'top_limit_type', 'top_limit_value', 'exclude_below_fees',
                                      'exclude_below_usd_cent', 'hhi']) + '\n'
-        assert lines[1] == ','.join(['bitcoin', '2010-01-01', 'False', 'False', 'absolute', '0', 'False', 'False',
+        assert lines[1] == ','.join(['bitcoin', '2010-01-01', 'True', 'False', 'absolute', '0', 'False', 'False',
                                      '100']) + '\n'
-        assert lines[2] == ','.join(['ethereum', '2010-01-01', 'False', 'False', 'absolute', '0', 'False', 'False',
+        assert lines[2] == ','.join(['ethereum', '2010-01-01', 'True', 'False', 'absolute', '0', 'False', 'False',
                                      '200']) + '\n'
-    os.remove(pathlib.Path(__file__).resolve().parent / 'output-no_clustering-exclude_contract_addresses-absolute_10-exclude_below_fees-exclude_below_usd_cent.csv')
+    os.remove(pathlib.Path(__file__).resolve().parent / 'output.csv')
 
 
 def test_get_active_source_keywords(mocker):

tokenomics_decentralization/helper.py

@@ -485,24 +485,17 @@ def get_output_row(ledger, date, metrics):
     return csv_row
 
 
-def write_csv_output(output_rows):
+def get_output_filename():
     """
-    Produces the output csv file for the given data.
-    :param output_rows: a list of lists, where each list corresponds to a line in the output csv file
+    Produces the name (full path) of the output file.
+    :returns output_filename: a pathlib path of the output file
     """
-    header = ['ledger', 'snapshot_date', 'clustering', 'exclude_contract_addresses', 'top_limit_type',
-              'top_limit_value', 'exclude_below_fees', 'exclude_below_usd_cent']
-    header += get_metrics()
-
-    clustering = get_clustering_flag()
     exclude_contract_addresses_flag = get_exclude_contracts_flag()
     top_limit_type = get_top_limit_type()
     top_limit_value = get_top_limit_value()
     exclude_below_fees_flag = get_exclude_below_fees_flag()
     exclude_below_usd_cent_flag = get_exclude_below_usd_cent_flag()
     output_filename = 'output'
-    if not clustering:
-        output_filename += '-no_clustering'
     if exclude_contract_addresses_flag:
         output_filename += '-exclude_contract_addresses'
     if top_limit_value:
@@ -512,9 +505,19 @@ def write_csv_output(output_rows):
     if exclude_below_usd_cent_flag:
         output_filename += '-exclude_below_usd_cent'
     output_filename += '.csv'
+    return get_output_directories()[0] / output_filename
+
+
+def write_csv_output(output_rows):
+    """
+    Produces the output csv file for the given data.
+    :param output_rows: a list of lists, where each list corresponds to a line in the output csv file
+    """
+    header = ['ledger', 'snapshot_date', 'clustering', 'exclude_contract_addresses', 'top_limit_type',
+              'top_limit_value', 'exclude_below_fees', 'exclude_below_usd_cent']
+    header += get_metrics()
 
-    output_dir = get_output_directories()[0]
-    with open(output_dir / output_filename, 'w') as f:
+    with open(get_output_filename(), 'w') as f:
         csv_writer = csv.writer(f)
         csv_writer.writerow(header)
         csv_writer.writerows(output_rows)