Merge lp:~camptocamp/openobject-server/trunk-deprecate-osv_osv into lp:openobject-server

[Alexandre Fayolle - camptocamp]

use warnings to flag deprecated features

* adds a deprecated decorator to flag methods and functions
* added a new metaclass for deprecated models (osv.osv, osv.osv_memory...)
* use warnings.warn explicitely in some parts of the core framework where comments told that something was deprecated
* added a new command line option to direct the warnings to the logs (default), stderr or hide them completely

[lp:~camptocamp/openobject-server/trunk-deprecate-osv_osv]

4447. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-09-21

[MRG] from trunk

4448. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-10-03

[MRG] from trunk

[Alexandre Fayolle - camptocamp (alexandre-fayolle-c2c)]

updated the MP to the lastest trunk

[lp:~camptocamp/openobject-server/trunk-deprecate-osv_osv]

4449. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-12-20

[MRG] updated to current trunk

4450. By Alexandre Fayolle - camptocamp on 2012-12-20

[MRG] updated to latest trunk

[Alexandre Fayolle - camptocamp (alexandre-fayolle-c2c)]

updated MP to latest trunk

Unmerged revisions

4450. By Alexandre Fayolle - camptocamp on 2012-12-20

[MRG] updated to latest trunk

4449. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-12-20

[MRG] updated to current trunk

4448. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-10-03

[MRG] from trunk

4447. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-09-21

[MRG] from trunk

4446. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-09-18

[FIX] do not regiser the deprecated base classes

4445. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-09-18

[IMP] add some DeprecationWarnings where comments say a method/class is deprecated

4444. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-09-18

[FIX] move deprecated_model metaclass from tools.deprecate to osv.orm

this avoids circular imports via osv.osv

4443. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-09-18

[IMP] control the display of DeprecationWarning from the command line

4442. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-09-18

[FIX] fix the deprecation warning in osv.osv

4441. By Alexandre Fayolle @ camptocamp <email address hidden> on 2012-09-17

[IMP] added openerp.tools.deprecate with some utilities to deprecate classes and methods
use these utilities to deprecate osv.osv, osv.osv_memory and osv.osv_abstract

=== modified file 'openerp/loglevels.py'
--- openerp/loglevels.py	2012-12-14 13:07:58 +0000
+++ openerp/loglevels.py	2012-12-20 14:32:31 +0000
@@ -21,6 +21,7 @@
 
 import sys
 import logging
+from openerp.tools.deprecate import deprecated
 
 LOG_NOTSET = 'notset'
 LOG_DEBUG = 'debug'
@@ -41,11 +42,9 @@
             "The netsvc.Logger API shouldn't be used anymore, please "
             "use the standard `logging.getLogger` API instead.")
         super(Logger, self).__init__()
-
+    @deprecated("notifyChannel API shouldn't be used anymore, please use "
+            "the standard `logging` module instead.")
     def notifyChannel(self, name, level, msg):
-        _logger.warning(
-            "notifyChannel API shouldn't be used anymore, please use "
-            "the standard `logging` module instead.")
         from service.web_services import common
 
         log = logging.getLogger(__name__ + '.deprecated.' + ustr(name))

=== modified file 'openerp/modules/module.py'
--- openerp/modules/module.py	2012-12-16 19:39:32 +0000
+++ openerp/modules/module.py	2012-12-20 14:32:31 +0000
@@ -27,6 +27,7 @@
 import sys
 import types
 import zipimport
+import warnings
 
 import openerp.tools as tools
 import openerp.tools.osutil as osutil
@@ -312,6 +313,9 @@
     terp_file = get_module_resource(module, '__openerp__.py')
     if not terp_file:
         terp_file = get_module_resource(module, '__terp__.py')
+        warnings.warn('__terp__.py is deprecated. Use __openerp__.py (%s)' % terp_file,
+                      DeprecationWarning)
+
     mod_path = get_module_path(module)
     if terp_file:
         info = {}

