t_py_generator.cc

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#include <string>
#include <fstream>
#include <iostream>
#include <vector>

#include <stdlib.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sstream>
#include <algorithm>
#include "t_generator.h"
#include "platform.h"
#include "version.h"

#ifdef SANDESH
#include <cassert>
#include "boost/tuple/tuple.hpp"
#endif
using namespace std;


class t_py_generator : public t_generator {
 public:
  t_py_generator(
      t_program* program,
      const std::map<std::string, std::string>& parsed_options,
      const std::string& option_string)
    : t_generator(program)
  {
    (void) option_string;
    std::map<std::string, std::string>::const_iterator iter;

    iter = parsed_options.find("new_style");
    gen_newstyle_ = (iter != parsed_options.end());

    iter = parsed_options.find("slots");
    gen_slots_ = (iter != parsed_options.end());

    iter = parsed_options.find("dynamic");
    gen_dynamic_ = (iter != parsed_options.end());

    if (gen_dynamic_) {
      gen_newstyle_ = 0; // dynamic is newstyle
      gen_dynbaseclass_ = "TBase";
      gen_dynbaseclass_exc_ = "TExceptionBase";
      import_dynbase_ = "from thrift.protocol.TBase import TBase, TExceptionBase\n";
    }

    iter = parsed_options.find("dynbase");
    if (iter != parsed_options.end()) {
      gen_dynbase_ = true;
      gen_dynbaseclass_ = (iter->second);
    }

    iter = parsed_options.find("dynexc");
    if (iter != parsed_options.end()) {
      gen_dynbaseclass_exc_ = (iter->second);
    }

    iter = parsed_options.find("dynimport");
    if (iter != parsed_options.end()) {
      gen_dynbase_ = true;
      import_dynbase_ = (iter->second);
    }

    iter = parsed_options.find("twisted");
    gen_twisted_ = (iter != parsed_options.end());

    iter = parsed_options.find("utf8strings");
    gen_utf8strings_ = (iter != parsed_options.end());

    copy_options_ = option_string;

    if (gen_twisted_){
      out_dir_base_ = "gen-py.twisted";
    } else {
      out_dir_base_ = "gen-py";
    }
  }

  void init_generator();
  void close_generator();

  void generate_typedef  (t_typedef*  ttypedef);
  void generate_enum     (t_enum*     tenum);
  void generate_const    (t_const*    tconst);
  void generate_struct   (t_struct*   tstruct);
  void generate_xception (t_struct*   txception);
  void generate_service  (t_service*  tservice);
#ifdef SANDESH
  void generate_sandesh  (t_sandesh* tsandesh);
#endif
  std::string render_const_value(t_type* type, t_const_value* value);

