wip: email format options

Author: trzejos

docs/usage.rst

@@ -198,6 +198,23 @@ follows:
    * - python
      - Require the regex to be valid in Python regex syntax.
 
+``--format-email``
+~~~~~~~~~~~~~~~~~~
+
+Set a mode for handling of the ``"email"`` and ``"idn-email"`` values for ``"format"``. The modes are as
+follows:
+
+.. list-table:: Email Options
+   :widths: 15 30
+   :header-rows: 1
+
+   * - mode
+     - description
+   * - default
+     - Require the email address to pass a basic sanity check
+   * - full
+     - Require the email to match RFC5321 for ``"email"`` or RFC6531 for ``"idn-email"```
+
 Other Options
 --------------
 

src/check_jsonschema/cli/main_command.py

@@ -74,6 +74,11 @@ def pretty_helptext_list(values: list[str] | tuple[str, ...]) -> str:
     date, date-time, email, ipv4, ipv6, regex, uuid
 
 \b
+For the "email" and "idn-email" formats, there are multiple modes which can be specified with
+'--format-email':
+    default  |  only check that the string contains "@"
+    full     |  check the string against RFC 5321 (email) or RFC 6531 (idn-email)
+
 For the "regex" format, there are multiple modes which can be specified with
 '--format-regex':
     default  |  check that the string is a valid ECMAScript regex
@@ -155,6 +160,16 @@ def pretty_helptext_list(values: list[str] | tuple[str, ...]) -> str:
     default=RegexVariantName.default.value,
     type=click.Choice([x.value for x in RegexVariantName], case_sensitive=False),
 )
+@click.option(
+    "--format-email",
+    help=(
+        "Set the mode of format validation for email addresses. "
+        "If `--disable-formats email` or `--disable-formats idn-email` is "
+        "used, this option has no effect on the disabled format."
+    ),
+    default=EmailVariantName.default.value,
+    type=click.Choice([x.value for x in EmailVariantName], case_sensitive=False),
+)
 @click.option(
     "--default-filetype",
     help="A default filetype to assume when a file's type is not detected",
@@ -240,6 +255,7 @@ def main(
     no_cache: bool,
     cache_filename: str | None,
     disable_formats: tuple[list[str], ...],
+    format_email: Literal["full", "default"],
     format_regex: Literal["python", "default"],
     default_filetype: Literal["json", "yaml", "toml", "json5"],
     traceback_mode: Literal["full", "short"],
@@ -267,6 +283,7 @@ def main(
     else:
         args.disable_formats = normalized_disable_formats
 
+    args.format_email = RegexVariantName(format_email)
     args.format_regex = RegexVariantName(format_regex)
     args.disable_cache = no_cache
     args.default_filetype = default_filetype

src/check_jsonschema/cli/parse_result.py

@@ -83,6 +83,7 @@ def set_validator(
     def format_opts(self) -> FormatOptions:
         return FormatOptions(
             enabled=not self.disable_all_formats,
+            email_variant=self.format_email,
             regex_variant=self.format_regex,
             disabled_formats=self.disable_formats,
         )

src/check_jsonschema/formats/__init__.py

@@ -9,7 +9,7 @@
 import jsonschema.validators
 import regress
 
-from .implementations import validate_rfc3339, validate_time
+from .implementations import validate_rfc3339, validate_rfc5321, validate_rfc6531, validate_time
 
 # all known format strings except for a selection from draft3 which have either
 # been renamed or removed:
@@ -39,6 +39,32 @@
 )
 
 
+class EmailVariantName(enum.Enum):
+    default = "default"
+    full = "full"
+
+
+class EmailImplementation:
+    def __init__(self, variant: EmailVariantName) -> None:
+        self.variant = variant
+
+    def check_format_email(self, instance: t.Any) -> bool:
+        if not isinstance(instance, str):
+            return True
+        if self.variant == EmailVariantName.default:
+            return "@" in instance
+        else:
+            return validate_rfc5321(instance)
+
+    def check_format_idn_email(self, instance: t.Any) -> bool:
+        if not isinstance(instance, str):
+            return True
+        if self.variant == EmailVariantName.default:
+            return "@" in instance
+        else:
+            return validate_rfc6531(instance)
+
+
 class RegexVariantName(enum.Enum):
     default = "default"
     python = "python"
@@ -70,10 +96,12 @@ def __init__(
         self,
         *,
         enabled: bool = True,
+        email_variant: EmailVariantName = EmailVariantName.default,
         regex_variant: RegexVariantName = RegexVariantName.default,
         disabled_formats: tuple[str, ...] = (),
     ) -> None:
         self.enabled = enabled
+        self.email_variant = email_variant
         self.regex_variant = regex_variant
         self.disabled_formats = disabled_formats
 
@@ -101,7 +129,10 @@ def make_format_checker(
 
     # replace the regex check
     del checker.checkers["regex"]
+    email_impl = EmailImplementation(opts.email_variant)
     regex_impl = RegexImplementation(opts.regex_variant)
+    checker.checks("email")(email_impl.check_format_email)
+    checker.checks("idn-email")(email_impl.check_format_idn_email)
     checker.checks("regex")(regex_impl.check_format)
     checker.checks("date-time")(validate_rfc3339)
     checker.checks("time")(validate_time)

src/check_jsonschema/formats/implementations/__init__.py

@@ -1,4 +1,6 @@
 from .iso8601_time import validate as validate_time
 from .rfc3339 import validate as validate_rfc3339
+from .rfc5321 import validate as validate_rfc5321
+from .rfc6531 import validate as validate_rfc6531
 
-__all__ = ("validate_rfc3339", "validate_time")
+__all__ = ("validate_rfc3339", "validate_rfc5321", "validate_rfc6531", "validate_time")

src/check_jsonschema/formats/implementations/rfc5321.py

@@ -0,0 +1,43 @@
+import re
+
+RFC5321_REGEX = re.compile(
+    r"""
+    ^
+    (
+    [!#-'*+/-9=?A-Z^-~-]+(\.[!#-'*+/-9=?A-Z^-~-]+)*
+    |
+    "([]!#-[^-~ \t]|(\\[\t -~]))+"
+    )
+    @
+    (
+    [!#-'*+/-9=?A-Z^-~-]+(\.[!#-'*+/-9=?A-Z^-~-]+)*
+    |
+    \[[\t -Z^-~]*]
+    )
+    $
+""",
+    re.VERBOSE | re.ASCII,
+)
+
+
+def validate(email_str: object) -> bool:
+    """Validate a string as a RFC5321 email address."""
+    if not isinstance(email_str, str):
+        return False
+    return not not RFC5321_REGEX.match(email_str)
+
+
+if __name__ == "__main__":
+    import timeit
+
+    N = 100_000
+    tests = (
+        ("basic", "user@example.com"),
+    )
+
+    print("benchmarking")
+    for name, val in tests:
+        all_times = timeit.repeat(
+            f"validate({val!r})", globals=globals(), repeat=3, number=N
+        )
+        print(f"{name} (valid={validate(val)}): {int(min(all_times) / N * 10**9)}ns")

src/check_jsonschema/formats/implementations/rfc6531.py

@@ -0,0 +1,67 @@
+import re
+
+RFC6531_REGEX = re.compile(
+    r"""
+    ^
+    # local part
+    (
+    ([0-9a-z!#$%&'*+-\/=?^_`\{|\}~\u{80}-\u{10FFFF}]+(\.[0-9a-z!#$%&'*+-\/=?^_`\{|\}~\u{80}-\u{10FFFF}]+)*)
+    |
+    # quoted string
+    ("(
+    [\x20-\x21\x23-\x5B\x5D-\x7E\u{80}-\u{10FFFF}]
+    |
+    \\[\x20-\x7E]
+    )*")
+    )(?<!.{64,})
+    @
+    # Domain/address
+    (
+    # Address literal
+    (\[(
+    # IPv4
+    (\d{1,3}(\.\d{1,3}){3})
+    |
+    # IPv6
+    (IPv6:[0-9a-f]{1,4}(:[0-9a-f]{1,4}){7})
+    |
+    (IPv6:([0-9a-f]{1,4}(:[0-9a-f]{1,4}){0,5})?::([0-9a-f]{1,4}(:[0-9a-f]{1,4}){0,5})?)
+    |
+    (IPv6:[0-9a-f]{1,4}(:[0-9a-f]{1,4}){5}:\d{1,3}(\.\d{1,3}){3})
+    |
+    (IPv6:([0-9a-f]{1,4}(:[0-9a-f]{1,4}){0,3})?::([0-9a-f]{1,4}(:[0-9a-f]{1,4}){0,3}:)?\d{1,3}(\.\d{1,3}){3})
+    |
+    # General address
+    ([a-z0-9-]*[[a-z0-9]:[\x21-\x5A\x5E-\x7E]+)
+    )\])
+    |
+    # Domain
+    ((?!.{256,})(([0-9a-z\u{80}-\u{10FFFF}]([0-9a-z-\u{80}-\u{10FFFF}]*[0-9a-z\u{80}-\u{10FFFF}])?))(\.([0-9a-z\u{80}-\u{10FFFF}]([0-9a-z-\u{80}-\u{10FFFF}]*[0-9a-z\u{80}-\u{10FFFF}])?))*)
+    )
+    $
+""",
+    re.VERBOSE | re.ASCII,
+)
+
+
+def validate(email_str: object) -> bool:
+    """Validate a string as a RFC6531 email address."""
+    if not isinstance(email_str, str):
+        return False
+    return not not RFC6531_REGEX.match(email_str)
+
+
+if __name__ == "__main__":
+    import timeit
+
+    N = 100_000
+    tests = (
+        ("basic", "user@example.com"),
+    )
+
+    print("benchmarking")
+    for name, val in tests:
+        all_times = timeit.repeat(
+            f"validate({val!r})", globals=globals(), repeat=3, number=N
+        )
+        print(f"{name} (valid={validate(val)}): {int(min(all_times) / N * 10**9)}ns")