Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DiffSync deprecation fix #281

Merged
merged 2 commits into from
Sep 26, 2024
Merged

DiffSync deprecation fix #281

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab7bf4a
DiffSync deprecation fix
abates Sep 26, 2024
e465626
Formatting
abates Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions diffsync/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
Any,
Set,
)
from typing_extensions import deprecated
import warnings

from pydantic import ConfigDict, BaseModel, PrivateAttr
Expand Down Expand Up @@ -894,15 +895,10 @@ def count(self, model: Union[StrType, "DiffSyncModel", Type["DiffSyncModel"], No
return self.store.count(model=model)


def DiffSync(*args: Any, **kwargs: Any) -> Adapter: # noqa pylint: disable=invalid-name
@deprecated("'diffsync.DiffSync' is deprecated and will be removed with 2.1, use 'diffsync.Adapter' instead.")
class DiffSync(Adapter):
"""For backwards-compatibility, keep around the old name."""

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()
10 changes: 10 additions & 0 deletions tests/unit/test_deprecation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

from diffsync import DiffSync

import pytest

def test_diffsync_deprecation_warning():
with pytest.deprecated_call():
class TestAdapter(DiffSync):
pass
TestAdapter()
Loading