  void generate_py_struct(t_struct* tstruct, bool is_exception);
  void generate_py_struct_definition(std::ofstream& out, t_struct* tstruct, bool is_xception=false, bool is_result=false);
  void generate_py_struct_reader(std::ofstream& out, t_struct* tstruct);
  void generate_py_struct_writer(std::ofstream& out, t_struct* tstruct);
  void generate_py_struct_required_validator(std::ofstream& out, t_struct* tstruct);
  void generate_py_function_helpers(t_function* tfunction);
#ifdef SANDESH
  void generate_py_struct_logger(std::ofstream& out, t_struct* tstruct);
  void generate_py_struct_sizeof(std::ofstream& out, t_struct* tstruct);
#endif

#ifdef SANDESH
  void generate_py_sandesh(t_sandesh *tsandesh);
  void generate_py_sandesh_definition(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_reader(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_writer(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_compare(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_required_validator(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_http_request_handler(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_http_attr(ofstream& out,
        t_type *ftype, const std::string& namel, const std::string& namer);
  void generate_py_sandesh_skeleton_request(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_request_list(std::ofstream& out);
  void generate_py_sandesh_http_request_list(std::ofstream& out, t_sandesh* tsandesh);
  void generate_struct_log(std::ofstream& out, std::string prefix, std::string log_str);
  void generate_container_log(std::ofstream& out, std::string prefix, t_type* ttype, string log_str);
  void generate_field_log(std::ofstream& out, t_field *tfield, std::string log_str, std::string prefix);
  void generate_py_sandesh_logger(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_hint(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_async(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_request(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_response(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_uve(std::ofstream& out, t_sandesh* tsandesh, bool update);
  void generate_py_sandesh_uve_list(std::ofstream& out);
  void generate_py_sandesh_alarm_list(std::ofstream& out);
  void generate_py_sandesh_trace(std::ofstream& out, t_sandesh* tsandesh);
  void generate_py_sandesh_sizeof(std::ofstream& out, t_sandesh* tsandesh);
#endif

#ifdef SANDESH
  void generate_py_sizeof(std::ofstream& out, const vector<t_field*>& fields);
#endif

  void generate_service_helpers   (t_service*  tservice);
  void generate_service_interface (t_service* tservice);
  void generate_service_client    (t_service* tservice);
  void generate_service_remote    (t_service* tservice);
  void generate_service_server    (t_service* tservice);
  void generate_process_function  (t_service* tservice, t_function* tfunction);

  void generate_deserialize_field        (std::ofstream &out,
                                          t_field*    tfield,
                                          std::string prefix="",
                                          bool inclass=false);

  void generate_deserialize_struct       (std::ofstream &out,
                                          t_struct*   tstruct,
                                          std::string prefix="");

  void generate_deserialize_container    (std::ofstream &out,
                                          t_type*     ttype,
                                          std::string prefix="");

  void generate_deserialize_set_element  (std::ofstream &out,
                                          t_set*      tset,
                                          std::string prefix="");

  void generate_deserialize_map_element  (std::ofstream &out,
                                          t_map*      tmap,
                                          std::string prefix="");

  void generate_deserialize_list_element (std::ofstream &out,
                                          t_list*     tlist,
                                          std::string prefix="");

  void generate_serialize_field          (std::ofstream &out,
                                          t_field*    tfield,
                                          std::string prefix="");

  void generate_serialize_struct         (std::ofstream &out,
                                          t_struct*   tstruct,
                                          std::string prefix="");

#ifdef SANDESH
  void generate_serialize_sandesh        (std::ofstream &out,
                                          t_sandesh*   tsandesh,
                                          std::string prefix="");
#endif

  void generate_serialize_container      (std::ofstream &out,
                                          t_type*     ttype,
                                          std::string prefix="");

  void generate_serialize_map_element    (std::ofstream &out,
                                          t_map*      tmap,
                                          std::string kiter,
                                          std::string viter);

  void generate_serialize_set_element    (std::ofstream &out,
                                          t_set*      tmap,
                                          std::string iter);

  void generate_serialize_list_element   (std::ofstream &out,
                                          t_list*     tlist,
                                          std::string iter);

  void generate_python_docstring         (std::ofstream& out,
                                          t_struct* tstruct);

  void generate_python_docstring         (std::ofstream& out,
                                          t_function* tfunction);

  void generate_python_docstring         (std::ofstream& out,
                                          t_doc*    tdoc,
                                          t_struct* tstruct,
                                          const char* subheader);

  void generate_python_docstring         (std::ofstream& out,
                                          t_doc* tdoc);

  std::string py_autogen_comment();
  std::string future_imports();
#ifdef SANDESH
  std::string py_autogen_sandesh_request_skeleton_comment();
  void py_autogen_sandesh_http_request_open(std::ofstream& out);
  void py_autogen_sandesh_http_request_close(std::ofstream& out);
#endif
  std::string py_imports();
  std::string render_includes();
  std::string render_fastbinary_includes();
#ifdef SANDESH
  std::string render_sandesh_includes();
#endif
  std::string declare_argument(t_field* tfield);
  std::string render_field_default_value(t_field* tfield);
  std::string type_name(t_type* ttype);
  std::string function_signature(t_function* tfunction, std::string prefix="");
  std::string function_signature_if(t_function* tfunction, std::string prefix="");
  std::string argument_list(t_struct* tstruct);
  std::string type_to_enum(t_type* ttype);
  std::string type_to_spec_args(t_type* ttype);

  static bool is_valid_namespace(const std::string& sub_namespace) {
    return sub_namespace == "twisted";
  }

  static std::string get_real_py_module(const t_program* program, bool gen_twisted) {
    if(gen_twisted) {
      std::string twisted_module = program->get_namespace("py.twisted");
      if(!twisted_module.empty()){
        return twisted_module;
      }
    }

    std::string real_module = program->get_namespace("py");
    if (real_module.empty()) {
      return program->get_name();
    }
    return real_module;
  }

 private:

  bool gen_newstyle_;

  bool gen_dynamic_;

  bool gen_dynbase_;
  std::string gen_dynbaseclass_;
  std::string gen_dynbaseclass_exc_;

  std::string import_dynbase_;

  bool gen_slots_;

  std::string copy_options_;

  bool gen_twisted_;

  bool gen_utf8strings_;

#ifdef SANDESH

  std::vector<std::string> sandesh_req_list_;

  std::vector<boost::tuple<std::string, std::string> > sandesh_uve_list_;

  std::vector<boost::tuple<std::string, std::string> > sandesh_alarm_list_;
#endif

  std::ofstream f_types_;
  std::ofstream f_consts_;
  std::ofstream f_service_;
#ifdef SANDESH
  std::ofstream f_request_impl_;
  std::ofstream f_http_request_;
#endif

  std::string package_dir_;

};


void t_py_generator::init_generator() {
  // Make output directory
  string module = get_real_py_module(program_, gen_twisted_);
  package_dir_ = get_out_dir();
  while (true) {
    // TODO: Do better error checking here.
    MKDIR(package_dir_.c_str());
    std::ofstream init_py((package_dir_+"/__init__.py").c_str());
    init_py.close();
    if (module.empty()) {
      break;
    }
    string::size_type pos = module.find('.');
    if (pos == string::npos) {
      package_dir_ += "/";
      package_dir_ += module;
      module.clear();
    } else {
      package_dir_ += "/";
      package_dir_ += module.substr(0, pos);
      module.erase(0, pos+1);
    }
  }

  // Make output file
  string f_types_name = package_dir_+"/"+"ttypes.py";
  f_types_.open(f_types_name.c_str());

  string f_consts_name = package_dir_+"/"+"constants.py";
  f_consts_.open(f_consts_name.c_str());

  string f_init_name = package_dir_+"/__init__.py";
  ofstream f_init;
  f_init.open(f_init_name.c_str());
  f_init  <<
    "__all__ = ['ttypes', 'constants'";
  vector<t_service*> services = program_->get_services();
  vector<t_service*>::iterator sv_iter;
  for (sv_iter = services.begin(); sv_iter != services.end(); ++sv_iter) {
    f_init << ", '" << (*sv_iter)->get_name() << "'";
  }
  f_init << "]" << endl;
  f_init.close();

  // Print header
  f_types_ <<
    py_autogen_comment() << endl <<
    py_imports() << endl <<
    future_imports() << endl <<
    render_includes() << endl <<
    render_fastbinary_includes() <<
    render_sandesh_includes() <<
    endl << endl;

  f_consts_ <<
    py_autogen_comment() << endl <<
    py_imports() << endl <<
    "from .ttypes import *" << endl <<
    endl;
#ifdef SANDESH
  string f_request_impl_name = package_dir_+"/request_skeleton.py";
  f_request_impl_.open(f_request_impl_name.c_str());
  f_request_impl_ <<
    py_autogen_comment() << endl;
  f_request_impl_ <<
    py_autogen_sandesh_request_skeleton_comment() << endl;

  string f_http_request_name = package_dir_+"/http_request.py";
  f_http_request_.open(f_http_request_name.c_str());
  f_http_request_ <<
    py_autogen_comment() << endl;
  f_http_request_ <<
    "from . import ttypes" << endl;
  py_autogen_sandesh_http_request_open(f_http_request_);
#endif
}

string t_py_generator::render_includes() {
  const vector<t_program*>& includes = program_->get_includes();
  string result = "";
  for (size_t i = 0; i < includes.size(); ++i) {
    result += "from ." + get_real_py_module(includes[i], gen_twisted_) + 
              " import ttypes as " + get_real_py_module(includes[i], gen_twisted_) + "_ttypes\n";
  }
  if (includes.size() > 0) {
    result += "\n";
  }
  return result;
}

string t_py_generator::render_fastbinary_includes() {
  string hdr = "";
  if (gen_dynamic_) {
    hdr += std::string(import_dynbase_);
  } else {
#ifdef SANDESH
    hdr +=
      "from pysandesh.transport import TTransport\n"
      "from pysandesh.protocol import TBinaryProtocol, TProtocol\n"
      "try:\n"
      "  from pysandesh.protocol import fastbinary\n"
      "except:\n"
      "  fastbinary = None\n";
#else
    hdr +=
      "from thrift.transport import TTransport\n"
      "from thrift.protocol import TBinaryProtocol, TProtocol\n"
      "try:\n"
      "  from thrift.protocol import fastbinary\n"
      "except:\n"
      "  fastbinary = None\n";
#endif
  }
  return hdr;
}

#ifdef SANDESH
string t_py_generator::render_sandesh_includes() {
  std::string module = get_real_py_module(program_, gen_twisted_);
  std::string sandesh_includes("\n");
  sandesh_includes +=
    "from io import StringIO\n"
    "import uuid\n"
    "import netaddr\n"
    "from sys import getsizeof\n"
    "from itertools import chain\n";
  if (module != "sandesh") {
    sandesh_includes +=
      "import bottle\n"
      "from pysandesh import sandesh_base\n"
      "from pysandesh.sandesh_http import SandeshHttp\n"
      "from pysandesh.sandesh_uve import SandeshUVETypeMaps\n"
      "from pysandesh.util import UTCTimestampUsec, UTCTimestampUsecToString\n"
      "from pysandesh import util\n"
      "from pysandesh.gen_py.sandesh.constants import *\n";
  }
  return sandesh_includes;
}
#endif

string t_py_generator::py_autogen_comment() {
#ifdef SANDESH
  return
    std::string("#\n") +
    "# Autogenerated by Sandesh Compiler (" + SANDESH_VERSION + ")\n" +
    "#\n" +
    "# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING\n" +
    "#\n" +
    "#  options string: " + copy_options_  + "\n" +
    "# Copyright (c) 2013 Juniper Networks, Inc. All rights reserved.\n" +
    "#\n";
#else
  return
    std::string("#\n") +
    "# Autogenerated by Thrift Compiler \n" +
    "#\n" +
    "# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING\n" +
    "#\n" +
    "#  options string: " + copy_options_  + "\n" +
    "#\n";
#endif
}

string t_py_generator::py_imports() {
#ifdef SANDESH
  return
    string("from pysandesh.Thrift import TType, TMessageType, TException");
#else
  return
    string("from thrift.Thrift import TType, TMessageType, TException");
#endif
}

string t_py_generator::future_imports() {
  std::string future_imports("\n");
  return future_imports;
}

void t_py_generator::close_generator() {
#ifdef SANDESH
  generate_py_sandesh_request_list(f_types_);
  generate_py_sandesh_uve_list(f_types_);
  generate_py_sandesh_alarm_list(f_types_);
#endif
  // Close types file
  f_types_.close();
  f_consts_.close();
#ifdef SANDESH
  f_request_impl_.close();
  py_autogen_sandesh_http_request_close(f_http_request_);
  f_http_request_.close();
#endif
}

void t_py_generator::generate_typedef(t_typedef* ttypedef) {
  (void) ttypedef;
}

void t_py_generator::generate_enum(t_enum* tenum) {
  std::ostringstream to_string_mapping, from_string_mapping;

  f_types_ <<
    "class " << tenum->get_name() <<
    (gen_newstyle_ ? "(object)" : "") <<
    (gen_dynamic_ ? "(" + gen_dynbaseclass_ + ")" : "") <<
    ":" << endl;
  indent_up();
  generate_python_docstring(f_types_, tenum);

  to_string_mapping << indent() << "_VALUES_TO_NAMES = {" << endl;
  from_string_mapping << indent() << "_NAMES_TO_VALUES = {" << endl;

  vector<t_enum_value*> constants = tenum->get_constants();
  vector<t_enum_value*>::iterator c_iter;
  for (c_iter = constants.begin(); c_iter != constants.end(); ++c_iter) {
    int value = (*c_iter)->get_value();
    indent(f_types_) << (*c_iter)->get_name() << " = " << value << endl;

    // Dictionaries to/from string names of enums
    to_string_mapping <<
      indent() << indent() << value << ": \"" <<
      escape_string((*c_iter)->get_name()) << "\"," << endl;
    from_string_mapping <<
      indent() << indent() << '"' << escape_string((*c_iter)->get_name()) <<
      "\": " << value << ',' << endl;
  }
  to_string_mapping << indent() << "}" << endl;
  from_string_mapping << indent() << "}" << endl;

  indent_down();
  f_types_ << endl;
  f_types_ << to_string_mapping.str() << endl << from_string_mapping.str() << endl;
}

void t_py_generator::generate_const(t_const* tconst) {
  t_type* type = tconst->get_type();
  string name = tconst->get_name();
  t_const_value* value = tconst->get_value();

  indent(f_consts_) << name << " = " << render_const_value(type, value);
  f_consts_ << endl;
}

string t_py_generator::render_const_value(t_type* type, t_const_value* value) {
  type = get_true_type(type);
  std::ostringstream out;

  if (type->is_base_type()) {
    t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
    switch (tbase) {
    case t_base_type::TYPE_STRING:
#ifdef SANDESH
    case t_base_type::TYPE_STATIC_CONST_STRING:
    case t_base_type::TYPE_XML:
#endif
      out << '"' << get_escaped_string(value) << '"';
      break;
    case t_base_type::TYPE_BOOL:
      out << (value->get_integer() > 0 ? "True" : "False");
      break;
    case t_base_type::TYPE_BYTE:
    case t_base_type::TYPE_I16:
    case t_base_type::TYPE_I32:
    case t_base_type::TYPE_I64:
#ifdef SANDESH
    case t_base_type::TYPE_U16:
    case t_base_type::TYPE_U32:
    case t_base_type::TYPE_U64:
    case t_base_type::TYPE_IPV4:
#endif
      out << value->get_integer();
      break;
    case t_base_type::TYPE_DOUBLE:
      if (value->get_type() == t_const_value::CV_INTEGER) {
        out << value->get_integer();
      } else {
        out << value->get_double();
      }
      break;
#ifdef SANDESH
    case t_base_type::TYPE_UUID:
      out << "uuid.UUID('{" << get_escaped_string(value) <<"}')";
      break;
    case t_base_type::TYPE_IPADDR:
      out << "netaddr.IPAddress('" << value->get_string() << "')";
      break;
#endif
    default:
      throw "compiler error: no const of base type " + t_base_type::t_base_name(tbase);
    }
  } else if (type->is_enum()) {
    indent(out) << value->get_integer();
  } else if (type->is_struct() || type->is_xception()) {
    out << type->get_name() << "(**{" << endl;
    indent_up();
    const vector<t_field*>& fields = ((t_struct*)type)->get_members();
    vector<t_field*>::const_iterator f_iter;
    const map<t_const_value*, t_const_value*>& val = value->get_map();
    map<t_const_value*, t_const_value*>::const_iterator v_iter;
    for (v_iter = val.begin(); v_iter != val.end(); ++v_iter) {
      t_type* field_type = NULL;
      for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
        if ((*f_iter)->get_name() == v_iter->first->get_string()) {
          field_type = (*f_iter)->get_type();
        }
      }
      if (field_type == NULL) {
        throw "type error: " + type->get_name() + " has no field " + v_iter->first->get_string();
      }
      out << indent();
      out << render_const_value(g_type_string, v_iter->first);
      out << " : ";
      out << render_const_value(field_type, v_iter->second);
      out << "," << endl;
    }
    indent_down();
    indent(out) << "})";
  } else if (type->is_map()) {
    t_type* ktype = ((t_map*)type)->get_key_type();
    t_type* vtype = ((t_map*)type)->get_val_type();
    out << "{" << endl;
    indent_up();
    const map<t_const_value*, t_const_value*>& val = value->get_map();
    map<t_const_value*, t_const_value*>::const_iterator v_iter;
    for (v_iter = val.begin(); v_iter != val.end(); ++v_iter) {
      out << indent();
      out << render_const_value(ktype, v_iter->first);
      out << " : ";
      out << render_const_value(vtype, v_iter->second);
      out << "," << endl;
    }
    indent_down();
    indent(out) << "}";
  } else if (type->is_list() || type->is_set()) {
    t_type* etype;
    if (type->is_list()) {
      etype = ((t_list*)type)->get_elem_type();
    } else {
      etype = ((t_set*)type)->get_elem_type();
    }
    if (type->is_set()) {
      out << "set(";
    }
    out << "[" << endl;
    indent_up();
    const vector<t_const_value*>& val = value->get_list();
    vector<t_const_value*>::const_iterator v_iter;
    for (v_iter = val.begin(); v_iter != val.end(); ++v_iter) {
      out << indent();
      out << render_const_value(etype, *v_iter);
      out << "," << endl;
    }
    indent_down();
    indent(out) << "]";
    if (type->is_set()) {
      out << ")";
    }
  } else {
    throw "CANNOT GENERATE CONSTANT FOR TYPE: " + type->get_name();
  }

  return out.str();
}

void t_py_generator::generate_struct(t_struct* tstruct) {
  generate_py_struct(tstruct, false);
}

void t_py_generator::generate_xception(t_struct* txception) {
  generate_py_struct(txception, true);
}

void t_py_generator::generate_sandesh(t_sandesh* tsandesh) {
  generate_py_sandesh(tsandesh);
}

void t_py_generator::generate_py_struct(t_struct* tstruct,
                                        bool is_exception) {
  generate_py_struct_definition(f_types_, tstruct, is_exception);
}

void t_py_generator::generate_py_struct_definition(ofstream& out,
                                                   t_struct* tstruct,
                                                   bool is_exception,
                                                   bool is_result) {
  (void) is_result;
  const vector<t_field*>& members = tstruct->get_members();
  const vector<t_field*>& sorted_members = tstruct->get_sorted_members();
  vector<t_field*>::const_iterator m_iter;

  out << std::endl <<
    "class " << tstruct->get_name();
  if (is_exception) {
    if (gen_dynamic_) {
      out << "(" << gen_dynbaseclass_exc_ << ")";
    } else {
      out << "(TException)";
    }
  } else {
    if (gen_newstyle_) {
      out << "(object)";
    } else if (gen_dynamic_) {
      out << "(" << gen_dynbaseclass_ << ")";
    }
  }
  out << ":" << endl;
  indent_up();
  generate_python_docstring(out, tstruct);

  out << endl;

  /*
     Here we generate the structure specification for the fastbinary codec.
     These specifications have the following structure:
     thrift_spec -> tuple of item_spec
     item_spec -> None | (tag, type_enum, name, spec_args, default)
     tag -> integer
     type_enum -> TType.I32 | TType.STRING | TType.STRUCT | ...
     name -> string_literal
     default -> None  # Handled by __init__
     spec_args -> None  # For simple types
                | (type_enum, spec_args)  # Value type for list/set
                | (type_enum, spec_args, type_enum, spec_args)
                  # Key and value for map
                | (class_name, spec_args_ptr) # For struct/exception
     class_name -> identifier  # Basically a pointer to the class
     spec_args_ptr -> expression  # just class_name.spec_args

     TODO(dreiss): Consider making this work for structs with negative tags.
  */

  if (gen_slots_) {
    indent(out) << "__slots__ = [ " << endl;
    indent_up();
    for (m_iter = sorted_members.begin(); m_iter != sorted_members.end(); ++m_iter) {
      indent(out) <<  "'" << (*m_iter)->get_name()  << "'," << endl;
    }
    indent_down();
    indent(out) << " ]" << endl << endl;

  }

  // TODO(dreiss): Look into generating an empty tuple instead of None
  // for structures with no members.
  // TODO(dreiss): Test encoding of structs where some inner structs
  // don't have thrift_spec.
  if (sorted_members.empty() || (sorted_members[0]->get_key() >= 0)) {
    indent(out) << "thrift_spec = (" << endl;
    indent_up();

    int sorted_keys_pos = 0;
    for (m_iter = sorted_members.begin(); m_iter != sorted_members.end(); ++m_iter) {

      for (; sorted_keys_pos != (*m_iter)->get_key(); sorted_keys_pos++) {
        indent(out) << "None, # " << sorted_keys_pos << endl;
      }

      indent(out) << "(" << (*m_iter)->get_key() << ", "
            << type_to_enum((*m_iter)->get_type()) << ", "
            << "'" << (*m_iter)->get_name() << "'" << ", "
            << type_to_spec_args((*m_iter)->get_type()) << ", "
            << render_field_default_value(*m_iter) << ", "
            << "),"
            << " # " << sorted_keys_pos
            << endl;

      sorted_keys_pos ++;
    }

    indent_down();
    indent(out) << ")" << endl << endl;
  } else {
    indent(out) << "thrift_spec = None" << endl;
  }


  if (members.size() > 0) {
    out <<
      indent() << "def __init__(self,";

    for (m_iter = members.begin(); m_iter != members.end(); ++m_iter) {
#ifdef SANDESH
      // skip const string
      t_type* type = get_true_type((*m_iter)->get_type());
      if (type->is_static_const_string()) {
        continue;
      }
#endif
      // This fills in default values, as opposed to nulls
      out << " " << declare_argument(*m_iter) << ",";
    }

    out << "):" << endl;

    indent_up();

    for (m_iter = members.begin(); m_iter != members.end(); ++m_iter) {
      // Initialize fields
      t_type* type = (*m_iter)->get_type();
      if (!type->is_base_type() && !type->is_enum() && (*m_iter)->get_value() != NULL) {
        indent(out) <<
          "if " << (*m_iter)->get_name() << " is " << "self.thrift_spec[" <<
            (*m_iter)->get_key() << "][4]:" << endl;
        indent(out) << "  " << (*m_iter)->get_name() << " = " <<
          render_field_default_value(*m_iter) << endl;
#ifdef SANDESH
      } else if (type->is_static_const_string()) {
        indent(out) <<
          "self." << (*m_iter)->get_name() << " = " <<
          render_const_value(type, (*m_iter)->get_value()) << endl;
      } else {
#else
      }
#endif
        indent(out) <<
          "self." << (*m_iter)->get_name() << " = " << (*m_iter)->get_name() << endl;
#ifdef SANDESH
      }
#endif
    }

#ifdef SANDESH
    for (m_iter = members.begin(); m_iter != members.end(); ++m_iter) {
      if ((*m_iter)->get_name() == "name") {
        std::map<std::string, std::string>::iterator it;
        it = (*m_iter)->annotations_.find("key");
        if (it != (*m_iter)->annotations_.end()) {
          indent(out) << "self._table = '" << it->second << "'" << endl;
        }
        break;
      }
    }
#endif

    indent_down();

    out << endl;
  }

  if (!gen_dynamic_) {
    generate_py_struct_reader(out, tstruct);
    generate_py_struct_writer(out, tstruct);
  }

#ifdef SANDESH
  generate_py_struct_logger(out, tstruct);
  generate_py_struct_sizeof(out, tstruct);
#endif

  // For exceptions only, generate a __str__ method. This is
  // because when raised exceptions are printed to the console, __repr__
  // isn't used. See python bug #5882
  if (is_exception) {
    out <<
      indent() << "def __str__(self):" << endl <<
      indent() << "  return repr(self)" << endl <<
      endl;
  }

  if (!gen_slots_) {
    // Printing utilities so that on the command line thrift
    // structs look pretty like dictionaries
    out <<
      indent() << "def __repr__(self):" << endl <<
      indent() << "  L = ['%s=%r' % (key, value)" << endl <<
      indent() << "    for key, value in self.__dict__.items()]" << endl <<
      indent() << "  return '%s(%s)' % (self.__class__.__name__, ', '.join(L))" << endl <<
      endl;

    // Equality and inequality methods that compare by value
    out <<
      indent() << "def __eq__(self, other):" << endl;
    indent_up();
    out <<
      indent() << "return isinstance(other, self.__class__) and "
                  "self.__dict__ == other.__dict__" << endl;
    indent_down();
    out << endl;

    out <<
      indent() << "def __ne__(self, other):" << endl;
    indent_up();

    out <<
      indent() << "return not (self == other)" << endl;
    indent_down();
    out << endl;

    // In python2 __hash__ function is implicit for user-defined objects
    // For python3, return id of object as hash which is status quo in python2.
    out <<
      indent() << "def __hash__(self):" << endl;
    indent_up();

    out <<
      indent() << "return id(self)" << endl;
    indent_down();
  } else if (!gen_dynamic_) {
    // no base class available to implement __eq__ and __repr__ and __ne__ for us
    // so we must provide one that uses __slots__
    out <<
      indent() << "def __repr__(self):" << endl <<
      indent() << "  L = ['%s=%r' % (key, getattr(self, key))" << endl <<
      indent() << "    for key in self.__slots__]" << endl <<
      indent() << "  return '%s(%s)' % (self.__class__.__name__, ', '.join(L))" << endl <<
      endl;

    // Equality method that compares each attribute by value and type, walking __slots__
    out <<
      indent() << "def __eq__(self, other):" << endl <<
      indent() << "  if not isinstance(other, self.__class__):" << endl <<
      indent() << "    return False" << endl <<
      indent() << "  for attr in self.__slots__:" << endl <<
      indent() << "    my_val = getattr(self, attr)" << endl <<
      indent() << "    other_val = getattr(other, attr)" << endl <<
      indent() << "    if my_val != other_val:" << endl <<
      indent() << "      return False" << endl <<
      indent() << "  return True" << endl <<
      endl;

    out <<
      indent() << "def __ne__(self, other):" << endl <<
      indent() << "  return not (self == other)" << endl <<
      endl;
  }
  indent_down();
}

void t_py_generator::generate_py_struct_reader(ofstream& out,
                                                t_struct* tstruct) {
  const vector<t_field*>& fields = tstruct->get_members();
  vector<t_field*>::const_iterator f_iter;

  indent(out) <<
    "def read(self, iprot):" << endl;
  indent_up();

  indent(out) <<
    "if iprot.__class__ == TBinaryProtocol.TBinaryProtocolAccelerated "
    "and isinstance(iprot.trans, TTransport.CReadableTransport) "
    "and self.thrift_spec is not None "
    "and fastbinary is not None:" << endl;
  indent_up();

  indent(out) <<
    "fastbinary.decode_binary(self, iprot.trans, (self.__class__, self.thrift_spec))" << endl;
#ifdef SANDESH
  indent(out) <<
    "return 0" << endl;
#else
  indent(out) <<
    "return" << endl;
#endif
  indent_down();

#ifdef SANDESH
  indent(out) <<
    "read_cnt = 0" << endl;
#endif

#ifdef SANDESH
  indent(out) <<
    "length = iprot.readStructBegin()" << endl;
  indent(out) <<
    "if length < 0: return -1" << endl;
  indent(out) <<
    "read_cnt += length" << endl;
#else
  indent(out) <<
    "iprot.readStructBegin()" << endl;
#endif

  // Loop over reading in fields
  indent(out) <<
    "while True:" << endl;
    indent_up();

    // Read beginning field marker
#ifdef SANDESH
    indent(out) <<
      "(length, fname, ftype, fid) = iprot.readFieldBegin()" << endl;
    indent(out) <<
      "if length < 0: return -1" << endl;
    indent(out) <<
      "read_cnt += length" << endl;
#else
    indent(out) <<
      "(fname, ftype, fid) = iprot.readFieldBegin()" << endl;
#endif

    // Check for field STOP marker and break
    indent(out) <<
      "if ftype == TType.STOP:" << endl;
    indent_up();
    indent(out) <<
      "break" << endl;
    indent_down();

    // Switch statement on the field we are reading
    bool first = true;

    // Generate deserialization code for known cases
    for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
      if (first) {
        first = false;
        out <<
          indent() << "if ";
      } else {
        out <<
          indent() << "elif ";
      }
      out << "fid == " << (*f_iter)->get_key() << ":" << endl;
      indent_up();
      indent(out) << "if ftype == " << type_to_enum((*f_iter)->get_type()) << ":" << endl;
      indent_up();
      generate_deserialize_field(out, *f_iter, "self.");
      indent_down();
      out <<
        indent() << "else:" << endl <<
        indent() << "  iprot.skip(ftype)" << endl;
      indent_down();
    }

    // In the default case we skip the field
    out <<
      indent() <<  "else:" << endl <<
      indent() <<  "  iprot.skip(ftype)" << endl;

    // Read field end marker
#ifdef SANDESH
    indent(out) <<
      "length = iprot.readFieldEnd()" << endl;
    indent(out) <<
      "if length < 0: return -1" << endl;
    indent(out) <<
      "read_cnt += length" << endl;
#else
    indent(out) <<
      "iprot.readFieldEnd()" << endl;
#endif

    indent_down();

#ifdef SANDESH
    indent(out) <<
      "length = iprot.readStructEnd()" << endl;
    indent(out) <<
      "if length < 0: return -1" << endl;
    indent(out) <<
      "read_cnt += length" << endl;
#else
    indent(out) <<
      "iprot.readStructEnd()" << endl;
#endif

#ifdef SANDESH
    indent(out) <<
      "return read_cnt" << endl;
#endif

    indent_down();
  out << endl;
}

void t_py_generator::generate_py_struct_writer(ofstream& out,
                                               t_struct* tstruct) {
  string name = tstruct->get_name();
  const vector<t_field*>& fields = tstruct->get_sorted_members();
  vector<t_field*>::const_iterator f_iter;

  indent(out) <<
    "def write(self, oprot):" << endl;
  indent_up();

  indent(out) <<
    "if oprot.__class__ == TBinaryProtocol.TBinaryProtocolAccelerated "
    "and self.thrift_spec is not None "
    "and fastbinary is not None:" << endl;
  indent_up();

  indent(out) <<
    "oprot.trans.write(fastbinary.encode_binary(self, (self.__class__, self.thrift_spec)))" << endl;
#ifdef SANDESH
  indent(out) <<
    "return 0" << endl;
#else
  indent(out) <<
    "return" << endl;
#endif
  indent_down();

#ifdef SANDESH
  indent(out) <<
    "if oprot.writeStructBegin(self.__class__.__name__) < 0: return -1" << endl;
#else
  indent(out) <<
    "oprot.writeStructBegin('" << name << "')" << endl;
#endif

  for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
    // Write field header
#ifdef SANDESH
    indent(out) <<
      "if self." << (*f_iter)->get_name() << " is not None:" << endl;
    indent_up();
    indent(out) <<
      "annotations = {}" << endl;
    if (!((*f_iter)->annotations_.empty())) {
      std::map<std::string, std::string>::iterator it;
      for (it = (*f_iter)->annotations_.begin(); it != (*f_iter)->annotations_.end(); it++) {
        if (((*f_iter)->get_name() == "name") && (it->first == "key")) {
          indent(out) << "if self._table is None or self._table is '': return -1" << endl;
          indent(out) << "annotations['key'] = " << "self._table" << endl;
        } else {
          indent(out) << "annotations['" << (*it).first << "'] = '" <<
            (*it).second << "'" << endl;
        }
      }
    }
    indent(out) <<
      "if oprot.writeFieldBegin(" <<
      "'" << (*f_iter)->get_name() << "', " <<
      type_to_enum((*f_iter)->get_type()) << ", " <<
      (*f_iter)->get_key() << ", annotations) < 0: return -1" << endl;
#else
    indent(out) <<
      "if self." << (*f_iter)->get_name() << " is not None:" << endl;
    indent_up();
    indent(out) <<
      "oprot.writeFieldBegin(" <<
      "'" << (*f_iter)->get_name() << "', " <<
      type_to_enum((*f_iter)->get_type()) << ", " <<
      (*f_iter)->get_key() << ")" << endl;
#endif

    // Write field contents
    generate_serialize_field(out, *f_iter, "self.");

    // Write field closer
#ifdef SANDESH
    indent(out) <<
      "if oprot.writeFieldEnd() < 0: return -1" << endl;
#else
    indent(out) <<
      "oprot.writeFieldEnd()" << endl;
#endif
    indent_down();
  }

  // Write the struct map
#ifdef SANDESH
  out <<
    indent() << "if oprot.writeFieldStop() < 0: return -1" << endl <<
    indent() << "if oprot.writeStructEnd() < 0: return -1" << endl <<
    indent() << "return 0" << endl;
#else
  out <<
    indent() << "oprot.writeFieldStop()" << endl <<
    indent() << "oprot.writeStructEnd()" << endl;
#endif
  out << endl;
  indent_down();
  generate_py_struct_required_validator(out, tstruct);
  out <<
    endl;
}

void t_py_generator::generate_py_struct_required_validator(ofstream& out,
                                               t_struct* tstruct) {
  indent(out) << "def validate(self):" << endl;
  indent_up();

  const vector<t_field*>& fields = tstruct->get_members();

  if (fields.size() > 0) {
    vector<t_field*>::const_iterator f_iter;

    for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
      t_field* field = (*f_iter);
      if (field->get_req() == t_field::T_REQUIRED) {
        indent(out) << "if self." << field->get_name() << " is None:" << endl;
        indent(out) << "  raise TProtocol.TProtocolException(message='Required field " <<
          field->get_name() << " is unset!')" << endl;
      }
    }
  }

  indent(out) << "return" << endl << endl;
  indent_down();
}

#ifdef SANDESH
void t_py_generator::generate_py_sandesh(t_sandesh *tsandesh) {
  generate_py_sandesh_definition(f_types_, tsandesh);
}

void t_py_generator::generate_py_sandesh_definition(ofstream& out,
                                                    t_sandesh* tsandesh) {
  const vector<t_field*>& members = tsandesh->get_members();
  const vector<t_field*>& sorted_members = tsandesh->get_sorted_members();
  vector<t_field*>::const_iterator m_iter;
  const t_base_type *sandesh_type = (t_base_type *)tsandesh->get_type();

  std::string base_class;
  if (sandesh_type->is_sandesh_system()) {
    base_class = "sandesh_base.SandeshSystem";
  } else if (sandesh_type->is_sandesh_object()) {
    base_class = "sandesh_base.SandeshObject";
  } else if (sandesh_type->is_sandesh_flow()) {
    if (sandesh_type->is_sandesh_session()) {
        base_class = "sandesh_base.SandeshFlowSession";
    } else {
        base_class = "sandesh_base.SandeshFlow";
    }
  } else if (sandesh_type->is_sandesh_request()) {
    base_class = "sandesh_base.SandeshRequest";
  } else if (sandesh_type->is_sandesh_response()) {
    base_class = "sandesh_base.SandeshResponse";
  } else if (sandesh_type->is_sandesh_uve()) {
    base_class = "sandesh_base.SandeshUVE";
  } else if (sandesh_type->is_sandesh_dynamic_uve()) {
    base_class = "sandesh_base.SandeshDynamicUVE";
  } else if (sandesh_type->is_sandesh_alarm()) {
    base_class = "sandesh_base.SandeshAlarm";
  } else if (sandesh_type->is_sandesh_trace() ||
             sandesh_type->is_sandesh_trace_object()) {
    base_class = "sandesh_base.SandeshTrace";
  } else {
    throw "compiler error: unsupported sandesh type " +
      t_base_type::t_base_name(sandesh_type->get_base());
  }

  out << std::endl <<
    "class " << tsandesh->get_name();
  out << "(" << base_class << "):" << endl;
  indent_up();
  // generate_python_docstring(out, tstruct);

  out << endl;

  /*
     Here we generate the structure specification for the fastbinary codec.
     These specifications have the following structure:
     thrift_spec -> tuple of item_spec
     item_spec -> None | (tag, type_enum, name, spec_args, default)
     tag -> integer
     type_enum -> TType.I32 | TType.STRING | TType.STRUCT | ...
     name -> string_literal
     default -> None  # Handled by __init__
     spec_args -> None  # For simple types
                | (type_enum, spec_args)  # Value type for list/set
                | (type_enum, spec_args, type_enum, spec_args)
                  # Key and value for map
                | (class_name, spec_args_ptr) # For struct/exception
     class_name -> identifier  # Basically a pointer to the class
     spec_args_ptr -> expression  # just class_name.spec_args

     TODO(dreiss): Consider making this work for structs with negative tags.
  */

  if (gen_slots_) {
    indent(out) << "__slots__ = [ " << endl;
    indent_up();
    for (m_iter = sorted_members.begin(); m_iter != sorted_members.end(); ++m_iter) {
      indent(out) <<  "'" << (*m_iter)->get_name()  << "'," << endl;
    }
    indent_down();
    indent(out) << " ]" << endl << endl;

  }

  // TODO(dreiss): Look into generating an empty tuple instead of None
  // for class with no members.
  // TODO(dreiss): Test encoding of class where some inner class
  // don't have thrift_spec.
  if (sorted_members.empty() || (sorted_members[0]->get_key() >= 0)) {
    indent(out) << "thrift_spec = (" << endl;
    indent_up();

    int sorted_keys_pos = 0;
    for (m_iter = sorted_members.begin(); m_iter != sorted_members.end(); ++m_iter) {

      for (; sorted_keys_pos != (*m_iter)->get_key(); sorted_keys_pos++) {
        indent(out) << "None, # " << sorted_keys_pos << endl;
      }

      indent(out) << "(" << (*m_iter)->get_key() << ", "
            << type_to_enum((*m_iter)->get_type()) << ", "
            << "'" << (*m_iter)->get_name() << "'" << ", "
            << type_to_spec_args((*m_iter)->get_type()) << ", "
            << render_field_default_value(*m_iter) << ", "
            << "),"
            << " # " << sorted_keys_pos
            << endl;

      sorted_keys_pos ++;
    }

    indent_down();
    indent(out) << ")" << endl << endl;
  } else {
    indent(out) << "thrift_spec = None" << endl << endl;
  }

  if (sandesh_type->is_sandesh_system()) {
    indent(out) << "rate_limit_buffer = util.deque(maxlen=sandesh_base."
                   "SandeshSystem._DEFAULT_SEND_RATELIMIT)" << endl << endl;
    indent(out) << "do_rate_limit_drop_log = True" << endl << endl;
  }

  {
    out <<
      indent() << "def __init__(self";

    for (m_iter = members.begin(); m_iter != members.end(); ++m_iter) {
      // skip const string
      t_type* type = get_true_type((*m_iter)->get_type());
      if (type->is_static_const_string()) {
        continue;
      }
      // This fills in default values, as opposed to nulls
      out << ", " << declare_argument(*m_iter);
    }

    if (sandesh_type->is_sandesh_system() ||
        sandesh_type->is_sandesh_object() ||
        sandesh_type->is_sandesh_flow()) {
      out << ", category='" << "__default__" <<
        "', level=SandeshLevel.SYS_INFO";
    }
    if (sandesh_type->is_sandesh_uve() ||
        sandesh_type->is_sandesh_dynamic_uve() ||
        sandesh_type->is_sandesh_alarm()) {
      out << ", table=None";
    }
    out << ", sandesh=sandesh_base.sandesh_global):" << endl;

    indent_up();
    if (sandesh_type->is_sandesh_trace()) {
      indent(out) << base_class <<
        ".__init__(self, type=SandeshType.TRACE)" << endl;
    } else if (sandesh_type->is_sandesh_trace_object()) {
      indent(out) << base_class <<
        ".__init__(self, type=SandeshType.TRACE_OBJECT)" << endl;
    } else {
      indent(out) << base_class << ".__init__(self)" << endl;
    }

    for (m_iter = members.begin(); m_iter != members.end(); ++m_iter) {
      // Initialize fields
      t_type* type = (*m_iter)->get_type();
      if (!type->is_base_type() && !type->is_enum() && (*m_iter)->get_value() != NULL) {
        indent(out) <<
          "if " << (*m_iter)->get_name() << " is " << "self.thrift_spec[" <<
            (*m_iter)->get_key() << "][4]:" << endl;
        indent(out) << "  " << (*m_iter)->get_name() << " = " <<
          render_field_default_value(*m_iter) << endl;
      } else if (type->is_static_const_string()) {
        indent(out) <<
          "self." << (*m_iter)->get_name() << " = " <<
          render_const_value(type, (*m_iter)->get_value()) << endl;
      } else {
        indent(out) <<
          "self." << (*m_iter)->get_name() << " = " << (*m_iter)->get_name() << endl;
      }
    }

    indent(out) << "self._scope = sandesh.scope()" << endl;
    indent(out) << "self._module = sandesh.module()" << endl;
    indent(out) << "self._source = sandesh.source_id()" << endl;
    indent(out) << "self._node_type = sandesh.node_type()" << endl;
    indent(out) << "self._instance_id = sandesh.instance_id()" << endl;
    indent(out) << "self._seqnum = 0" << endl;
    indent(out) << "self._timestamp = UTCTimestampUsec()" << endl;
    indent(out) << "self._versionsig = " << tsandesh->get_4byte_fingerprint() << endl;
    generate_py_sandesh_hint(out, tsandesh);
    if (sandesh_type->is_sandesh_system() ||
        sandesh_type->is_sandesh_object() ||
        sandesh_type->is_sandesh_flow()) {
      indent(out) << "self._category = category" << endl;
      indent(out) << "self._level = level" << endl;
    }
    if (sandesh_type->is_sandesh_uve() ||
        sandesh_type->is_sandesh_dynamic_uve() ||
        sandesh_type->is_sandesh_alarm()) {
      indent(out) << "if table is not None:" << endl;
      indent_up();
      indent(out) << "self.data._table = table" << endl;
      indent_down();
    }
    indent_down();

    out << endl;
  }

  if (sandesh_type->is_sandesh_system() ||
      sandesh_type->is_sandesh_object() ||
      sandesh_type->is_sandesh_flow()) {
    generate_py_sandesh_async(out, tsandesh);
  } else if (sandesh_type->is_sandesh_request()) {
    generate_py_sandesh_request(out, tsandesh);
  } else if (sandesh_type->is_sandesh_response()) {
    generate_py_sandesh_response(out, tsandesh);
  } else if (sandesh_type->is_sandesh_uve() ||
             sandesh_type->is_sandesh_alarm()) {
    generate_py_sandesh_uve(out, tsandesh, true);
  } else if (sandesh_type->is_sandesh_dynamic_uve()) {
    generate_py_sandesh_uve(out, tsandesh, false);
  } else if (sandesh_type->is_sandesh_trace() ||
             sandesh_type->is_sandesh_trace_object()) {
    generate_py_sandesh_trace(out, tsandesh);
  }

  generate_py_sandesh_logger(out, tsandesh);

  if (!gen_dynamic_) {
    generate_py_sandesh_reader(out, tsandesh);
    generate_py_sandesh_writer(out, tsandesh);
  }

  generate_py_sandesh_compare(out, tsandesh);
  generate_py_sandesh_sizeof(out, tsandesh);

  if (!gen_slots_) {
    // Printing utilities so that on the command line thrift
    // structs look pretty like dictionaries
    out <<
      indent() << "def __repr__(self):" << endl <<
      indent() << "  L = ['%s=%r' % (key, value)" << endl <<
      indent() << "    for key, value in self.__dict__.items()]" << endl <<
      indent() << "  return '%s(%s)' % (self.__class__.__name__, ', '.join(L))" << endl <<
      endl;

    // Equality and inequality methods that compare by value
    out <<
      indent() << "def __eq__(self, other):" << endl;
    indent_up();
    out <<
      indent() << "return isinstance(other, self.__class__) and "
                  "self.__dict__ == other.__dict__" << endl;
    indent_down();
    out << endl;

    out <<
      indent() << "def __ne__(self, other):" << endl;
    indent_up();

    out <<
      indent() << "return not (self == other)" << endl;
    indent_down();
  } else if (!gen_dynamic_) {
    // no base class available to implement __eq__ and __repr__ and __ne__ for us
    // so we must provide one that uses __slots__
    out <<
      indent() << "def __repr__(self):" << endl <<
      indent() << "  L = ['%s=%r' % (key, getattr(self, key))" << endl <<
      indent() << "    for key in self.__slots__]" << endl <<
      indent() << "  return '%s(%s)' % (self.__class__.__name__, ', '.join(L))" << endl <<
      endl;

    // Equality method that compares each attribute by value and type, walking __slots__
    out <<
      indent() << "def __eq__(self, other):" << endl <<
      indent() << "  if not isinstance(other, self.__class__):" << endl <<
      indent() << "    return False" << endl <<
      indent() << "  for attr in self.__slots__:" << endl <<
      indent() << "    my_val = getattr(self, attr)" << endl <<
      indent() << "    other_val = getattr(other, attr)" << endl <<
      indent() << "    if my_val != other_val:" << endl <<
      indent() << "      return False" << endl <<
      indent() << "  return True" << endl <<
      endl;

    out <<
      indent() << "def __ne__(self, other):" << endl <<
      indent() << "  return not (self == other)" << endl <<
      endl;
  }
  indent_down();
}

void t_py_generator::generate_py_sandesh_reader(ofstream& out,
                                                t_sandesh* tsandesh) {
  const vector<t_field*>& fields = tsandesh->get_members();
  vector<t_field*>::const_iterator f_iter;

  indent(out) <<
    "def read(self, iprot):" << endl;
  indent_up();

  indent(out) <<
    "if iprot.__class__ == TBinaryProtocol.TBinaryProtocolAccelerated "
    "and isinstance(iprot.trans, TTransport.CReadableTransport) "
    "and self.thrift_spec is not None "
    "and fastbinary is not None:" << endl;
  indent_up();

  indent(out) <<
    "fastbinary.decode_binary(self, iprot.trans, (self.__class__, self.thrift_spec))" << endl;
  indent(out) <<
    "return -1" << endl;
  indent_down();

  indent(out) <<
    "read_cnt = 0" << endl;

  indent(out) <<
    "(length, sandesh_name) = iprot.readSandeshBegin()" << endl;
  indent(out) <<
    "if length < 0: return -1" << endl;
  indent(out) <<
    "read_cnt += length" << endl;

  // Loop over reading in fields
  indent(out) <<
    "while True:" << endl;
    indent_up();

    // Read beginning field marker
    indent(out) <<
      "(length, fname, ftype, fid) = iprot.readFieldBegin()" << endl;
    indent(out) <<
      "if length < 0: return -1" << endl;
    indent(out) <<
      "read_cnt += length" << endl;

    // Check for field STOP marker and break
    indent(out) <<
      "if ftype == TType.STOP:" << endl;
    indent_up();
    indent(out) <<
      "break" << endl;
    indent_down();

    // Switch statement on the field we are reading
    bool first = true;

    // Generate deserialization code for known cases
    for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
      if (first) {
        first = false;
        out <<
          indent() << "if ";
      } else {
        out <<
          indent() << "elif ";
      }
      out << "fid == " << (*f_iter)->get_key() << ":" << endl;
      indent_up();
      indent(out) << "if ftype == " << type_to_enum((*f_iter)->get_type()) << ":" << endl;
      indent_up();
      generate_deserialize_field(out, *f_iter, "self.");
      indent_down();
      out <<
        indent() << "else:" << endl <<
        indent() << "  iprot.skip(ftype)" << endl;
      indent_down();
    }

    // In the default case we skip the field
    out <<
      indent() <<  "else:" << endl <<
      indent() <<  "  iprot.skip(ftype)" << endl;

    // Read field end marker
    indent(out) <<
      "length = iprot.readFieldEnd()" << endl;
    indent(out) <<
      "if length < 0: return -1" << endl;
    indent(out) <<
      "read_cnt += length" << endl;

    indent_down();

    indent(out) <<
      "length = iprot.readSandeshEnd()" << endl;
    indent(out) <<
      "if length < 0: return -1" << endl;
    indent(out) <<
      "read_cnt += length" << endl;

    indent(out) <<
      "return read_cnt" << endl;

    indent_down();
  out << endl;
}

void t_py_generator::generate_py_sandesh_writer(ofstream& out,
                                                t_sandesh* tsandesh) {
  const vector<t_field*>& fields = tsandesh->get_sorted_members();
  vector<t_field*>::const_iterator f_iter;

  indent(out) <<
    "def write(self, oprot):" << endl;
  indent_up();

  indent(out) <<
    "if oprot.__class__ == TBinaryProtocol.TBinaryProtocolAccelerated "
    "and self.thrift_spec is not None "
    "and fastbinary is not None:" << endl;
  indent_up();

  indent(out) <<
    "oprot.trans.write(fastbinary.encode_binary(self, (self.__class__, self.thrift_spec)))" << endl;
  indent(out) <<
    "return 0" << endl;
  indent_down();

  indent(out) <<
    "if oprot.writeSandeshBegin(self.__class__.__name__) < 0: return -1" << endl;
  for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
    // Write field header
    indent(out) <<
      "if self." << (*f_iter)->get_name() << " is not None:" << endl;
    indent_up();
    indent(out) <<
      "annotations = {}" << endl;
    if (!((*f_iter)->annotations_.empty())) {
      std::map<std::string, std::string>::iterator it;
      for (it = (*f_iter)->annotations_.begin(); it != (*f_iter)->annotations_.end(); it++) {
        indent(out) << "annotations['" << (*it).first << "'] = '" <<
          (*it).second << "'" << endl;
      }
    }
    indent(out) <<
      "if oprot.writeFieldBegin(" <<
      "'" << (*f_iter)->get_name() << "', " <<
      type_to_enum((*f_iter)->get_type()) << ", " <<
      (*f_iter)->get_key() << ", annotations) < 0: return -1" << endl;

    // Write field contents
    generate_serialize_field(out, *f_iter, "self.");

    // Write field closer
    indent(out) <<
      "if oprot.writeFieldEnd() < 0: return -1" << endl;

    indent_down();
  }

  // Write the struct map
  indent(out) <<
    "if oprot.writeFieldStop() < 0: return -1" << endl;
  indent(out) <<
    "if oprot.writeSandeshEnd() < 0: return -1" << endl;
  indent(out) <<
    "return 0" << endl;
  out << endl;
  indent_down();
  generate_py_sandesh_required_validator(out, tsandesh);
  out <<
    endl;
}

void t_py_generator::generate_py_sandesh_required_validator(ofstream& out,
                                                            t_sandesh* tsandesh) {
  indent(out) << "def validate(self):" << endl;
  indent_up();

  const vector<t_field*>& fields = tsandesh->get_members();

  if (fields.size() > 0) {
    vector<t_field*>::const_iterator f_iter;

    for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
      t_field* field = (*f_iter);
      if (field->get_req() == t_field::T_REQUIRED) {
        indent(out) << "if self." << field->get_name() << " is None:" << endl;
        indent(out) << "  raise TProtocol.TProtocolException(message='Required field " <<
          field->get_name() << " is unset!')" << endl;
      }
    }
  }

  indent(out) << "return" << endl << endl;
  indent_down();
}

void t_py_generator::generate_py_sandesh_compare(ofstream& out,
                                                 t_sandesh* tsandesh) {
  const vector<t_field*>& fields = tsandesh->get_sorted_members();
  vector<t_field*>::const_iterator f_iter;

  indent(out) <<
    "def compare(self, other):" << endl;
  indent_up();
  indent(out) <<
    "if not isinstance(other, self.__class__):" << endl;
  indent_up();
  indent(out) <<
    "return False" << endl;
  indent_down();

  for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
      indent(out) <<
        "if self." << (*f_iter)->get_name() << " != " <<
        "other." << (*f_iter)->get_name() << ":" << endl;
      indent_up();
      indent(out) << "return False" << endl;
      indent_down();
  }

  indent(out) << "return True" << endl << endl;
  indent_down();
}

void t_py_generator::generate_py_sandesh_http_attr(ofstream& out,
        t_type *ftype, const std::string& namel, const std::string& namer) {

  if (ftype->is_base_type()) {

    t_base_type::t_base bftype = ((t_base_type *)ftype)->get_base();

    indent(out) <<
      "if bottle.request.query." << namer << ":" << endl;
    indent_up();
    if (bftype == t_base_type::TYPE_STRING) {
      indent(out) <<
        "sandesh_req." << namel << " = str(" <<
        "bottle.request.query." << namer << ")" << endl;
    } else if (bftype == t_base_type::TYPE_UUID) {
      indent(out) << "try:" << endl;
      indent_up();
      indent(out) << "sandesh_req." << namel << " = uuid.UUID("
        << "bottle.request.query." << namer << ")" << endl;
      indent_down();
      indent(out) << "except ValueError:" << endl;
      indent_up();
      indent(out) << "return SandeshHttp.http_error('Invalid value for "
        << namel << ":" << namer << "')" << endl;
      indent_down();
    } else if (bftype == t_base_type::TYPE_IPADDR) {
      indent(out) << "try:" << endl;
      indent_up();
      indent(out) << "sandesh_req." << namel << " = netaddr.IPAddress("
        << "bottle.request.query." << namer << ")" << endl;
      indent_down();
      indent(out) << "except ValueError:" << endl;
      indent_up();
      indent(out) << "return SandeshHttp.http_error('Invalid value for "
        << namel << ":" << namer << "')" << endl;
      indent_down();
    } else {
      assert(bftype == t_base_type::TYPE_BOOL ||
             bftype == t_base_type::TYPE_BYTE ||
             bftype == t_base_type::TYPE_I16 ||
             bftype == t_base_type::TYPE_I32 ||
             bftype == t_base_type::TYPE_I64 ||
             bftype == t_base_type::TYPE_U16 ||
             bftype == t_base_type::TYPE_U32 ||
             bftype == t_base_type::TYPE_U64 ||
             bftype == t_base_type::TYPE_IPV4);
      indent(out) <<
        "try:" << endl;
      indent_up();
      indent(out) <<
        "sandesh_req." << namel << " = int(" <<
        "bottle.request.query." << namer << ")" << endl;
      indent_down();
      indent(out) <<
        "except ValueError:" << endl;
      indent_up();
      indent(out) <<
        "return SandeshHttp.http_error('Invalid data provided in Sandesh Request')" << endl;
      indent_down();
    }
    indent_down();

  } else {
    // Ignore this field for now
  }
}

void t_py_generator::generate_py_sandesh_http_request_handler(ofstream& out,
                                                              t_sandesh* tsandesh) {
  const vector<t_field*>& fields = tsandesh->get_sorted_members();
  vector<t_field*>::const_iterator f_iter;

  indent(out) <<
    "@staticmethod" << endl;
  indent(out) <<
    "def handle_http_request(sandesh=sandesh_base.sandesh_global):" << endl;
  indent_up();
  indent(out) <<
    "sandesh_req = " << tsandesh->get_name() << "()" << endl;
  indent(out) <<
    "if not sandesh_req:" << endl;
  indent_up();
  indent(out) << "return SandeshHttp.http_error('Sandesh Request \"" << tsandesh->get_name() <<
      "\" not implemented')" << endl;
  indent_down();
  for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
    t_type *ftype = (*f_iter)->get_type();
    if (f_iter == fields.begin()) {
      generate_py_sandesh_http_attr(out, ftype, (*f_iter)->get_name(), "x");
    }
    generate_py_sandesh_http_attr(out, ftype, (*f_iter)->get_name(), (*f_iter)->get_name());
  }
  // TODO: Call validate() to check if all the mandatory parameters are provided
  indent(out) << "sandesh_req._context = bottle.request.url" << endl;
  indent(out) << "handle_req_fn = getattr(sandesh_req, \"handle_request\", None)" << endl;
  indent(out) << "if callable(handle_req_fn):" << endl;
  indent_up();
  indent(out) << "handle_req_fn(sandesh_req)" << endl;
  indent_down();
  indent(out) << "else:" << endl;
  indent_up();
  indent(out) << "return SandeshHttp.http_error('Sandesh Request \"" << tsandesh->get_name() <<
          "\" not implemented')" << endl;
  indent_down();
  indent(out) << "resp = SandeshHttp.get_http_response()" << endl;
  indent(out) << "if resp:" << endl;
  indent_up();
  indent(out) << "return resp" << endl;
  indent_down();
  indent(out) << "else:" << endl;
  indent_up();
  indent(out) << "return SandeshHttp.http_error('No Response for Sandesh Request \"" <<
    tsandesh->get_name() << "\"')" << endl;
  indent_down();
  indent(out) << endl;
  indent_down();
  indent_down();
}

void t_py_generator::generate_py_sandesh_request_list(ofstream& out) {
  out << endl << endl;
  out << "_SANDESH_REQUEST_LIST = [" << endl;
  std::vector<std::string>::const_iterator it;
  for (it = sandesh_req_list_.begin(); it != sandesh_req_list_.end(); ++it) {
    indent(out) << *it << "," << endl;
  }
  out << "]" << endl;
}

void t_py_generator::generate_py_sandesh_http_request_list(ofstream& out,
                                                           t_sandesh* tsandesh) {
  indent(out) <<
    "{ 'uri':" << "'/Snh_" << tsandesh->get_name() << "'" <<
    ", 'method':" << "ttypes." << tsandesh->get_name() << ".handle_http_request " <<
    "}," << endl;
}

void t_py_generator::py_autogen_sandesh_http_request_open(ofstream& out) {
  indent(out) << endl;
  indent(out) <<
    "_HTTP_REQUEST_LIST = [" << endl;
}

void t_py_generator::py_autogen_sandesh_http_request_close(ofstream& out) {
  out << "]" << endl << endl;
}

std::string t_py_generator::py_autogen_sandesh_request_skeleton_comment() {
    return
      std::string("\n") +
      "# This autogenerated skeleton file illustrates the implementation of" +
      "\n" +
      "# derived class to handle the sandesh request." +
      "\n";
}

void t_py_generator::generate_py_sandesh_skeleton_request(ofstream& out,
                                                          t_sandesh* tsandesh) {
  const vector<t_field*>& members = tsandesh->get_members();
  vector<t_field*>::const_iterator m_iter;

  out << endl <<
    "# Create a derived class from \"" << tsandesh->get_name() << "\" to handle ";
  out << endl <<
    "# the sandesh request. Add this derived class \"" << tsandesh->get_name() << "_derived\"";
  out << endl <<
    "# in module " << tsandesh->get_name() << "_derived.py and " <<
    "add it in your package" << endl;

  out << endl <<
    "class " << tsandesh->get_name() << "_derived";
  out << "(" << tsandesh->get_name() << "):" << endl;
  indent_up();
  out << endl;

  if (members.size() > 0) {
    out <<
      indent() << "def __init__(self):" << endl;
    indent_up();
    out <<
      indent() << tsandesh->get_name() << ".__init__(self";

    for (m_iter = members.begin(); m_iter != members.end(); ++m_iter) {
      // skip const string
      t_type* type = get_true_type((*m_iter)->get_type());
      if (type->is_static_const_string()) {
        continue;
      }
      // This fills in default values, as opposed to nulls
      out << ", " << declare_argument(*m_iter);
    }
    out << ")" << endl;
    indent_down();
  }
  out << endl;
  out << indent() << "def handle_request(self):" << endl;
  indent_up();
  indent(out) <<
    "# Add your code to handle the \"" << tsandesh->get_name() <<
    "\" request" << endl;
  indent(out) <<
    "pass" << endl;
  indent_down();
  indent(out) << endl;
}

void t_py_generator::generate_struct_log(ofstream& out,
                                         string prefix,
                                         string log_str) {
  indent(out) <<
    log_str << ".write('<<  ')" << endl;
  indent(out) <<
    log_str << ".write(" << prefix << ".log())" << endl;
  indent(out) <<
    log_str << ".write('>>')" << endl;
}

void t_py_generator::generate_container_log(ofstream& out,
                                            string prefix,
                                            t_type* ttype,
                                            string log_str) {
  if (ttype->is_map()) {
    string kiter = tmp("kiter");
    string viter = tmp("viter");
    indent(out) <<
      log_str << ".write('{ ')" << endl;
    indent(out) <<
      "for " << kiter << "," << viter << " in " << prefix << ".items():" << endl;
    indent_up();
    t_field kfield(((t_map*)ttype)->get_key_type(), kiter);
    generate_field_log(out, &kfield, log_str, "");
    indent(out) <<
      log_str << ".write(' : ')" << endl;
    t_field vfield(((t_map*)ttype)->get_val_type(), viter);
    generate_field_log(out, &vfield, log_str, "");
    indent_down();
    indent(out) <<
      log_str << ".write(' }')" << endl;
  } else if (ttype->is_set()) {
    string iter = tmp("iter");
    indent(out) <<
      log_str << ".write('( ')" << endl;
    indent(out) <<
      "for " << iter << " in " << prefix << ":" << endl;
    indent_up();
    t_field efield(((t_set*)ttype)->get_elem_type(), iter);
    generate_field_log(out, &efield, log_str, "");
    indent(out) <<
      log_str << ".write(', ')" << endl;
    indent_down();
    indent(out) <<
      log_str << ".write(' )')" << endl;
  } else if (ttype->is_list()) {
    string iter = tmp("iter");
    indent(out) <<
      log_str << ".write('[ ')" << endl;
    indent(out) <<
      "for " << iter << " in " << prefix << ":" << endl;
    indent_up();
    t_field efield(((t_list*)ttype)->get_elem_type(), iter);
    generate_field_log(out, &efield, log_str, "");
    indent(out) <<
      log_str << ".write(', ')" << endl;
    indent_down();
    indent(out) <<
    log_str << ".write(' ]')" << endl;
  }
}

void t_py_generator::generate_field_log(ofstream& out,
                                        t_field *tfield,
                                        string log_str,
                                        string prefix) {
  t_type* type = get_true_type(tfield->get_type());

  if (type->is_struct() || type->is_xception()) {
      generate_struct_log(out, prefix + tfield->get_name(), log_str);
  } else if (type->is_container()) {
      generate_container_log(out, prefix + tfield->get_name(), type, log_str);
  } else if (type->is_base_type() || type->is_enum()) {
    string name = prefix + tfield->get_name();
    if (type->is_base_type()) {
      t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
      switch (tbase) {
      case t_base_type::TYPE_VOID:
        break;
      case t_base_type::TYPE_STRING:
      case t_base_type::TYPE_STATIC_CONST_STRING:
      case t_base_type::TYPE_XML:
        indent(out) <<
          log_str << ".write(" << name << ")" << endl;
        break;
      case t_base_type::TYPE_BOOL:
        indent(out) <<
          "if " << name << ":" << endl;
        indent_up();
        indent(out) <<
          log_str << ".write('True')" << endl;
        indent_down();
        indent(out) <<
          "else:" << endl;
        indent_up();
        indent(out) <<
          log_str << ".write('False')" << endl;
        indent_down();
        break;
      case t_base_type::TYPE_BYTE:
        indent(out) <<
          log_str << ".write(hex(" << name << "))" << endl;
        break;
      case t_base_type::TYPE_I16:
        indent(out) <<
          log_str << ".write(str(" << name << "))" << endl;
        break;
      case t_base_type::TYPE_I32:
        indent(out) <<
          log_str << ".write(str(" << name << "))" << endl;
        break;
      case t_base_type::TYPE_I64:
        indent(out) <<
          log_str << ".write(str(" << name << "))" << endl;
        break;
      case t_base_type::TYPE_U16:
        indent(out) <<
          log_str << ".write(str(" << name << "))" << endl;
        break;
      case t_base_type::TYPE_U32:
        indent(out) <<
          log_str << ".write(str(" << name << "))" << endl;
        break;
      case t_base_type::TYPE_U64:
        indent(out) <<
          log_str << ".write(str(" << name << "))" << endl;
        break;
      case t_base_type::TYPE_DOUBLE:
        indent(out) <<
          log_str << ".write(str(" << name << "))" << endl;
        break;
      case t_base_type::TYPE_IPV4:
        indent(out) << "import socket, struct" << endl;
        indent(out) <<
          log_str << ".write(socket.inet_ntoa(struct.pack('!L'," << name << ")))" << endl;
        break;
      case t_base_type::TYPE_IPADDR:
        indent(out) <<
          log_str << ".write(str(" << name << "))" << endl;
        break;
      case t_base_type::TYPE_UUID:
        indent(out) <<
          log_str << ".write(str(" << name << "))" << endl;
        break;
      default:
        throw "compiler error: unrecognized base type " + t_base_type::t_base_name(tbase);
      }
    } else if (type->is_enum()) {
        indent(out) <<
          log_str << ".write(str(" << name << "))" << endl;
    }
  } else {
    printf("DO NOT KNOW HOW TO GENERATE LOG FOR FIELD '%s' TYPE '%s'\n",
           tfield->get_name().c_str(),
           type->get_name().c_str());
  }
}

void t_py_generator::generate_py_sandesh_logger(ofstream &out,
                                                t_sandesh* tsandesh) {
  const vector<t_field*>& fields = tsandesh->get_members();
  vector<t_field*>::const_iterator f_iter;
  t_base_type *sandesh_type = (t_base_type *)tsandesh->get_type();

  std::string log_str = "log_str";
  indent(out) <<
    "def log(self, trace=False):" << endl;
  indent_up();
  indent(out) <<
    log_str << " = StringIO()" << endl;
  bool init = false;
  for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
    if (!init) {
      init = true;
      indent(out) << "if trace:" << endl;
      indent_up();
      indent(out) << log_str << ".write(str(self._timestamp))" << endl;
      indent(out) << log_str << ".write(' ')" << endl;
      indent_down();
      // Only systemlog, objectlog, and flowlog have valid level and category
      if (sandesh_type->is_sandesh_system() ||
          sandesh_type->is_sandesh_object() ||
          sandesh_type->is_sandesh_flow()) {
        indent(out) <<
          "if self._category is not None:" << endl;
        indent_up();
        indent(out) << log_str << ".write(self._category)" << endl;
        indent_down();
        indent(out) << log_str << ".write(' [')" << endl;
        indent(out) << log_str << ".write(SandeshLevel._VALUES_TO_NAMES["
          << "self._level])" << endl;
        indent(out) << log_str << ".write(']: ')" << endl;
      }
      indent(out) << log_str << ".write(self.__class__.__name__ + " <<
        "': ')" << endl;
    }
    indent(out) <<
      "if self." << (*f_iter)->get_name() << " is not None:" << endl;
    indent_up();
    if (sandesh_type->is_sandesh_system() ||
        sandesh_type->is_sandesh_trace()) {
      generate_field_log(out, *f_iter, log_str, "self.");
      indent(out) << log_str << ".write('  ')" << endl;
    } else {
      indent(out) << log_str <<
        ".write('" << (*f_iter)->get_name() << " = ')"<< endl;
      generate_field_log(out, *f_iter, log_str, "self.");
      indent(out) << log_str << ".write('  ')" << endl;
    }
    indent_down();
  }
  indent(out) <<
    "return log_str.getvalue()" << endl << endl;
  indent_down();
}

void t_py_generator::generate_py_struct_logger(ofstream &out,
                                               t_struct* tstruct) {
  const vector<t_field*>& fields = tstruct->get_members();
  vector<t_field*>::const_iterator f_iter;

  std::string log_str = "log_str";
  indent(out) <<
    "def log(self):" << endl;
  indent_up();
  indent(out) <<
    log_str << " = StringIO()" << endl;

  for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
    indent(out) <<
      "if self." << (*f_iter)->get_name() << " is not None:" << endl;
    indent_up();
    t_type *type = get_true_type((*f_iter)->get_type());
    bool write_fname = true;
    if (type->is_base_type()) {
      t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
      if (tbase == t_base_type::TYPE_STATIC_CONST_STRING) {
        write_fname = false;
      }
    }
    if (write_fname) {
      indent(out) <<
        log_str << ".write('" << (*f_iter)->get_name() << " = ')"<< endl;
    }
    generate_field_log(out, *f_iter, log_str, "self.");
    indent(out) <<
      log_str << ".write('  ')" << endl;
    indent_down();
  }
  indent(out) <<
    "return log_str.getvalue()" << endl << endl;
  indent_down();
}

