Use t.Literal instead of pattern if possible.

src/antsibull_docs/schemas/docs/base.py

@@ -92,8 +92,8 @@
 
       class Model(BaseModel):
           new_name: str
-          # Use pydantic.constr so that json-schema validations will also need to match the pattern
-          type: constr(pattern='^(int|str|float)$')
+          # Use t.Literal so that json-schema validations will also need to match the pattern
+          type: t.Literal["int", "str", "float"]
 
           # Use validator on a specific attribute to change the value of the attribute
           @validator('type', pre=True)
@@ -150,11 +150,25 @@ def handle_renamed_attribute(cls, values):
 REQUIRED_ENV_VAR_F = p.Field(..., pattern="[A-Z_]+")
 
 #: option types are a set of strings that represent the types handled by argspec.
-OPTION_TYPE_F = p.Field(
+OPTION_TYPE = t.Literal[
+    "any",
+    "bits",
+    "bool",
+    "bytes",
+    "dict",
+    "float",
+    "int",
+    "json",
+    "jsonarg",
+    "list",
+    "path",
+    "raw",
+    "sid",
     "str",
-    pattern="^(any|bits|bool|bytes|dict|float|int|json|jsonarg|list"
-    "|path|raw|sid|str|tmppath|pathspec|pathlist)$",
-)
+    "tmppath",
+    "pathspec",
+    "pathlist",
+]
 
 #: Constrained string type for version numbers
 REQUIRED_VERSION_F = p.Field(..., pattern="^([0-9][0-9.]+)$")
@@ -172,11 +186,24 @@ def handle_renamed_attribute(cls, values):
 REQUIRED_COLLECTION_NAME_OR_EMPTY_STR_F = p.Field("", pattern="^([^.]+\\.[^.]+)?$")
 
 #: Constrained string listing the possible types of a return field
-RETURN_TYPE_F = p.Field(
+RETURN_TYPE = t.Literal[
+    "any",
+    "bits",
+    "bool",
+    "bytes",
+    "complex",
+    "dict",
+    "float",
+    "int",
+    "json",
+    "jsonarg",
+    "list",
+    "path",
+    "sid",
     "str",
-    pattern="^(any|bits|bool|bytes|complex|dict|float|int|json"
-    "|jsonarg|list|path|sid|str|pathspec|pathlist)$",
-)
+    "pathspec",
+    "pathlist",
+]
 
 
 def is_json_value(value: t.Any) -> bool:
@@ -467,9 +494,9 @@ class OptionsSchema(BaseModel):
     aliases: list[str] = []
     choices: t.Union[list[t.Any], dict[t.Any, list[str]]] = []
     default: t.Any = None  # JSON value
-    elements: str = OPTION_TYPE_F
+    elements: OPTION_TYPE = "str"
     required: bool = False
-    type: str = OPTION_TYPE_F
+    type: OPTION_TYPE = "str"
     version_added: str = "historical"
     version_added_collection: str = COLLECTION_NAME_F
 
@@ -576,7 +603,7 @@ class AttributeSchemaBase(BaseModel, metaclass=abc.ABCMeta):
     # Without this base class, we would hit https://github.com/samuelcolvin/pydantic/issues/1259
     description: list[str]
     details: list[str] = []
-    support: str = p.Field("str", pattern="^(full|partial|none|N/A)$")
+    support: t.Literal["full", "partial", "none", "N/A"]
     version_added: str = "historical"
     version_added_collection: str = COLLECTION_NAME_F
 

src/antsibull_docs/schemas/docs/callback.py

@@ -5,7 +5,7 @@
 # SPDX-FileCopyrightText: 2020, Ansible Project
 """Schemas for the plugin DOCUMENTATION data."""
 
-import pydantic as p
+import typing as t
 
 from .base import BaseModel
 from .plugin import (
@@ -15,8 +15,6 @@
     PluginReturnSchema,
 )
 
-REQUIRED_CALLBACK_TYPE_F = p.Field(..., pattern="^(aggregate|notification|stdout)$")
-
 
 class InnerCallbackDocSchema(InnerDocSchema):
     """
@@ -26,7 +24,7 @@ class InnerCallbackDocSchema(InnerDocSchema):
     having separate types.
     """
 
-    type: str = REQUIRED_CALLBACK_TYPE_F
+    type: t.Literal["aggregate", "notification", "stdout"]
 
 
 class CallbackDocSchema(BaseModel):

src/antsibull_docs/schemas/docs/plugin.py

@@ -14,7 +14,7 @@
     COLLECTION_NAME_F,
     REQUIRED_CLI_F,
     REQUIRED_ENV_VAR_F,
-    RETURN_TYPE_F,
+    RETURN_TYPE,
     BaseModel,
     DeprecationSchema,
     DocSchema,
@@ -87,10 +87,10 @@ class ReturnSchema(BaseModel):
 
     description: list[str]
     choices: t.Union[list[t.Any], dict[t.Any, list[str]]] = []
-    elements: str = RETURN_TYPE_F
+    elements: RETURN_TYPE = "str"
     returned: str = "success"
     sample: t.Any = None  # JSON value
-    type: str = RETURN_TYPE_F
+    type: RETURN_TYPE = "str"
     version_added: str = "historical"
     version_added_collection: str = COLLECTION_NAME_F
 

tests/functional/baseline-default/collections/ns/col2/foo3_module.rst

@@ -428,6 +428,6 @@ The errors were:
 
         Unable to normalize foo3: return due to: 2 validation errors for PluginReturnSchema
         return -> bar -> type
-          String should match pattern '^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$' (type=string_pattern_mismatch; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
+          Input should be 'any', 'bits', 'bool', 'bytes', 'complex', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'sid', 'str', 'pathspec' or 'pathlist' (type=literal_error; expected='any', 'bits', 'bool', 'bytes', 'complex', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'sid', 'str', 'pathspec' or 'pathlist')
         return -> baz
           Input should be a valid dictionary or instance of OuterReturnSchema (type=model_type; class_name=OuterReturnSchema)

tests/functional/baseline-default/collections/ns/col2/foo_module.rst

@@ -33,7 +33,7 @@ The errors were:
         doc -> options -> bar -> description -> 1
           Input should be a valid string (type=string_type)
         doc -> options -> bar -> type
-          String should match pattern '^(any|bits|bool|bytes|dict|float|int|json|jsonarg|list|path|raw|sid|str|tmppath|pathspec|pathlist)$' (type=string_pattern_mismatch; pattern=^(any|bits|bool|bytes|dict|float|int|json|jsonarg|list|path|raw|sid|str|tmppath|pathspec|pathlist)$)
+          Input should be 'any', 'bits', 'bool', 'bytes', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'raw', 'sid', 'str', 'tmppath', 'pathspec' or 'pathlist' (type=literal_error; expected='any', 'bits', 'bool', 'bytes', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'raw', 'sid', 'str', 'tmppath', 'pathspec' or 'pathlist')
         doc -> options -> foo
           Input should be a valid dictionary or instance of ModuleOptionsSchema (type=model_type; class_name=ModuleOptionsSchema)
         doc -> options -> subfoo -> bam

tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo3_module.rst

@@ -428,6 +428,6 @@ The errors were:
 
         Unable to normalize foo3: return due to: 2 validation errors for PluginReturnSchema
         return -> bar -> type
-          String should match pattern '^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$' (type=string_pattern_mismatch; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
+          Input should be 'any', 'bits', 'bool', 'bytes', 'complex', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'sid', 'str', 'pathspec' or 'pathlist' (type=literal_error; expected='any', 'bits', 'bool', 'bytes', 'complex', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'sid', 'str', 'pathspec' or 'pathlist')
         return -> baz
           Input should be a valid dictionary or instance of OuterReturnSchema (type=model_type; class_name=OuterReturnSchema)

tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo_module.rst

@@ -33,7 +33,7 @@ The errors were:
         doc -> options -> bar -> description -> 1
           Input should be a valid string (type=string_type)
         doc -> options -> bar -> type
-          String should match pattern '^(any|bits|bool|bytes|dict|float|int|json|jsonarg|list|path|raw|sid|str|tmppath|pathspec|pathlist)$' (type=string_pattern_mismatch; pattern=^(any|bits|bool|bytes|dict|float|int|json|jsonarg|list|path|raw|sid|str|tmppath|pathspec|pathlist)$)
+          Input should be 'any', 'bits', 'bool', 'bytes', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'raw', 'sid', 'str', 'tmppath', 'pathspec' or 'pathlist' (type=literal_error; expected='any', 'bits', 'bool', 'bytes', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'raw', 'sid', 'str', 'tmppath', 'pathspec' or 'pathlist')
         doc -> options -> foo
           Input should be a valid dictionary or instance of ModuleOptionsSchema (type=model_type; class_name=ModuleOptionsSchema)
         doc -> options -> subfoo -> bam

tests/functional/baseline-simplified-rst/collections/ns/col2/foo3_module.rst

@@ -197,6 +197,6 @@ The errors were:
 
         Unable to normalize foo3: return due to: 2 validation errors for PluginReturnSchema
         return -> bar -> type
-          String should match pattern '^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$' (type=string_pattern_mismatch; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
+          Input should be 'any', 'bits', 'bool', 'bytes', 'complex', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'sid', 'str', 'pathspec' or 'pathlist' (type=literal_error; expected='any', 'bits', 'bool', 'bytes', 'complex', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'sid', 'str', 'pathspec' or 'pathlist')
         return -> baz
           Input should be a valid dictionary or instance of OuterReturnSchema (type=model_type; class_name=OuterReturnSchema)

tests/functional/baseline-simplified-rst/collections/ns/col2/foo_module.rst

@@ -19,7 +19,7 @@ The errors were:
         doc -> options -> bar -> description -> 1
           Input should be a valid string (type=string_type)
         doc -> options -> bar -> type
-          String should match pattern '^(any|bits|bool|bytes|dict|float|int|json|jsonarg|list|path|raw|sid|str|tmppath|pathspec|pathlist)$' (type=string_pattern_mismatch; pattern=^(any|bits|bool|bytes|dict|float|int|json|jsonarg|list|path|raw|sid|str|tmppath|pathspec|pathlist)$)
+          Input should be 'any', 'bits', 'bool', 'bytes', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'raw', 'sid', 'str', 'tmppath', 'pathspec' or 'pathlist' (type=literal_error; expected='any', 'bits', 'bool', 'bytes', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'raw', 'sid', 'str', 'tmppath', 'pathspec' or 'pathlist')
         doc -> options -> foo
           Input should be a valid dictionary or instance of ModuleOptionsSchema (type=model_type; class_name=ModuleOptionsSchema)
         doc -> options -> subfoo -> bam