clarify documentation of strip_whitespace (pydantic#9471)

koxudaxi · May 21, 2024 · c89968b · c89968b
1 parent f356552
commit c89968b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/pydantic/types.py b/pydantic/types.py
@@ -682,7 +682,7 @@ class StringConstraints(annotated_types.GroupedMetadata):
     Apply constraints to `str` types.
 
     Attributes:
-        strip_whitespace: Whether to strip whitespace from the string.
+        strip_whitespace: Whether to remove leading and trailing whitespace.
         to_upper: Whether to convert the string to uppercase.
         to_lower: Whether to convert the string to lowercase.
         strict: Whether to validate the string in strict mode.

diff --git a/tests/test_types.py b/tests/test_types.py
@@ -1278,6 +1278,8 @@ def __bool__(self) -> bool:
         ('bool_check', BoolCastable(), ValidationError),
         ('str_check', 's', 's'),
         ('str_check', '  s  ', 's'),
+        ('str_check', ' leading', 'leading'),
+        ('str_check', 'trailing ', 'trailing'),
         ('str_check', b's', 's'),
         ('str_check', b'  s  ', 's'),
         ('str_check', bytearray(b's' * 5), 'sssss'),