void t_py_generator::generate_py_sizeof(std::ofstream& out,
                                        const vector<t_field*>& fields) {
  indent(out) << "def __sizeof__(self):" << endl;
  indent_up();
  indent(out) << "size = 0" << endl;
  vector<t_field*>::const_iterator f_iter;
  for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
    std::string fname((*f_iter)->get_name());
    indent(out) << "if self." << fname << " is not None:" << endl;
    indent_up();
    indent(out) << "size += getsizeof(self." << fname << ")" << endl;
    t_type* type = get_true_type((*f_iter)->get_type());
    if (type->is_container()) {
      if (type->is_map()) {
        indent(out) <<
          "size += sum(map(getsizeof, chain.from_iterable(iter(self." <<
          fname << ".items()))))" << endl;

      } else {
        indent(out) <<
          "size += sum(map(getsizeof, self." << fname << "))" << endl;
      }
    }
    indent_down();
  }
  indent(out) << "return size" << endl << endl;
  indent_down();
}

void t_py_generator::generate_py_struct_sizeof(std::ofstream& out,
                                               t_struct* tstruct) {
    const vector<t_field*>& fields = tstruct->get_members();
    generate_py_sizeof(out, fields);
}

void t_py_generator::generate_py_sandesh_sizeof(std::ofstream& out,
                                                t_sandesh* tsandesh) {
    const vector<t_field*>& fields = tsandesh->get_members();
    generate_py_sizeof(out, fields);
}

