Mark the email address argument to validate_email as positional-only

JoshData · Oct 19, 2023 · 371c120 · 371c120
1 parent 2a9653b
commit 371c120
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@ In Development
 * Python 3.8+ is now required (support for Python 3.7 was dropped).
 * The old `email` field on the returned `ValidatedEmail` object, which in the previous version was superseded by `normalized`, will now raise a deprecation warning if used. See https://stackoverflow.com/q/879173 for strategies to suppress the DeprecationWarning.
 * A `__version__` module attribute is added.
+* The email address argument to validate_email is now marked as positional-only to better reflect the documented usage using the new Python 3.8 feature.
 
 2.0.0 (April 15, 2023)
 ----------------------

diff --git a/email_validator/validate_email.py b/email_validator/validate_email.py
@@ -7,8 +7,8 @@
 
 def validate_email(
     email: Union[str, bytes],
-    # /, # not supported in Python 3.6, 3.7
-    *,
+    /,  # prior arguments are positional-only
+    *,  # subsequent arguments are keyword-only
     allow_smtputf8: Optional[bool] = None,
     allow_empty_local: bool = False,
     allow_quoted_local: Optional[bool] = None,