upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-06-14 19:20:09 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

logging: use logger.warning for DeprecatedArgumentAction (#9630)

Browse source
This commit is contained in:
alexzorin 2023-03-28 05:13:16 +11:00 committed by GitHub
parent a16f316b8f
commit fbf7f1f4d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
certbot/CHANGELOG.md
View file

@ -21,7 +21,7 @@ Certbot adheres to [Semantic Versioning](https://semver.org/).
### Fixed
*
* Deprecated flags were inadvertently not printing warnings since v1.16.0. This is now fixed.
More details about these changes can be found on our GitHub repo.

3
certbot/certbot/util.py
View file

@ -18,7 +18,6 @@ from typing import Optional
from typing import Set
from typing import Tuple
from typing import Union
import warnings
import configargparse
@ -455,7 +454,7 @@ class DeprecatedArgumentAction(argparse.Action):
"""Action to log a warning when an argument is used."""
def __call__(self, unused1: Any, unused2: Any, unused3: Any,
option_string: Optional[str] = None) -> None:
warnings.warn("Use of %s is deprecated." % option_string, DeprecationWarning)
logger.warning("Use of %s is deprecated.", option_string)
def add_deprecated_argument(add_argument: Callable[..., None], argument_name: str,

8
certbot/tests/util_test.py
View file

@ -351,19 +351,19 @@ class AddDeprecatedArgumentTest(unittest.TestCase):
def test_warning_no_arg(self):
self._call("--old-option", 0)
with mock.patch("warnings.warn") as mock_warn:
with mock.patch("certbot.util.logger.warning") as mock_warn:
self.parser.parse_args(["--old-option"])
assert mock_warn.call_count == 1
assert "is deprecated" in mock_warn.call_args[0][0]
assert "--old-option" in mock_warn.call_args[0][0]
assert "--old-option" in mock_warn.call_args[0][1]
def test_warning_with_arg(self):
self._call("--old-option", 1)
with mock.patch("warnings.warn") as mock_warn:
with mock.patch("certbot.util.logger.warning") as mock_warn:
self.parser.parse_args(["--old-option", "42"])
assert mock_warn.call_count == 1
assert "is deprecated" in mock_warn.call_args[0][0]
assert "--old-option" in mock_warn.call_args[0][0]
assert "--old-option" in mock_warn.call_args[0][1]
def test_help(self):
self._call("--old-option", 2)