void t_py_generator::generate_py_sandesh_hint(ofstream& out,
                                              t_sandesh* tsandesh) {
  bool has_key_annotation = tsandesh->has_key_annotation();
  string shints = "0";

  if (has_key_annotation) {
    shints += " | SANDESH_KEY_HINT";
  }

  indent(out) << "self._hints = " << shints << endl;
}

void t_py_generator::generate_py_sandesh_trace(std::ofstream& out,
                                               t_sandesh* tsandesh) {
}

void t_py_generator::generate_py_sandesh_async(std::ofstream& out,
                                               t_sandesh* tsandesh) {
}

void t_py_generator::generate_py_sandesh_request(std::ofstream& out,
                                                 t_sandesh* tsandesh) {
  // Generate http request handler
  generate_py_sandesh_http_request_handler(out, tsandesh);
  // Update sandesh request list
  sandesh_req_list_.push_back(tsandesh->get_name());
  // Update _HTTP_REQUEST_LIST in http_request.py
  generate_py_sandesh_http_request_list(f_http_request_, tsandesh);
  // Generate the Sandesh Request Skeleton
  generate_py_sandesh_skeleton_request(f_request_impl_, tsandesh);
}

void t_py_generator::generate_py_sandesh_response(std::ofstream& out,
                                                  t_sandesh* tsandesh) {
}

