Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

gardening

  • Loading branch information...
commit 485ef6938f8314567ad49c16589de9e31fac383f 1 parent 8964ac5
@mcdonc mcdonc authored
Showing with 77 additions and 60 deletions.
  1. +77 −60 TODO.txt
View
137 TODO.txt
@@ -1,6 +1,81 @@
:mod:`repoze.bfg` TODOs
=======================
+Must-Have (before 1.0)
+----------------------
+
+- Test on GAE, Jython, PyPy, IronPython.
+
+- Add docs for httpexceptions module for each webob.exc class that inherits
+ from WSGIHTTPException.
+
+- Add a ``handler`` ZCML directive. This implies some slightly dicey
+ refactoring of the configurator to allow it to generate ZCML
+ "discriminators" for views and routes.
+
+- Provide a .flash API on session object.
+
+- Make default renderer work (renderer registered with no name, which is
+ active for every view unless the view names a specific renderer).
+
+- Use ``@register_view`` instead of ``@view_config`` and change view docs to
+ use "view registration" instead of "view configuration".
+
+- Remove calls to config.begin()/config.end() from startup config code in
+ tutorials and paster templates (no longer required).
+
+- SQLAlchemy idiomatics:
+
+ <RaFromBRC> mcdonc: those paster templates all look pretty good... the
+ only thing i'd consider is adjusting your config variable names to match
+ exactly what sqlalchemy uses as parameter names, see here:
+ http://www.sqlalchemy.org/docs/core/engines.html
+
+ <RaFromBRC> mcdonc: especially in the pylons_sqla ini file, where the db
+ initialization is mixed in w/ the app config...
+
+ <RaFromBRC> ... i'd use "sqlalchemy.PARAMETER" for all of the sqla
+ settings, so it could easily be handed to engine_from_config w/o any need
+ to parse by hand
+
+ <RaFromBRC> mcdonc: in the other ini files, where sqlalchemy is given its
+ own part, the "sqlalchemy." prefix probably isn't necessary, but matching
+ the parameter names (e.g. 'url' instead of 'db_string') is still probably
+ a good idea
+
+- Non-bwcompat use of threadlocals that need to be documented or ameliorated:
+
+ security.principals_allowed_by_permission
+
+ resource.OverrideProvider._get_overrides: can't credibly be removed,
+ because it stores an overrideprovider as a module-scope global.
+
+ traversal.traverse: this API is a stepchild, and needs to be changed.
+
+ Configurator.add_translation_dirs: not passed any context but a message,
+ can't credibly be removed.
+
+- Better ``config.add_handler`` documentation.
+
+Should-Have
+-----------
+
+- Create a ``docs`` directory for each paster template.
+
+- Remove "BFG" from Pyramid-specific environ variables.
+
+- translationdir ZCML directive use of ``path_spec`` should maybe die.
+
+- Add CRSF token creation/checking machinery (only "should have" vs. "must
+ have" because I'm not sure it belongs in Pyramid.. it definitely must exist
+ in formgen libraries, and *might* belong in Pyramid).
+
+- Change "Cleaning up After a Request" in the urldispatch chapter to
+ use ``request.add_response_callback``.
+
+Nice-to-Have
+------------
+
- Supply ``X-Vhm-Host`` support.
- Basic WSGI documentation (pipeline / app / server).
@@ -50,65 +125,7 @@
- Raise an exception when a value in response_headerlist is not a
string or decide to encode.
-- Change "Cleaning up After a Request" in the urldispatch chapter to
- use ``request.add_response_callback``.
-
-- Update App engine chapter.
-
-- Browser id?
-
-- .flash API on session.
-
-- CRSF token machinery
-
-- ``add_handler`` documentation.
-
-- ``handler`` ZCML directive.
-
-- ``docs`` directory for each paster template.
-
-- "BFG" in environ variables.
-
-- Test on GAE, Jython, PyPy, IronPython.
-
-- Add docs for httpexceptions.
-
-- RendererHelper -> RendererInfo?
-
-- translationdir ZCML directive use of ``path_spec`` should maybe die.
-
-- SQLAlchemy idiomatics:
-
- <RaFromBRC> mcdonc: those paster templates all look pretty good... the
- only thing i'd consider is adjusting your config variable names to match
- exactly what sqlalchemy uses as parameter names, see here:
- http://www.sqlalchemy.org/docs/core/engines.html
-
- <RaFromBRC> mcdonc: especially in the pylons_sqla ini file, where the db
- initialization is mixed in w/ the app config...
-
- <RaFromBRC> ... i'd use "sqlalchemy.PARAMETER" for all of the sqla
- settings, so it could easily be handed to engine_from_config w/o any need
- to parse by hand
-
- <RaFromBRC> mcdonc: in the other ini files, where sqlalchemy is given its
- own part, the "sqlalchemy." prefix probably isn't necessary, but matching
- the parameter names (e.g. 'url' instead of 'db_string') is still probably
- a good idea
-
-- Default renderer.
+- Update App engine chapter with less creaky directions.
-- Non-bwcompat use of threadlocals:
+- Add functionality that mocks the behavior of ``repoze.browserid``.
- security.principals_allowed_by_permission
-
- resource.OverrideProvider._get_overrides: can't credibly be removed,
- because it stores an overrideprovider as a module-scope global.
-
- traversal.traverse: this API is a stepchild, and needs to be changed.
-
- Configurator.add_translation_dirs: not passed any context but a message,
- can't credibly be removed.
-
-- Use ``@register_view`` instead of ``@view_config`` and change view docs to
- use "view registration" instead of "view configuration".
Please sign in to comment.
Something went wrong with that request. Please try again.