jenkins-bot has submitted this change and it was merged. Change subject: [IMPROV] Make deprecation messages consistent ...................................................................... [IMPROV] Make deprecation messages consistent Some deprecation messages use a semicolon while others use a normal comma. This is changing them into semicolons. Change-Id: I92cebffe9f746ede03da3851a19e812f3ce155a9 --- M pywikibot/site.py M pywikibot/tools/__init__.py M tests/aspects.py M tests/deprecation_tests.py 4 files changed, 30 insertions(+), 57 deletions(-) Approvals: John Vandenberg: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/site.py b/pywikibot/site.py index e77315c..8208363 100644 --- a/pywikibot/site.py +++ b/pywikibot/site.py @@ -3634,7 +3634,7 @@ filterredir = None else: filterredir = False - warn('The value "{0!r}" for "filterredir" is deprecated, use ' + warn('The value "{0!r}" for "filterredir" is deprecated; use ' '{1} instead.'.format(old, filterredir), DeprecationWarning, 3) apgen = self._generator(api.PageGenerator, type_arg="allpages", diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index bd96771..34be4cc 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -1098,7 +1098,7 @@ def issue_deprecation_warning(name, instead, depth): """Issue a deprecation warning.""" if instead: - warn(u'{0} is deprecated, use {1} instead.'.format(name, instead), + warn('{0} is deprecated; use {1} instead.'.format(name, instead), DeprecationWarning, depth + 1) else: warn(u'{0} is deprecated.'.format(name), _NotImplementedWarning, @@ -1433,7 +1433,7 @@ if not warning_message: if replacement_name: - warning_message = u"{0}.{1} is deprecated, use {2} instead." + warning_message = '{0}.{1} is deprecated; use {2} instead.' else: warning_message = u"{0}.{1} is deprecated." diff --git a/tests/aspects.py b/tests/aspects.py index 42d2f06..5710e8d 100644 --- a/tests/aspects.py +++ b/tests/aspects.py @@ -1315,7 +1315,7 @@ """Test cases for deprecation function in the tools module.""" - _generic_match = re.compile(r'.* is deprecated(, use .* instead)?\.') + _generic_match = re.compile(r'.* is deprecated(; use .* instead)?\.') skip_list = [ unittest.case._AssertRaisesContext, @@ -1371,7 +1371,7 @@ else: msg = '{0} is deprecated'.format(deprecated) if instead: - msg += ', use {0} instead'.format(instead) + msg += '; use {0} instead'.format(instead) msg += '.' return msg diff --git a/tests/deprecation_tests.py b/tests/deprecation_tests.py index e7f4fa9..160cf3e 100644 --- a/tests/deprecation_tests.py +++ b/tests/deprecation_tests.py @@ -365,9 +365,8 @@ rv = func(bah='b') self.assertEqual(rv, 'b') - self.assertDeprecation( - 'bah argument of ' + __name__ + '.' + func.__name__ + ' is ' - 'deprecated; use foo instead.') + self.assertOneDeprecationParts( + 'bah argument of ' + __name__ + '.' + func.__name__, 'foo') self._reset_messages() @@ -591,9 +590,9 @@ rv = f.deprecated_instance_method_arg(bah='b') self.assertEqual(rv, 'b') self.assertEqual(f.foo, 'b') - self.assertDeprecation( - 'bah argument of %s.DeprecatedMethodClass.deprecated_instance_' - 'method_arg is deprecated; use foo instead.' % __name__) + self.assertOneDeprecationParts( + 'bah argument of ' + __name__ + '.DeprecatedMethodClass.' + 'deprecated_instance_method_arg', 'foo') self._reset_messages() @@ -612,36 +611,26 @@ rv = f.deprecated_instance_method_args(bah='b', bah2='c') self.assertEqual(rv, ('b', 'c')) - self.assertDeprecation( + self.assertDeprecationParts( 'bah argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args is deprecated; use foo instead.') - self.assertDeprecation( + 'deprecated_instance_method_args', 'foo') + self.assertDeprecationParts( 'bah2 argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args is deprecated; use foo2 instead.') + 'deprecated_instance_method_args', 'foo2') self._reset_messages() rv = f.deprecated_instance_method_args(foo='b', bah2='c') self.assertEqual(rv, ('b', 'c')) - self.assertNoDeprecation( - 'bah argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args is deprecated; use foo instead.') - self.assertDeprecation( + self.assertOneDeprecationParts( 'bah2 argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args is deprecated; use foo2 instead.') - - self._reset_messages() + 'deprecated_instance_method_args', 'foo2') rv = f.deprecated_instance_method_args(foo2='c', bah='b') self.assertEqual(rv, ('b', 'c')) - self.assertDeprecation( + self.assertOneDeprecationParts( 'bah argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args is deprecated; use foo instead.') - self.assertNoDeprecation( - 'bah2 argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args is deprecated; use foo2 instead.') - - self._reset_messages() + 'deprecated_instance_method_args', 'foo') rv = f.deprecated_instance_method_args(foo=1, foo2=2) self.assertEqual(rv, (1, 2)) @@ -657,42 +646,26 @@ rv = f.deprecated_instance_method_args_multi(bah='b', bah2='c') self.assertEqual(rv, ('b', 'c')) - self.assertDeprecation( + self.assertDeprecationParts( 'bah argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args_multi is deprecated; ' - 'use foo instead.') - self.assertDeprecation( + 'deprecated_instance_method_args_multi', 'foo') + self.assertDeprecationParts( 'bah2 argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args_multi is deprecated; ' - 'use foo2 instead.') + 'deprecated_instance_method_args_multi', 'foo2') self._reset_messages() rv = f.deprecated_instance_method_args_multi(foo='b', bah2='c') self.assertEqual(rv, ('b', 'c')) - self.assertNoDeprecation( - 'bah argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args_multi is deprecated; ' - 'use foo instead.') - self.assertDeprecation( + self.assertOneDeprecationParts( 'bah2 argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args_multi is deprecated; ' - 'use foo2 instead.') - - self._reset_messages() + 'deprecated_instance_method_args_multi', 'foo2') rv = f.deprecated_instance_method_args_multi(foo2='c', bah='b') self.assertEqual(rv, ('b', 'c')) - self.assertDeprecation( + self.assertOneDeprecationParts( 'bah argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args_multi is deprecated; ' - 'use foo instead.') - self.assertNoDeprecation( - 'bah2 argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_args_multi is deprecated; ' - 'use foo2 instead.') - - self._reset_messages() + 'deprecated_instance_method_args_multi', 'foo') rv = f.deprecated_instance_method_args_multi(foo=1, foo2=2) self.assertEqual(rv, (1, 2)) @@ -713,9 +686,9 @@ self.assertEqual(f.foo, 'b') self.assertDeprecationParts( __name__ + '.DeprecatedMethodClass.deprecated_instance_method_and_arg') - self.assertDeprecation( + self.assertDeprecationParts( 'bah argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_and_arg is deprecated; use foo instead.') + 'deprecated_instance_method_and_arg', 'foo') self._reset_messages() @@ -740,9 +713,9 @@ self.assertEqual(f.foo, 'b') self.assertDeprecationParts( __name__ + '.DeprecatedMethodClass.deprecated_instance_method_and_arg2') - self.assertDeprecation( + self.assertDeprecationParts( 'bah argument of ' + __name__ + '.DeprecatedMethodClass.' - 'deprecated_instance_method_and_arg2 is deprecated; use foo instead.') + 'deprecated_instance_method_and_arg2', 'foo') self._reset_messages() -- To view, visit https://gerrit.wikimedia.org/r/228424 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I92cebffe9f746ede03da3851a19e812f3ce155a9 Gerrit-PatchSet: 3 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: XZise &lt;CommodoreFabianus(a)gmx.de&gt; Gerrit-Reviewer: John Vandenberg &lt;jayvdb(a)gmail.com&gt; Gerrit-Reviewer: Ladsgroup &lt;ladsgroup(a)gmail.com&gt; Gerrit-Reviewer: Merlijn van Deen &lt;valhallasw(a)arctus.nl&gt; Gerrit-Reviewer: XZise &lt;CommodoreFabianus(a)gmx.de&gt; Gerrit-Reviewer: jenkins-bot <>