void t_py_generator::generate_py_sandesh_uve(std::ofstream& out,
                                             t_sandesh* tsandesh,
                                             bool update) {
  const vector<t_field*>& fields = tsandesh->get_members();
  vector<t_field*>::const_iterator f_iter = fields.begin();
  assert((*f_iter)->get_name() == "data");
  t_type* t = get_true_type((*f_iter)->get_type());
  t_struct* ts = (t_struct*)t;
  if (update) {
      out << indent() << "def update_uve(self, tdata):" << endl;
      indent_up();
      assert(t->is_struct());
      const vector<t_field*>& sfields = ts->get_members();
      vector<t_field*>::const_iterator s_iter;

      for (s_iter = sfields.begin(); s_iter != sfields.end(); ++s_iter) {
        out << indent() << "if self.data." << (*s_iter)->get_name() << " is not None:" << endl;
        indent_up();
        out << indent() << "tdata." << (*s_iter)->get_name() << " = self.data." <<
            (*s_iter)->get_name() << endl;
        indent_down();
      }
      out << indent() << "return tdata" << endl;
      f_iter++;
      assert(f_iter == fields.end());
      indent_down();
      out << endl;
  }

  const t_base_type *sandesh_type = (t_base_type *)tsandesh->get_type();
  if (sandesh_type->is_sandesh_uve() || sandesh_type->is_sandesh_dynamic_uve()) {
    // Update sandesh UVE list
    sandesh_uve_list_.push_back(boost::make_tuple(tsandesh->get_name(),
                                                  ts->get_name()));
  } else if (sandesh_type->is_sandesh_alarm()) {
    // Update sandesh Alarm list
    sandesh_alarm_list_.push_back(boost::make_tuple(tsandesh->get_name(),
                                                    ts->get_name()));
  }
}

void t_py_generator::generate_py_sandesh_uve_list(ofstream& out) {
  out << endl << endl;
  out << "_SANDESH_UVE_LIST = [" << endl;
  std::vector<boost::tuple<std::string, std::string> >::const_iterator it;
  for (it = sandesh_uve_list_.begin(); it != sandesh_uve_list_.end(); ++it) {
    indent(out) << "(" << it->get<0>() << ", " << it->get<1>() << ")," << endl;
  }
  out << "]" << endl;
}

void t_py_generator::generate_py_sandesh_alarm_list(ofstream& out) {
  out << endl << endl;
  out << "_SANDESH_ALARM_LIST = [" << endl;
  std::vector<boost::tuple<std::string, std::string> >::const_iterator it;
  for (it = sandesh_alarm_list_.begin(); it != sandesh_alarm_list_.end();
       ++it) {
    indent(out) << "(" << it->get<0>() << ", " << it->get<1>() << ")," << endl;
  }
  out << "]" << endl;
}
#endif

void t_py_generator::generate_service(t_service* tservice) {
  string f_service_name = package_dir_+"/"+service_name_+".py";
  f_service_.open(f_service_name.c_str());

  f_service_ <<
    py_autogen_comment() << endl <<
    py_imports() << endl;

  if (tservice->get_extends() != NULL) {
    f_service_ <<
      "import " << get_real_py_module(tservice->get_extends()->get_program(), gen_twisted_) <<
      "." << tservice->get_extends()->get_name() << endl;
  }

  f_service_ <<
    "from .ttypes import *" << endl <<
    "from thrift.Thrift import TProcessor" << endl <<
    render_fastbinary_includes() << endl;

  if (gen_twisted_) {
    f_service_ <<
      "from zope.interface import Interface, implements" << endl <<
      "from twisted.internet import defer" << endl <<
      "from thrift.transport import TTwisted" << endl;
  }

  f_service_ << endl;

  // Generate the three main parts of the service (well, two for now in PHP)
  generate_service_interface(tservice);
  generate_service_client(tservice);
  generate_service_server(tservice);
  generate_service_helpers(tservice);
  generate_service_remote(tservice);

  // Close service file
  f_service_.close();
}

void t_py_generator::generate_service_helpers(t_service* tservice) {
  vector<t_function*> functions = tservice->get_functions();
  vector<t_function*>::iterator f_iter;

  f_service_ <<
    "# HELPER FUNCTIONS AND STRUCTURES" << endl;

  for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
    t_struct* ts = (*f_iter)->get_arglist();
    generate_py_struct_definition(f_service_, ts, false);
    generate_py_function_helpers(*f_iter);
  }
}

void t_py_generator::generate_py_function_helpers(t_function* tfunction) {
  if (!tfunction->is_oneway()) {
    t_struct result(program_, tfunction->get_name() + "_result");
    t_field success(tfunction->get_returntype(), "success", 0);
    if (!tfunction->get_returntype()->is_void()) {
      result.append(&success);
    }

    t_struct* xs = tfunction->get_xceptions();
    const vector<t_field*>& fields = xs->get_members();
    vector<t_field*>::const_iterator f_iter;
    for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
      result.append(*f_iter);
    }
    generate_py_struct_definition(f_service_, &result, false, true);
  }
}

void t_py_generator::generate_service_interface(t_service* tservice) {
  string extends = "";
  string extends_if = "";
  if (tservice->get_extends() != NULL) {
    extends = type_name(tservice->get_extends());
    extends_if = "(" + extends + ".Iface)";
  } else {
    if (gen_twisted_) {
      extends_if = "(Interface)";
    } else if (gen_newstyle_ || gen_dynamic_) {
      extends_if = "(object)";
    }
  }

  f_service_ <<
    "class Iface" << extends_if << ":" << endl;
  indent_up();
  generate_python_docstring(f_service_, tservice);
  vector<t_function*> functions = tservice->get_functions();
  if (functions.empty()) {
    f_service_ <<
      indent() << "pass" << endl;
  } else {
    vector<t_function*>::iterator f_iter;
    for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
      f_service_ <<
        indent() << "def " << function_signature_if(*f_iter) << ":" << endl;
      indent_up();
      generate_python_docstring(f_service_, (*f_iter));
      f_service_ <<
        indent() << "pass" << endl << endl;
      indent_down();
    }
  }

  indent_down();
  f_service_ <<
    endl;
}

