diff --git a/CHANGES.rst b/CHANGES.rst index c4ca57431..7948934f7 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -21,9 +21,17 @@ Bug Fixes Backward Incompatibilities -------------------------- +- Replace ``pyramid.util.DottedNameResolver`` with a shim. Users should use + ``pyramid.path.DottedNameResolver`` instead. See + https://github.com/Pylons/pyramid/pull/3837. + Deprecations ------------ +- Deprecate ``pyramid.util.DottedNameResolver`` in favor of + ``pyramid.path.DottedNameResolver``. See + https://github.com/Pylons/pyramid/pull/3837. + Documentation Changes --------------------- diff --git a/src/pyramid/scripts/pshell.py b/src/pyramid/scripts/pshell.py index 0ac3871c7..003dc322f 100644 --- a/src/pyramid/scripts/pshell.py +++ b/src/pyramid/scripts/pshell.py @@ -7,9 +7,10 @@ import textwrap from pyramid.paster import bootstrap +from pyramid.path import DottedNameResolver from pyramid.scripts.common import get_config_loader, parse_vars from pyramid.settings import aslist -from pyramid.util import DottedNameResolver, make_contextmanager +from pyramid.util import make_contextmanager def main(argv=sys.argv, quiet=False): diff --git a/src/pyramid/util.py b/src/pyramid/util.py index 288867c12..74677c59e 100644 --- a/src/pyramid/util.py +++ b/src/pyramid/util.py @@ -4,8 +4,7 @@ import inspect import platform import weakref - -from pyramid.path import DottedNameResolver as _DottedNameResolver +from zope.deprecation import deprecated _marker = object() @@ -20,11 +19,25 @@ PYPY = False -class DottedNameResolver(_DottedNameResolver): - def __init__( - self, package=None - ): # default to package = None for bw compat - _DottedNameResolver.__init__(self, package) +def DottedNameResolver(package=None): + """ + .. deprecated:: 2.2 + + Please use :class:`pyramid.path.DottedNameResolver` instead. + + """ + from pyramid.path import DottedNameResolver as _DottedNameResolver + + return _DottedNameResolver(package) + + +deprecated( + 'DottedNameResolver', + ( + '`pyramid.util.DottedNameResolver` has been moved to ' + '`pyramid.path.DottedNameResolver`.' + ), +) def text_(s, encoding='latin-1', errors='strict'): diff --git a/tests/test_util.py b/tests/test_util.py index c96e7bb1f..11afe8c12 100644 --- a/tests/test_util.py +++ b/tests/test_util.py @@ -4,6 +4,41 @@ from pyramid.util import bytes_, text_ +class TestDottedNameResolver(unittest.TestCase): + def _makeOne(self, *args): + from pyramid.util import DottedNameResolver + + return DottedNameResolver(*args) + + def test_resolve(self): + """ + Test that basic resolver functionality works as expected. + """ + import tests.test_util + + resolver = self._makeOne() + result = resolver.resolve('tests.test_util') + self.assertEqual(result, tests.test_util) + + def test_package_none(self): + """ + Test that package defaults to ``None``, rather than new behavior of + ``caller_package``. + """ + resolver = self._makeOne() + self.assertRaises(ValueError, resolver.resolve, '.test_util') + + def test_package_explicit(self): + """ + Test that package argument is honored. + """ + import tests.test_util + + resolver = self._makeOne('tests') + result = resolver.resolve('.test_util') + self.assertEqual(result, tests.test_util) + + class Test_InstancePropertyHelper(unittest.TestCase): def _makeOne(self): cls = self._getTargetClass()