email: rename parse_email to split_email

Author: NickCrews

docs/reference/lib/email.md

@@ -3,7 +3,7 @@
 This contains utilities, blockers, and comparers relevant to email addresses
 
 ::: mismo.lib.email.clean_email
-::: mismo.lib.email.parse_email
+::: mismo.lib.email.split_email
 ::: mismo.lib.email.match_level
 ::: mismo.lib.email.EmailMatchLevel
 ::: mismo.lib.email.EmailsDimension

mismo/lib/email/__init__.py

@@ -6,4 +6,4 @@
 from mismo.lib.email._core import EmailsDimension as EmailsDimension
 from mismo.lib.email._core import clean_email as clean_email
 from mismo.lib.email._core import match_level as match_level
-from mismo.lib.email._core import parse_email as parse_email
+from mismo.lib.email._core import split_email as split_email

mismo/lib/email/_core.py

@@ -29,8 +29,8 @@ def clean_email(email: ir.StringValue, *, normalize: bool = False) -> ir.StringV
     return email
 
 
-def parse_email(email: ir.StringValue) -> ir.StructValue:
-    """Parse an email into <user>@<domain> parts
+def split_email(email: ir.StringValue) -> ir.StructValue:
+    """Split an email address into <user>@<domain> parts
 
     Parameters
     ----------
@@ -87,7 +87,7 @@ def match_level(
     """
 
     def norm_and_parse(e):
-        return parse_email(clean_email(e, normalize=True))
+        return split_email(clean_email(e, normalize=True))
 
     if isinstance(e1, ir.StringValue):
         e1 = norm_and_parse(e1)
@@ -145,7 +145,7 @@ def prepare(self, t: ir.Table) -> ir.Table:
         """Add a column with the parsed and normalized email addresses."""
         return t.mutate(
             get_column(t, self.column)
-            .map(lambda email: parse_email(clean_email(email, normalize=True)))
+            .map(lambda email: split_email(clean_email(email, normalize=True)))
             .name(self.column_parsed)
         )
 

mismo/lib/email/tests/test_core.py

@@ -43,8 +43,8 @@ def test_clean_email(input, exp):
         pytest.param(None, None, None, None, id="null"),
     ],
 )
-def test_parse_email(input, expfull, expuser, expdomain):
-    result = email.parse_email(ibis.literal(input, str)).execute()
+def test_split_email_address(input, expfull, expuser, expdomain):
+    result = email.split_email(ibis.literal(input, str)).execute()
     assert result["full"] == expfull
     assert result["user"] == expuser
     assert result["domain"] == expdomain