add config

Author: samuelcolvin

pyproject.toml

@@ -150,7 +150,7 @@ require_change_file = false
 include = ['python/pydantic_core', 'tests/test_typing.py']
 reportUnnecessaryTypeIgnoreComment = true
 executionEnvironments = [
-    { root = "tests", reportPrivateImportUsage = false, reportMissingParameterType = false },
+    { root = "tests", reportPrivateImportUsage = false, reportMissingParameterType = false, reportAny = false },
 ]
 
 [tool.inline-snapshot.shortcuts]

python/pydantic_core/_pydantic_core.pyi

@@ -522,15 +522,15 @@ class Url(SupportsAllComparisons):
     by Mozilla.
     """
 
-    def __init__(self, url: str, *, extra_trailing_slash: bool = True) -> None:
+    def __init__(self, url: str, *, add_trailing_slash: bool = True) -> None:
         """Initialize a new URL object.
 
         Args:
             url: The URL string to parse.
-            extra_trailing_slash: Whether to add an extra trailing slash to the URL, defaults to `True` for
+            add_trailing_slash: Whether to add an extra trailing slash to some URLs, defaults to `True` for
                 backward compatibility, default will change to `False` in v3 version.
         """
-    def __new__(cls, url: str, *, extra_trailing_slash: bool = True) -> Self: ...
+    def __new__(cls, url: str, *, add_trailing_slash: bool = True) -> Self: ...
     @property
     def scheme(self) -> str: ...
     @property
@@ -575,15 +575,15 @@ class MultiHostUrl(SupportsAllComparisons):
     by Mozilla.
     """
 
-    def __init__(self, url: str, *, extra_trailing_slash: bool = True) -> None:
+    def __init__(self, url: str, *, add_trailing_slash: bool = True) -> None:
         """Initialize a new MultiHostUrl object.
 
         Args:
             url: The URL string to parse.
-            extra_trailing_slash: Whether to add an extra trailing slash to the URL, defaults to `True` for
+            add_trailing_slash: Whether to add an extra trailing slash to some URLs, defaults to `True` for
                 backward compatibility, default will change to `False` in v3 version.
         """
-    def __new__(cls, url: str, *, extra_trailing_slash: bool = True) -> Self: ...
+    def __new__(cls, url: str, *, add_trailing_slash: bool = True) -> Self: ...
     @property
     def scheme(self) -> str: ...
     @property

python/pydantic_core/core_schema.py

@@ -75,6 +75,8 @@ class CoreConfig(TypedDict, total=False):
         validate_by_alias: Whether to use the field's alias when validating against the provided input data. Default is `True`.
         validate_by_name: Whether to use the field's name when validating against the provided input data. Default is `False`. Replacement for `populate_by_name`.
         serialize_by_alias: Whether to serialize by alias. Default is `False`, expected to change to `True` in V3.
