#41 add configurable default for string formatting

This changes the default way a name will be represented if it has a nickname, it will now include parenthesis around the nickname by default.

Author: derek73

nameparser/config/__init__.py

@@ -145,6 +145,13 @@ class Constants(object):
     :param regexes: 
         :py:attr:`regexes`  wrapped with :py:class:`TupleManager`.
     """
+    
+    string_format = "{title} {first} {middle} {last} {suffix} ({nickname})"
+    """
+    The default string format use for all new HumanName instances.
+    """
+    
+    
     def __init__(self, 
                     prefixes=PREFIXES, 
                     suffixes=SUFFIXES,

nameparser/parser.py

@@ -68,7 +68,7 @@ def __init__(self, full_name="", constants=CONSTANTS, encoding=ENCODING,
             self.has_own_config = True
 
         self.ENCODING = encoding
-        self.string_format = string_format
+        self.string_format = string_format or self.C.string_format
         self.full_name = full_name
 
     def __iter__(self):

tests.py

@@ -1758,12 +1758,18 @@ def test_downcasing_mc(self):
 
 class HumanNameOutputFormatTests(HumanNameTestBase):
 
-    def test_formating(self):
+    def test_formatting_init_argument(self):
+        hn = HumanName("Rev John A. Kenneth Doe III (Kenny)", 
+            string_format = "TEST1")
+        self.assertEqual(u(hn), "TEST1")
+
+    def test_formatting_constants_attribute(self):
+        from nameparser.config import CONSTANTS
+        _orig = CONSTANTS.string_format
+        CONSTANTS.string_format = "TEST2"
         hn = HumanName("Rev John A. Kenneth Doe III (Kenny)")
-        hn.string_format = "{title} {first} {middle} {last} {suffix} ({nickname})"
-        self.assertEqual(u(hn), "Rev John A. Kenneth Doe III (Kenny)")
-        hn.string_format = "{last}, {title} {first} {middle}, {suffix} ({nickname})"
-        self.assertEqual(u(hn), "Doe, Rev John A. Kenneth, III (Kenny)")
+        self.assertEqual(u(hn), "TEST2")
+        CONSTANTS.string_format = _orig
 
     def test_quote_nickname_formating(self):
         hn = HumanName("Rev John A. Kenneth Doe III (Kenny)")
@@ -1821,6 +1827,13 @@ def test_formating_of_nicknames_with_double_quotes(self):
         hn.nickname=''
         self.assertEqual(u(hn), "Rev John A. Kenneth Doe III")
 
+    def test_formating_of_nicknames_in_middle(self):
+        hn = HumanName("Rev John A. Kenneth Doe III (Kenny)")
+        hn.string_format = "{title} {first} ({nickname}) {middle} {last} {suffix}"
+        self.assertEqual(u(hn), "Rev John (Kenny) A. Kenneth Doe III")
+        hn.nickname=''
+        self.assertEqual(u(hn), "Rev John A. Kenneth Doe III")
+
 TEST_NAMES = (
     "John Doe",
     "John Doe, Jr.",