void t_py_generator::generate_service_client(t_service* tservice) {
  string extends = "";
  string extends_client = "";
  if (tservice->get_extends() != NULL) {
    extends = type_name(tservice->get_extends());
    if (gen_twisted_) {
      extends_client = "(" + extends + ".Client)";
    } else {
      extends_client = extends + ".Client, ";
    }
  } else {
    if (gen_twisted_ && (gen_newstyle_ || gen_dynamic_)) {
      extends_client = "(object)";
    }
  }

  if (gen_twisted_) {
    f_service_ <<
      "class Client" << extends_client << ":" << endl <<
      "  implements(Iface)" << endl << endl;
  } else {
    f_service_ <<
      "class Client(" << extends_client << "Iface):" << endl;
  }
  indent_up();
  generate_python_docstring(f_service_, tservice);

  // Constructor function
  if (gen_twisted_) {
    f_service_ <<
      indent() << "def __init__(self, transport, oprot_factory):" << endl;
  } else {
    f_service_ <<
      indent() << "def __init__(self, iprot, oprot=None):" << endl;
  }
  if (extends.empty()) {
    if (gen_twisted_) {
      f_service_ <<
        indent() << "  self._transport = transport" << endl <<
        indent() << "  self._oprot_factory = oprot_factory" << endl <<
        indent() << "  self._seqid = 0" << endl <<
        indent() << "  self._reqs = {}" << endl <<
        endl;
    } else {
      f_service_ <<
        indent() << "  self._iprot = self._oprot = iprot" << endl <<
        indent() << "  if oprot is not None:" << endl <<
        indent() << "    self._oprot = oprot" << endl <<
        indent() << "  self._seqid = 0" << endl <<
        endl;
    }
  } else {
    if (gen_twisted_) {
      f_service_ <<
        indent() << "  " << extends << ".Client.__init__(self, transport, oprot_factory)" << endl <<
        endl;
    } else {
      f_service_ <<
        indent() << "  " << extends << ".Client.__init__(self, iprot, oprot)" << endl <<
        endl;
    }
  }

  // Generate client method implementations
  vector<t_function*> functions = tservice->get_functions();
  vector<t_function*>::const_iterator f_iter;
  for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
    t_struct* arg_struct = (*f_iter)->get_arglist();
    const vector<t_field*>& fields = arg_struct->get_members();
    vector<t_field*>::const_iterator fld_iter;
    string funname = (*f_iter)->get_name();

    // Open function
    indent(f_service_) <<
      "def " << function_signature(*f_iter) << ":" << endl;
    indent_up();
    generate_python_docstring(f_service_, (*f_iter));
    if (gen_twisted_) {
      indent(f_service_) << "self._seqid += 1" << endl;
      if (!(*f_iter)->is_oneway()) {
        indent(f_service_) <<
          "d = self._reqs[self._seqid] = defer.Deferred()" << endl;
      }
    }

    indent(f_service_) <<
      "self.send_" << funname << "(";

    bool first = true;
    for (fld_iter = fields.begin(); fld_iter != fields.end(); ++fld_iter) {
      if (first) {
        first = false;
      } else {
        f_service_ << ", ";
      }
      f_service_ << (*fld_iter)->get_name();
    }
    f_service_ << ")" << endl;

    if (!(*f_iter)->is_oneway()) {
      f_service_ << indent();
      if (gen_twisted_) {
        f_service_ << "return d" << endl;
      } else {
        if (!(*f_iter)->get_returntype()->is_void()) {
          f_service_ << "return ";
        }
        f_service_ <<
          "self.recv_" << funname << "()" << endl;
      }
    } else {
      if (gen_twisted_) {
        f_service_ <<
          indent() << "return defer.succeed(None)" << endl;
      }
    }
    indent_down();
    f_service_ << endl;

    indent(f_service_) <<
      "def send_" << function_signature(*f_iter) << ":" << endl;

    indent_up();

    std::string argsname = (*f_iter)->get_name() + "_args";

    // Serialize the request header
    if (gen_twisted_) {
      f_service_ <<
        indent() << "oprot = self._oprot_factory.getProtocol(self._transport)" << endl <<
        indent() <<
          "oprot.writeMessageBegin('" << (*f_iter)->get_name() << "', TMessageType.CALL, self._seqid)"
        << endl;
    } else {
      f_service_ <<
        indent() << "self._oprot.writeMessageBegin('" << (*f_iter)->get_name() << "', TMessageType.CALL, self._seqid)" << endl;
    }

    f_service_ <<
      indent() << "args = " << argsname << "()" << endl;

    for (fld_iter = fields.begin(); fld_iter != fields.end(); ++fld_iter) {
      f_service_ <<
        indent() << "args." << (*fld_iter)->get_name() << " = " << (*fld_iter)->get_name() << endl;
    }

    // Write to the stream
    if (gen_twisted_) {
      f_service_ <<
        indent() << "args.write(oprot)" << endl <<
        indent() << "oprot.writeMessageEnd()" << endl <<
        indent() << "oprot.trans.flush()" << endl;
    } else {
      f_service_ <<
        indent() << "args.write(self._oprot)" << endl <<
        indent() << "self._oprot.writeMessageEnd()" << endl <<
        indent() << "self._oprot.trans.flush()" << endl;
    }

    indent_down();

    if (!(*f_iter)->is_oneway()) {
      std::string resultname = (*f_iter)->get_name() + "_result";
      // Open function
      f_service_ <<
        endl;
      if (gen_twisted_) {
        f_service_ <<
          indent() << "def recv_" << (*f_iter)->get_name() <<
              "(self, iprot, mtype, rseqid):" << endl;
      } else {
        t_struct noargs(program_);
        t_function recv_function((*f_iter)->get_returntype(),
                               string("recv_") + (*f_iter)->get_name(),
                               &noargs);
        f_service_ <<
          indent() << "def " << function_signature(&recv_function) << ":" << endl;
      }
      indent_up();

      // TODO(mcslee): Validate message reply here, seq ids etc.

      if (gen_twisted_) {
        f_service_ <<
          indent() << "d = self._reqs.pop(rseqid)" << endl;
      } else {
        f_service_ <<
          indent() << "(fname, mtype, rseqid) = self._iprot.readMessageBegin()" << endl;
      }

      f_service_ <<
        indent() << "if mtype == TMessageType.EXCEPTION:" << endl <<
        indent() << "  x = TApplicationException()" << endl;

      if (gen_twisted_) {
        f_service_ <<
          indent() << "  x.read(iprot)" << endl <<
          indent() << "  iprot.readMessageEnd()" << endl <<
          indent() << "  return d.errback(x)" << endl <<
          indent() << "result = " << resultname << "()" << endl <<
          indent() << "result.read(iprot)" << endl <<
          indent() << "iprot.readMessageEnd()" << endl;
      } else {
        f_service_ <<
          indent() << "  x.read(self._iprot)" << endl <<
          indent() << "  self._iprot.readMessageEnd()" << endl <<
          indent() << "  raise x" << endl <<
          indent() << "result = " << resultname << "()" << endl <<
          indent() << "result.read(self._iprot)" << endl <<
          indent() << "self._iprot.readMessageEnd()" << endl;
      }

      // Careful, only return _result if not a void function
      if (!(*f_iter)->get_returntype()->is_void()) {
        f_service_ <<
          indent() << "if result.success is not None:" << endl;
          if (gen_twisted_) {
            f_service_ <<
              indent() << "  return d.callback(result.success)" << endl;
          } else {
            f_service_ <<
              indent() << "  return result.success" << endl;
          }
      }

      t_struct* xs = (*f_iter)->get_xceptions();
      const std::vector<t_field*>& xceptions = xs->get_members();
      vector<t_field*>::const_iterator x_iter;
      for (x_iter = xceptions.begin(); x_iter != xceptions.end(); ++x_iter) {
        f_service_ <<
          indent() << "if result." << (*x_iter)->get_name() << " is not None:" << endl;
          if (gen_twisted_) {
            f_service_ <<
              indent() << "  return d.errback(result." << (*x_iter)->get_name() << ")" << endl;

          } else {
            f_service_ <<
              indent() << "  raise result." << (*x_iter)->get_name() << "" << endl;
          }
      }

      // Careful, only return _result if not a void function
      if ((*f_iter)->get_returntype()->is_void()) {
        if (gen_twisted_) {
          indent(f_service_) <<
            "return d.callback(None)" << endl;
        } else {
          indent(f_service_) <<
            "return" << endl;
        }
      } else {
        if (gen_twisted_) {
          f_service_ <<
            indent() << "return d.errback(TApplicationException(TApplicationException.MISSING_RESULT, \"" << (*f_iter)->get_name() << " failed: unknown result\"))" << endl;
        } else {
          f_service_ <<
            indent() << "raise TApplicationException(TApplicationException.MISSING_RESULT, \"" << (*f_iter)->get_name() << " failed: unknown result\");" << endl;
        }
      }

      // Close function
      indent_down();
      f_service_ << endl;
    }
  }

  indent_down();
  f_service_ <<
    endl;
}

void t_py_generator::generate_service_remote(t_service* tservice) {
  vector<t_function*> functions = tservice->get_functions();
  vector<t_function*>::iterator f_iter;

  string f_remote_name = package_dir_+"/"+service_name_+"-remote";
  ofstream f_remote;
  f_remote.open(f_remote_name.c_str());

  f_remote <<
    "#!/usr/bin/env python" << endl <<
    py_autogen_comment() << endl <<
    "import sys" << endl <<
    "import pprint" << endl <<
    "from urlparse import urlparse" << endl <<
    "from thrift.transport import TTransport" << endl <<
    "from thrift.transport import TSocket" << endl <<
    "from thrift.transport import THttpClient" << endl <<
    "from thrift.protocol import TBinaryProtocol" << endl <<
    endl;

  f_remote <<
    "import " << service_name_ << endl <<
    "from .ttypes import *" << endl <<
    endl;

  f_remote <<
    "if len(sys.argv) <= 1 or sys.argv[1] == '--help':" << endl <<
    "  print ''" << endl <<
    "  print 'Usage: ' + sys.argv[0] + ' [-h host[:port]] [-u url] [-f[ramed]] function [arg1 [arg2...]]'" << endl <<
    "  print ''" << endl <<
    "  print 'Functions:'" << endl;
  for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
    f_remote <<
      "  print '  " << (*f_iter)->get_returntype()->get_name() << " " << (*f_iter)->get_name() << "(";
    t_struct* arg_struct = (*f_iter)->get_arglist();
    const std::vector<t_field*>& args = arg_struct->get_members();
    vector<t_field*>::const_iterator a_iter;
    int num_args = args.size();
    bool first = true;
    for (int i = 0; i < num_args; ++i) {
      if (first) {
        first = false;
      } else {
        f_remote << ", ";
      }
      f_remote <<
        args[i]->get_type()->get_name() << " " << args[i]->get_name();
    }
    f_remote << ")'" << endl;
  }
  f_remote <<
    "  print ''" << endl <<
    "  sys.exit(0)" << endl <<
    endl;

  f_remote <<
    "pp = pprint.PrettyPrinter(indent = 2)" << endl <<
    "host = 'localhost'" << endl <<
    "port = 9090" << endl <<
    "uri = ''" << endl <<
    "framed = False" << endl <<
    "http = False" << endl <<
    "argi = 1" << endl <<
    endl <<
    "if sys.argv[argi] == '-h':" << endl <<
    "  parts = sys.argv[argi+1].split(':')" << endl <<
    "  host = parts[0]" << endl <<
    "  if len(parts) > 1:" << endl <<
    "    port = int(parts[1])" << endl <<
    "  argi += 2" << endl <<
    endl <<
    "if sys.argv[argi] == '-u':" << endl <<
    "  url = urlparse(sys.argv[argi+1])" << endl <<
    "  parts = url[1].split(':')" << endl <<
    "  host = parts[0]" << endl <<
    "  if len(parts) > 1:" << endl <<
    "    port = int(parts[1])" << endl <<
    "  else:" << endl <<
    "    port = 80" << endl <<
    "  uri = url[2]" << endl <<
    "  if url[4]:" << endl <<
    "    uri += '?%s' % url[4]" << endl <<
    "  http = True" << endl <<
    "  argi += 2" << endl <<
    endl <<
    "if sys.argv[argi] == '-f' or sys.argv[argi] == '-framed':" << endl <<
    "  framed = True" << endl <<
    "  argi += 1" << endl <<
    endl <<
    "cmd = sys.argv[argi]" << endl <<
    "args = sys.argv[argi+1:]" << endl <<
    endl <<
    "if http:" << endl <<
    "  transport = THttpClient.THttpClient(host, port, uri)" << endl <<
    "else:" << endl <<
    "  socket = TSocket.TSocket(host, port)" << endl <<
    "  if framed:" << endl <<
    "    transport = TTransport.TFramedTransport(socket)" << endl <<
    "  else:" << endl <<
    "    transport = TTransport.TBufferedTransport(socket)" << endl <<
    "protocol = TBinaryProtocol.TBinaryProtocol(transport)" << endl <<
    "client = " << service_name_ << ".Client(protocol)" << endl <<
    "transport.open()" << endl <<
    endl;

  // Generate the dispatch methods
  bool first = true;

  for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
    if (first) {
      first = false;
    } else {
      f_remote << "el";
    }

    t_struct* arg_struct = (*f_iter)->get_arglist();
    const std::vector<t_field*>& args = arg_struct->get_members();
    vector<t_field*>::const_iterator a_iter;
    int num_args = args.size();

    f_remote <<
      "if cmd == '" << (*f_iter)->get_name() << "':" << endl <<
      "  if len(args) != " << num_args << ":" << endl <<
      "    print '" << (*f_iter)->get_name() << " requires " << num_args << " args'" << endl <<
      "    sys.exit(1)" << endl <<
      "  pp.pprint(client." << (*f_iter)->get_name() << "(";
    for (int i = 0; i < num_args; ++i) {
      if (args[i]->get_type()->is_string()) {
        f_remote << "args[" << i << "],";
      } else {
        f_remote << "eval(args[" << i << "]),";
      }
    }
    f_remote << "))" << endl;

    f_remote << endl;
  }
  f_remote << "else:" << endl;
  f_remote << "  print 'Unrecognized method %s' % cmd" << endl;
  f_remote << "  sys.exit(1)" << endl;
  f_remote << endl;

  f_remote << "transport.close()" << endl;

  // Close service file
  f_remote.close();

#ifndef _MSC_VER

  // Make file executable, love that bitwise OR action
  chmod(f_remote_name.c_str(),
          S_IRUSR
        | S_IWUSR
        | S_IXUSR
#ifndef MINGW
        | S_IRGRP
        | S_IXGRP
        | S_IROTH
        | S_IXOTH
#endif
  );

#endif // _MSC_VER
}

void t_py_generator::generate_service_server(t_service* tservice) {
  // Generate the dispatch methods
  vector<t_function*> functions = tservice->get_functions();
  vector<t_function*>::iterator f_iter;

  string extends = "";
  string extends_processor = "";
  if (tservice->get_extends() != NULL) {
    extends = type_name(tservice->get_extends());
    extends_processor = extends + ".Processor, ";
  }

  // Generate the header portion
  if (gen_twisted_) {
    f_service_ <<
      "class Processor(" << extends_processor << "TProcessor):" << endl <<
      "  implements(Iface)" << endl << endl;
  } else {
    f_service_ <<
      "class Processor(" << extends_processor << "Iface, TProcessor):" << endl;
  }

  indent_up();

  indent(f_service_) <<
    "def __init__(self, handler):" << endl;
  indent_up();
  if (extends.empty()) {
    if (gen_twisted_) {
      f_service_ <<
        indent() << "self._handler = Iface(handler)" << endl;
    } else {
      f_service_ <<
        indent() << "self._handler = handler" << endl;
    }

    f_service_ <<
      indent() << "self._processMap = {}" << endl;
  } else {
    if (gen_twisted_) {
      f_service_ <<
        indent() << extends << ".Processor.__init__(self, Iface(handler))" << endl;
    } else {
      f_service_ <<
        indent() << extends << ".Processor.__init__(self, handler)" << endl;
    }
  }
  for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
    f_service_ <<
      indent() << "self._processMap[\"" << (*f_iter)->get_name() << "\"] = Processor.process_" << (*f_iter)->get_name() << endl;
  }
  indent_down();
  f_service_ << endl;

  // Generate the server implementation
  indent(f_service_) <<
    "def process(self, iprot, oprot):" << endl;
  indent_up();

  f_service_ <<
    indent() << "(name, type, seqid) = iprot.readMessageBegin()" << endl;

  // TODO(mcslee): validate message

  // HOT: dictionary function lookup
  f_service_ <<
    indent() << "if name not in self._processMap:" << endl <<
    indent() << "  iprot.skip(TType.STRUCT)" << endl <<
    indent() << "  iprot.readMessageEnd()" << endl <<
    indent() << "  x = TApplicationException(TApplicationException.UNKNOWN_METHOD, 'Unknown function %s' % (name))" << endl <<
    indent() << "  oprot.writeMessageBegin(name, TMessageType.EXCEPTION, seqid)" << endl <<
    indent() << "  x.write(oprot)" << endl <<
    indent() << "  oprot.writeMessageEnd()" << endl <<
    indent() << "  oprot.trans.flush()" << endl;

  if (gen_twisted_) {
    f_service_ <<
      indent() << "  return defer.succeed(None)" << endl;
  } else {
    f_service_ <<
      indent() << "  return" << endl;
  }

  f_service_ <<
    indent() << "else:" << endl;

  if (gen_twisted_) {
    f_service_ <<
      indent() << "  return self._processMap[name](self, seqid, iprot, oprot)" << endl;
  } else {
    f_service_ <<
      indent() << "  self._processMap[name](self, seqid, iprot, oprot)" << endl;

    // Read end of args field, the T_STOP, and the struct close
    f_service_ <<
      indent() << "return True" << endl;
  }

  indent_down();
  f_service_ << endl;

  // Generate the process subfunctions
  for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
    generate_process_function(tservice, *f_iter);
  }

  indent_down();
  f_service_ << endl;
}

