python/google/protobuf/pyext/cpp_message.py

   1 # Protocol Buffers - Google's data interchange format
   2 # Copyright 2008 Google Inc.  All rights reserved.
   3 # https://developers.google.com/protocol-buffers/
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions are
   7 # met:
   8 #
   9 #     * Redistributions of source code must retain the above copyright
  10 # notice, this list of conditions and the following disclaimer.
  11 #     * Redistributions in binary form must reproduce the above
  12 # copyright notice, this list of conditions and the following disclaimer
  13 # in the documentation and/or other materials provided with the
  14 # distribution.
  15 #     * Neither the name of Google Inc. nor the names of its
  16 # contributors may be used to endorse or promote products derived from
  17 # this software without specific prior written permission.
  18 #
  19 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 """Protocol message implementation hooks for C++ implementation.
  32
  33 Contains helper functions used to create protocol message classes from
  34 Descriptor objects at runtime backed by the protocol buffer C++ API.
  35 """
  36
  37 __author__ = 'tibell@google.com (Johan Tibell)'
  38
  39 from google.protobuf.pyext import _message
  40 from google.protobuf import message
  41
  42
  43 def NewMessage(bases, message_descriptor, dictionary):
  44   """Creates a new protocol message *class*."""
  45   new_bases = []
  46   for base in bases:
  47     if base is message.Message:
  48       # _message.Message must come before message.Message as it
  49       # overrides methods in that class.
  50       new_bases.append(_message.Message)
  51     new_bases.append(base)
  52   return tuple(new_bases)
  53
  54
  55 def InitMessage(message_descriptor, cls):
  56   """Constructs a new message instance (called before instance's __init__)."""
  57
  58   def SubInit(self, **kwargs):
  59     super(cls, self).__init__(message_descriptor, **kwargs)
  60   cls.__init__ = SubInit
  61   cls.AddDescriptors(message_descriptor)