various 2.0 preparation things

Author: Leo Kirchner

.flake8

@@ -2,3 +2,4 @@
 # E501: Line length is enforced by Black, so flake8 doesn't need to check it
 # W503: Black disagrees with this rule, as does PEP 8; Black wins
 ignore = E501, W503
+exclude = .venv

diffsync/__init__.py

@@ -855,7 +855,15 @@ def count(self, model: Union[StrType, "DiffSyncModel", Type["DiffSyncModel"], No
 
 
 # For backwards-compatibility, keep around the old name
-DiffSync = Adapter
+def DiffSync(*args: Any, **kwargs: Any) -> Adapter:  # noqa
+    import warnings
 
-# DiffSyncModel references DiffSync and DiffSync references DiffSyncModel. Break the typing loop:
+    warnings.warn(
+        "'diffsync.DiffSync' is deprecated and will be removed with 2.1, use 'diffsync.Adapter' instead.",
+        DeprecationWarning,
+    )
+    return Adapter(*args, **kwargs)
+
+
+# DiffSyncModel references Adapter and Adapter references DiffSyncModel. Break the typing loop:
 DiffSyncModel.model_rebuild()

docs/source/upgrading/01-upgrading-to-2.0.md

@@ -2,6 +2,10 @@
 
 With diffsync 2.0, there a couple of breaking changes. What they are and how to deal with them is described in this document.
 
+## Rename of the `diffsync.Diffsync` class to `diffsync.Adapter`
+
+The main diffsync class `diffsync.Diffsync` has been renamed to `diffsync.Adapter` as we have found that this is the verbiage that is most often used by users and explains the intent of the class clearer. The old name will still be around until 2.1, but is considered deprecated at this point.
+
 ## Upgrade to Pydantic's major version 2
 
 A [migration guide](https://docs.pydantic.dev/latest/migration/) is available in the Pydantic documentation. Here are the key things that may apply to your usage of diffsync:
@@ -22,7 +26,7 @@ class Person(DiffSyncModel):
     age: Optional[int]
 
 # After
-class BetterPerson(DiffSyncModel)
+class BetterPerson(DiffSyncModel):
     _identifiers = ("name",)
     _attributes = ("age",)
 

tests/unit/test_diffsync_model_flags.py

@@ -194,7 +194,7 @@ class ParentModel(DiffSyncModel):
         attribute: str
         children: List[ChildModel] = []
 
-    class Adapter(DiffSync):
+    class TestAdapter(Adapter):
         """Test adapter."""
 
         top_level = ["parent"]
@@ -218,9 +218,9 @@ def load(self, is_source=False) -> None:
                 parent.add_child(child)
                 self.add(child)
 
-    source_adapter = Adapter()
+    source_adapter = TestAdapter()
     source_adapter.load(is_source=True)
-    destination_adapter = Adapter()
+    destination_adapter = TestAdapter()
     destination_adapter.load()
 
     source_adapter.sync_to(destination_adapter)