=== modified file 'openerp/netsvc.py'
--- openerp/netsvc.py	2012-12-10 13:21:33 +0000
+++ openerp/netsvc.py	2012-12-20 14:32:31 +0000
@@ -35,6 +35,7 @@
 import time
 import types
 from pprint import pformat
+import warnings
 
 # TODO modules that import netsvc only for things from loglevels must be changed to use loglevels.
 from loglevels import *
@@ -232,6 +233,12 @@
     for logconfig_item in default_config + pseudo_config + logconfig:
         _logger.debug('logger level set: "%s"', logconfig_item)
 
+    if tools.config['deprecation_warnings'] == 'show':
+        warnings.filterwarnings('default', category=DeprecationWarning)
+    elif tools.config['deprecation_warnings'] == 'log':
+        warnings.filterwarnings('default', category=DeprecationWarning)
+        logging.captureWarnings(True)
+
 # A alternative logging scheme for automated runs of the
 # server intended to test it.
 def init_alternative_logger():

=== modified file 'openerp/osv/fields.py'
--- openerp/osv/fields.py	2012-12-19 09:36:55 +0000
+++ openerp/osv/fields.py	2012-12-20 14:32:31 +0000
@@ -42,6 +42,7 @@
 import re
 import xmlrpclib
 from psycopg2 import Binary
+import warnings
 
 import openerp
 import openerp.tools as tools
@@ -164,10 +165,11 @@
     def __init__(self, string='unknown', required=False, **args):
         super(boolean, self).__init__(string=string, required=required, **args)
         if required:
-            _logger.debug(
+            warnings.warn(
                 "required=True is deprecated: making a boolean field"
                 " `required` has no effect, as NULL values are "
-                "automatically turned into False. args: %r",args)
+                "automatically turned into False.  args: %r" % args,
+                DeprecationWarning, stacklevel=2)
 
 class integer(_column):
     _type = 'integer'
@@ -695,9 +697,10 @@
         for id in ids:
             res[id] = []
         if offset:
-            _logger.warning(
+            warnings.warn(
                 "Specifying offset at a many2many.get() is deprecated and may"
-                " produce unpredictable results.")
+                " produce unpredictable results.",
+                DeprecationWarning, stacklevel=2)
         obj = model.pool.get(self._obj)
         rel, id1, id2 = self._sql_names(model)
 

=== modified file 'openerp/osv/orm.py'
--- openerp/osv/orm.py	2012-12-18 22:39:59 +0000
+++ openerp/osv/orm.py	2012-12-20 14:32:31 +0000
@@ -58,6 +58,7 @@
 
 import psycopg2
 from lxml import etree
+import warnings
 
 import fields
 import openerp
@@ -67,6 +68,7 @@
 from openerp.tools.misc import CountingStream
 from openerp.tools.safe_eval import safe_eval as eval
 from openerp.tools.translate import _
+from openerp.tools.deprecate import deprecated
 from openerp import SUPERUSER_ID
 from query import Query
 
@@ -333,7 +335,6 @@
         self._cr = cr
         self._uid = uid
         self._id = id
-        self._table = table # deprecated, use _model!
         self._model = table
         self._table_name = self._table._name
         self.__logger = logging.getLogger('openerp.osv.orm.browse_record.' + self._table_name)
@@ -353,6 +354,11 @@
 
         self._cache = cache
 
+    @property
+    def _table(self):
+        warnings.warn('_table is deprecated. Use _model', DeprecationWarning, stacklevel=2)
+        return self._model
+
     def __getitem__(self, name):
         if name == 'id':
             return self._id
@@ -376,10 +382,8 @@
                 else:
                     return attr
             else:
-                error_msg = "Field '%s' does not exist in object '%s'" % (name, self)
+                error_msg = "Field '%s' does not exist in object '%s'" % (name, self) 
                 self.__logger.warning(error_msg)
