Pylons Changelog
=================

0.9.5 (Apr 11th, 2007)
* Fixed a Python 2.3 incompatibility with paster shell, causing the
  Exception:
  File "Pylons-0.9.5-py2.3.egg/pylons/commands.py", line 357, in command
    locs.update([(name, getattr(base, name)) for name in base_public])
  AttributeError: keys
* Fixed paster shell breaking for projects where the base package was not
  the first package listed in top_level.txt. Patch from Alberto Valverde.
  Fixes #229.
* Fixed doc references to config['app_conf']. Fixes #116.
* Changed `get_engine_conf` to properly evaluate sqlalchemy echo statement
  when its 'debug'. Fixes #226.
* make_session and create_engine now accept keyword arguments to pass to
  SQLAlchemy's create_engine.
* make_session now accepts the keyword argument 'session_kwargs' to pass
  to SQLAlchemy's create_session.
* Fixed _inspect_call to call function with keyword arguments instead of list
  args. Corrects issue with action defaults that caused the value for the 
  latter args to be in the wrong spots. Spotted by Topher. Fixes #223.
* Added the allow_none option (passed to xmlrpc.dumps) to XMLRPCController.
  Suggested by Jaroslaw Zabiello.
* Updated XMLRPC Controller with patch for name lookup and additional unit
  tests for the patch. Fixes #216.
* Updated docs for validate decorator to more clearly illustrate what the
  post_only args apply to. Fixes #221.
* Added ability to return strings in the WSGIController. Fixes #218.
* Added lazy i18n translation functions. Patch from David Smith. Fixes #181.
* Added fix for XMLRPCController system.methodHelp function and unit test.
  Patch and unit test submitted by Graham Higgins.
* Fixed bug in validate decorator with new UnicodeMultiDict response content
  not properly retaining form content as unicode for formencode's htmlfill.
* Fixed bug in XMLRPC Controller with xmlrpclib Faults not being properly
  transformed into a WSGI response within the controller.
* WARNING: Pylons now requires the decorator module: it no longer packages
  it as pylons.decorator. Code relying on the pylons.decorator.decorator
  function will trigger a deprecation warning and should be changed to use
  decorator.decorator.
* WARNING: pylons.h was deprecated for using projects' lib.helpers module
  directly in 0.9.3. pylons.h is now formally deprecated (emits
  DeprecationWarnings). Projects still accessing pylons.h must change the
  following import:
      from pylons import h
  to:
      import MYPROJ.lib.helpers as h
* pylons.jsonify and pylons.Controller references have been deprecated
  (they are misplaced references). They continue to be available at
  pylons.decorators.jsonify and pylons.controllers.Controller, as they always
  have been.
* Updated templating Buffet to recognize format parameter and properly pass it
  to the template engine.
* Updated LICENSE for new year and to indicate license covering templates
  generated. Fixes #188.
* Interactive debugger now supports Mako. After r1780 if you are using a 
  custom theme you will need to change '%(myghty_data)s' to 
  '%(template_data)s' in your template. If you are using JavaScript the tab 
  id is now "template_data".
* Fixed bug in WSGIController with private function attempts not returning a
  valid WSGI response.
* Added full unit test coverage of cache decorator.
* Adding messages binary file, enabling i18n unit tests. Updating pylons.i18n
  to import LanguageError. Fixes #193.
* Adding i18n tests, not active yet as they're waiting on a binary file from a
  patch. Refs #193.
* Updated tests so that they now work with nose, removing py.test requirement.
* Switching config setup to load keys into main config dict with app_conf and
  global_conf keys set for any code looking for those keys. Fixes #116.
* PylonsInstaller is now the default paste.app_install entry point for new
  projects: this makes Cheetah no longer required for the paster make-config
  command. (Thanks Alexander Schremmer, Ian Bicking)
* Added custom redirect_to function in pylons.helpers that will take an
  optional _response arg to pull headers and cookies out for preservation
  during a redirect. Fixes #136.
* Changed config.Config.__init__ to take all options as keyword args so
  unused args can be skipped. Fixes #162.
* The request object can now automatically decode GET/POST/params vars to
  unicode, when its charset attribute is set.
* Added a new request_settings keyword arg to Config's constructor. Allows
  setting the default charset and errors values of of the request object.
* Deprecated Config constructor's default_charset keyword arg. Use Config's
  response_settings keyword arg instead.
* Fixed paster controller to test for lib.base and only add that import 
  statement when its present. This fixes the controller template when used with
  minimal Pylons project templates. Fixes #140 and fixes #139.
