Added zipcode truncation + foreign zip code fields

Author: mwcaisse

tonic_textual/classes/generator_metadata/hipaa_address_generator_metadata.py

@@ -25,6 +25,12 @@ class HipaaAddressGeneratorMetadata(BaseMetadata):
     realistic_synthetic_values : bool
         When ``True``, generates realistic-looking synthetic address values.
         Default is ``True``.
+    use_three_digit_zips : bool
+        When ``True`` zip codes are always truncated to three digits.
+        Default is ``False``
+    replace_foreign_zip_codes_with_zeros : bool
+        When ``True`` foreign zip codes become all zeros
+        Default is ``False``
     """
 
     def __init__(
@@ -35,6 +41,8 @@ def __init__(
             realistic_synthetic_values: bool = True,
             swaps: Optional[Dict[str,str]] = {},
             constant_value: Optional[str] = None,
+            use_three_digit_zips: bool = False,
+            replace_foreign_zip_codes_with_zeros: bool = False,
     ):
         super().__init__(
             custom_generator=GeneratorType.HipaaAddressGenerator,
@@ -45,6 +53,8 @@ def __init__(
         self["useNonHipaaAddressGenerator"] = use_non_hipaa_address_generator
         self["replaceTruncatedZerosInZipCode"] = replace_truncated_zeros_in_zip_code
         self["realisticSyntheticValues"] = realistic_synthetic_values
+        self["useThreeDigitZips"] = use_three_digit_zips
+        self["replaceForeignZipCodesWithZeros"] = replace_foreign_zip_codes_with_zeros
 
     @property
     def use_non_hipaa_address_generator(self) -> bool:
@@ -70,6 +80,22 @@ def realistic_synthetic_values(self) -> bool:
     def realistic_synthetic_values(self, value: bool):
         self["realisticSyntheticValues"] = value
 
+    @property
+    def use_three_digit_zips(self) -> bool:
+        return self["useThreeDigitZips"]
+
+    @use_three_digit_zips.setter
+    def use_three_digit_zips(self, value: bool):
+        self["useThreeDigitZips"] = value
+
+    @property
+    def replace_foreign_zip_codes_with_zeros(self) -> bool:
+        return self["replaceForeignZipCodesWithZeros"]
+
+    @replace_foreign_zip_codes_with_zeros.setter
+    def replace_foreign_zip_codes_with_zeros(self, value: bool):
+        self["replaceForeignZipCodesWithZeros"] = value
+
     def to_payload(self) -> Dict:
         return dict(self)
 
@@ -89,7 +115,9 @@ def from_payload(payload: Dict) -> "HipaaAddressGeneratorMetadata":
             replace_truncated_zeros_in_zip_code=payload.get("replaceTruncatedZerosInZipCode", True),
             realistic_synthetic_values=payload.get("realisticSyntheticValues", True),
             swaps=base_metadata.swaps,
-            constant_value=base_metadata.constant_value
+            constant_value=base_metadata.constant_value,
+            use_three_digit_zips=payload.get("useThreeDigitZips", False),
+            replace_foreign_zip_codes_with_zeros=payload.get("replaceForeignZipCodesWithZeros", False)
         )
 
 default_hipaa_address_generator_metadata = HipaaAddressGeneratorMetadata()

tonic_textual/classes/generator_metadata/person_age_generator_metadata.py

@@ -22,7 +22,7 @@ class PersonAgeGeneratorMetadata(BaseDateTimeGeneratorMetadata):
         7 years.
     use_passthrough_or_group_age_generator : bool
         When ``True`` passes through ages 89 or under. Changes other ages to "90+"
-        Default ``False``
+        Default is ``False``
     """
 
     def __init__(