get rid of pydantic v2>v3 deprication warning; add optional indentation

examples/registration.py

@@ -29,7 +29,7 @@
 )
 
 print("\n[Registration Options - Simple]")
-print(options_to_json(simple_registration_options))
+print(options_to_json(simple_registration_options, indent=2))
 
 # Complex Options
 complex_registration_options = generate_registration_options(
@@ -52,7 +52,7 @@
 )
 
 print("\n[Registration Options - Complex]")
-print(options_to_json(complex_registration_options))
+print(options_to_json(complex_registration_options, indent=2))
 
 # Registration Response Verification
 registration_verification = verify_registration_response(

webauthn/helpers/options_to_json.py

@@ -10,13 +10,23 @@ def options_to_json(
     options: Union[
         PublicKeyCredentialCreationOptions,
         PublicKeyCredentialRequestOptions,
-    ]
+    ],
+    indent: int|None=None,
 ) -> str:
     """
     Prepare options for transmission to the front end as JSON
     """
-    return options.json(
-        by_alias=True,
-        exclude_unset=False,
-        exclude_none=True,
-    )
+    if hasattr(options, 'model_dump_json'): # model_dump_json was introduced in v2..
+        return options.model_dump_json(     # ..won't work in v1.
+            by_alias=True,
+            exclude_unset=False,
+            exclude_none=True,
+            indent=indent,
+        )
+    else:
+        return options.json(  # noqa: D102
+            by_alias=True,
+            exclude_unset=False,
+            exclude_none=False,
+            indent=indent,
+        )

webauthn/helpers/structs.py

@@ -1,6 +1,6 @@
 from enum import Enum
-from typing import Callable, List, Literal, Optional, Any, Dict
-
+from typing import Callable, List, Literal, Optional, Any, Dict, TypeVar
+import typing_extensions
 
 try:
     from pydantic import (  # type: ignore[attr-defined]
@@ -10,6 +10,7 @@
         FieldValidationInfo,
         model_serializer,
     )
+    from pydantic.deprecated import parse as _deprecated_parse
 
     PYDANTIC_V2 = True
 except ImportError:
@@ -18,6 +19,9 @@
 
     PYDANTIC_V2 = False
 
+Model = TypeVar('Model', bound='BaseModel')
+IncEx: typing_extensions.TypeAlias = 'set[int] | set[str] | dict[int, Any] | dict[str, Any] | None'
+
 from .base64url_to_bytes import base64url_to_bytes
 from .bytes_to_base64url import bytes_to_base64url
 from .cose import COSEAlgorithmIdentifier
@@ -98,6 +102,40 @@ def _pydantic_v2_serialize_bytes_fields(
 
             return serialized
 
+        @classmethod
+        def parse_raw(  # noqa: D102
+            cls: type[Model],
+            b: str | bytes,
+            *,
+            content_type: str | None = None,
+            encoding: str = 'utf8',
+            proto: _deprecated_parse.Protocol | None = None,
+            allow_pickle: bool = False,
+        ) -> Model:
+            return super().model_validate_json(b)
+
+        def json(  # noqa: D102
+            self,
+            *,
+            include: IncEx = None,
+            exclude: IncEx = None,
+            by_alias: bool = False,
+            exclude_unset: bool = False,
+            exclude_defaults: bool = False,
+            exclude_none: bool = False,
+            encoder: Callable[[Any], Any] | None = None,  # type: ignore[assignment]
+            models_as_dict: bool = None,  # type: ignore[assignment]
+            **dumps_kwargs: Any,
+        ) -> str:
+            return self.model_dump_json(
+                include=include,
+                exclude=exclude,
+                by_alias=by_alias,
+                exclude_unset=exclude_unset,
+                exclude_defaults=exclude_defaults,
+                exclude_none=exclude_none,
+        )
+
     else:
 
         class Config: