feat: Add Pydantic V2 support with V1 compatibility layer (#3924)

jstvz · web-flow · commit d4405e396fba · 2025-10-13T09:53:15.000+05:30
diff --git a/cumulusci/core/config/project_config.py b/cumulusci/core/config/project_config.py
@@ -22,7 +22,7 @@
 API_VERSION_RE = re.compile(r"^\d\d+\.0$")
 
 import github3
-from pydantic import ValidationError
+from pydantic.v1 import ValidationError
 
 from cumulusci.core.config import FlowConfig, TaskConfig
 from cumulusci.core.config.base_task_flow_config import BaseTaskFlowConfig
diff --git a/cumulusci/core/dependencies/dependencies.py b/cumulusci/core/dependencies/dependencies.py
@@ -6,10 +6,10 @@
 from typing import List, Optional
 from zipfile import ZipFile
 
-import pydantic
+import pydantic.v1 as pydantic
 from github3.exceptions import NotFoundError
 from github3.repos.repo import Repository
-from pydantic.networks import AnyUrl
+from pydantic.v1.networks import AnyUrl
 
 from cumulusci.core.config import OrgConfig
 from cumulusci.core.config.project_config import BaseProjectConfig
diff --git a/cumulusci/core/dependencies/tests/test_dependencies.py b/cumulusci/core/dependencies/tests/test_dependencies.py
@@ -5,7 +5,7 @@
 from zipfile import ZipFile
 
 import pytest
-from pydantic import ValidationError
+from pydantic.v1 import ValidationError
 
 from cumulusci.core.config.org_config import OrgConfig, VersionInfo
 from cumulusci.core.config.project_config import BaseProjectConfig
diff --git a/cumulusci/core/source_transforms/tests/test_transforms.py b/cumulusci/core/source_transforms/tests/test_transforms.py
@@ -8,7 +8,7 @@
 
 import pytest
 from lxml import etree as ET
-from pydantic import ValidationError
+from pydantic.v1 import ValidationError
 
 from cumulusci.core.exceptions import CumulusCIException, TaskOptionsError
 from cumulusci.core.source_transforms.transforms import (
diff --git a/cumulusci/core/source_transforms/transforms.py b/cumulusci/core/source_transforms/transforms.py
@@ -10,7 +10,7 @@
 from zipfile import ZipFile
 
 from lxml import etree as ET
-from pydantic import BaseModel, root_validator
+from pydantic.v1 import BaseModel, root_validator
 
 from cumulusci.core.dependencies.utils import TaskContext
 from cumulusci.core.enums import StrEnum
diff --git a/cumulusci/core/tasks.py b/cumulusci/core/tasks.py
@@ -11,7 +11,7 @@
 from contextlib import nullcontext
 from typing import Any, Callable, Dict, List, Optional, Type, Union
 
-from pydantic.error_wrappers import ValidationError
+from pydantic.v1.error_wrappers import ValidationError
 
 from cumulusci import __version__
 from cumulusci.core.config import TaskConfig
diff --git a/cumulusci/core/versions.py b/cumulusci/core/versions.py
@@ -1,7 +1,7 @@
 import re
 from typing import Optional, Union
 
-from pydantic import BaseModel
+from pydantic.v1 import BaseModel
 
 from cumulusci.core.enums import StrEnum
 
diff --git a/cumulusci/oauth/client.py b/cumulusci/oauth/client.py
@@ -19,7 +19,7 @@
 from cryptography.hazmat.primitives import hashes, serialization
 from cryptography.hazmat.primitives.asymmetric import rsa
 from cryptography.x509.oid import NameOID
-from pydantic import BaseModel
+from pydantic.v1 import BaseModel
 
 from cumulusci.core.exceptions import CumulusCIUsageError
 from cumulusci.oauth.exceptions import OAuth2Error
diff --git a/cumulusci/tasks/bulkdata/extract_dataset_utils/extract_yml.py b/cumulusci/tasks/bulkdata/extract_dataset_utils/extract_yml.py
@@ -2,7 +2,7 @@
 import typing as T
 from pathlib import Path
 
-from pydantic import Field, validator
+from pydantic.v1 import Field, validator
 
 from cumulusci.core.enums import StrEnum
 from cumulusci.tasks.bulkdata.utils import DataApi
diff --git a/cumulusci/tasks/bulkdata/extract_dataset_utils/synthesize_extract_declarations.py b/cumulusci/tasks/bulkdata/extract_dataset_utils/synthesize_extract_declarations.py
@@ -2,7 +2,7 @@
 import re
 import typing as T
 
-from pydantic import validator
+from pydantic.v1 import validator
 
 from cumulusci.salesforce_api.org_schema import NOT_EXTRACTABLE, Field, Schema
 from cumulusci.utils.iterators import partition
diff --git a/cumulusci/tasks/bulkdata/extract_dataset_utils/tests/test_extract_yml.py b/cumulusci/tasks/bulkdata/extract_dataset_utils/tests/test_extract_yml.py
@@ -1,7 +1,7 @@
 from io import StringIO
 
 import pytest
-from pydantic import ValidationError
+from pydantic.v1 import ValidationError
 
 from cumulusci.tasks.bulkdata.extract_dataset_utils.extract_yml import (
     ExtractDeclaration,
diff --git a/cumulusci/tasks/bulkdata/mapping_parser.py b/cumulusci/tasks/bulkdata/mapping_parser.py
@@ -7,7 +7,7 @@
 from pathlib import Path
 from typing import IO, Any, Callable, Dict, List, Mapping, Optional, Tuple, Union
 
-from pydantic import Field, ValidationError, root_validator, validator
+from pydantic.v1 import Field, ValidationError, root_validator, validator
 from simple_salesforce import Salesforce
 from typing_extensions import Literal
 
diff --git a/cumulusci/tasks/bulkdata/select_utils.py b/cumulusci/tasks/bulkdata/select_utils.py
@@ -4,7 +4,7 @@
 import typing as T
 from enum import Enum
 
-from pydantic import Field, root_validator, validator
+from pydantic.v1 import Field, root_validator, validator
 
 from cumulusci.core.enums import StrEnum
 from cumulusci.tasks.bulkdata.utils import CaseInsensitiveDict
diff --git a/cumulusci/tasks/create_package_version.py b/cumulusci/tasks/create_package_version.py
@@ -5,7 +5,7 @@
 import zipfile
 from typing import List, Optional
 
-from pydantic import BaseModel, validator
+from pydantic.v1 import BaseModel, validator
 from simple_salesforce.exceptions import SalesforceMalformedRequest
 
 from cumulusci.core.config.util import get_devhub_config
diff --git a/cumulusci/tasks/datadictionary.py b/cumulusci/tasks/datadictionary.py
@@ -6,7 +6,7 @@
 from zipfile import ZipFile
 
 from github3.repos.repo import Repository
-from pydantic import BaseModel
+from pydantic.v1 import BaseModel
 
 from cumulusci.core.dependencies.dependencies import (
     Dependency,
diff --git a/cumulusci/tasks/metadata_etl/layouts.py b/cumulusci/tasks/metadata_etl/layouts.py
@@ -1,6 +1,6 @@
 from typing import List, Optional
 
-from pydantic import BaseModel, root_validator
+from pydantic.v1 import BaseModel, root_validator
 from typing_extensions import Literal
 
 from cumulusci.core.exceptions import TaskOptionsError
diff --git a/cumulusci/tasks/metadata_etl/permissions.py b/cumulusci/tasks/metadata_etl/permissions.py
@@ -1,6 +1,6 @@
 import typing as T
 
-import pydantic
+import pydantic.v1 as pydantic
 
 from cumulusci.core.exceptions import TaskOptionsError
 from cumulusci.tasks.metadata_etl import MetadataSingleEntityTransformTask
diff --git a/cumulusci/tasks/metadata_etl/remote_site_settings.py b/cumulusci/tasks/metadata_etl/remote_site_settings.py
@@ -1,7 +1,7 @@
 from typing import List, Optional
 
-import pydantic
-from pydantic import BaseModel
+import pydantic.v1 as pydantic
+from pydantic.v1 import BaseModel
 
 from cumulusci.core.exceptions import TaskOptionsError
 from cumulusci.tasks.metadata_etl.base import BaseMetadataSynthesisTask
diff --git a/cumulusci/tasks/salesforce/Deploy.py b/cumulusci/tasks/salesforce/Deploy.py
@@ -2,7 +2,7 @@
 from typing import List, Optional, Union
 
 from defusedxml.minidom import parseString
-from pydantic import ValidationError
+from pydantic.v1 import ValidationError
 
 from cumulusci.cli.ui import CliTable
 from cumulusci.core.dependencies.utils import TaskContext
diff --git a/cumulusci/tasks/salesforce/tests/test_update_dependencies.py b/cumulusci/tasks/salesforce/tests/test_update_dependencies.py
@@ -3,7 +3,7 @@
 import zipfile
 from unittest import mock
 
-import pydantic
+import pydantic.v1 as pydantic
 import pytest
 
 from cumulusci.core.dependencies.dependencies import (
diff --git a/cumulusci/tasks/tests/test_create_package_version.py b/cumulusci/tasks/tests/test_create_package_version.py
@@ -10,7 +10,7 @@
 import pytest
 import responses
 import yaml
-from pydantic import ValidationError
+from pydantic.v1 import ValidationError
 
 from cumulusci.core.config import BaseProjectConfig, TaskConfig, UniversalConfig
 from cumulusci.core.dependencies.dependencies import (
diff --git a/cumulusci/utils/options.py b/cumulusci/utils/options.py
@@ -2,7 +2,7 @@
 from inspect import signature
 from typing import Any, Dict, List
 
-from pydantic import DirectoryPath, Field, FilePath, create_model
+from pydantic.v1 import DirectoryPath, Field, FilePath, create_model
 
 from cumulusci.core.exceptions import TaskOptionsError
 from cumulusci.utils.yaml.model_parser import CCIDictModel
diff --git a/cumulusci/utils/parallel/task_worker_queues/parallel_worker.py b/cumulusci/utils/parallel/task_worker_queues/parallel_worker.py
@@ -7,7 +7,7 @@
 from pathlib import Path
 from traceback import format_exc
 
-from pydantic import BaseModel
+from pydantic.v1 import BaseModel
 
 from cumulusci.core.config import (
     BaseConfig,
diff --git a/cumulusci/utils/yaml/cumulusci_yml.py b/cumulusci/utils/yaml/cumulusci_yml.py
@@ -9,8 +9,8 @@
 from pathlib import Path
 from typing import Any, Dict, List, Optional, Sequence, Union
 
-from pydantic import Field, root_validator, validator
-from pydantic.types import DirectoryPath
+from pydantic.v1 import Field, root_validator, validator
+from pydantic.v1.types import DirectoryPath
 from typing_extensions import Literal, TypedDict
 
 from cumulusci.core.enums import StrEnum
@@ -280,7 +280,6 @@ class ErrorDict(TypedDict):
 
 def _log_yaml_errors(logger, errors: List[ErrorDict]):
     "Format and log a Pydantic-style error dictionary"
-    global has_shown_yaml_error_message
     plural = "" if len(errors) <= 1 else "s"
     logger.warning(f"CumulusCI Configuration Warning{plural}:")
     for error in errors:
diff --git a/cumulusci/utils/yaml/model_parser.py b/cumulusci/utils/yaml/model_parser.py
@@ -1,8 +1,8 @@
 from pathlib import Path
 from typing import IO, Sequence, Union
 
-from pydantic import BaseModel, ValidationError
-from pydantic.error_wrappers import ErrorWrapper
+from pydantic.v1 import BaseModel, ValidationError
+from pydantic.v1.error_wrappers import ErrorWrapper
 
 from cumulusci.utils.yaml.safer_loader import load_from_source, load_yaml_data
 
diff --git a/cumulusci/utils/yaml/tests/test_cumulusci_yml.py b/cumulusci/utils/yaml/tests/test_cumulusci_yml.py
@@ -4,7 +4,7 @@
 from unittest.mock import MagicMock, Mock, patch
 
 import pytest
-from pydantic import ValidationError
+from pydantic.v1 import ValidationError
 
 from cumulusci.utils import temporary_dir
 from cumulusci.utils.yaml.cumulusci_yml import (
diff --git a/cumulusci/utils/yaml/tests/test_model_parser.py b/cumulusci/utils/yaml/tests/test_model_parser.py
@@ -2,7 +2,7 @@
 from unittest.mock import Mock
 
 import pytest
-from pydantic import Field
+from pydantic.v1 import Field
 
 from cumulusci.utils.yaml.model_parser import CCIDictModel, CCIModel, ValidationError
 
@@ -20,7 +20,7 @@ class TestCCIModel:
     def test_fields_property(self):
         # JSON is YAML. Strange but true.
         foo = Document.parse_from_yaml(StringIO("{bar: 'blah'}"))
-        assert type(foo) == Foo
+        assert isinstance(foo, Foo)
         assert foo.fields_ == []
         assert foo.fields == []
 
@@ -122,7 +122,7 @@ class Document(CCIDictModel):
 
         # JSON is YAML. Strange but true.
         foo = Document.parse_from_yaml(StringIO("{bar: 'blah'}"))
-        assert type(foo) == Foo
+        assert isinstance(foo, Foo)
         assert foo["fields"] == []
 
         foo = Document.parse_from_yaml(StringIO("{bar: 'blah', fields: [1,2]}"))
diff --git a/pyproject.toml b/pyproject.toml
@@ -36,7 +36,7 @@ dependencies = [
     "MarkupSafe",
     "packaging>=23.0",
     "psutil",
-    "pydantic<2",
+    "pydantic>=2.0,<3",
     "PyJWT",
     "pytz",
     "pyyaml",
@@ -53,7 +53,7 @@ dependencies = [
     "sarge",
     "selenium<4",
     "simple-salesforce==1.11.4",
-    "snowfakery>=4.0.0",
+    "snowfakery>=4.1.0",
     "xmltodict",
     "docutils<=0.21.2",
 ]
@@ -105,6 +105,9 @@ Changelog = "https://cumulusci.readthedocs.io/en/stable/history.html"
 [tool.hatch.version]
 path = "cumulusci/__about__.py"
 
+[tool.hatch.metadata]
+allow-direct-references = true
+
 [tool.hatch.build]
 include = [
     "/cumulusci",
diff --git a/uv.lock b/uv.lock