-                if self.__logger.isEnabledFor(logging.DEBUG):
-                    self.__logger.debug(''.join(traceback.format_stack()))
                 raise KeyError(error_msg)
 
             # if the field is a classic one or a many2one, we'll fetch all classic and many2one fields
@@ -714,9 +718,11 @@
 
     CONCURRENCY_CHECK_FIELD = '__last_update'
 
+    @deprecated("log() is deprecated. Please use OpenChatter notification "
+                "system instead of the res.log mechanism.")
     def log(self, cr, uid, id, message, secondary=False, context=None):
-        return _logger.warning("log() is deprecated. Please use OpenChatter notification system instead of the res.log mechanism.")
-
+        return
+    
     def view_init(self, cr, uid, fields_list, context=None):
         """Override this method to do specific things when a view on the object is opened."""
         pass
@@ -2059,7 +2065,9 @@
         """
         if context is None:
             context = {}
-
+        if submenu:
+            warnings.warn('using the submenu named argument in Model.fields_view_get is deprecated',
+                          DeprecationWarning, stacklevel=2)
         def encode(s):
             if isinstance(s, unicode):
                 return s.encode('utf8')
@@ -3735,7 +3743,8 @@
         for f in list(fields_pre) + list(fields_post):
             field_column = self._all_columns.get(f) and self._all_columns.get(f).column
             if field_column and field_column.deprecated:
-                _logger.warning('Field %s.%s is deprecated: %s', self._name, f, field_column.deprecated)
+                warnings.warn('Field %s.%s is deprecated: %s' % (self._name, f, field_column.deprecated),
+                              DeprecationWarning, stacklevel=2)
 
         readonly = None
         for vals in res:
@@ -4124,7 +4133,9 @@
         for field in vals:
             field_column = self._all_columns.get(field) and self._all_columns.get(field).column
             if field_column and field_column.deprecated:
-                _logger.warning('Field %s.%s is deprecated: %s', self._name, field, field_column.deprecated)
+                warnings.warn('Field %s.%s is deprecated: %s' % (self._name, field,
+                                                                 field_column.deprecated),
+                              DeprecationWarning, stacklevel=2)
             if field in self._columns:
                 if self._columns[field]._classic_write and not (hasattr(self._columns[field], '_fnct_inv')):
                     if (not totranslate) or not self._columns[field].translate:
@@ -5038,9 +5049,9 @@
         cr.execute(query + "WHERE ID IN %s", (tuple(ids),))
         return [x[0] for x in cr.fetchall()]
 
+    @deprecated("You are using deprecated Model.check_recursion(). "
+                "Please use '_check_recursion()' instead!")
     def check_recursion(self, cr, uid, ids, context=None, parent=None):
-        _logger.warning("You are using deprecated %s.check_recursion(). Please use the '_check_recursion()' instead!" % \
-                        self._name)
         assert parent is None or parent in self._columns or parent in self._inherit_fields,\
                     "The 'parent' parameter passed to check_recursion() must be None or a valid field name"
         return self._check_recursion(cr, uid, ids, context, parent)
@@ -5282,12 +5293,24 @@
     if len(items) == 1:
         return lambda gettable: (gettable[items[0]],)
     return operator.itemgetter(*items)
+
 class ImportWarning(Warning):
     """ Used to send warnings upwards the stack during the import process
     """
     pass
 
 
+class deprecated_model(MetaModel):
+    """issues a DeprecationWarning when the class is used as a parent class
+    """
+    def __new__(meta, name, bases, attrs):
+        for b in bases:
+            if isinstance(b, deprecated_model):
+                warning =  getattr(b, '__deprecation_warning__', '%(class)s is deprecated')
+                warnings.warn(warning % {'class': name}, DeprecationWarning, stacklevel=2)
+        return super(deprecated_model, meta).__new__(meta, name, bases, attrs)
+
+
 def convert_pgerror_23502(model, fields, info, e):
     m = re.match(r'^null value in column "(?P<field>\w+)" violates '
                  r'not-null constraint\n',

=== modified file 'openerp/osv/osv.py'
--- openerp/osv/osv.py	2012-12-09 03:49:10 +0000
+++ openerp/osv/osv.py	2012-12-20 14:32:31 +0000
@@ -26,6 +26,7 @@
 import threading
 
 from psycopg2 import IntegrityError, errorcodes
+import warnings
 
 import orm
 import openerp
@@ -33,7 +34,7 @@
 import openerp.pooler as pooler
 import openerp.sql_db as sql_db
 from openerp.tools.translate import translate
-from openerp.osv.orm import MetaModel, Model, TransientModel, AbstractModel
+from openerp.osv.orm import MetaModel, Model, TransientModel, AbstractModel, deprecated_model
 import openerp.exceptions
 
 _logger = logging.getLogger(__name__)
@@ -41,6 +42,7 @@
 # Deprecated.
 class except_osv(Exception):
     def __init__(self, name, value):
+        warnings.warn('except_osv is deprecated', DeprecationWarning, stacklevel=2)
         self.name = name
         self.value = value
         self.args = (name, value)
@@ -208,11 +210,19 @@
             cr.close()
         return res
 
-# deprecated - for backward compatibility.
-osv = Model
-osv_memory = TransientModel
-osv_abstract = AbstractModel # ;-)
-
+# deprecated - for backward compatibility
+class osv(Model):
+    __metaclass__ = deprecated_model
+    __deprecation_warning__ = "osv.osv is deprecated. Use orm.Model"
+    _register=False
+class osv_memory(TransientModel):
+    __metaclass__ = deprecated_model
+    __deprecation_warning__ = "osv.osv_memory is deprecated. Use orm.TransientModel"
+    _register=False
+class osv_abstract(AbstractModel):
+    __metaclass__ = deprecated_model
+    __deprecation_warning__ = "osv.osv_abstract is deprecated. Use orm.AbstractModel"
+    _register=False
 
 def start_object_proxy():
     object_proxy()

=== modified file 'openerp/sql_db.py'
--- openerp/sql_db.py	2012-12-14 12:43:10 +0000
+++ openerp/sql_db.py	2012-12-20 14:32:31 +0000
@@ -37,11 +37,13 @@
 
 from functools import wraps
 import logging
+import warnings
 import psycopg2.extensions
 from psycopg2.extensions import ISOLATION_LEVEL_AUTOCOMMIT, ISOLATION_LEVEL_READ_COMMITTED, ISOLATION_LEVEL_REPEATABLE_READ
 from psycopg2.pool import PoolError
 from psycopg2.psycopg1 import cursor as psycopg1cursor
 from threading import currentThread
+from openerp.tools.deprecate import deprecated
 
 psycopg2.extensions.register_type(psycopg2.extensions.UNICODE)
 
@@ -476,13 +478,14 @@
         _logger.debug('create %scursor to %r', cursor_type, self.dbname)
         return Cursor(self._pool, self.dbname, serialized=serialized)
 
-    # serialized_cursor is deprecated - cursors are serialized by default
-    serialized_cursor = cursor
+    @deprecated("serialized_cursor is deprecated - cursors are serialized by default")
+    def serialized_cursor(self):
+        return self.cursor()
 
+    @deprecated("__nonzero__() is deprecated. (It is too expensive to test a connection.)")
     def __nonzero__(self):
         """Check if connection is possible"""
         try:
-            _logger.warning("__nonzero__() is deprecated. (It is too expensive to test a connection.)")
             cr = self.cursor()
             cr.close()
             return True

=== modified file 'openerp/tools/config.py'
--- openerp/tools/config.py	2012-12-20 10:15:11 +0000
+++ openerp/tools/config.py	2012-12-20 14:32:31 +0000
@@ -187,6 +187,9 @@
         group.add_option('--log-response', action="append_const", dest="log_handler", const="openerp.netsvc.rpc.response:DEBUG", help='shortcut for --log-handler=openerp.netsvc.rpc.response:DEBUG')
         group.add_option('--log-web', action="append_const", dest="log_handler", const="openerp.addons.web.http:DEBUG", help='shortcut for --log-handler=openerp.addons.web.http:DEBUG')
         group.add_option('--log-sql', action="append_const", dest="log_handler", const="openerp.sql_db:DEBUG", help='shortcut for --log-handler=openerp.sql_db:DEBUG')
+        group.add_option('--deprecation-warnings', metavar='<log|stderr|hide>',
+                         default='log', dest="deprecation_warnings",
+                         help="log deprecation warnings (default), print them on stderr, or hide them altogether")
         # For backward-compatibility, map the old log levels to something
         # quite close.
         levels = ['info', 'debug_rpc', 'warn', 'test', 'critical',
@@ -384,7 +387,8 @@
                 'netrpc', 'xmlrpc', 'syslog', 'without_demo', 'timezone',
                 'xmlrpcs_interface', 'xmlrpcs_port', 'xmlrpcs',
                 'static_http_enable', 'static_http_document_root', 'static_http_url_prefix',
-                'secure_cert_file', 'secure_pkey_file', 'dbfilter', 'log_handler', 'log_level'
+                'secure_cert_file', 'secure_pkey_file', 'dbfilter', 'log_handler', 'log_level',
+                'deprecation_warnings',
                 ]
 
         for arg in keys:

=== modified file 'openerp/tools/convert.py'
--- openerp/tools/convert.py	2012-12-17 14:47:53 +0000
+++ openerp/tools/convert.py	2012-12-20 14:32:31 +0000
@@ -25,6 +25,7 @@
 import os.path
 import pickle
 import re
+import warnings
 
 # for eval context:
 import time
@@ -838,7 +839,8 @@
             raise Exception( "Mismatch xml format: only terp or openerp as root tag" )
 
         if de.tag == 'terp':
-            _logger.warning("The tag <terp/> is deprecated, use <openerp/>")
+            warnings.warn("The tag <terp/> is deprecated, use <openerp/>",
+                          DeprecationWarning, stacklevel=2)
 
         for n in de.findall('./data'):
             for rec in n:

=== added file 'openerp/tools/deprecate.py'
--- openerp/tools/deprecate.py	1970-01-01 00:00:00 +0000
+++ openerp/tools/deprecate.py	2012-12-20 14:32:31 +0000
@@ -0,0 +1,19 @@
+
+from warnings import warn
+import openerp
+
+
+
+def deprecated(message=None, name=None):
+    def decorator(func):
+        if message is None:
+            msg = 'the function %s is deprecated' % func.func_name
+        else:
+            msg = message
+        def wrapper(*args, **kwargs):
+            warn(msg, DeprecationWarning, stacklevel=2)
+            return func(*args, **kwargs)
+        wrapper.__name__ = name or func.__name__
+        wrapper.__doc__ = func.__doc__
+        return wrapper
+    return decorator

=== modified file 'openerp/tools/misc.py'
--- openerp/tools/misc.py	2012-12-17 15:02:41 +0000
+++ openerp/tools/misc.py	2012-12-20 14:32:31 +0000
@@ -36,6 +36,7 @@
 import threading
 import time
 import zipfile
+import warnings
 from collections import defaultdict
 from datetime import datetime
 from itertools import islice, izip
@@ -48,6 +49,7 @@
 except ImportError:
     html2text = None
 
+from openerp.tools.deprecate import deprecated
 from config import config
 from cache import *
 
@@ -410,6 +412,8 @@
     """
 
     def __init__(self, value, accuracy=2, rounding=None):
+        warnings.warn('Use res.currency.round instead of currency',
+                      DeprecationWarning, stacklevel=2)
         if rounding is None:
             rounding=10**-accuracy
         self.rounding=rounding