* Fixed the paster shell error: KeyError: 'pylons.routes_dict' when calling
  app.get and app.post.
* Fixed paster shell not working on projects with names containing hyphens.
* Fixed the config directive 'sqlalchemy.echo' set to False being interpreted
  as True. Patch by Alex Conrad.
* Fixed paster shell not restoring CONFIG['global_conf'].

0.9.4.1 (Jan. 5th, 2007)
* Added restcontroller command that generates a RESTful controller template
  and provides the appropriate map.resource command to add. Suggested by 
  Matthew Scott.
* Fixed SQLObject pylons.database.PackageHub error:
  exceptions.NameError: global name 'CONFIG' is not defined
* Fixed pylons.database.session_context not working outside of requests
  (such as in websetup.py).
* Updated template options config to take template options for multiple 
  engines for less binding to Myghty.
* Fixed paster shell incorrectly importing the the tuple (model,) as the
  model object.

0.9.4 (Dec. 29th, 2006)
* WARNING: Removed the lang_extract and lang_compile commands. They used
  pygettext.py and its associated msgfmt.py, which lacked the ability to
  extract ngettext style function calls and had issues with unicode strings.
  The new I18NToolBox project aims to provide this functionality (and more)
  via the gettext command line utilities. http://i18ntoolbox.ufsoft.org
* All Pylons special objects are now available within paster shell (not just
  h and g).
* WARNING: Myghty's allow_globals config var has changed, causing the
  following when running pre-compiled templates:
      Error(TypeError): do_run_component() takes exactly 13 non-keyword
      arguments (5 given)
  Delete the compiled Myghty templates directory (specified by cache_dir or
  myghty_data_dir in the config file) to resolve the error.
* Changed i18n functions in templates to use proxy objects so that using
  set_lang in a template works right. Fixes #153.
* Now allowing any template plugin to overwrite global PYLONS_VARS (such as c,
  g), not just pylonsmyghty.
* Adding SQLAlchemy support to the database.py file. Saves the session engine
  to g to maintain it during the apps lifetime. Uses SessionContext plugin for
  management of the current session.
* Updated config object so that init_app can take an optional template engine
  argument to declare the default template engine.
* Updated Myghty plugin to use extra_vars_func when passed in.
* Fixed Buffet to use extra_vars_func properly.
* Fixed the validate decorator when there are validation errors and
  variable_decode=True: now passing the original params to htmlfill.render
  instead of the varable_decode'd version. Patch by FlimFlamMan.
* Added ungettext function for use with pluralized i18n, and the N_ function
  (gettext_noop) to mark global strings for translation. Added ungettext, N_
  and translator objects to be globals for templates. Refs #126.
* WARNING: The localization function '_' now uses ugettext (returns unicode
  strings) instead of gettext. To preserve the old behavior, append the
  following line to your project's lib.base and lib.helpers imports:
  from pylons.helpers import gettext as _
* Pylons special objects are now available within the interactive debugger
  (deprecating _attach_locals).
* Added setup-app run before unit tests run so that webapp has proper setup
  tasks handled. Fixes #113.
* Added paste.deploy.CONFIG setup to middleware.py, websetup.py and testing
  files in the Pylons project templates. Closes #112.
* Added security policy doc to index for use as Pylons security policy.
  Closes #91.
* Improved the repr() of the c context object to show attributes.
* Set environ['paste.testing_variables'] whenever that key is available, not
  just in testing mode.
* Added capability to have an action be a generator function.
* Added introspection capability to XMLRPCController and signature checking.
* Updated Controller to use additional arg lookup scheme so that the source of
  the function args for _inspect_call can be easily overridden.
* Updated RPCController, renamed to XMLRPCController. XMLRPCController now
  functions properly and will automatically return proper xmlrpc responses.
* Added test configuration ini file to default template. Closes #114.
* Fixed problem with pylons.database.PackageHub.__get__ raising errors
  other than AttributeError when the database isn't configured.  Added
  new UnconfiguredConnectionError exception, instead of just KeyError
  or TypeError (depending on what part of the configuration failed).
* Fixed default g init, since bare object has no init method. Reported by Ian 
  Bicking.
* Fixed issue with SQLObject method override having wrong name. Reported by
  climbus with patch. Fixes #133.
* Moved log function to pylons.helpers and translation functions to
  pylons.i18n. using pylons.util purely for Pylons internal util functions.
