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

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 

26import sys 

27from typing import Callable, Optional, TypeVar, Union 

28 

29if sys.version_info >= (3, 10): 

30 from typing import ParamSpec 

31else: 

32 from typing_extensions import ParamSpec 

33 

34__version__ = (0, 24, 1) 

35 

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

37 

38P = ParamSpec("P") 

39R = TypeVar("R") 

40F = TypeVar("F", bound=Callable[..., object]) 

41 

42try: 

43 from dissolve import replace_me 

44except ImportError: 

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

46 # of its replace_me decorator 

47 def replace_me( 

48 since: Optional[Union[str, tuple[int, ...]]] = None, 

49 remove_in: Optional[Union[str, tuple[int, ...]]] = None, 

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

51 """Decorator to mark functions as deprecated. 

52 

53 Args: 

54 since: Version when the function was deprecated 

55 remove_in: Version when the function will be removed 

56 

57 Returns: 

58 Decorator function 

59 """ 

60 

61 def decorator(func: F) -> F: 

62 import functools 

63 import warnings 

64 

65 m = f"{func.__name__} is deprecated" # type: ignore[attr-defined] 

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

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

68 

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

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

71 elif since_str is not None: 

72 m += f" since {since_str}" 

73 elif remove_in_str is not None: 

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

75 else: 

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

77 

78 @functools.wraps(func) 

79 def _wrapped_func(*args, **kwargs): # type: ignore[no-untyped-def] 

80 warnings.warn( 

81 m, 

82 DeprecationWarning, 

83 stacklevel=2, 

84 ) 

85 return func(*args, **kwargs) # type: ignore[operator] 

86 

87 return _wrapped_func # type: ignore[return-value] 

88 

89 return decorator