MAINT: move bulleted_list

Author: Joe Jevnik

zipline/pipeline/domain.py

@@ -25,6 +25,7 @@
 from trading_calendars import get_calendar
 
 from zipline.country import CountryCode
+from zipline.utils.formatting import bulleted_list
 from zipline.utils.input_validation import expect_types, optional
 from zipline.utils.memoize import lazyval
 from zipline.utils.pandas_utils import days_at_time
@@ -313,12 +314,6 @@ def infer_domain(terms):
         raise AmbiguousDomain(sorted(domains, key=repr))
 
 
-def bulleted_list(items):
-    """Format a bulleted list of values.
-    """
-    return "\n".join(map("  - {}".format, items))
-
-
 # This would be better if we provided more context for which domains came from
 # which terms.
 class AmbiguousDomain(Exception):
@@ -335,7 +330,9 @@ def __init__(self, domains):
         self.domains = domains
 
     def __str__(self):
-        return self._TEMPLATE.format(domains=bulleted_list(self.domains))
+        return self._TEMPLATE.format(
+            domains=bulleted_list(self.domains, indent=2),
+        )
 
 
 class EquitySessionDomain(Domain):

zipline/utils/formatting.py

@@ -43,3 +43,24 @@ def plural(singular, plural, seq):
         return singular
 
     return plural
+
+
+def bulleted_list(items, indent=0, bullet_type='-'):
+    """Format a bulleted list of values.
+
+    Parameters
+    ----------
+    items : sequence
+        The items to make a list.
+    indent : int, optional
+        The number of spaces to add before each bullet.
+    bullet_type : str, optional
+        The bullet type to use.
+
+    Returns
+    -------
+    formatted_list : str
+        The formatted list as a single string.
+    """
+    format_string = ' ' * indent + bullet_type + ' {}'
+    return "\n".join(map(format_string.format, items))