From 111a6fbae020f99c206b97459920908baad604cd Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 16 Nov 2010 18:17:54 -0500 Subject: - Add deprecation warnings to import of ``pyramid.chameleon_text`` and ``pyramid.chameleon_zpt`` of ``get_renderer``, ``get_template``, ``render_template``, and ``render_template_to_response``. --- CHANGES.txt | 7 +++++++ TODO.txt | 3 --- pyramid/chameleon_text.py | 23 +++++++++++++++++++++++ pyramid/chameleon_zpt.py | 22 ++++++++++++++++++++++ pyramid/tests/test_chameleon_text.py | 4 ++++ pyramid/tests/test_chameleon_zpt.py | 4 ++++ 6 files changed, 60 insertions(+), 3 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index 7dee3f99d..f25d0e83f 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -1,6 +1,13 @@ Next release ============ +Bug Fixes +--------- + +- Add deprecation warnings to import of ``pyramid.chameleon_text`` and + ``pyramid.chameleon_zpt`` of ``get_renderer``, ``get_template``, + ``render_template``, and ``render_template_to_response``. + 1.0a3 (2010-11-16) ================== diff --git a/TODO.txt b/TODO.txt index afe9e8532..33d39a825 100644 --- a/TODO.txt +++ b/TODO.txt @@ -120,9 +120,6 @@ - Add deprecation warnings for: - - Use of chameleon_zpt and chameleon_text templating functions (use - renderer API instead). - - settings.get_settings - zcml.zcml_configure diff --git a/pyramid/chameleon_text.py b/pyramid/chameleon_text.py index 1f31f3add..f8d96ddf5 100644 --- a/pyramid/chameleon_text.py +++ b/pyramid/chameleon_text.py @@ -1,5 +1,6 @@ import sys +from zope.deprecation import deprecated from zope.interface import implements try: @@ -80,6 +81,11 @@ def get_renderer(path): factory = renderers.RendererHelper(path, package=package) return factory.get_renderer() +deprecated( + 'get_renderer', + '(pyramid.chameleon_text.get_renderer is deprecated ' + 'as of Pyramid 1.0; instead use pyramid.renderers.get_renderer)') + def get_template(path): """ Return the underyling object representing a :term:`Chameleon` text template using the template implied by the ``path`` argument. @@ -94,6 +100,12 @@ def get_template(path): factory = renderers.RendererHelper(path, package=package) return factory.get_renderer().implementation() +deprecated( + 'render_template', + '(pyramid.chameleon_text.render_template is deprecated ' + 'as of Pyramid 1.0; instead use ' + 'pyramid.renderers.get_renderer().implementation())') + def render_template(path, **kw): """ Render a :term:`Chameleon` text template using the template implied by the ``path`` argument. The ``path`` argument may be a @@ -110,6 +122,11 @@ def render_template(path, **kw): renderer = renderers.RendererHelper(path, package=package) return renderer.render(kw, None, request=request) +deprecated( + 'render_template', + '(pyramid.chameleon_text.render_template is deprecated ' + 'as of Pyramid 1.0; instead use pyramid.renderers.render)') + def render_template_to_response(path, **kw): """ Render a :term:`Chameleon` text template using the template implied by the ``path`` argument. The ``path`` argument may be a @@ -126,3 +143,9 @@ def render_template_to_response(path, **kw): request = kw.pop('request', None) renderer = renderers.RendererHelper(path, package=package) return renderer.render_to_response(kw, None, request=request) + +deprecated( + 'render_template_to_response', + '(pyramid.chameleon_text.render_template_to_response is deprecated ' + 'as of Pyramid 1.0; instead use pyramid.renderers.render_to_response)') + diff --git a/pyramid/chameleon_zpt.py b/pyramid/chameleon_zpt.py index 6aae59a87..55bef1d0c 100644 --- a/pyramid/chameleon_zpt.py +++ b/pyramid/chameleon_zpt.py @@ -1,6 +1,7 @@ import sys import threading +from zope.deprecation import deprecated from zope.interface import implements try: @@ -65,6 +66,11 @@ def get_renderer(path): factory = renderers.RendererHelper(name=path, package=package) return factory.get_renderer() +deprecated( + 'get_renderer', + '(pyramid.chameleon_zpt.get_renderer is deprecated ' + 'as of Pyramid 1.0; instead use pyramid.renderers.get_renderer)') + def get_template(path): """ Return the underyling object representing a :term:`Chameleon` ZPT template using the template implied by the ``path`` argument. @@ -79,6 +85,12 @@ def get_template(path): factory = renderers.RendererHelper(name=path, package=package) return factory.get_renderer().implementation() +deprecated( + 'get_template', + '(pyramid.chameleon_zpt.get_template is deprecated ' + 'as of Pyramid 1.0; instead use ' + 'pyramid.renderers.get_renderer().implementation())') + def render_template(path, **kw): """ Render a :term:`Chameleon` ZPT template using the template implied by the ``path`` argument. The ``path`` argument may be a @@ -95,6 +107,11 @@ def render_template(path, **kw): renderer = renderers.RendererHelper(name=path, package=package) return renderer.render(kw, None, request=request) +deprecated( + 'render_template', + '(pyramid.chameleon_zpt.render_template is deprecated as of Pyramid 1.0; ' + 'instead use pyramid.renderers.render)') + def render_template_to_response(path, **kw): """ Render a :term:`Chameleon` ZPT template using the template implied by the ``path`` argument. The ``path`` argument may be a @@ -111,3 +128,8 @@ def render_template_to_response(path, **kw): request = kw.pop('request', None) renderer = renderers.RendererHelper(name=path, package=package) return renderer.render_to_response(kw, None, request=request) + +deprecated( + 'render_template', + '(pyramid.chameleon_zpt.render_template_to_response is deprecated; as of ' + 'Pyramid 1.0, instead use pyramid.renderers.render_to_response)') diff --git a/pyramid/tests/test_chameleon_text.py b/pyramid/tests/test_chameleon_text.py index a42b92bfa..027fa9474 100644 --- a/pyramid/tests/test_chameleon_text.py +++ b/pyramid/tests/test_chameleon_text.py @@ -11,9 +11,13 @@ class Base: os.unlink(self._getTemplatePath('minimal.txt.py')) except: pass + from zope.deprecation import __show__ + __show__.off() def tearDown(self): cleanUp() + from zope.deprecation import __show__ + __show__.on() def _getTemplatePath(self, name): import os diff --git a/pyramid/tests/test_chameleon_zpt.py b/pyramid/tests/test_chameleon_zpt.py index 8f0b3f03c..3e508ce6a 100644 --- a/pyramid/tests/test_chameleon_zpt.py +++ b/pyramid/tests/test_chameleon_zpt.py @@ -5,9 +5,13 @@ from pyramid.testing import cleanUp class Base(object): def setUp(self): cleanUp() + from zope.deprecation import __show__ + __show__.off() def tearDown(self): cleanUp() + from zope.deprecation import __show__ + __show__.on() def _getTemplatePath(self, name): import os -- cgit v1.2.3