compiler/cpp/src/generate/t_py_generator.cc

   1 // Copyright (c) 2006- Facebook
   2 // Distributed under the Thrift Software License
   3 //
   4 // See accompanying file LICENSE or visit the Thrift site at:
   5 // http://developers.facebook.com/thrift/
   6
   7 #include <stdlib.h>
   8 #include <sys/stat.h>
   9 #include <sys/types.h>
  10 #include <sstream>
  11 #include <algorithm>
  12 #include "t_py_generator.h"
  13 using namespace std;
  14
  15 /**
  16  * Prepares for file generation by opening up the necessary file output
  17  * streams.
  18  *
  19  * @param tprogram The program to generate
  20  */
  21 void t_py_generator::init_generator() {
  22   // Make output directory
  23   string module = get_real_py_module(program_);
  24   package_dir_ = get_out_dir();
  25   while (true) {
  26     // TODO: Do better error checking here.
  27     mkdir(package_dir_.c_str(), S_IRWXU | S_IRWXG | S_IRWXO);
  28     std::ofstream init_py((package_dir_+"/__init__.py").c_str());
  29     init_py.close();
  30     if (module.empty()) {
  31       break;
  32     }
  33     string::size_type pos = module.find('.');
  34     if (pos == string::npos) {
  35       package_dir_ += "/";
  36       package_dir_ += module;
  37       module.clear();
  38     } else {
  39       package_dir_ += "/";
  40       package_dir_ += module.substr(0, pos);
  41       module.erase(0, pos+1);
  42     }
  43   }
  44
  45   // Make output file
  46   string f_types_name = package_dir_+"/"+"ttypes.py";
  47   f_types_.open(f_types_name.c_str());
  48
  49   string f_consts_name = package_dir_+"/"+"constants.py";
  50   f_consts_.open(f_consts_name.c_str());
  51
  52   string f_init_name = package_dir_+"/__init__.py";
  53   ofstream f_init;
  54   f_init.open(f_init_name.c_str());
  55   f_init  <<
  56     "__all__ = ['ttypes', 'constants'";
  57   vector<t_service*> services = program_->get_services();
  58   vector<t_service*>::iterator sv_iter;
  59   for (sv_iter = services.begin(); sv_iter != services.end(); ++sv_iter) {
  60     f_init << ", '" << (*sv_iter)->get_name() << "'";
  61   }
  62   f_init << "]" << endl;
  63   f_init.close();
  64
  65   // Print header
  66   f_types_ <<
  67     py_autogen_comment() << endl <<
  68     py_imports() << endl <<
  69     render_includes() << endl <<
  70     render_fastbinary_includes() <<
  71     endl << endl;
  72
  73   f_consts_ <<
  74     py_autogen_comment() << endl <<
  75     py_imports() << endl <<
  76     "from ttypes import *" << endl <<
  77     endl;
  78 }
  79
  80 /**
  81  * Renders all the imports necessary for including another Thrift program
  82  */
  83 string t_py_generator::render_includes() {
  84   const vector<t_program*>& includes = program_->get_includes();
  85   string result = "";
  86   for (size_t i = 0; i < includes.size(); ++i) {
  87     result += "import " + get_real_py_module(includes[i]) + ".ttypes\n";
  88   }
  89   if (includes.size() > 0) {
  90     result += "\n";
  91   }
  92   return result;
  93 }
  94
  95 /**
  96  * Renders all the imports necessary to use the accelerated TBinaryProtocol
  97  */
  98 string t_py_generator::render_fastbinary_includes() {
  99   return
 100     "from thrift.transport import TTransport\n"
 101     "from thrift.protocol import TBinaryProtocol\n"
 102     "try:\n"
 103     "  from thrift.protocol import fastbinary\n"
 104     "except:\n"
 105     "  fastbinary = None\n";
 106 }
 107
 108 /**
 109  * Autogen'd comment
 110  */
 111 string t_py_generator::py_autogen_comment() {
 112   return
 113     std::string("#\n") +
 114     "# Autogenerated by Thrift\n" +
 115     "#\n" +
 116     "# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING\n" +
 117     "#\n";
 118 }
 119
 120 /**
 121  * Prints standard thrift imports
 122  */
 123 string t_py_generator::py_imports() {
 124   return
 125     string("from thrift.Thrift import *");
 126 }
 127
 128 /**
 129  * Closes the type files
 130  */
 131 void t_py_generator::close_generator() {
 132   // Close types file
 133   f_types_.close();
 134   f_consts_.close();
 135 }
 136
 137 /**
 138  * Generates a typedef. This is not done in Python, types are all implicit.
 139  *
 140  * @param ttypedef The type definition
 141  */
 142 void t_py_generator::generate_typedef(t_typedef* ttypedef) {}
 143
 144 /**
 145  * Generates code for an enumerated type. Done using a class to scope
 146  * the values.
 147  *
 148  * @param tenum The enumeration
 149  */
 150 void t_py_generator::generate_enum(t_enum* tenum) {
 151   f_types_ <<
 152     "class " << tenum->get_name() <<
 153     (gen_newstyle_ ? "(object)" : "") <<
 154     ":" << endl;
 155   indent_up();
 156
 157   vector<t_enum_value*> constants = tenum->get_constants();
 158   vector<t_enum_value*>::iterator c_iter;
 159   int value = -1;
 160   for (c_iter = constants.begin(); c_iter != constants.end(); ++c_iter) {
 161     if ((*c_iter)->has_value()) {
 162       value = (*c_iter)->get_value();
 163     } else {
 164       ++value;
 165     }
 166
 167     f_types_ <<
 168       indent() << (*c_iter)->get_name() << " = " << value << endl;
 169   }
 170
 171   indent_down();
 172   f_types_ << endl;
 173 }
 174
 175 /**
 176  * Generate a constant value
 177  */
 178 void t_py_generator::generate_const(t_const* tconst) {
 179   t_type* type = tconst->get_type();
 180   string name = tconst->get_name();
 181   t_const_value* value = tconst->get_value();
 182
 183   indent(f_consts_) << name << " = " << render_const_value(type, value);
 184   f_consts_ << endl << endl;
 185 }
 186
 187 /**
 188  * Prints the value of a constant with the given type. Note that type checking
 189  * is NOT performed in this function as it is always run beforehand using the
 190  * validate_types method in main.cc
 191  */
 192 string t_py_generator::render_const_value(t_type* type, t_const_value* value) {
 193   std::ostringstream out;
 194
 195   if (type->is_base_type()) {
 196     t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
 197     switch (tbase) {
 198     case t_base_type::TYPE_STRING:
 199       out << "'" << value->get_string() << "'";
 200       break;
 201     case t_base_type::TYPE_BOOL:
 202       out << (value->get_integer() > 0 ? "True" : "False");
 203       break;
 204     case t_base_type::TYPE_BYTE:
 205     case t_base_type::TYPE_I16:
 206     case t_base_type::TYPE_I32:
 207     case t_base_type::TYPE_I64:
 208       out << value->get_integer();
 209       break;
 210     case t_base_type::TYPE_DOUBLE:
 211       if (value->get_type() == t_const_value::CV_INTEGER) {
 212         out << value->get_integer();
 213       } else {
 214         out << value->get_double();
 215       }
 216       break;
 217     default:
 218       throw "compiler error: no const of base type " + t_base_type::t_base_name(tbase);
 219     }
 220   } else if (type->is_enum()) {
 221     indent(out) << value->get_integer();
 222   } else if (type->is_struct() || type->is_xception()) {
 223     out << type->get_name() << "({" << endl;
 224     indent_up();
 225     const vector<t_field*>& fields = ((t_struct*)type)->get_members();
 226     vector<t_field*>::const_iterator f_iter;
 227     const map<t_const_value*, t_const_value*>& val = value->get_map();
 228     map<t_const_value*, t_const_value*>::const_iterator v_iter;
 229     for (v_iter = val.begin(); v_iter != val.end(); ++v_iter) {
 230       t_type* field_type = NULL;
 231       for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
 232         if ((*f_iter)->get_name() == v_iter->first->get_string()) {
 233           field_type = (*f_iter)->get_type();
 234         }
 235       }
 236       if (field_type == NULL) {
 237         throw "type error: " + type->get_name() + " has no field " + v_iter->first->get_string();
 238       }
 239       out << indent();
 240       out << render_const_value(g_type_string, v_iter->first);
 241       out << " : ";
 242       out << render_const_value(field_type, v_iter->second);
 243       out << "," << endl;
 244     }
 245     indent_down();
 246     indent(out) << "})";
 247   } else if (type->is_map()) {
 248     t_type* ktype = ((t_map*)type)->get_key_type();
 249     t_type* vtype = ((t_map*)type)->get_val_type();
 250     out << "{" << endl;
 251     indent_up();
 252     const map<t_const_value*, t_const_value*>& val = value->get_map();
 253     map<t_const_value*, t_const_value*>::const_iterator v_iter;
 254     for (v_iter = val.begin(); v_iter != val.end(); ++v_iter) {
 255       out << indent();
 256       out << render_const_value(ktype, v_iter->first);
 257       out << " : ";
 258       out << render_const_value(vtype, v_iter->second);
 259       out << "," << endl;
 260     }
 261     indent_down();
 262     indent(out) << "}";
 263   } else if (type->is_list() || type->is_set()) {
 264     t_type* etype;
 265     if (type->is_list()) {
 266       etype = ((t_list*)type)->get_elem_type();
 267     } else {
 268       etype = ((t_set*)type)->get_elem_type();
 269     }
 270     if (type->is_set()) {
 271       out << "set(";
 272     }
 273     out << "[" << endl;
 274     indent_up();
 275     const vector<t_const_value*>& val = value->get_list();
 276     vector<t_const_value*>::const_iterator v_iter;
 277     for (v_iter = val.begin(); v_iter != val.end(); ++v_iter) {
 278       out << indent();
 279       out << render_const_value(etype, *v_iter);
 280       out << "," << endl;
 281     }
 282     indent_down();
 283     indent(out) << "]";
 284     if (type->is_set()) {
 285       out << ")";
 286     }
 287   }
 288
 289   return out.str();
 290 }
 291
 292 /**
 293  * Generates a python struct
 294  */
 295 void t_py_generator::generate_struct(t_struct* tstruct) {
 296   generate_py_struct(tstruct, false);
 297 }
 298
 299 /**
 300  * Generates a struct definition for a thrift exception. Basically the same
 301  * as a struct but extends the Exception class.
 302  *
 303  * @param txception The struct definition
 304  */
 305 void t_py_generator::generate_xception(t_struct* txception) {
 306   generate_py_struct(txception, true);
 307 }
 308
 309 /**
 310  * Generates a python struct
 311  */
 312 void t_py_generator::generate_py_struct(t_struct* tstruct,
 313                                         bool is_exception) {
 314   generate_py_struct_definition(f_types_, tstruct, is_exception);
 315 }
 316
 317 /**
 318  * Comparator to sort fields in ascending order by key.
 319  * Make this a functor instead of a function to help GCC inline it.
 320  * The arguments are (const) references to const pointers to const t_fields.
 321  * Unfortunately, we cannot declare it within the function.  Boo!
 322  * http://www.open-std.org/jtc1/sc22/open/n2356/ (paragraph 9).
 323  */
 324 struct FieldKeyCompare {
 325   bool operator()(t_field const * const & a, t_field const * const & b) {
 326     return a->get_key() < b->get_key();
 327   }
 328 };
 329
 330 /**
 331  * Generates a struct definition for a thrift data type.
 332  *
 333  * @param tstruct The struct definition
 334  */
 335 void t_py_generator::generate_py_struct_definition(ofstream& out,
 336                                                    t_struct* tstruct,
 337                                                    bool is_exception,
 338                                                    bool is_result) {
 339
 340   const vector<t_field*>& members = tstruct->get_members();
 341   vector<t_field*>::const_iterator m_iter;
 342   vector<t_field*> sorted_members(members);
 343   std::sort(sorted_members.begin(), sorted_members.end(), FieldKeyCompare());
 344
 345   out <<
 346     "class " << tstruct->get_name();
 347   if (is_exception) {
 348     out << "(Exception)";
 349   } else if (gen_newstyle_) {
 350     out << "(object)";
 351   }
 352   out <<
 353     ":" << endl;
 354   indent_up();
 355
 356   out << endl;
 357
 358   /*
 359      Here we generate the structure specification for the fastbinary codec.
 360      These specifications have the following structure:
 361      thrift_spec -> tuple of item_spec
 362      item_spec -> None | (tag, type_enum, name, spec_args, default)
 363      tag -> integer
 364      type_enum -> TType.I32 | TType.STRING | TType.STRUCT | ...
 365      name -> string_literal
 366      default -> None  # Handled by __init__
 367      spec_args -> None  # For simple types
 368                 | (type_enum, spec_args)  # Value type for list/set
 369                 | (type_enum, spec_args, type_enum, spec_args)
 370                   # Key and value for map
 371                 | (class_name, spec_args_ptr) # For struct/exception
 372      class_name -> identifier  # Basically a pointer to the class
 373      spec_args_ptr -> expression  # just class_name.spec_args
 374
 375      TODO(dreiss): Consider making this work for structs with negative tags.
 376   */
 377
 378   // TODO(dreiss): Look into generating an empty tuple instead of None
 379   // for structures with no members.
 380   // TODO(dreiss): Test encoding of structs where some inner structs
 381   // don't have thrift_spec.
 382   if (sorted_members.empty() || (sorted_members[0]->get_key() >= 0)) {
 383     indent(out) << "thrift_spec = (" << endl;
 384     indent_up();
 385
 386     int sorted_keys_pos = 0;
 387     for (m_iter = sorted_members.begin(); m_iter != sorted_members.end(); ++m_iter) {
 388
 389       for (; sorted_keys_pos != (*m_iter)->get_key(); sorted_keys_pos++) {
 390         indent(out) << "None, # " << sorted_keys_pos << endl;
 391       }
 392
 393       indent(out) << "(" << (*m_iter)->get_key() << ", "
 394             << type_to_enum((*m_iter)->get_type()) << ", "
 395             << "'" << (*m_iter)->get_name() << "'" << ", "
 396             << type_to_spec_args((*m_iter)->get_type()) << ", "
 397             << "None" << ", "
 398             << "),"
 399             << " # " << sorted_keys_pos
 400             << endl;
 401
 402       sorted_keys_pos ++;
 403     }
 404
 405     indent_down();
 406     indent(out) << ")" << endl << endl;
 407   } else {
 408     indent(out) << "thrift_spec = None" << endl;
 409   }
 410
 411
 412   out <<
 413     indent() << "def __init__(self, d=None):" << endl;
 414   indent_up();
 415
 416   if (members.size() == 0) {
 417     indent(out) <<
 418       "pass" <<endl;
 419   } else {
 420     for (m_iter = members.begin(); m_iter != members.end(); ++m_iter) {
 421       // This fills in default values, as opposed to nulls
 422       indent(out) <<
 423         declare_field(*m_iter) << endl;
 424     }
 425
 426     indent(out) <<
 427       "if isinstance(d, dict):" << endl;
 428     indent_up();
 429     for (m_iter = members.begin(); m_iter != members.end(); ++m_iter) {
 430       out <<
 431         indent() << "if '" << (*m_iter)->get_name() << "' in d:" << endl <<
 432         indent() << "  self." << (*m_iter)->get_name() << " = d['" << (*m_iter)->get_name() << "']" << endl;
 433     }
 434     indent_down();
 435   }
 436
 437   indent_down();
 438
 439   out << endl;
 440
 441
 442   generate_py_struct_reader(out, tstruct);
 443   generate_py_struct_writer(out, tstruct);
 444
 445   // Printing utilities so that on the command line thrift
 446   // structs look pretty like dictionaries
 447   out <<
 448     indent() << "def __str__(self): " << endl <<
 449     indent() << "  return str(self.__dict__)" << endl <<
 450     endl <<
 451     indent() << "def __repr__(self): " << endl <<
 452     indent() << "  return repr(self.__dict__)" << endl <<
 453     endl;
 454
 455   // Equality and inequality methods that compare by value
 456   out <<
 457     indent() << "def __eq__(self, other):" << endl;
 458   indent_up();
 459   out <<
 460     indent() << "return isinstance(other, self.__class__) and "
 461                 "self.__dict__ == other.__dict__" << endl;
 462   indent_down();
 463   out << endl;
 464
 465   out <<
 466     indent() << "def __ne__(self, other):" << endl;
 467   indent_up();
 468   out <<
 469     indent() << "return not (self == other)" << endl;
 470   indent_down();
 471   out << endl;
 472
 473   indent_down();
 474 }
 475
 476 /**
 477  * Generates the read method for a struct
 478  */
 479 void t_py_generator::generate_py_struct_reader(ofstream& out,
 480                                                 t_struct* tstruct) {
 481   const vector<t_field*>& fields = tstruct->get_members();
 482   vector<t_field*>::const_iterator f_iter;
 483
 484   indent(out) <<
 485     "def read(self, iprot):" << endl;
 486   indent_up();
 487
 488   indent(out) <<
 489     "if iprot.__class__ == TBinaryProtocol.TBinaryProtocolAccelerated "
 490     "and isinstance(iprot.trans, TTransport.CReadableTransport) "
 491     "and self.thrift_spec is not None "
 492     "and fastbinary is not None:" << endl;
 493   indent_up();
 494
 495   indent(out) <<
 496     "fastbinary.decode_binary(self, iprot.trans, (self.__class__, self.thrift_spec))" << endl;
 497   indent(out) <<
 498     "return" << endl;
 499   indent_down();
 500
 501   indent(out) <<
 502     "iprot.readStructBegin()" << endl;
 503
 504   // Loop over reading in fields
 505   indent(out) <<
 506     "while True:" << endl;
 507     indent_up();
 508
 509     // Read beginning field marker
 510     indent(out) <<
 511       "(fname, ftype, fid) = iprot.readFieldBegin()" << endl;
 512
 513     // Check for field STOP marker and break
 514     indent(out) <<
 515       "if ftype == TType.STOP:" << endl;
 516     indent_up();
 517     indent(out) <<
 518       "break" << endl;
 519     indent_down();
 520
 521     // Switch statement on the field we are reading
 522     bool first = true;
 523
 524     // Generate deserialization code for known cases
 525     for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
 526       if (first) {
 527         first = false;
 528         out <<
 529           indent() << "if ";
 530       } else {
 531         out <<
 532           indent() << "elif ";
 533       }
 534       out << "fid == " << (*f_iter)->get_key() << ":" << endl;
 535       indent_up();
 536       indent(out) << "if ftype == " << type_to_enum((*f_iter)->get_type()) << ":" << endl;
 537       indent_up();
 538       generate_deserialize_field(out, *f_iter, "self.");
 539       indent_down();
 540       out <<
 541         indent() << "else:" << endl <<
 542         indent() << "  iprot.skip(ftype)" << endl;
 543       indent_down();
 544     }
 545
 546     // In the default case we skip the field
 547     out <<
 548       indent() <<  "else:" << endl <<
 549       indent() <<  "  iprot.skip(ftype)" << endl;
 550
 551     // Read field end marker
 552     indent(out) <<
 553       "iprot.readFieldEnd()" << endl;
 554
 555     indent_down();
 556
 557     indent(out) <<
 558       "iprot.readStructEnd()" << endl;
 559
 560     indent_down();
 561   out << endl;
 562 }
 563
 564 void t_py_generator::generate_py_struct_writer(ofstream& out,
 565                                                t_struct* tstruct) {
 566   string name = tstruct->get_name();
 567   const vector<t_field*>& fields = tstruct->get_members();
 568   vector<t_field*>::const_iterator f_iter;
 569
 570   indent(out) <<
 571     "def write(self, oprot):" << endl;
 572   indent_up();
 573
 574   indent(out) <<
 575     "if oprot.__class__ == TBinaryProtocol.TBinaryProtocolAccelerated "
 576     "and self.thrift_spec is not None "
 577     "and fastbinary is not None:" << endl;
 578   indent_up();
 579
 580   indent(out) <<
 581     "oprot.trans.write(fastbinary.encode_binary(self, (self.__class__, self.thrift_spec)))" << endl;
 582   indent(out) <<
 583     "return" << endl;
 584   indent_down();
 585
 586   indent(out) <<
 587     "oprot.writeStructBegin('" << name << "')" << endl;
 588
 589   for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
 590     // Write field header
 591     indent(out) <<
 592       "if self." << (*f_iter)->get_name() << " != None:" << endl;
 593     indent_up();
 594     indent(out) <<
 595       "oprot.writeFieldBegin(" <<
 596       "'" << (*f_iter)->get_name() << "', " <<
 597       type_to_enum((*f_iter)->get_type()) << ", " <<
 598       (*f_iter)->get_key() << ")" << endl;
 599
 600     // Write field contents
 601     generate_serialize_field(out, *f_iter, "self.");
 602
 603     // Write field closer
 604     indent(out) <<
 605       "oprot.writeFieldEnd()" << endl;
 606
 607     indent_down();
 608   }
 609
 610   // Write the struct map
 611   out <<
 612     indent() << "oprot.writeFieldStop()" << endl <<
 613     indent() << "oprot.writeStructEnd()" << endl;
 614
 615   indent_down();
 616   out <<
 617     endl;
 618 }
 619
 620 /**
 621  * Generates a thrift service.
 622  *
 623  * @param tservice The service definition
 624  */
 625 void t_py_generator::generate_service(t_service* tservice) {
 626   string f_service_name = package_dir_+"/"+service_name_+".py";
 627   f_service_.open(f_service_name.c_str());
 628
 629   f_service_ <<
 630     py_autogen_comment() << endl <<
 631     py_imports() << endl;
 632
 633   if (tservice->get_extends() != NULL) {
 634     f_service_ <<
 635       "import " << get_real_py_module(tservice->get_extends()->get_program()) <<
 636       "." << tservice->get_extends()->get_name() << endl;
 637   }
 638
 639   f_service_ <<
 640     "from ttypes import *" << endl <<
 641     "from thrift.Thrift import TProcessor" << endl <<
 642     render_fastbinary_includes() <<
 643     endl << endl;
 644
 645   // Generate the three main parts of the service (well, two for now in PHP)
 646   generate_service_interface(tservice);
 647   generate_service_client(tservice);
 648   generate_service_server(tservice);
 649   generate_service_helpers(tservice);
 650   generate_service_remote(tservice);
 651
 652   // Close service file
 653   f_service_ << endl;
 654   f_service_.close();
 655 }
 656
 657 /**
 658  * Generates helper functions for a service.
 659  *
 660  * @param tservice The service to generate a header definition for
 661  */
 662 void t_py_generator::generate_service_helpers(t_service* tservice) {
 663   vector<t_function*> functions = tservice->get_functions();
 664   vector<t_function*>::iterator f_iter;
 665
 666   f_service_ <<
 667     "# HELPER FUNCTIONS AND STRUCTURES" << endl << endl;
 668
 669   for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
 670     t_struct* ts = (*f_iter)->get_arglist();
 671     generate_py_struct_definition(f_service_, ts, false);
 672     generate_py_function_helpers(*f_iter);
 673   }
 674 }
 675
 676 /**
 677  * Generates a struct and helpers for a function.
 678  *
 679  * @param tfunction The function
 680  */
 681 void t_py_generator::generate_py_function_helpers(t_function* tfunction) {
 682   t_struct result(program_, tfunction->get_name() + "_result");
 683   t_field success(tfunction->get_returntype(), "success", 0);
 684   if (!tfunction->get_returntype()->is_void()) {
 685     result.append(&success);
 686   }
 687
 688   t_struct* xs = tfunction->get_xceptions();
 689   const vector<t_field*>& fields = xs->get_members();
 690   vector<t_field*>::const_iterator f_iter;
 691   for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
 692     result.append(*f_iter);
 693   }
 694   generate_py_struct_definition(f_service_, &result, false, true);
 695 }
 696
 697 /**
 698  * Generates a service interface definition.
 699  *
 700  * @param tservice The service to generate a header definition for
 701  */
 702 void t_py_generator::generate_service_interface(t_service* tservice) {
 703   string extends = "";
 704   string extends_if = "";
 705   if (tservice->get_extends() != NULL) {
 706     extends = type_name(tservice->get_extends());
 707     extends_if = "(" + extends + ".Iface)";
 708   }
 709
 710   f_service_ <<
 711     "class Iface" << extends_if << ":" << endl;
 712   indent_up();
 713   vector<t_function*> functions = tservice->get_functions();
 714   vector<t_function*>::iterator f_iter;
 715   for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
 716     f_service_ <<
 717       indent() << "def " << function_signature(*f_iter) << ":" << endl <<
 718       indent() << "  pass" << endl << endl;
 719   }
 720   indent_down();
 721   f_service_ <<
 722     endl;
 723 }
 724
 725 /**
 726  * Generates a service client definition.
 727  *
 728  * @param tservice The service to generate a server for.
 729  */
 730 void t_py_generator::generate_service_client(t_service* tservice) {
 731   string extends = "";
 732   string extends_client = "";
 733   if (tservice->get_extends() != NULL) {
 734     extends = type_name(tservice->get_extends());
 735     extends_client = extends + ".Client, ";
 736   }
 737
 738   f_service_ <<
 739     "class Client(" << extends_client << "Iface):" << endl;
 740   indent_up();
 741
 742   // Constructor function
 743   f_service_ <<
 744     indent() << "def __init__(self, iprot, oprot=None):" << endl;
 745   if (extends.empty()) {
 746     f_service_ <<
 747       indent() << "  self._iprot = self._oprot = iprot" << endl <<
 748       indent() << "  if oprot != None:" << endl <<
 749       indent() << "    self._oprot = oprot" << endl <<
 750       indent() << "  self._seqid = 0" << endl <<
 751       endl;
 752   } else {
 753     f_service_ <<
 754       indent() << "  " << extends << ".Client.__init__(self, iprot, oprot)" << endl <<
 755       endl;
 756   }
 757
 758   // Generate client method implementations
 759   vector<t_function*> functions = tservice->get_functions();
 760   vector<t_function*>::const_iterator f_iter;
 761   for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
 762     t_struct* arg_struct = (*f_iter)->get_arglist();
 763     const vector<t_field*>& fields = arg_struct->get_members();
 764     vector<t_field*>::const_iterator fld_iter;
 765     string funname = (*f_iter)->get_name();
 766
 767     // Open function
 768     indent(f_service_) <<
 769       "def " << function_signature(*f_iter) << ":" << endl;
 770     indent_up();
 771       indent(f_service_) <<
 772         "self.send_" << funname << "(";
 773
 774       bool first = true;
 775       for (fld_iter = fields.begin(); fld_iter != fields.end(); ++fld_iter) {
 776         if (first) {
 777           first = false;
 778         } else {
 779           f_service_ << ", ";
 780         }
 781         f_service_ << (*fld_iter)->get_name();
 782       }
 783       f_service_ << ")" << endl;
 784
 785       if (!(*f_iter)->is_async()) {
 786         f_service_ << indent();
 787         if (!(*f_iter)->get_returntype()->is_void()) {
 788           f_service_ << "return ";
 789         }
 790         f_service_ <<
 791           "self.recv_" << funname << "()" << endl;
 792       }
 793     indent_down();
 794     f_service_ << endl;
 795
 796     indent(f_service_) <<
 797       "def send_" << function_signature(*f_iter) << ":" << endl;
 798     indent_up();
 799
 800       std::string argsname = (*f_iter)->get_name() + "_args";
 801
 802       // Serialize the request header
 803       f_service_ <<
 804         indent() << "self._oprot.writeMessageBegin('" << (*f_iter)->get_name() << "', TMessageType.CALL, self._seqid)" << endl;
 805
 806       f_service_ <<
 807         indent() << "args = " << argsname << "()" << endl;
 808
 809       for (fld_iter = fields.begin(); fld_iter != fields.end(); ++fld_iter) {
 810         f_service_ <<
 811           indent() << "args." << (*fld_iter)->get_name() << " = " << (*fld_iter)->get_name() << endl;
 812       }
 813
 814       // Write to the stream
 815       f_service_ <<
 816         indent() << "args.write(self._oprot)" << endl <<
 817         indent() << "self._oprot.writeMessageEnd()" << endl <<
 818         indent() << "self._oprot.trans.flush()" << endl;
 819
 820     indent_down();
 821
 822     if (!(*f_iter)->is_async()) {
 823       std::string resultname = (*f_iter)->get_name() + "_result";
 824       t_struct noargs(program_);
 825
 826       t_function recv_function((*f_iter)->get_returntype(),
 827                                string("recv_") + (*f_iter)->get_name(),
 828                                &noargs);
 829       // Open function
 830       f_service_ <<
 831         endl <<
 832         indent() << "def " << function_signature(&recv_function) << ":" << endl;
 833       indent_up();
 834
 835       // TODO(mcslee): Validate message reply here, seq ids etc.
 836
 837       f_service_ <<
 838         indent() << "(fname, mtype, rseqid) = self._iprot.readMessageBegin()" << endl <<
 839         indent() << "if mtype == TMessageType.EXCEPTION:" << endl <<
 840         indent() << "  x = TApplicationException()" << endl <<
 841         indent() << "  x.read(self._iprot)" << endl <<
 842         indent() << "  self._iprot.readMessageEnd()" << endl <<
 843         indent() << "  raise x" << endl;
 844
 845       f_service_ <<
 846         indent() << "result = " << resultname << "()" << endl <<
 847         indent() << "result.read(self._iprot)" << endl <<
 848         indent() << "self._iprot.readMessageEnd()" << endl;
 849
 850       // Careful, only return _result if not a void function
 851       if (!(*f_iter)->get_returntype()->is_void()) {
 852         f_service_ <<
 853           indent() << "if result.success != None:" << endl <<
 854           indent() << "  return result.success" << endl;
 855       }
 856
 857       t_struct* xs = (*f_iter)->get_xceptions();
 858       const std::vector<t_field*>& xceptions = xs->get_members();
 859       vector<t_field*>::const_iterator x_iter;
 860       for (x_iter = xceptions.begin(); x_iter != xceptions.end(); ++x_iter) {
 861         f_service_ <<
 862           indent() << "if result." << (*x_iter)->get_name() << " != None:" << endl <<
 863           indent() << "  raise result." << (*x_iter)->get_name() << "" << endl;
 864       }
 865
 866       // Careful, only return _result if not a void function
 867       if ((*f_iter)->get_returntype()->is_void()) {
 868         indent(f_service_) <<
 869           "return" << endl;
 870       } else {
 871         f_service_ <<
 872           indent() << "raise TApplicationException(TApplicationException.MISSING_RESULT, \"" << (*f_iter)->get_name() << " failed: unknown result\");" << endl;
 873       }
 874
 875       // Close function
 876       indent_down();
 877       f_service_ << endl;
 878     }
 879   }
 880
 881   indent_down();
 882   f_service_ <<
 883     endl;
 884 }
 885
 886 /**
 887  * Generates a command line tool for making remote requests
 888  *
 889  * @param tservice The service to generate a remote for.
 890  */
 891 void t_py_generator::generate_service_remote(t_service* tservice) {
 892   vector<t_function*> functions = tservice->get_functions();
 893   vector<t_function*>::iterator f_iter;
 894
 895   string f_remote_name = package_dir_+"/"+service_name_+"-remote";
 896   ofstream f_remote;
 897   f_remote.open(f_remote_name.c_str());
 898
 899   f_remote <<
 900     "#!/usr/bin/env python" << endl <<
 901     py_autogen_comment() << endl <<
 902     "import sys" << endl <<
 903     "import pprint" << endl <<
 904     "from urlparse import urlparse" << endl <<
 905     "from thrift.transport import TTransport" << endl <<
 906     "from thrift.transport import TSocket" << endl <<
 907     "from thrift.transport import THttpClient" << endl <<
 908     "from thrift.protocol import TBinaryProtocol" << endl <<
 909     endl;
 910
 911   f_remote <<
 912     "import " << service_name_ << endl <<
 913     "from ttypes import *" << endl <<
 914     endl;
 915
 916   f_remote <<
 917     "if len(sys.argv) <= 1 or sys.argv[1] == '--help':" << endl <<
 918     "  print ''" << endl <<
 919     "  print 'Usage: ' + sys.argv[0] + ' [-h host:port] [-u url] [-f[ramed]] function [arg1 [arg2...]]'" << endl <<
 920     "  print ''" << endl <<
 921     "  print 'Functions:'" << endl;
 922   for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
 923     f_remote <<
 924       "  print '  " << (*f_iter)->get_returntype()->get_name() << " " << (*f_iter)->get_name() << "(";
 925     t_struct* arg_struct = (*f_iter)->get_arglist();
 926     const std::vector<t_field*>& args = arg_struct->get_members();
 927     vector<t_field*>::const_iterator a_iter;
 928     int num_args = args.size();
 929     bool first = true;
 930     for (int i = 0; i < num_args; ++i) {
 931       if (first) {
 932         first = false;
 933       } else {
 934         f_remote << ", ";
 935       }
 936       f_remote <<
 937         args[i]->get_type()->get_name() << " " << args[i]->get_name();
 938     }
 939     f_remote << ")'" << endl;
 940   }
 941   f_remote <<
 942     "  print ''" << endl <<
 943     "  sys.exit(0)" << endl <<
 944     endl;
 945
 946   f_remote <<
 947     "pp = pprint.PrettyPrinter(indent = 2)" << endl <<
 948     "host = 'localhost'" << endl <<
 949     "port = 9090" << endl <<
 950     "uri = ''" << endl <<
 951     "framed = False" << endl <<
 952     "http = False" << endl <<
 953     "argi = 1" << endl <<
 954     endl <<
 955     "if sys.argv[argi] == '-h':" << endl <<
 956     "  parts = sys.argv[argi+1].split(':') " << endl <<
 957     "  host = parts[0]" << endl <<
 958     "  port = int(parts[1])" << endl <<
 959     "  argi += 2" << endl <<
 960     endl <<
 961     "if sys.argv[argi] == '-u':" << endl <<
 962     "  url = urlparse(sys.argv[argi+1])" << endl <<
 963     "  parts = url[1].split(':') " << endl <<
 964     "  host = parts[0]" << endl <<
 965     "  if len(parts) > 1:" << endl <<
 966     "    port = int(parts[1])" << endl <<
 967     "  else:" << endl <<
 968     "    port = 80" << endl <<
 969     "  uri = url[2]" << endl <<
 970     "  http = True" << endl <<
 971     "  argi += 2" << endl <<
 972     endl <<
 973     "if sys.argv[argi] == '-f' or sys.argv[argi] == '-framed':" << endl <<
 974     "  framed = True" << endl <<
 975     "  argi += 1" << endl <<
 976     endl <<
 977     "cmd = sys.argv[argi]" << endl <<
 978     "args = sys.argv[argi+1:]" << endl <<
 979     endl <<
 980     "if http:" << endl <<
 981     "  transport = THttpClient.THttpClient(host, port, uri)" << endl <<
 982     "else:" << endl <<
 983     "  socket = TSocket.TSocket(host, port)" << endl <<
 984     "  if framed:" << endl <<
 985     "    transport = TTransport.TFramedTransport(socket)" << endl <<
 986     "  else:" << endl <<
 987     "    transport = TTransport.TBufferedTransport(socket)" << endl <<
 988     "protocol = TBinaryProtocol.TBinaryProtocol(transport)" << endl <<
 989     "client = " << service_name_ << ".Client(protocol)" << endl <<
 990     "transport.open()" << endl <<
 991     endl;
 992
 993   // Generate the dispatch methods
 994   bool first = true;
 995
 996   for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
 997     if (first) {
 998       first = false;
 999     } else {
1000       f_remote << "el";
1001     }
1002
1003     t_struct* arg_struct = (*f_iter)->get_arglist();
1004     const std::vector<t_field*>& args = arg_struct->get_members();
1005     vector<t_field*>::const_iterator a_iter;
1006     int num_args = args.size();
1007
1008     f_remote <<
1009       "if cmd == '" << (*f_iter)->get_name() << "':" << endl <<
1010       "  if len(args) != " << num_args << ":" << endl <<
1011       "    print '" << (*f_iter)->get_name() << " requires " << num_args << " args'" << endl <<
1012       "    sys.exit(1)" << endl <<
1013       "  pp.pprint(client." << (*f_iter)->get_name() << "(";
1014     for (int i = 0; i < num_args; ++i) {
1015       if (args[i]->get_type()->is_string()) {
1016         f_remote << "args[" << i << "],";
1017       } else {
1018         f_remote << "eval(args[" << i << "]),";
1019       }
1020     }
1021     f_remote << "))" << endl;
1022
1023     f_remote << endl;
1024   }
1025
1026   f_remote << "transport.close()" << endl;
1027
1028   // Close service file
1029   f_remote.close();
1030
1031   // Make file executable, love that bitwise OR action
1032   chmod(f_remote_name.c_str(),
1033         S_IRUSR |
1034         S_IWUSR |
1035         S_IXUSR |
1036         S_IRGRP |
1037         S_IXGRP |
1038         S_IROTH |
1039         S_IXOTH);
1040 }
1041
1042 /**
1043  * Generates a service server definition.
1044  *
1045  * @param tservice The service to generate a server for.
1046  */
1047 void t_py_generator::generate_service_server(t_service* tservice) {
1048   // Generate the dispatch methods
1049   vector<t_function*> functions = tservice->get_functions();
1050   vector<t_function*>::iterator f_iter;
1051
1052   string extends = "";
1053   string extends_processor = "";
1054   if (tservice->get_extends() != NULL) {
1055     extends = type_name(tservice->get_extends());
1056     extends_processor = extends + ".Processor, ";
1057   }
1058
1059   // Generate the header portion
1060   f_service_ <<
1061     "class Processor(" << extends_processor << "Iface, TProcessor):" << endl;
1062   indent_up();
1063
1064   indent(f_service_) <<
1065     "def __init__(self, handler):" << endl;
1066   indent_up();
1067   if (extends.empty()) {
1068     f_service_ <<
1069       indent() << "self._handler = handler" << endl <<
1070       indent() << "self._processMap = {}" << endl;
1071   } else {
1072     f_service_ <<
1073       indent() << extends << ".Processor.__init__(self, handler)" << endl;
1074   }
1075   for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
1076     f_service_ <<
1077       indent() << "self._processMap[\"" << (*f_iter)->get_name() << "\"] = Processor.process_" << (*f_iter)->get_name() << endl;
1078   }
1079   indent_down();
1080   f_service_ << endl;
1081
1082   // Generate the server implementation
1083   indent(f_service_) <<
1084     "def process(self, iprot, oprot):" << endl;
1085   indent_up();
1086
1087   f_service_ <<
1088     indent() << "(name, type, seqid) = iprot.readMessageBegin()" << endl;
1089
1090   // TODO(mcslee): validate message
1091
1092   // HOT: dictionary function lookup
1093   f_service_ <<
1094     indent() << "if name not in self._processMap:" << endl <<
1095     indent() << "  iprot.skip(TType.STRUCT)" << endl <<
1096     indent() << "  iprot.readMessageEnd()" << endl <<
1097     indent() << "  x = TApplicationException(TApplicationException.UNKNOWN_METHOD, 'Unknown function %s' % (name))" << endl <<
1098     indent() << "  oprot.writeMessageBegin(name, TMessageType.EXCEPTION, seqid)" << endl <<
1099     indent() << "  x.write(oprot)" << endl <<
1100     indent() << "  oprot.writeMessageEnd()" << endl <<
1101     indent() << "  oprot.trans.flush()" << endl <<
1102     indent() << "  return" << endl <<
1103     indent() << "else:" << endl <<
1104     indent() << "  self._processMap[name](self, seqid, iprot, oprot)" << endl;
1105
1106   // Read end of args field, the T_STOP, and the struct close
1107   f_service_ <<
1108     indent() << "return True" << endl;
1109
1110   indent_down();
1111   f_service_ << endl;
1112
1113   // Generate the process subfunctions
1114   for (f_iter = functions.begin(); f_iter != functions.end(); ++f_iter) {
1115     generate_process_function(tservice, *f_iter);
1116   }
1117
1118   indent_down();
1119   f_service_ << endl;
1120 }
1121
1122 /**
1123  * Generates a process function definition.
1124  *
1125  * @param tfunction The function to write a dispatcher for
1126  */
1127 void t_py_generator::generate_process_function(t_service* tservice,
1128                                                t_function* tfunction) {
1129   // Open function
1130   indent(f_service_) <<
1131     "def process_" << tfunction->get_name() <<
1132     "(self, seqid, iprot, oprot):" << endl;
1133   indent_up();
1134
1135   string argsname = tfunction->get_name() + "_args";
1136   string resultname = tfunction->get_name() + "_result";
1137
1138   f_service_ <<
1139     indent() << "args = " << argsname << "()" << endl <<
1140     indent() << "args.read(iprot)" << endl <<
1141     indent() << "iprot.readMessageEnd()" << endl;
1142
1143   t_struct* xs = tfunction->get_xceptions();
1144   const std::vector<t_field*>& xceptions = xs->get_members();
1145   vector<t_field*>::const_iterator x_iter;
1146
1147   // Declare result for non async function
1148   if (!tfunction->is_async()) {
1149     f_service_ <<
1150       indent() << "result = " << resultname << "()" << endl;
1151   }
1152
1153   // Try block for a function with exceptions
1154   if (xceptions.size() > 0) {
1155     f_service_ <<
1156       indent() << "try:" << endl;
1157     indent_up();
1158   }
1159
1160   // Generate the function call
1161   t_struct* arg_struct = tfunction->get_arglist();
1162   const std::vector<t_field*>& fields = arg_struct->get_members();
1163   vector<t_field*>::const_iterator f_iter;
1164
1165   f_service_ << indent();
1166   if (!tfunction->is_async() && !tfunction->get_returntype()->is_void()) {
1167     f_service_ << "result.success = ";
1168   }
1169   f_service_ <<
1170     "self._handler." << tfunction->get_name() << "(";
1171   bool first = true;
1172   for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
1173     if (first) {
1174       first = false;
1175     } else {
1176       f_service_ << ", ";
1177     }
1178     f_service_ << "args." << (*f_iter)->get_name();
1179   }
1180   f_service_ << ")" << endl;
1181
1182   if (!tfunction->is_async() && xceptions.size() > 0) {
1183     indent_down();
1184     for (x_iter = xceptions.begin(); x_iter != xceptions.end(); ++x_iter) {
1185       f_service_ <<
1186         indent() << "except " << (*x_iter)->get_type()->get_name() << ", " << (*x_iter)->get_name() << ":" << endl;
1187       if (!tfunction->is_async()) {
1188         indent_up();
1189         f_service_ <<
1190           indent() << "result." << (*x_iter)->get_name() << " = " << (*x_iter)->get_name() << endl;
1191         indent_down();
1192       } else {
1193         f_service_ <<
1194           indent() << "pass" << endl;
1195       }
1196     }
1197   }
1198
1199   // Shortcut out here for async functions
1200   if (tfunction->is_async()) {
1201     f_service_ <<
1202       indent() << "return" << endl;
1203     indent_down();
1204     f_service_ << endl;
1205     return;
1206   }
1207
1208   f_service_ <<
1209     indent() << "oprot.writeMessageBegin(\"" << tfunction->get_name() << "\", TMessageType.REPLY, seqid)" << endl <<
1210     indent() << "result.write(oprot)" << endl <<
1211     indent() << "oprot.writeMessageEnd()" << endl <<
1212     indent() << "oprot.trans.flush()" << endl;
1213
1214   // Close function
1215   indent_down();
1216   f_service_ << endl;
1217 }
1218
1219 /**
1220  * Deserializes a field of any type.
1221  */
1222 void t_py_generator::generate_deserialize_field(ofstream &out,
1223                                                 t_field* tfield,
1224                                                 string prefix,
1225                                                 bool inclass) {
1226   t_type* type = get_true_type(tfield->get_type());
1227
1228   if (type->is_void()) {
1229     throw "CANNOT GENERATE DESERIALIZE CODE FOR void TYPE: " +
1230       prefix + tfield->get_name();
1231   }
1232
1233   string name = prefix + tfield->get_name();
1234
1235   if (type->is_struct() || type->is_xception()) {
1236     generate_deserialize_struct(out,
1237                                 (t_struct*)type,
1238                                  name);
1239   } else if (type->is_container()) {
1240     generate_deserialize_container(out, type, name);
1241   } else if (type->is_base_type() || type->is_enum()) {
1242     indent(out) <<
1243       name << " = iprot.";
1244
1245     if (type->is_base_type()) {
1246       t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
1247       switch (tbase) {
1248       case t_base_type::TYPE_VOID:
1249         throw "compiler error: cannot serialize void field in a struct: " +
1250           name;
1251         break;
1252       case t_base_type::TYPE_STRING:
1253         out << "readString();";
1254         break;
1255       case t_base_type::TYPE_BOOL:
1256         out << "readBool();";
1257         break;
1258       case t_base_type::TYPE_BYTE:
1259         out << "readByte();";
1260         break;
1261       case t_base_type::TYPE_I16:
1262         out << "readI16();";
1263         break;
1264       case t_base_type::TYPE_I32:
1265         out << "readI32();";
1266         break;
1267       case t_base_type::TYPE_I64:
1268         out << "readI64();";
1269         break;
1270       case t_base_type::TYPE_DOUBLE:
1271         out << "readDouble();";
1272         break;
1273       default:
1274         throw "compiler error: no PHP name for base type " + t_base_type::t_base_name(tbase);
1275       }
1276     } else if (type->is_enum()) {
1277       out << "readI32();";
1278     }
1279     out << endl;
1280
1281   } else {
1282     printf("DO NOT KNOW HOW TO DESERIALIZE FIELD '%s' TYPE '%s'\n",
1283            tfield->get_name().c_str(), type->get_name().c_str());
1284   }
1285 }
1286
1287 /**
1288  * Generates an unserializer for a struct, calling read()
1289  */
1290 void t_py_generator::generate_deserialize_struct(ofstream &out,
1291                                                   t_struct* tstruct,
1292                                                   string prefix) {
1293   out <<
1294     indent() << prefix << " = " << type_name(tstruct) << "()" << endl <<
1295     indent() << prefix << ".read(iprot)" << endl;
1296 }
1297
1298 /**
1299  * Serialize a container by writing out the header followed by
1300  * data and then a footer.
1301  */
1302 void t_py_generator::generate_deserialize_container(ofstream &out,
1303                                                     t_type* ttype,
1304                                                     string prefix) {
1305   string size = tmp("_size");
1306   string ktype = tmp("_ktype");
1307   string vtype = tmp("_vtype");
1308   string etype = tmp("_etype");
1309
1310   t_field fsize(g_type_i32, size);
1311   t_field fktype(g_type_byte, ktype);
1312   t_field fvtype(g_type_byte, vtype);
1313   t_field fetype(g_type_byte, etype);
1314
1315   // Declare variables, read header
1316   if (ttype->is_map()) {
1317     out <<
1318       indent() << prefix << " = {}" << endl <<
1319       indent() << "(" << ktype << ", " << vtype << ", " << size << " ) = iprot.readMapBegin() " << endl;
1320   } else if (ttype->is_set()) {
1321     out <<
1322       indent() << prefix << " = set()" << endl <<
1323       indent() << "(" << etype << ", " << size << ") = iprot.readSetBegin()" << endl;
1324   } else if (ttype->is_list()) {
1325     out <<
1326       indent() << prefix << " = []" << endl <<
1327       indent() << "(" << etype << ", " << size << ") = iprot.readListBegin()" << endl;
1328   }
1329
1330   // For loop iterates over elements
1331   string i = tmp("_i");
1332   indent(out) <<
1333     "for " << i << " in xrange(" << size << "):" << endl;
1334
1335     indent_up();
1336
1337     if (ttype->is_map()) {
1338       generate_deserialize_map_element(out, (t_map*)ttype, prefix);
1339     } else if (ttype->is_set()) {
1340       generate_deserialize_set_element(out, (t_set*)ttype, prefix);
1341     } else if (ttype->is_list()) {
1342       generate_deserialize_list_element(out, (t_list*)ttype, prefix);
1343     }
1344
1345     indent_down();
1346
1347   // Read container end
1348   if (ttype->is_map()) {
1349     indent(out) << "iprot.readMapEnd()" << endl;
1350   } else if (ttype->is_set()) {
1351     indent(out) << "iprot.readSetEnd()" << endl;
1352   } else if (ttype->is_list()) {
1353     indent(out) << "iprot.readListEnd()" << endl;
1354   }
1355 }
1356
1357
1358 /**
1359  * Generates code to deserialize a map
1360  */
1361 void t_py_generator::generate_deserialize_map_element(ofstream &out,
1362                                                        t_map* tmap,
1363                                                        string prefix) {
1364   string key = tmp("_key");
1365   string val = tmp("_val");
1366   t_field fkey(tmap->get_key_type(), key);
1367   t_field fval(tmap->get_val_type(), val);
1368
1369   generate_deserialize_field(out, &fkey);
1370   generate_deserialize_field(out, &fval);
1371
1372   indent(out) <<
1373     prefix << "[" << key << "] = " << val << endl;
1374 }
1375
1376 /**
1377  * Write a set element
1378  */
1379 void t_py_generator::generate_deserialize_set_element(ofstream &out,
1380                                                        t_set* tset,
1381                                                        string prefix) {
1382   string elem = tmp("_elem");
1383   t_field felem(tset->get_elem_type(), elem);
1384
1385   generate_deserialize_field(out, &felem);
1386
1387   indent(out) <<
1388     prefix << ".add(" << elem << ")" << endl;
1389 }
1390
1391 /**
1392  * Write a list element
1393  */
1394 void t_py_generator::generate_deserialize_list_element(ofstream &out,
1395                                                         t_list* tlist,
1396                                                         string prefix) {
1397   string elem = tmp("_elem");
1398   t_field felem(tlist->get_elem_type(), elem);
1399
1400   generate_deserialize_field(out, &felem);
1401
1402   indent(out) <<
1403     prefix << ".append(" << elem << ")" << endl;
1404 }
1405
1406
1407 /**
1408  * Serializes a field of any type.
1409  *
1410  * @param tfield The field to serialize
1411  * @param prefix Name to prepend to field name
1412  */
1413 void t_py_generator::generate_serialize_field(ofstream &out,
1414                                                t_field* tfield,
1415                                                string prefix) {
1416   t_type* type = get_true_type(tfield->get_type());
1417
1418   // Do nothing for void types
1419   if (type->is_void()) {
1420     throw "CANNOT GENERATE SERIALIZE CODE FOR void TYPE: " +
1421       prefix + tfield->get_name();
1422   }
1423
1424   if (type->is_struct() || type->is_xception()) {
1425     generate_serialize_struct(out,
1426                               (t_struct*)type,
1427                               prefix + tfield->get_name());
1428   } else if (type->is_container()) {
1429     generate_serialize_container(out,
1430                                  type,
1431                                  prefix + tfield->get_name());
1432   } else if (type->is_base_type() || type->is_enum()) {
1433
1434     string name = prefix + tfield->get_name();
1435
1436     indent(out) <<
1437       "oprot.";
1438
1439     if (type->is_base_type()) {
1440       t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
1441       switch (tbase) {
1442       case t_base_type::TYPE_VOID:
1443         throw
1444           "compiler error: cannot serialize void field in a struct: " + name;
1445         break;
1446       case t_base_type::TYPE_STRING:
1447         out << "writeString(" << name << ")";
1448         break;
1449       case t_base_type::TYPE_BOOL:
1450         out << "writeBool(" << name << ")";
1451         break;
1452       case t_base_type::TYPE_BYTE:
1453         out << "writeByte(" << name << ")";
1454         break;
1455       case t_base_type::TYPE_I16:
1456         out << "writeI16(" << name << ")";
1457         break;
1458       case t_base_type::TYPE_I32:
1459         out << "writeI32(" << name << ")";
1460         break;
1461       case t_base_type::TYPE_I64:
1462         out << "writeI64(" << name << ")";
1463         break;
1464       case t_base_type::TYPE_DOUBLE:
1465         out << "writeDouble(" << name << ")";
1466         break;
1467       default:
1468         throw "compiler error: no PHP name for base type " + t_base_type::t_base_name(tbase);
1469       }
1470     } else if (type->is_enum()) {
1471       out << "writeI32(" << name << ")";
1472     }
1473     out << endl;
1474   } else {
1475     printf("DO NOT KNOW HOW TO SERIALIZE FIELD '%s%s' TYPE '%s'\n",
1476            prefix.c_str(),
1477            tfield->get_name().c_str(),
1478            type->get_name().c_str());
1479   }
1480 }
1481
1482 /**
1483  * Serializes all the members of a struct.
1484  *
1485  * @param tstruct The struct to serialize
1486  * @param prefix  String prefix to attach to all fields
1487  */
1488 void t_py_generator::generate_serialize_struct(ofstream &out,
1489                                                t_struct* tstruct,
1490                                                string prefix) {
1491   indent(out) <<
1492     prefix << ".write(oprot)" << endl;
1493 }
1494
1495 void t_py_generator::generate_serialize_container(ofstream &out,
1496                                                   t_type* ttype,
1497                                                   string prefix) {
1498   if (ttype->is_map()) {
1499     indent(out) <<
1500       "oprot.writeMapBegin(" <<
1501       type_to_enum(((t_map*)ttype)->get_key_type()) << ", " <<
1502       type_to_enum(((t_map*)ttype)->get_val_type()) << ", " <<
1503       "len(" << prefix << "))" << endl;
1504   } else if (ttype->is_set()) {
1505     indent(out) <<
1506       "oprot.writeSetBegin(" <<
1507       type_to_enum(((t_set*)ttype)->get_elem_type()) << ", " <<
1508       "len(" << prefix << "))" << endl;
1509   } else if (ttype->is_list()) {
1510     indent(out) <<
1511       "oprot.writeListBegin(" <<
1512       type_to_enum(((t_list*)ttype)->get_elem_type()) << ", " <<
1513       "len(" << prefix << "))" << endl;
1514   }
1515
1516   if (ttype->is_map()) {
1517     string kiter = tmp("kiter");
1518     string viter = tmp("viter");
1519     indent(out) <<
1520       "for " << kiter << "," << viter << " in " << prefix << ".items():" << endl;
1521     indent_up();
1522     generate_serialize_map_element(out, (t_map*)ttype, kiter, viter);
1523     indent_down();
1524   } else if (ttype->is_set()) {
1525     string iter = tmp("iter");
1526     indent(out) <<
1527       "for " << iter << " in " << prefix << ":" << endl;
1528     indent_up();
1529     generate_serialize_set_element(out, (t_set*)ttype, iter);
1530     indent_down();
1531   } else if (ttype->is_list()) {
1532     string iter = tmp("iter");
1533     indent(out) <<
1534       "for " << iter << " in " << prefix << ":" << endl;
1535     indent_up();
1536     generate_serialize_list_element(out, (t_list*)ttype, iter);
1537     indent_down();
1538   }
1539
1540   if (ttype->is_map()) {
1541     indent(out) <<
1542       "oprot.writeMapEnd()" << endl;
1543   } else if (ttype->is_set()) {
1544     indent(out) <<
1545       "oprot.writeSetEnd()" << endl;
1546   } else if (ttype->is_list()) {
1547     indent(out) <<
1548       "oprot.writeListEnd()" << endl;
1549   }
1550 }
1551
1552 /**
1553  * Serializes the members of a map.
1554  *
1555  */
1556 void t_py_generator::generate_serialize_map_element(ofstream &out,
1557                                                      t_map* tmap,
1558                                                      string kiter,
1559                                                      string viter) {
1560   t_field kfield(tmap->get_key_type(), kiter);
1561   generate_serialize_field(out, &kfield, "");
1562
1563   t_field vfield(tmap->get_val_type(), viter);
1564   generate_serialize_field(out, &vfield, "");
1565 }
1566
1567 /**
1568  * Serializes the members of a set.
1569  */
1570 void t_py_generator::generate_serialize_set_element(ofstream &out,
1571                                                      t_set* tset,
1572                                                      string iter) {
1573   t_field efield(tset->get_elem_type(), iter);
1574   generate_serialize_field(out, &efield, "");
1575 }
1576
1577 /**
1578  * Serializes the members of a list.
1579  */
1580 void t_py_generator::generate_serialize_list_element(ofstream &out,
1581                                                       t_list* tlist,
1582                                                       string iter) {
1583   t_field efield(tlist->get_elem_type(), iter);
1584   generate_serialize_field(out, &efield, "");
1585 }
1586
1587 /**
1588  * Declares a field, which may include initialization as necessary.
1589  *
1590  * @param ttype The type
1591  */
1592 string t_py_generator::declare_field(t_field* tfield) {
1593   string result = "self." + tfield->get_name();
1594   t_type* type = get_true_type(tfield->get_type());
1595   if (tfield->get_value() != NULL) {
1596     result += " = " + render_const_value(type, tfield->get_value());
1597   } else {
1598     result += " = None";
1599   }
1600   return result;
1601 }
1602
1603 /**
1604  * Renders a function signature of the form 'type name(args)'
1605  *
1606  * @param tfunction Function definition
1607  * @return String of rendered function definition
1608  */
1609 string t_py_generator::function_signature(t_function* tfunction,
1610                                            string prefix) {
1611   // TODO(mcslee): Nitpicky, no ',' if argument_list is empty
1612   return
1613     prefix + tfunction->get_name() +
1614     "(self, " + argument_list(tfunction->get_arglist()) + ")";
1615 }
1616
1617 /**
1618  * Renders a field list
1619  */
1620 string t_py_generator::argument_list(t_struct* tstruct) {
1621   string result = "";
1622
1623   const vector<t_field*>& fields = tstruct->get_members();
1624   vector<t_field*>::const_iterator f_iter;
1625   bool first = true;
1626   for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
1627     if (first) {
1628       first = false;
1629     } else {
1630       result += ", ";
1631     }
1632     result += (*f_iter)->get_name();
1633   }
1634   return result;
1635 }
1636
1637 string t_py_generator::type_name(t_type* ttype) {
1638   t_program* program = ttype->get_program();
1639   if (program != NULL && program != program_) {
1640     if (ttype->is_service()) {
1641       return get_real_py_module(program) + "." + ttype->get_name();
1642     } else {
1643       return get_real_py_module(program) + ".ttypes." + ttype->get_name();
1644     }
1645   }
1646   return ttype->get_name();
1647 }
1648
1649 /**
1650  * Converts the parse type to a Python tyoe
1651  */
1652 string t_py_generator::type_to_enum(t_type* type) {
1653   type = get_true_type(type);
1654
1655   if (type->is_base_type()) {
1656     t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
1657     switch (tbase) {
1658     case t_base_type::TYPE_VOID:
1659       throw "NO T_VOID CONSTRUCT";
1660     case t_base_type::TYPE_STRING:
1661       return "TType.STRING";
1662     case t_base_type::TYPE_BOOL:
1663       return "TType.BOOL";
1664     case t_base_type::TYPE_BYTE:
1665       return "TType.BYTE";
1666     case t_base_type::TYPE_I16:
1667       return "TType.I16";
1668     case t_base_type::TYPE_I32:
1669       return "TType.I32";
1670     case t_base_type::TYPE_I64:
1671       return "TType.I64";
1672     case t_base_type::TYPE_DOUBLE:
1673       return "TType.DOUBLE";
1674     }
1675   } else if (type->is_enum()) {
1676     return "TType.I32";
1677   } else if (type->is_struct() || type->is_xception()) {
1678     return "TType.STRUCT";
1679   } else if (type->is_map()) {
1680     return "TType.MAP";
1681   } else if (type->is_set()) {
1682     return "TType.SET";
1683   } else if (type->is_list()) {
1684     return "TType.LIST";
1685   }
1686
1687   throw "INVALID TYPE IN type_to_enum: " + type->get_name();
1688 }
1689
1690 /** See the comment inside generate_py_struct_definition for what this is. */
1691 string t_py_generator::type_to_spec_args(t_type* ttype) {
1692   while (ttype->is_typedef()) {
1693     ttype = ((t_typedef*)ttype)->get_type();
1694   }
1695
1696   if (ttype->is_base_type() || ttype->is_enum()) {
1697     return "None";
1698   } else if (ttype->is_struct() || ttype->is_xception()) {
1699     return "(" + type_name(ttype) + ", " + type_name(ttype) + ".thrift_spec)";
1700   } else if (ttype->is_map()) {
1701     return "(" +
1702       type_to_enum(((t_map*)ttype)->get_key_type()) + "," +
1703       type_to_spec_args(((t_map*)ttype)->get_key_type()) + "," +
1704       type_to_enum(((t_map*)ttype)->get_val_type()) + "," +
1705       type_to_spec_args(((t_map*)ttype)->get_val_type()) +
1706       ")";
1707
1708   } else if (ttype->is_set()) {
1709     return "(" +
1710       type_to_enum(((t_set*)ttype)->get_elem_type()) + "," +
1711       type_to_spec_args(((t_set*)ttype)->get_elem_type()) +
1712       ")";
1713
1714   } else if (ttype->is_list()) {
1715     return "(" +
1716       type_to_enum(((t_list*)ttype)->get_elem_type()) + "," +
1717       type_to_spec_args(((t_list*)ttype)->get_elem_type()) +
1718       ")";
1719   }
1720
1721   throw "INVALID TYPE IN type_to_spec_args: " + ttype->get_name();
1722 }