Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/dulwich/__init__.py: 84%

1# __init__.py -- The git module of dulwich 

2# Copyright (C) 2007 James Westby <jw+debian@jameswestby.net> 

3# Copyright (C) 2008 Jelmer Vernooij <jelmer@jelmer.uk> 

4# 

5# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later 

6# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU 

7# General Public License as published by the Free Software Foundation; version 2.0 

8# or (at your option) any later version. You can redistribute it and/or 

9# modify it under the terms of either of these two licenses. 

10# 

11# Unless required by applicable law or agreed to in writing, software 

12# distributed under the License is distributed on an "AS IS" BASIS, 

13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

14# See the License for the specific language governing permissions and 

15# limitations under the License. 

16# 

17# You should have received a copy of the licenses; if not, see 

18# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License 

19# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache 

20# License, Version 2.0. 

21# 

22 

23 

24"""Python implementation of the Git file formats and protocols.""" 

25 

26from collections.abc import Callable 

27from typing import Any, ParamSpec, TypeVar 

28 

29__version__ = (0, 24, 8) 

30 

31__all__ = ["__version__", "replace_me"] 

32 

33P = ParamSpec("P") 

34R = TypeVar("R") 

35F = TypeVar("F", bound=Callable[..., Any]) 

36 

37try: 

38 from dissolve import replace_me as replace_me 

39except ImportError: 

40 # if dissolve is not installed, then just provide a basic implementation 

41 # of its replace_me decorator 

42 def replace_me( 

43 since: tuple[int, ...] | str | None = None, 

44 remove_in: tuple[int, ...] | str | None = None, 

45 ) -> Callable[[F], F]: 

46 """Decorator to mark functions as deprecated. 

47 

48 Args: 

49 since: Version when the function was deprecated 

50 remove_in: Version when the function will be removed 

51 

52 Returns: 

53 Decorator function 

54 """ 

55 

56 def decorator(func: Callable[P, R]) -> Callable[P, R]: 

57 import functools 

58 import warnings 

59 

60 m = f"{func.__name__} is deprecated" 

61 since_str = str(since) if since is not None else None 

62 remove_in_str = str(remove_in) if remove_in is not None else None 

63 

64 if since_str is not None and remove_in_str is not None: 

65 m += f" since {since_str} and will be removed in {remove_in_str}" 

66 elif since_str is not None: 

67 m += f" since {since_str}" 

68 elif remove_in_str is not None: 

69 m += f" and will be removed in {remove_in_str}" 

70 else: 

71 m += " and will be removed in a future version" 

72 

73 @functools.wraps(func) 

74 def _wrapped_func(*args: P.args, **kwargs: P.kwargs) -> R: 

75 warnings.warn( 

76 m, 

77 DeprecationWarning, 

78 stacklevel=2, 

79 ) 

80 return func(*args, **kwargs) 

81 

82 return _wrapped_func 

83 

84 return decorator # type: ignore[return-value]