* WARNING: Removed 0.8.x legacy code and backwards compatibility functions.
* PylonsApp now has option to not use Routes middleware, default resolving 
  uses new wsgi.org routing_args spec.
* Refactored routes dispatching to use new Routes middleware.
* Fixed paster shell command to properly acquire mapper object without
  relying on the template being configured in a specific manner.
* Added keyword argument pool_connection to
  pylons.database.PackageHub; if set to false then SQLObject connections
  won't use pooled database connections (a new connection will be
  opened for each request).

0.9.3 (Nov 1st, 2006)
* Updated project template to support full_stack option to make it easier to
  use Pylons apps within larger WSGI stacks.
* Added deprecation warnings to legacy objects and for 1.0 functionality that
  will change.
* Added cache decorator and Cheetah template functional tests. Patch and unit
  tests provided by Climbus.
* Fixed readline support in the stock interactive console paster shell.
  Reported by Alex Conrad.
* A controller's __after__ method will now be called after actions invoke
  redirect_to (or raise any HTTPException). Reported by David Turner.
* Fixed config to use myghty_data_dir instead of cache_dir setting if its 
  set as well. Reported by Shannon -jj Behrens.
* Added traceback hiding so that more of the traceback relating to Pylons code
  is removed from the default traceback making it easier to focus on the code
  in an app that actually caused the problem. Closes #119.
* Added ability to use '_' translation method directly from templates and in
  the controller without having to use it under h._.
* Added 's' and 'l' Myghty escaping flags to default project templates. 
  Suggested by Jamie Wilkinson. Closes #110.
* Fixed SCGI bug with QUERY_STRING test when WSGI states it doesn't have to
  exist. Reported by Riklaunim.
* Added pylons_minimal template, prone to fine-tuning.
* Added option for PylonsApp to take a globals object to avoid checking a
  hardcoded path for a Globals object.
* Removed old Helpers legacy object entirely, replaced pylons.h with proper
  StackedObjectProxy. Cleaned up PylonsApp and PylonsBaseApp to accept a
  helpers reference so that Pylons can be ignorant of where the helpers came
  from.
* Fixed bug with lang app_conf option being set improperly. Reported
  by Laurent.
* Fixed pylons.h to work proper with new and old-style helper imports.
* Fixed render functions always passing disable_unicode=False to Myghty.

0.9.2 (Sept. 7th, 2006)
* Fixed problem with dashes in controller names, resolves #107.
* Updated default ini file to use localhost from address. Refs #104.
* Updated default development.ini to use a single cache_dir setting which
  is the base dir that cache files, session files, and template caching will
  be saved in. Config object now looks to cache_dir setting properly for
  Myghty templates. Fixes #104.
* Updated default template controller to provide better example of directly
  serving Myghty templates.
* Fixed legacy (0.8) controller methods' **ARGS (also m.request_args and
  pylons.params) to be of the expected mixed dictionary instead of MultiDict.
* Fixed _attach_locals not attaching g and cache objects.
* Added g object to the shell. Works as long as the Pylons app can respond
  to a path of '/'. The pylons.g variable will also be setup properly for
  use in the shell.
* Myghty template options are now passed properly to the template creation, and
  allow_globals now works to add Myghty template globals.
* Re-organized helpers, switched Helpers class to use static methods to reduce
  code duplication.
* Helpers cleanup:
    - Old-style Helper object uses StackedObjectProxy just like the new
      scheme, thus avoiding possible WSGI stack issues.
    - New project templates use new-style Helpers scheme.
    - Updated wsgiapp to utilize new Helpers cleanup style. The 'h' object
      is now friendlier to use, and maps directly to a projects lib.helpers 
      file. No more wacky Helpers object proxying to it.
    - Added translator global to __init__.py for use with new Helpers cleanup.
    - Copied Helpers function methods directly into util so they can be used
      stand-alone.
    - Deprecated h.lang (for h.set_lang/h.get_lang)
* Moved the 'default_charset' option from PylonsApp's constructor to
  Config's.
* Added 'error' controller route to the top of the Pylons template to avoid
  the common issue people discover when removing the generic default route.
* Changing validate decorator to have variable_decode option, which will
  also run formencode's variable_decode function over the form input.
* Switched to using Context obj classes instead of RequestLocal which is
  being phased out.
* Added an 'encode_variables' option to the validate decorator.
* Switched all current_obj calls to _current_obj to avoid triggering
  deprecation warnings.
