Commits

Mike Orr committed 5de7bac

Deprecate webhelpers.pylonslib.grid (migrate to webhelpers.html.grid).
Add Pyramid suggestions to webhelpers.pylonslib.* docstrings.

Comments (0)

Files changed (5)

   - Adjust test in 'test_date.py' to account for leap years. (#61, reported
     by Andrey Rahmatullin / wrar)
 
-* webhelpers.html.grid:
+* webhelpers.html.grid, webhelpers.pylonslib.grid:
 
    - Add 'request' and 'url_generator' args to support paged display,
-     following the latest Paginate precedent.
+     following the latest Paginate precedent. (webhelpers.html.grid only)
+   - Deprecate webhelpers.pylonslib.grid. It may be removed in a future
+     version.
   
 * webhelpers.paginate:
 

webhelpers/pylonslib/flash.py

 THE IMPLEMENTATION DEPENDS ON PYLONS.  However, it can easily be adapted
 for another web framework.
 
+PYRAMID USERS: use the flash methods built into Pyramid's ``Session`` object.
+This implementation is incompatible with Pyramid.
+
 A typical Pylons application instantiates a ``Flash`` object in 
 myapp/lib/helpers.py::
 

webhelpers/pylonslib/grid.py

 """
-**This module is experimental. API changes are expected in the next version.
-If your application depends on the current API, please copy the module into
-your application.**
+This module is DEPRECATED. Please use ``webhelpers.html.grid`` in new
+applications. Support for paged grids has been added to that module in a
+framework-neutral way.
+
+PYRAMID USERS: This implementation is incompatible with Pyramid. Use
+``webhelpers.html.grid`` instead.
 """
 
 
 from webhelpers.html.builder import HTML, literal
 import webhelpers.html.grid as grid
+from webhelpers.misc import deprecate
 
 class NoRequestError(Exception):
     pass
     """
     
     def __init__(self, request, *args, **kw):
+        deprecate("please migrate to webhelpers.html.grid")
         self.request = request
         super(PylonsGrid, self).__init__(*args, **kw)
     

webhelpers/pylonslib/minify.py

 built-in "_jsmin" package due to licensing issues; details in 
 webhelpers/pylonslib/_jsmin.py .)
 
+PYRAMID USERS: this implementation is incompatible with Pyramid. No
+Pyramid-compatible implementation is currently known.
+
 Contributed by Pedro Algarvio and Domen Kozar <ufs@ufsoft.org>.
 URL: http://docs.fubar.si/minwebhelpers/
 """

webhelpers/pylonslib/secure_form.py

 Generates form tags that include client-specific authorization tokens to be
 verified by the destined web app.
 
+PYRAMID USERS: Use the csrf_token methods built into Pyramid's ``Session``
+object.  This implementation is incompatible with Pyramid.
+
 Authorization tokens are stored in the client's session. The web app can then
 verify the request's submitted authorization token with the value in the
 client's session.
 Pylons provides an ``authenticate_form`` decorator that does this verification
 on the behalf of controllers.
 
-These helpers depend on Pylons' ``session`` object.  Most of them can be easily 
+These helpers depend on Pylons' ``session`` object.  Most of them can be easily
 ported to another framework by changing the API calls.
 
 The helpers are implemented in such a way that it should be easy to create your
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.