MapperExtension's append_result and populate_instance's docs/API are incorrect

The docs (or is it the API) for both of these extension functions are incorrect. The docs say:

If this method returns True, it is assumed that the mapper should do the appending, else
if this method returns False, it is assumed that the append was handled by this method.

The code actually expects these functions to return sqlalchemy.orm.mapper.EXT_PASS to notify the mapper should do the appending, and anything else assumes the append was handled by the extension method

There may be others that are also doing the wrong thing (probably create_instance)

Comments (4)