void t_py_generator::generate_process_function(t_service* tservice,
                                               t_function* tfunction) {
  (void) tservice;
  // Open function
  indent(f_service_) <<
    "def process_" << tfunction->get_name() <<
    "(self, seqid, iprot, oprot):" << endl;
  indent_up();

  string argsname = tfunction->get_name() + "_args";
  string resultname = tfunction->get_name() + "_result";

  f_service_ <<
    indent() << "args = " << argsname << "()" << endl <<
    indent() << "args.read(iprot)" << endl <<
    indent() << "iprot.readMessageEnd()" << endl;

  t_struct* xs = tfunction->get_xceptions();
  const std::vector<t_field*>& xceptions = xs->get_members();
  vector<t_field*>::const_iterator x_iter;

  // Declare result for non oneway function
  if (!tfunction->is_oneway()) {
    f_service_ <<
      indent() << "result = " << resultname << "()" << endl;
  }

  if (gen_twisted_) {
    // Generate the function call
    t_struct* arg_struct = tfunction->get_arglist();
    const std::vector<t_field*>& fields = arg_struct->get_members();
    vector<t_field*>::const_iterator f_iter;

    f_service_ <<
      indent() << "d = defer.maybeDeferred(self._handler." <<
        tfunction->get_name() << ", ";
    bool first = true;
    for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
      if (first) {
        first = false;
      } else {
        f_service_ << ", ";
      }
      f_service_ << "args." << (*f_iter)->get_name();
    }
    f_service_ << ")" << endl;

    // Shortcut out here for oneway functions
    if (tfunction->is_oneway()) {
      f_service_ <<
        indent() << "return d" << endl;
      indent_down();
      f_service_ << endl;
      return;
    }

    f_service_ <<
      indent() <<
        "d.addCallback(self.write_results_success_" <<
          tfunction->get_name() << ", result, seqid, oprot)" << endl;

    if (xceptions.size() > 0) {
      f_service_ <<
        indent() <<
          "d.addErrback(self.write_results_exception_" <<
            tfunction->get_name() << ", result, seqid, oprot)" << endl;
    }

    f_service_ <<
      indent() << "return d" << endl;

    indent_down();
    f_service_ << endl;

    indent(f_service_) <<
        "def write_results_success_" << tfunction->get_name() <<
        "(self, success, result, seqid, oprot):" << endl;
    indent_up();
    f_service_ <<
      indent() << "result.success = success" << endl <<
      indent() << "oprot.writeMessageBegin(\"" << tfunction->get_name() <<
        "\", TMessageType.REPLY, seqid)" << endl <<
      indent() << "result.write(oprot)" << endl <<
      indent() << "oprot.writeMessageEnd()" << endl <<
      indent() << "oprot.trans.flush()" << endl;
    indent_down();
    f_service_ << endl;

    // Try block for a function with exceptions
    if (!tfunction->is_oneway() && xceptions.size() > 0) {
      indent(f_service_) <<
        "def write_results_exception_" << tfunction->get_name() <<
        "(self, error, result, seqid, oprot):" << endl;
      indent_up();
      f_service_ <<
        indent() << "try:" << endl;

      // Kinda absurd
      f_service_ <<
        indent() << "  error.raiseException()" << endl;
      for (x_iter = xceptions.begin(); x_iter != xceptions.end(); ++x_iter) {
        f_service_ <<
          indent() << "except " << type_name((*x_iter)->get_type()) << ", " << (*x_iter)->get_name() << ":" << endl;
        if (!tfunction->is_oneway()) {
          indent_up();
          f_service_ <<
            indent() << "result." << (*x_iter)->get_name() << " = " << (*x_iter)->get_name() << endl;
          indent_down();
        } else {
          f_service_ <<
            indent() << "pass" << endl;
        }
      }
      f_service_ <<
        indent() << "oprot.writeMessageBegin(\"" << tfunction->get_name() <<
          "\", TMessageType.REPLY, seqid)" << endl <<
        indent() << "result.write(oprot)" << endl <<
        indent() << "oprot.writeMessageEnd()" << endl <<
        indent() << "oprot.trans.flush()" << endl;
      indent_down();
      f_service_ << endl;
    }
  } else {

    // Try block for a function with exceptions
    if (xceptions.size() > 0) {
      f_service_ <<
        indent() << "try:" << endl;
      indent_up();
    }

    // Generate the function call
    t_struct* arg_struct = tfunction->get_arglist();
    const std::vector<t_field*>& fields = arg_struct->get_members();
    vector<t_field*>::const_iterator f_iter;

    f_service_ << indent();
    if (!tfunction->is_oneway() && !tfunction->get_returntype()->is_void()) {
      f_service_ << "result.success = ";
    }
    f_service_ <<
      "self._handler." << tfunction->get_name() << "(";
    bool first = true;
    for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
      if (first) {
        first = false;
      } else {
        f_service_ << ", ";
      }
      f_service_ << "args." << (*f_iter)->get_name();
    }
    f_service_ << ")" << endl;

    if (!tfunction->is_oneway() && xceptions.size() > 0) {
      indent_down();
      for (x_iter = xceptions.begin(); x_iter != xceptions.end(); ++x_iter) {
        f_service_ <<
          indent() << "except " << type_name((*x_iter)->get_type()) << ", " << (*x_iter)->get_name() << ":" << endl;
        if (!tfunction->is_oneway()) {
          indent_up();
          f_service_ <<
            indent() << "result." << (*x_iter)->get_name() << " = " << (*x_iter)->get_name() << endl;
          indent_down();
        } else {
          f_service_ <<
            indent() << "pass" << endl;
        }
      }
    }

    // Shortcut out here for oneway functions
    if (tfunction->is_oneway()) {
      f_service_ <<
        indent() << "return" << endl;
      indent_down();
      f_service_ << endl;
      return;
    }

    f_service_ <<
      indent() << "oprot.writeMessageBegin(\"" << tfunction->get_name() << "\", TMessageType.REPLY, seqid)" << endl <<
      indent() << "result.write(oprot)" << endl <<
      indent() << "oprot.writeMessageEnd()" << endl <<
      indent() << "oprot.trans.flush()" << endl;

    // Close function
    indent_down();
    f_service_ << endl;
  }
}

void t_py_generator::generate_deserialize_field(ofstream &out,
                                                t_field* tfield,
                                                string prefix,
                                                bool inclass) {
  (void) inclass;
  t_type* type = get_true_type(tfield->get_type());

  if (type->is_void()) {
    throw "CANNOT GENERATE DESERIALIZE CODE FOR void TYPE: " +
      prefix + tfield->get_name();
  }

  string name = prefix + tfield->get_name();

  if (type->is_struct() || type->is_xception()) {
    generate_deserialize_struct(out,
                                (t_struct*)type,
                                 name);
  } else if (type->is_container()) {
    generate_deserialize_container(out, type, name);
  } else if (type->is_base_type() || type->is_enum()) {
    indent(out) <<
#ifdef SANDESH
      "(length, " << name << ") = iprot.";
#else
      name << " = iprot.";
#endif
    if (type->is_base_type()) {
      t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
      switch (tbase) {
      case t_base_type::TYPE_VOID:
        throw "compiler error: cannot serialize void field in a struct: " +
          name;
        break;
      case t_base_type::TYPE_STRING:
#ifdef SANDESH
      case t_base_type::TYPE_STATIC_CONST_STRING:
#endif
        if (((t_base_type*)type)->is_binary() || !gen_utf8strings_) {
          out << "readString();";
        } else {
          out << "readString().decode('utf-8')";
        }
        break;
#ifdef SANDESH
      case t_base_type::TYPE_XML:
        out << "readXML();";
        break;
      case t_base_type::TYPE_UUID:
        out << "readUUID();";
        break;
#endif
      case t_base_type::TYPE_BOOL:
        out << "readBool();";
        break;
      case t_base_type::TYPE_BYTE:
        out << "readByte();";
        break;
      case t_base_type::TYPE_I16:
        out << "readI16();";
        break;
      case t_base_type::TYPE_I32:
        out << "readI32();";
        break;
      case t_base_type::TYPE_I64:
        out << "readI64();";
        break;
#ifdef SANDESH
      case t_base_type::TYPE_U16:
        out << "readU16();";
        break;
      case t_base_type::TYPE_U32:
        out << "readU32();";
        break;
      case t_base_type::TYPE_U64:
        out << "readU64();";
        break;
      case t_base_type::TYPE_IPV4:
        out << "readIPV4();";
        break;
      case t_base_type::TYPE_IPADDR:
        out << "readIPADDR()";
        break;
#endif
      case t_base_type::TYPE_DOUBLE:
        out << "readDouble();";
        break;
      default:
        throw "compiler error: no PHP name for base type " + t_base_type::t_base_name(tbase);
      }
    } else if (type->is_enum()) {
      out << "readI32();";
    }
    out << endl;
#ifdef SANDESH
    indent(out) << "if length < 0: return -1" << endl;
    indent(out) << "read_cnt += length" << endl;
#endif
  } else {
    printf("DO NOT KNOW HOW TO DESERIALIZE FIELD '%s' TYPE '%s'\n",
           tfield->get_name().c_str(), type->get_name().c_str());
  }
}

void t_py_generator::generate_deserialize_struct(ofstream &out,
                                                  t_struct* tstruct,
                                                  string prefix) {
  out <<
    indent() << prefix << " = " << type_name(tstruct) << "()" << endl <<
#ifdef SANDESH
    indent() << "read_cnt += " << prefix << ".read(iprot)" << endl;
#else
    indent() << prefix << ".read(iprot)" << endl;
#endif
}

void t_py_generator::generate_deserialize_container(ofstream &out,
                                                    t_type* ttype,
                                                    string prefix) {
  string size = tmp("_size");
  string ktype = tmp("_ktype");
  string vtype = tmp("_vtype");
  string etype = tmp("_etype");

  t_field fsize(g_type_i32, size);
  t_field fktype(g_type_byte, ktype);
  t_field fvtype(g_type_byte, vtype);
  t_field fetype(g_type_byte, etype);

  // Declare variables, read header
  if (ttype->is_map()) {
    out <<
      indent() << prefix << " = {}" << endl <<
#ifdef SANDESH
      indent() << "(length, " << ktype << ", " << vtype << ", " << size << " ) = iprot.readMapBegin() " << endl <<
      indent() << "read_cnt += length" << endl;
#else
      indent() << "(" << ktype << ", " << vtype << ", " << size << " ) = iprot.readMapBegin() " << endl;
#endif
  } else if (ttype->is_set()) {
    out <<
      indent() << prefix << " = set()" << endl <<
#ifdef SANDESH
      indent() << "(length, " << etype << ", " << size << ") = iprot.readSetBegin()" << endl <<
      indent() << "read_cnt += length" << endl;
#else
      indent() << "(" << etype << ", " << size << ") = iprot.readSetBegin()" << endl;
#endif
  } else if (ttype->is_list()) {
    out <<
      indent() << prefix << " = []" << endl <<
#ifdef SANDESH
      indent() << "(length, " << etype << ", " << size << ") = iprot.readListBegin()" << endl <<
      indent() << "read_cnt += length" << endl;
#else
      indent() << "(" << etype << ", " << size << ") = iprot.readListBegin()" << endl;
#endif
  }

  // For loop iterates over elements
  string i = tmp("_i");
  indent(out) <<
    "for " << i << " in range(" << size << "):" << endl;

    indent_up();

    if (ttype->is_map()) {
      generate_deserialize_map_element(out, (t_map*)ttype, prefix);
    } else if (ttype->is_set()) {
#ifdef SANDESH
      t_type *etype = ((t_set*)ttype)->get_elem_type();
      if (etype->is_base_type() || etype->is_enum()) {
        indent(out) << "read_cnt += iprot.readContainerElementBegin()" << endl;
      }
#endif
      generate_deserialize_set_element(out, (t_set*)ttype, prefix);
#ifdef SANDESH
      if (etype->is_base_type() || etype->is_enum()) {
        indent(out) << "read_cnt += iprot.readContainerElementEnd()" << endl;
      }
#endif
    } else if (ttype->is_list()) {
#ifdef SANDESH
      t_type *etype = ((t_list*)ttype)->get_elem_type();
      if (etype->is_base_type() || etype->is_enum()) {
        indent(out) << "read_cnt += iprot.readContainerElementBegin()" << endl;
      }
#endif
      generate_deserialize_list_element(out, (t_list*)ttype, prefix);
#ifdef SANDESH
      if (etype->is_base_type() || etype->is_enum()) {
        indent(out) << "read_cnt += iprot.readContainerElementEnd()" << endl;
      }
#endif
    }

    indent_down();

  // Read container end
  if (ttype->is_map()) {
#ifdef SANDESH
    indent(out) << "read_cnt += iprot.readMapEnd()" << endl;
#else
    indent(out) << "iprot.readMapEnd()" << endl;
#endif
  } else if (ttype->is_set()) {
#ifdef SANDESH
    indent(out) << "read_cnt += iprot.readSetEnd()" << endl;
#else
    indent(out) << "iprot.readSetEnd()" << endl;
#endif
  } else if (ttype->is_list()) {
#ifdef SANDESH
    indent(out) << "read_cnt += iprot.readListEnd()" << endl;
#else
    indent(out) << "iprot.readListEnd()" << endl;
#endif
  }
}


void t_py_generator::generate_deserialize_map_element(ofstream &out,
                                                       t_map* tmap,
                                                       string prefix) {
  string key = tmp("_key");
  string val = tmp("_val");
  t_field fkey(tmap->get_key_type(), key);
  t_field fval(tmap->get_val_type(), val);

#ifdef SANDESH
  t_type* kttype = tmap->get_key_type();
  if (kttype->is_base_type() || kttype->is_enum()) {
    indent(out) << "read_cnt += iprot.readContainerElementBegin()" << endl;
  }
#endif
  generate_deserialize_field(out, &fkey);
#ifdef SANDESH
  if (kttype->is_base_type() || kttype->is_enum()) {
    indent(out) << "read_cnt += iprot.readContainerElementEnd()" << endl;
  }
#endif

#ifdef SANDESH
  t_type* vttype = tmap->get_val_type();
  if (vttype->is_base_type() || vttype->is_enum()) {
    indent(out) << "read_cnt += iprot.readContainerElementBegin()" << endl;
  }
#endif
  generate_deserialize_field(out, &fval);
#ifdef SANDESH
  if (vttype->is_base_type() || vttype->is_enum()) {
    indent(out) << "read_cnt += iprot.readContainerElementEnd()" << endl;
  }
#endif

  indent(out) <<
    prefix << "[" << key << "] = " << val << endl;
}

void t_py_generator::generate_deserialize_set_element(ofstream &out,
                                                       t_set* tset,
                                                       string prefix) {
  string elem = tmp("_elem");
  t_field felem(tset->get_elem_type(), elem);

  generate_deserialize_field(out, &felem);

  indent(out) <<
    prefix << ".add(" << elem << ")" << endl;
}

void t_py_generator::generate_deserialize_list_element(ofstream &out,
                                                        t_list* tlist,
                                                        string prefix) {
  string elem = tmp("_elem");
  t_field felem(tlist->get_elem_type(), elem);

  generate_deserialize_field(out, &felem);

  indent(out) <<
    prefix << ".append(" << elem << ")" << endl;
}