+        url_add_trailing_slash: Whether to add an extra trailing slash to some URLs, defaults to `True` for
+            backward compatibility, default will change to `False` in v3 version.
     """
 
     title: str
@@ -114,6 +116,7 @@ class CoreConfig(TypedDict, total=False):
     validate_by_alias: bool  # default: True
     validate_by_name: bool  # default: False
     serialize_by_alias: bool  # default: False
+    url_add_trailing_slash: bool  # default: True
 
 
 IncExCall: TypeAlias = 'set[int | str] | dict[int | str, IncExCall] | None'
@@ -3824,7 +3827,7 @@ class UrlSchema(TypedDict, total=False):
     default_host: str
     default_port: int
     default_path: str
-    extra_trailing_slash: bool
+    add_trailing_slash: bool
     strict: bool
     ref: str
     metadata: dict[str, Any]
@@ -3839,7 +3842,7 @@ def url_schema(
     default_host: str | None = None,
     default_port: int | None = None,
     default_path: str | None = None,
-    extra_trailing_slash: bool | None = None,
+    add_trailing_slash: bool | None = None,
     strict: bool | None = None,
     ref: str | None = None,
     metadata: dict[str, Any] | None = None,
@@ -3864,7 +3867,7 @@ def url_schema(
         default_host: The default host to use if the URL does not have a host
         default_port: The default port to use if the URL does not have a port
         default_path: The default path to use if the URL does not have a path
-        extra_trailing_slash: Whether to add an extra trailing slash to the URL, defaults to `True` for
+        add_trailing_slash: Whether to add an extra trailing slash to some URLs, defaults to `True` for
             backward compatibility, default will change to `False` in v3 version.
         strict: Whether to use strict URL parsing
         ref: optional unique identifier of the schema, used to reference the schema in other places
@@ -3883,7 +3886,7 @@ def url_schema(
         ref=ref,
         metadata=metadata,
         serialization=serialization,
-        extra_trailing_slash=extra_trailing_slash,
+        add_trailing_slash=add_trailing_slash,
     )
 
 
@@ -3895,7 +3898,7 @@ class MultiHostUrlSchema(TypedDict, total=False):
     default_host: str
     default_port: int
     default_path: str
-    extra_trailing_slash: bool
+    add_trailing_slash: bool
     strict: bool
     ref: str
     metadata: dict[str, Any]
@@ -3910,7 +3913,7 @@ def multi_host_url_schema(
     default_host: str | None = None,
     default_port: int | None = None,
     default_path: str | None = None,
-    extra_trailing_slash: bool | None = None,
+    add_trailing_slash: bool | None = None,
     strict: bool | None = None,
     ref: str | None = None,
     metadata: dict[str, Any] | None = None,
@@ -3935,7 +3938,7 @@ def multi_host_url_schema(
         default_host: The default host to use if the URL does not have a host
         default_port: The default port to use if the URL does not have a port
         default_path: The default path to use if the URL does not have a path
-        extra_trailing_slash: Whether to add an extra trailing slash to the URL, defaults to `True` for
+        add_trailing_slash: Whether to add an extra trailing slash to some URLs, defaults to `True` for
             backward compatibility, default will change to `False` in v3 version.
         strict: Whether to use strict URL parsing
         ref: optional unique identifier of the schema, used to reference the schema in other places
@@ -3950,7 +3953,7 @@ def multi_host_url_schema(
         default_host=default_host,
         default_port=default_port,
         default_path=default_path,
-        extra_trailing_slash=extra_trailing_slash,
+        add_trailing_slash=add_trailing_slash,
         strict=strict,
         ref=ref,
         metadata=metadata,

src/url.rs

@@ -50,28 +50,28 @@ static SCHEMA_URL_SINGLE_FALSE: GILOnceCell<SchemaValidator> = GILOnceCell::new(
 static SCHEMA_URL_MULTI_TRUE: GILOnceCell<SchemaValidator> = GILOnceCell::new();
 static SCHEMA_URL_MULTI_FALSE: GILOnceCell<SchemaValidator> = GILOnceCell::new();
 
-fn get_schema_validator(py: Python<'_>, multi_host: bool, extra_trailing_slash: bool) -> &SchemaValidator {
-    match (multi_host, extra_trailing_slash) {
+fn get_schema_validator(py: Python<'_>, multi_host: bool, add_trailing_slash: bool) -> &SchemaValidator {
+    match (multi_host, add_trailing_slash) {
         (false, true) => SCHEMA_URL_SINGLE_TRUE.get_or_init(py, || build_schema_validator(py, "url", true)),
         (false, false) => SCHEMA_URL_SINGLE_FALSE.get_or_init(py, || build_schema_validator(py, "url", false)),
         (true, true) => SCHEMA_URL_MULTI_TRUE.get_or_init(py, || build_schema_validator(py, "multi-host-url", true)),
         (true, false) => SCHEMA_URL_MULTI_FALSE.get_or_init(py, || build_schema_validator(py, "multi-host-url", false)),
     }
 }
 
-fn build_schema_validator(py: Python, schema_type: &str, extra_trailing_slash: bool) -> SchemaValidator {
+fn build_schema_validator(py: Python, schema_type: &str, add_trailing_slash: bool) -> SchemaValidator {
     let schema = PyDict::new(py);
     schema.set_item("type", schema_type).unwrap();
-    schema.set_item("extra_trailing_slash", extra_trailing_slash).unwrap();
+    schema.set_item("add_trailing_slash", add_trailing_slash).unwrap();
     SchemaValidator::py_new(py, &schema, None).unwrap()
 }
 
 #[pymethods]
 impl PyUrl {
     #[new]
-    #[pyo3(signature = (url, *, extra_trailing_slash=true))]
-    pub fn py_new(py: Python, url: &Bound<'_, PyAny>, extra_trailing_slash: bool) -> PyResult<Self> {
-        let schema_validator = get_schema_validator(py, false, extra_trailing_slash);
+    #[pyo3(signature = (url, *, add_trailing_slash=true))]
+    pub fn py_new(py: Python, url: &Bound<'_, PyAny>, add_trailing_slash: bool) -> PyResult<Self> {
+        let schema_validator = get_schema_validator(py, false, add_trailing_slash);
         let schema_obj = schema_validator.validate_python(py, url, None, None, None, None, false.into(), None, None)?;
         schema_obj.extract(py)
     }
@@ -248,9 +248,9 @@ impl PyMultiHostUrl {
 #[pymethods]
 impl PyMultiHostUrl {
     #[new]
-    #[pyo3(signature = (url, *, extra_trailing_slash=true))]
-    pub fn py_new(py: Python, url: &Bound<'_, PyAny>, extra_trailing_slash: bool) -> PyResult<Self> {
-        let schema_validator = get_schema_validator(py, true, extra_trailing_slash);
+    #[pyo3(signature = (url, *, add_trailing_slash=true))]
+    pub fn py_new(py: Python, url: &Bound<'_, PyAny>, add_trailing_slash: bool) -> PyResult<Self> {
+        let schema_validator = get_schema_validator(py, true, add_trailing_slash);
         let schema_obj = schema_validator.validate_python(py, url, None, None, None, None, false.into(), None, None)?;
         schema_obj.extract(py)
     }

src/validators/url.rs

@@ -10,7 +10,7 @@ use ahash::AHashSet;
 use pyo3::IntoPyObjectExt;
 use url::{ParseError, SyntaxViolation, Url};
 
-use crate::build_tools::{is_strict, py_schema_err};
+use crate::build_tools::{is_strict, py_schema_err, schema_or_config};
 use crate::errors::ToErrorValue;
 use crate::errors::{ErrorType, ErrorTypeDefaults, ValError, ValResult};
 use crate::input::downcast_python_input;
@@ -34,7 +34,17 @@ pub struct UrlValidator {
     default_port: Option<u16>,
     default_path: Option<String>,
     name: String,
-    extra_trailing_slash: bool,
+    add_trailing_slash: bool,
+}
+
+fn get_add_trailing_slash(schema: &Bound<'_, PyDict>, config: Option<&Bound<'_, PyDict>>) -> PyResult<bool> {
+    schema_or_config(
+        schema,
+        config,
+        intern!(schema.py(), "add_trailing_slash"),
+        intern!(schema.py(), "url_add_trailing_slash"),
+    )
+    .map(|v| v.unwrap_or(true))
 }
 
 impl BuildValidator for UrlValidator {
@@ -56,9 +66,7 @@ impl BuildValidator for UrlValidator {
             default_path: schema.get_as(intern!(schema.py(), "default_path"))?,
             allowed_schemes,
             name,
-            extra_trailing_slash: schema
-                .get_as(intern!(schema.py(), "extra_trailing_slash"))?
-                .unwrap_or(true),
+            add_trailing_slash: get_add_trailing_slash(schema, config)?,
         }
         .into())
     }
@@ -73,7 +81,7 @@ impl Validator for UrlValidator {
         input: &(impl Input<'py> + ?Sized),
         state: &mut ValidationState<'_, 'py>,
     ) -> ValResult<PyObject> {
-        let mut either_url = self.get_url(input, state.strict_or(self.strict), self.extra_trailing_slash)?;
+        let mut either_url = self.get_url(input, state.strict_or(self.strict), self.add_trailing_slash)?;
 
         if let Some((ref allowed_schemes, ref expected_schemes_repr)) = self.allowed_schemes {
             if !allowed_schemes.contains(either_url.url().scheme()) {
@@ -114,7 +122,7 @@ impl UrlValidator {
         &self,
         input: &(impl Input<'py> + ?Sized),
         strict: bool,
-        extra_trailing_slash: bool,
+        add_trailing_slash: bool,
     ) -> ValResult<EitherUrl<'py>> {
         match input.validate_str(strict, false) {
             Ok(val_match) => {
@@ -124,7 +132,7 @@ impl UrlValidator {
 
                 self.check_length(input, url_str)?;
 
-                parse_url(url_str, input, strict, extra_trailing_slash).map(EitherUrl::Owned)
+                parse_url(url_str, input, strict, add_trailing_slash).map(EitherUrl::Owned)
             }
             Err(_) => {
                 // we don't need to worry about whether the url was parsed in strict mode before,
@@ -136,7 +144,7 @@ impl UrlValidator {
                     let url_str = multi_host_url.get().__str__();
                     self.check_length(input, &url_str)?;
 
-                    parse_url(&url_str, input, strict, extra_trailing_slash).map(EitherUrl::Owned)
+                    parse_url(&url_str, input, strict, add_trailing_slash).map(EitherUrl::Owned)
                 } else {
                     Err(ValError::new(ErrorTypeDefaults::UrlType, input))
                 }
@@ -208,7 +216,7 @@ pub struct MultiHostUrlValidator {
     default_port: Option<u16>,
     default_path: Option<String>,
     name: String,
-    extra_trailing_slash: bool,
+    add_trailing_slash: bool,
 }
 
 impl BuildValidator for MultiHostUrlValidator {
@@ -236,9 +244,7 @@ impl BuildValidator for MultiHostUrlValidator {
             default_port: schema.get_as(intern!(schema.py(), "default_port"))?,
             default_path: schema.get_as(intern!(schema.py(), "default_path"))?,
             name,
-            extra_trailing_slash: schema
-                .get_as(intern!(schema.py(), "extra_trailing_slash"))?
-                .unwrap_or(true),
+            add_trailing_slash: get_add_trailing_slash(schema, config)?,
         }
         .into())
     }
@@ -253,7 +259,7 @@ impl Validator for MultiHostUrlValidator {
         input: &(impl Input<'py> + ?Sized),
         state: &mut ValidationState<'_, 'py>,
     ) -> ValResult<PyObject> {
-        let mut multi_url = self.get_url(input, state.strict_or(self.strict), self.extra_trailing_slash)?;
+        let mut multi_url = self.get_url(input, state.strict_or(self.strict), self.add_trailing_slash)?;
 
         if let Some((ref allowed_schemes, ref expected_schemes_repr)) = self.allowed_schemes {
             if !allowed_schemes.contains(multi_url.url().scheme()) {
@@ -293,7 +299,7 @@ impl MultiHostUrlValidator {
         &self,
         input: &(impl Input<'py> + ?Sized),
         strict: bool,
-        extra_trailing_slash: bool,
+        add_trailing_slash: bool,
     ) -> ValResult<EitherMultiHostUrl<'py>> {
         match input.validate_str(strict, false) {
             Ok(val_match) => {
@@ -303,7 +309,7 @@ impl MultiHostUrlValidator {
 
                 self.check_length(input, || url_str.len())?;
 
-                parse_multihost_url(url_str, input, strict, extra_trailing_slash).map(EitherMultiHostUrl::Rust)
+                parse_multihost_url(url_str, input, strict, add_trailing_slash).map(EitherMultiHostUrl::Rust)
             }
             Err(_) => {
                 // we don't need to worry about whether the url was parsed in strict mode before,
@@ -384,7 +390,7 @@ fn parse_multihost_url<'py>(
     url_str: &str,
     input: &(impl Input<'py> + ?Sized),
     strict: bool,
-    extra_trailing_slash: bool,
+    add_trailing_slash: bool,
 ) -> ValResult<PyMultiHostUrl> {
     macro_rules! parsing_err {
         ($parse_error:expr) => {
@@ -474,7 +480,7 @@ fn parse_multihost_url<'py>(
     // with just one host, for consistent behaviour, we parse the URL the same as with multiple hosts
 
     let reconstructed_url = format!("{prefix}{}", &url_str[start..]);
-    let ref_url = parse_url(&reconstructed_url, input, strict, extra_trailing_slash)?;
+    let ref_url = parse_url(&reconstructed_url, input, strict, add_trailing_slash)?;
 
     if hosts.is_empty() {
         // if there's no one host (e.g. no `,`), we allow it to be empty to allow for default hosts
@@ -488,7 +494,7 @@ fn parse_multihost_url<'py>(
             .iter()
             .map(|host| {
                 let reconstructed_url = format!("{prefix}{host}");
-                parse_url(&reconstructed_url, input, strict, extra_trailing_slash).map(Into::into)
+                parse_url(&reconstructed_url, input, strict, add_trailing_slash).map(Into::into)
             })
             .collect::<ValResult<_>>()?;
 
@@ -500,7 +506,7 @@ fn parse_multihost_url<'py>(
     }
 }
 
-fn parse_url(url_str: &str, input: impl ToErrorValue, strict: bool, extra_trailing_slash: bool) -> ValResult<PyUrl> {
+fn parse_url(url_str: &str, input: impl ToErrorValue, strict: bool, add_trailing_slash: bool) -> ValResult<PyUrl> {
     if url_str.is_empty() {
         return Err(ValError::new(
             ErrorType::UrlParsing {
@@ -510,7 +516,7 @@ fn parse_url(url_str: &str, input: impl ToErrorValue, strict: bool, extra_traili
             input,
         ));
     }
-    let remove_trailing_slash = !extra_trailing_slash && !url_str.ends_with('/');
+    let remove_trailing_slash = !add_trailing_slash && !url_str.ends_with('/');
 
     // if we're in strict mode, we consider a syntax violation as an error
     if strict {