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 public 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 typing import Any, Callable, Optional, TypeVar
27
28__version__ = (0, 23, 1)
29
30__all__ = ["replace_me"]
31
32F = TypeVar("F", bound=Callable[..., Any])
33
34try:
35 from dissolve import replace_me
36except ImportError:
37 # if dissolve is not installed, then just provide a basic implementation
38 # of its replace_me decorator
39 def replace_me(
40 since: Optional[str] = None, remove_in: Optional[str] = None
41 ) -> Callable[[F], F]:
42 def decorator(func: F) -> F:
43 import warnings
44
45 m = f"{func.__name__} is deprecated"
46 if since is not None and remove_in is not None:
47 m += f" since {since} and will be removed in {remove_in}"
48 elif since is not None:
49 m += f" since {since}"
50 elif remove_in is not None:
51 m += f" and will be removed in {remove_in}"
52 else:
53 m += " and will be removed in a future version"
54
55 warnings.warn(
56 m,
57 DeprecationWarning,
58 stacklevel=2,
59 )
60 return func
61
62 return decorator