* Added is_xhr to Request object in Paste.
* Bumping up dependency to latest Paste.
* Switching back to prior controller import check, throwing a more detailed
  error with a suggest fix should the user really want a URL with that name
  in it. (refs #67)
* Fixes bug with prior fix for #67. Wasn't properly testing the full package
  name to include the current project which would incorrectly restrict
  valid controller names (refs #67).
* Fixed '_method_' checking to test in a more efficient manner.
* Added deprecation warning for legacy mode activation. Not necessary to
  update multiple files, as all of legacy mode is enabled via the Legacy
  WSGI app. Fixes #89.
* Fixed controller command to check controller name and refuse to create
  controllers that have name clashes with existing modules that could be
  imported. Reported (with patch) by Chuck Adams. Fixes #67.
* Added capability for 'c' object to throw an exception when an attribute
  is used that doesn't exist. Closes #84.
* Fix for endless error document call when an error document controller
  wants to throw a error that the error_mapper catches.

0.9.1 (August 11th, 2006)
* Fixed __all__ export typo in templating.py. Added example of render
  with a template.
* Fixed issue with set_lang not using proper CONFIG var.
* Minor tweaks to update docs in pylons.helpers and move remaining legacy
  code into legacy module. Updated wsgiapp to refer to new locations of
  legacy compatibility objects.
* The interactive debugger's 'full traceback' link is now only displayed
  when the full traceback differs from the regular (includes hidden
  frames).
* Providing an optional text version of exception tracebacks and the
  associated extra data within the interactive debugger.
* The 'Debug at: http://hostname/_debug/view/XXXXX' URLs now display the
  interactive debugger properly skinned.
* Fixed issue in PasteScript with new controller sub-directories lacking a
  __init__.py file. This fixes an import error when using the controller.
  PasteScript dependency updated to fixed version. Reported by Artur Lew.
* Removed lowercasing of the module name during resolver import.
* Removed [full] recommendation from docs.

0.9 (July 28th, 2006)
* config file option 'debug' now defaults to false when undefined
* Removed the components directory from the template
* Updated paste.errordocuments support
* Fix for multi-word controller names such that front_page / 
  FrontPageController can be used as a controller name. Patch contributed
  by Timo Mihaljov.
* Cleaned up imports in wsgiapp and new project to better reflect where
  things really come from.
* Removed unnecessary myghty usage from wsgiapp for url unescaping, now
  uses urllib as the myghty function did.
* Removing 'response' to import, sticking with Response as its more
  consistent with the fact that Response is a class/factory and not an
  instance like request, and the other lower-case objects.
* Added redirect_to under pylons.helpers, and added import from helpers
  directly into lib/base.py for use in controllers.
* Consolidated legacy objects into legacy module.
* Adding abort method that raises the appropriate exception for the status
  code.
* Removing form_fill, obsolete by the validate decorator.
* Relocated 'params' object to only take effect in legacy mode.
* Updated Pylons template to use WSGIController as the new default Controller.
* Altered the wsgi dispatch to examine the controller, and instantiate it if
  it's just a class. Otherwise, if the controller is a subclass of Controller
  but not of WSGIController, it assumes its an older Controller class that
  may return a WSGIResponse, and calls it appropriately.
* Dispatch now fixes up environ to move 'path_info' Route var into the WSGI
  PATH_INFO, and the rest is pushed into SCRIPT_NAME. This is for use with
  other WSGI apps under controller mount points.
* Added WSGIController which takes a normal WSGI interface call and returns
  the appropriate WSGI response.
* Added automatic copying of Route variables declared in an action's
  function definition to the 'c' object.
* WebHelpers' .js files are now automatically published under the 
  '/javascripts/' URL path. Individual WebHelpers' .js files can be
  overridden by other .js files inside the project's 'public/javascripts'
  directory
* Added exception toss when a template engine doesn't exist.
* Added alias option to Buffet to support aliasing more template engines
  to other engine names
* Buffet enhancements to support caching of any template with any template
  engine
* All render commands processed through Buffet
* Backwards compatibility 'm' object for use with legacy projects
* Added use of Beaker middleware for session and caching functionality
* Fixed error traceback and updated template to use proper error images and
  stylesheets.

0.8.2 (**dev**)
* Fixed default controller to allow for actions with - in them. The - will be
  replaced with an underscore, while the original action name in the mapper
  dict is unchanged. Patch by Thomas Sidwick.

0.8.1 (May 10th, 2006)
* Added REST decorators and re-arranged decorator layout to support more styles
  of decorators for future expansion.
* Fixed dependency requirement bug that had Pylons locked to simplejson 1.1
  even though a newer version was out.