void t_py_generator::generate_serialize_field(ofstream &out,
                                               t_field* tfield,
                                               string prefix) {
  t_type* type = get_true_type(tfield->get_type());

  // Do nothing for void types
  if (type->is_void()) {
    throw "CANNOT GENERATE SERIALIZE CODE FOR void TYPE: " +
      prefix + tfield->get_name();
  }

  if (type->is_struct() || type->is_xception()) {
    generate_serialize_struct(out,
                              (t_struct*)type,
                              prefix + tfield->get_name());
  } else if (type->is_container()) {
    generate_serialize_container(out,
                                 type,
                                 prefix + tfield->get_name());
  } else if (type->is_base_type() || type->is_enum()) {

    string name = prefix + tfield->get_name();

    indent(out) <<
      "if oprot.";

    if (type->is_base_type()) {
      t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
      switch (tbase) {
      case t_base_type::TYPE_VOID:
        throw
          "compiler error: cannot serialize void field in a struct: " + name;
        break;
      case t_base_type::TYPE_STRING:
#ifdef SANDESH
      case t_base_type::TYPE_STATIC_CONST_STRING:
#endif
        if (((t_base_type*)type)->is_binary() || !gen_utf8strings_) {
          out << "writeString(" << name << ")";
        } else {
          out << "writeString(" << name << ".encode('utf-8'))";
        }
        break;
#ifdef SANDESH
      case t_base_type::TYPE_XML:
        out << "writeXML(" << name << ")";
        break;
      case t_base_type::TYPE_UUID:
        out << "writeUUID(" << name << ")";
        break;
#endif
      case t_base_type::TYPE_BOOL:
        out << "writeBool(" << name << ")";
        break;
      case t_base_type::TYPE_BYTE:
        out << "writeByte(" << name << ")";
        break;
      case t_base_type::TYPE_I16:
        out << "writeI16(" << name << ")";
        break;
      case t_base_type::TYPE_I32:
        out << "writeI32(" << name << ")";
        break;
      case t_base_type::TYPE_I64:
        out << "writeI64(" << name << ")";
        break;
#ifdef SANDESH
      case t_base_type::TYPE_U16:
        out << "writeU16(" << name << ")";
        break;
      case t_base_type::TYPE_U32:
        out << "writeU32(" << name << ")";
        break;
      case t_base_type::TYPE_U64:
        out << "writeU64(" << name << ")";
        break;
      case t_base_type::TYPE_IPV4:
        out << "writeIPV4(" << name << ")";
        break;
      case t_base_type::TYPE_IPADDR:
        out << "writeIPADDR(" << name << ")";
        break;
#endif
      case t_base_type::TYPE_DOUBLE:
        out << "writeDouble(" << name << ")";
        break;
      default:
        throw "compiler error: no PHP name for base type " + t_base_type::t_base_name(tbase);
      }
    } else if (type->is_enum()) {
      out << "writeI32(" << name << ")";
    }
    out << " < 0: return -1" << endl;
#ifdef SANDESH
  } else if (type->is_sandesh()) {
    generate_serialize_sandesh(out, (t_sandesh*)type,
                               prefix + tfield->get_name());
#endif
  } else {
    printf("DO NOT KNOW HOW TO SERIALIZE FIELD '%s%s' TYPE '%s'\n",
           prefix.c_str(),
           tfield->get_name().c_str(),
           type->get_name().c_str());
  }
}

void t_py_generator::generate_serialize_struct(ofstream &out,
                                               t_struct* tstruct,
                                               string prefix) {
  (void) tstruct;
  indent(out) <<
    "if " << prefix << ".write(oprot) < 0: return -1" << endl;
}

#ifdef SANDESH

void t_py_generator::generate_serialize_sandesh(ofstream &out,
                                                t_sandesh* tsandesh,
                                                string prefix) {
  (void) tsandesh;
  indent(out) <<
    "if " << prefix << ".write(oprot) < 0: return -1" << endl;
}
#endif

void t_py_generator::generate_serialize_container(ofstream &out,
                                                  t_type* ttype,
                                                  string prefix) {
  if (ttype->is_map()) {
    indent(out) <<
      "if oprot.writeMapBegin(" <<
      type_to_enum(((t_map*)ttype)->get_key_type()) << ", " <<
      type_to_enum(((t_map*)ttype)->get_val_type()) << ", " <<
      "len(" << prefix << ")) < 0: return -1" << endl;
  } else if (ttype->is_set()) {
    indent(out) <<
      "if oprot.writeSetBegin(" <<
      type_to_enum(((t_set*)ttype)->get_elem_type()) << ", " <<
      "len(" << prefix << ")) < 0: return -1" << endl;
  } else if (ttype->is_list()) {
    indent(out) <<
      "if oprot.writeListBegin(" <<
      type_to_enum(((t_list*)ttype)->get_elem_type()) << ", " <<
      "len(" << prefix << ")) < 0: return -1" << endl;
  }

  if (ttype->is_map()) {
    string kiter = tmp("kiter");
    string viter = tmp("viter");
    indent(out) <<
      "for " << kiter << "," << viter << " in " << prefix << ".items():" << endl;
    indent_up();
    generate_serialize_map_element(out, (t_map*)ttype, kiter, viter);
    indent_down();
  } else if (ttype->is_set()) {
    string iter = tmp("iter");
    indent(out) <<
      "for " << iter << " in " << prefix << ":" << endl;
    indent_up();
#ifdef SANDESH
    t_type *etype = ((t_set*)ttype)->get_elem_type();
    if (etype->is_base_type() || etype->is_enum()) {
      indent(out) << "if oprot.writeContainerElementBegin() < 0: return -1" << endl;
    }
#endif
    generate_serialize_set_element(out, (t_set*)ttype, iter);
#ifdef SANDESH
    if (etype->is_base_type() || etype->is_enum()) {
      indent(out) << "if oprot.writeContainerElementEnd() < 0: return -1" << endl;
    }
#endif
    indent_down();
  } else if (ttype->is_list()) {
    string iter = tmp("iter");
    indent(out) <<
      "for " << iter << " in " << prefix << ":" << endl;
    indent_up();
#ifdef SANDESH
      t_type *etype = ((t_list*)ttype)->get_elem_type();
      if (etype->is_base_type() || etype->is_enum()) {
        indent(out) << "if oprot.writeContainerElementBegin() < 0: return -1" << endl;
      }
#endif
    generate_serialize_list_element(out, (t_list*)ttype, iter);
#ifdef SANDESH
      if (etype->is_base_type() || etype->is_enum()) {
        indent(out) << "if oprot.writeContainerElementEnd() < 0: return -1" << endl;
      }
#endif
    indent_down();
  }

  if (ttype->is_map()) {
    indent(out) <<
      "if oprot.writeMapEnd() < 0: return -1" << endl;
  } else if (ttype->is_set()) {
    indent(out) <<
      "if oprot.writeSetEnd() < 0: return -1" << endl;
  } else if (ttype->is_list()) {
    indent(out) <<
      "if oprot.writeListEnd() < 0: return -1" << endl;
  }
}

void t_py_generator::generate_serialize_map_element(ofstream &out,
                                                     t_map* tmap,
                                                     string kiter,
                                                     string viter) {
#ifdef SANDESH
  t_type* kttype = tmap->get_key_type();
  if (kttype->is_base_type() || kttype->is_enum()) {
    indent(out) << "if oprot.writeContainerElementBegin() < 0: return -1" << endl;
  }
#endif
  t_field kfield(tmap->get_key_type(), kiter);
  generate_serialize_field(out, &kfield, "");
#ifdef SANDESH
  if (kttype->is_base_type() || kttype->is_enum()) {
    indent(out) << "if oprot.writeContainerElementEnd() < 0: return -1" << endl;
  }
#endif

#ifdef SANDESH
  t_type* vttype = tmap->get_val_type();
  if (vttype->is_base_type() || vttype->is_enum()) {
    indent(out) << "if oprot.writeContainerElementBegin() < 0: return -1" << endl;
  }
#endif
  t_field vfield(tmap->get_val_type(), viter);
  generate_serialize_field(out, &vfield, "");
#ifdef SANDESH
  if (vttype->is_base_type() || vttype->is_enum()) {
    indent(out) << "if oprot.writeContainerElementEnd() < 0: return -1" << endl;
  }
#endif
}

void t_py_generator::generate_serialize_set_element(ofstream &out,
                                                     t_set* tset,
                                                     string iter) {
  t_field efield(tset->get_elem_type(), iter);
  generate_serialize_field(out, &efield, "");
}

void t_py_generator::generate_serialize_list_element(ofstream &out,
                                                      t_list* tlist,
                                                      string iter) {
  t_field efield(tlist->get_elem_type(), iter);
  generate_serialize_field(out, &efield, "");
}

void t_py_generator::generate_python_docstring(ofstream& out,
                                               t_struct* tstruct) {
  generate_python_docstring(out, tstruct, tstruct, "Attributes");
}

void t_py_generator::generate_python_docstring(ofstream& out,
                                               t_function* tfunction) {
  generate_python_docstring(out, tfunction, tfunction->get_arglist(), "Parameters");
}

void t_py_generator::generate_python_docstring(ofstream& out,
                                               t_doc*    tdoc,
                                               t_struct* tstruct,
                                               const char* subheader) {
  bool has_doc = false;
  stringstream ss;
  if (tdoc->has_doc()) {
    has_doc = true;
    ss << tdoc->get_doc();
  }

  const vector<t_field*>& fields = tstruct->get_members();
  if (fields.size() > 0) {
    if (has_doc) {
      ss << endl;
    }
    has_doc = true;
    ss << subheader << ":\n";
    vector<t_field*>::const_iterator p_iter;
    for (p_iter = fields.begin(); p_iter != fields.end(); ++p_iter) {
      t_field* p = *p_iter;
      ss << " - " << p->get_name();
      if (p->has_doc()) {
        ss << ": " << p->get_doc();
      } else {
        ss << endl;
      }
    }
  }

  if (has_doc) {
    generate_docstring_comment(out,
      "\"\"\"\n",
      "", ss.str(),
      "\"\"\"\n");
  }
}

void t_py_generator::generate_python_docstring(ofstream& out,
                                               t_doc* tdoc) {
  if (tdoc->has_doc()) {
    generate_docstring_comment(out,
      "\"\"\"\n",
      "", tdoc->get_doc(),
      "\"\"\"\n");
  }
}

string t_py_generator::declare_argument(t_field* tfield) {
  std::ostringstream result;
  result << tfield->get_name() << "=";
  if (tfield->get_value() != NULL) {
    result << "thrift_spec[" <<
      tfield->get_key() << "][4]";
  } else {
    result << "None";
  }
  return result.str();
}

string t_py_generator::render_field_default_value(t_field* tfield) {
  t_type* type = get_true_type(tfield->get_type());
  if (tfield->get_value() != NULL) {
    return render_const_value(type, tfield->get_value());
  } else {
    return "None";
  }
}

string t_py_generator::function_signature(t_function* tfunction,
                                           string prefix) {
  // TODO(mcslee): Nitpicky, no ',' if argument_list is empty
  return
    prefix + tfunction->get_name() +
    "(self, " + argument_list(tfunction->get_arglist()) + ")";
}

string t_py_generator::function_signature_if(t_function* tfunction,
                                           string prefix) {
  // TODO(mcslee): Nitpicky, no ',' if argument_list is empty
  string signature = prefix + tfunction->get_name() + "(";
  if (!gen_twisted_) {
    signature += "self, ";
  }
  signature += argument_list(tfunction->get_arglist()) + ")";
  return signature;
}


string t_py_generator::argument_list(t_struct* tstruct) {
  string result = "";

  const vector<t_field*>& fields = tstruct->get_members();
  vector<t_field*>::const_iterator f_iter;
  bool first = true;
  for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
    if (first) {
      first = false;
    } else {
      result += ", ";
    }
    result += (*f_iter)->get_name();
  }
  return result;
}

string t_py_generator::type_name(t_type* ttype) {
  t_program* program = ttype->get_program();
  if (ttype->is_service()) {
    return get_real_py_module(program, gen_twisted_) + "." + ttype->get_name();
  }
  if (program != NULL && program != program_) {
    return get_real_py_module(program, gen_twisted_) + "_ttypes." + ttype->get_name();
  }
  return ttype->get_name();
}

string t_py_generator::type_to_enum(t_type* type) {
  type = get_true_type(type);

  if (type->is_base_type()) {
    t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
    switch (tbase) {
    case t_base_type::TYPE_VOID:
      throw "NO T_VOID CONSTRUCT";
    case t_base_type::TYPE_STRING:
      return "TType.STRING";
    case t_base_type::TYPE_BOOL:
      return "TType.BOOL";
    case t_base_type::TYPE_BYTE:
      return "TType.BYTE";
    case t_base_type::TYPE_I16:
      return "TType.I16";
    case t_base_type::TYPE_I32:
      return "TType.I32";
    case t_base_type::TYPE_I64:
      return "TType.I64";
    case t_base_type::TYPE_DOUBLE:
      return "TType.DOUBLE";
#ifdef SANDESH
    case t_base_type::TYPE_XML:
      return "TType.XML";
    case t_base_type::TYPE_UUID:
      return "TType.UUID";
    case t_base_type::TYPE_U16:
      return "TType.U16";
    case t_base_type::TYPE_U32:
      return "TType.U32";
    case t_base_type::TYPE_U64:
      return "TType.U64";
    case t_base_type::TYPE_IPV4:
      return "TType.IPV4";
    case t_base_type::TYPE_IPADDR:
      return "TType.IPADDR";
    case t_base_type::TYPE_STATIC_CONST_STRING:
      return "TType.STRING";
    case t_base_type::TYPE_SANDESH_SYSTEM:
      return "TType.STRING";
    case t_base_type::TYPE_SANDESH_REQUEST:
      return "TType.STRING";
    case t_base_type::TYPE_SANDESH_RESPONSE:
      return "TType.STRING";
    case t_base_type::TYPE_SANDESH_TRACE:
      return "TType.STRING";
    case t_base_type::TYPE_SANDESH_TRACE_OBJECT:
        return "TType.STRING";
    case t_base_type::TYPE_SANDESH_BUFFER:
      return "TTytpe.STRING";
    case t_base_type::TYPE_SANDESH_UVE:
      return "TTytpe.STRING";
    case t_base_type::TYPE_SANDESH_DYNAMIC_UVE:
      return "TTytpe.STRING";
    case t_base_type::TYPE_SANDESH_ALARM:
      return "TTytpe.STRING";
    case t_base_type::TYPE_SANDESH_OBJECT:
      return "TTytpe.STRING";
    case t_base_type::TYPE_SANDESH_FLOW:
      return "TTytpe.STRING";
    case t_base_type::TYPE_SANDESH_SESSION:
      return "TTytpe.STRING";
#endif
    }
  } else if (type->is_enum()) {
    return "TType.I32";
  } else if (type->is_struct() || type->is_xception()) {
    return "TType.STRUCT";
#ifdef SANDESH
  } else if (type->is_sandesh()) {
    return "TType.SANDESH";
#endif
  } else if (type->is_map()) {
    return "TType.MAP";
  } else if (type->is_set()) {
    return "TType.SET";
  } else if (type->is_list()) {
    return "TType.LIST";
  }

  throw "INVALID TYPE IN type_to_enum: " + type->get_name();
}

string t_py_generator::type_to_spec_args(t_type* ttype) {
  while (ttype->is_typedef()) {
    ttype = ((t_typedef*)ttype)->get_type();
  }

  if (ttype->is_base_type() || ttype->is_enum()) {
    return "None";
  } else if (ttype->is_struct() || ttype->is_xception()) {
    return "(" + type_name(ttype) + ", " + type_name(ttype) + ".thrift_spec)";
  } else if (ttype->is_map()) {
    return "(" +
      type_to_enum(((t_map*)ttype)->get_key_type()) + "," +
      type_to_spec_args(((t_map*)ttype)->get_key_type()) + "," +
      type_to_enum(((t_map*)ttype)->get_val_type()) + "," +
      type_to_spec_args(((t_map*)ttype)->get_val_type()) +
      ")";

  } else if (ttype->is_set()) {
    return "(" +
      type_to_enum(((t_set*)ttype)->get_elem_type()) + "," +
      type_to_spec_args(((t_set*)ttype)->get_elem_type()) +
      ")";

  } else if (ttype->is_list()) {
    return "(" +
      type_to_enum(((t_list*)ttype)->get_elem_type()) + "," +
      type_to_spec_args(((t_list*)ttype)->get_elem_type()) +
      ")";
  }

  throw "INVALID TYPE IN type_to_spec_args: " + ttype->get_name();
}


THRIFT_REGISTER_GENERATOR(py, "Python",
"    new_style:       Generate new-style classes.\n" \
"    twisted:         Generate Twisted-friendly RPC services.\n" \
"    utf8strings:     Encode/decode strings using utf8 in the generated code.\n" \
"    slots:           Generate code using slots for instance members.\n" \
"    dynamic:         Generate dynamic code, less code generated but slower.\n" \
"    dynbase=CLS      Derive generated classes from class CLS instead of TBase.\n" \
"    dynexc=CLS       Derive generated exceptions from CLS instead of TExceptionBase.\n" \
"    dynimport='from foo.bar import CLS'\n" \
"                     Add an import line to generated code to find the dynbase class.\n")