FilesExpand file tree

main

/

deprecation_utils.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

49 lines (40 loc) · 2.03 KB

main

/

deprecation_utils.py

Copy path

Top

File metadata and controls

• Code
• Blame

49 lines (40 loc) · 2.03 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

import inspect

import warnings

from typing import Any, Dict, Optional, Union

from packaging import version

def deprecate(*args, take_from: Optional[Union[Dict, Any]] = None, standard_warn=True):

from .. import __version__

deprecated_kwargs = take_from

values = ()

if not isinstance(args[0], tuple):

args = (args,)

for attribute, version_name, message in args:

if version.parse(version.parse(__version__).base_version) >= version.parse(version_name):

raise ValueError(

f"The deprecation tuple {(attribute, version_name, message)} should be removed since diffusers'"

f" version {__version__} is >= {version_name}"

)

warning = None

if isinstance(deprecated_kwargs, dict) and attribute in deprecated_kwargs:

values += (deprecated_kwargs.pop(attribute),)

warning = f"The `{attribute}` argument is deprecated and will be removed in version {version_name}."

elif hasattr(deprecated_kwargs, attribute):

values += (getattr(deprecated_kwargs, attribute),)

warning = f"The `{attribute}` attribute is deprecated and will be removed in version {version_name}."

elif deprecated_kwargs is None:

warning = f"`{attribute}` is deprecated and will be removed in version {version_name}."

if warning is not None:

warning = warning + " " if standard_warn else ""

warnings.warn(warning + message, FutureWarning, stacklevel=2)

if isinstance(deprecated_kwargs, dict) and len(deprecated_kwargs) > 0:

call_frame = inspect.getouterframes(inspect.currentframe())[1]

filename = call_frame.filename

line_number = call_frame.lineno

function = call_frame.function

key, value = next(iter(deprecated_kwargs.items()))

raise TypeError(f"{function} in {filename} line {line_number-1} got an unexpected keyword argument `{key}`")

if len(values) == 0:

return

elif len(values) == 1:

return values[0]

return values