Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #176 from tvannoy/python-client
Python client stub generator
- Loading branch information
Showing
7 changed files
with
281 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| #include "pyclientstubgenerator.h" | ||
| #include <algorithm> | ||
|
|
||
| #define TEMPLATE_PYTHON_CLIENT_SIGCLASS "class <stubname>(client.Client):" | ||
|
|
||
| #define TEMPLATE_PYTHON_CLIENT_SIGCONSTRUCTOR "def __init__(self, connector, version='2.0'):\n super(<stubname>, self).__init__(connector, version)" | ||
|
|
||
| #define TEMPLATE_PYTHON_CLIENT_SIGMETHOD "def <methodname>(self<parameters>):" | ||
|
|
||
| #define TEMPLATE_NAMED_ASSIGNMENT "parameters[\'<paramname>\'] = <paramname>" | ||
| #define TEMPLATE_POSITION_ASSIGNMENT "parameters.append(<paramname>)" | ||
|
|
||
| #define TEMPLATE_METHODCALL "result = self.call_method(\'<name>\', parameters)" | ||
| #define TEMPLATE_NOTIFICATIONCALL "self.call_notification(\'<name>\', parameters)" | ||
|
|
||
| using namespace std; | ||
| using namespace jsonrpc; | ||
|
|
||
|
|
||
| PythonClientStubGenerator::PythonClientStubGenerator(const string &stubname, std::vector<Procedure> &procedures, std::ostream& outputstream) : | ||
| StubGenerator(stubname, procedures, outputstream) | ||
| { | ||
| } | ||
|
|
||
| PythonClientStubGenerator::PythonClientStubGenerator(const string &stubname, std::vector<Procedure> &procedures, const string filename) : | ||
| StubGenerator(stubname, procedures, filename) | ||
| { | ||
| } | ||
|
|
||
| void PythonClientStubGenerator::generateStub() | ||
| { | ||
| this->writeLine("#"); | ||
| this->writeLine("# This file is generated by jsonrpcstub, DO NOT CHANGE IT MANUALLY!"); | ||
| this->writeLine("#"); | ||
| this->writeNewLine(); | ||
| this->writeLine("#"); | ||
| this->writeLine("# To use this client, jsonrpc_pyclient must be installed:"); | ||
| this->writeLine("# pip install jsonrpc_pyclient"); | ||
| this->writeLine("#"); | ||
| this->writeNewLine(); | ||
| this->writeLine("from jsonrpc_pyclient import client"); | ||
| this->writeNewLine(); | ||
|
|
||
| this->writeLine(replaceAll(TEMPLATE_PYTHON_CLIENT_SIGCLASS, "<stubname>", this->stubname)); | ||
| this->increaseIndentation(); | ||
|
|
||
| this->writeLine(replaceAll(TEMPLATE_PYTHON_CLIENT_SIGCONSTRUCTOR, "<stubname>", this->stubname)); | ||
| this->writeNewLine(); | ||
|
|
||
| for (unsigned int i=0; i < procedures.size(); i++) | ||
| { | ||
| this->generateMethod(procedures[i]); | ||
| } | ||
|
|
||
| this->decreaseIndentation(); | ||
| this->writeNewLine(); | ||
| } | ||
|
|
||
| void PythonClientStubGenerator::generateMethod(Procedure &proc) | ||
| { | ||
| string procsignature = TEMPLATE_PYTHON_CLIENT_SIGMETHOD; | ||
| replaceAll2(procsignature, "<methodname>", normalizeString(proc.GetProcedureName())); | ||
|
|
||
| // generate parameters string | ||
| string params = generateParameterDeclarationList(proc); | ||
| replaceAll2(procsignature, "<parameters>", params); | ||
|
|
||
| this->writeLine(procsignature); | ||
| this->increaseIndentation(); | ||
|
|
||
| generateAssignments(proc); | ||
| this->writeNewLine(); | ||
| generateProcCall(proc); | ||
| this->writeNewLine(); | ||
|
|
||
| this->decreaseIndentation(); | ||
| } | ||
|
|
||
| string PythonClientStubGenerator::generateParameterDeclarationList(Procedure &proc) | ||
| { | ||
| stringstream param_string; | ||
| parameterNameList_t list = proc.GetParameters(); | ||
|
|
||
| for (parameterNameList_t::iterator it = list.begin(); it != list.end(); ++it) | ||
| { | ||
| param_string << ", "; | ||
| param_string << it->first; | ||
| } | ||
|
|
||
| return param_string.str(); | ||
| } | ||
|
|
||
| void PythonClientStubGenerator::generateAssignments(Procedure &proc) | ||
| { | ||
| string assignment; | ||
| parameterNameList_t list = proc.GetParameters(); | ||
| if(list.size() > 0) | ||
| { | ||
| parameterDeclaration_t declType = proc.GetParameterDeclarationType(); | ||
| if (proc.GetParameterDeclarationType() == PARAMS_BY_NAME) | ||
| { | ||
| this->writeLine("parameters = {}"); | ||
| } | ||
| else if(proc.GetParameterDeclarationType() == PARAMS_BY_POSITION) | ||
| { | ||
| this->writeLine("parameters = []"); | ||
| } | ||
|
|
||
| for (parameterNameList_t::iterator it = list.begin(); it != list.end(); ++it) | ||
| { | ||
|
|
||
| if(declType == PARAMS_BY_NAME) | ||
| { | ||
| assignment = TEMPLATE_NAMED_ASSIGNMENT; | ||
| } | ||
| else | ||
| { | ||
| assignment = TEMPLATE_POSITION_ASSIGNMENT; | ||
| } | ||
| replaceAll2(assignment, "<paramname>", it->first); | ||
| this->writeLine(assignment); | ||
| } | ||
| } | ||
| else | ||
| { | ||
| this->writeLine("parameters = None"); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| void PythonClientStubGenerator::generateProcCall(Procedure &proc) | ||
| { | ||
| string call; | ||
| if (proc.GetProcedureType() == RPC_METHOD) | ||
| { | ||
| call = TEMPLATE_METHODCALL; | ||
| this->writeLine(replaceAll(call, "<name>", proc.GetProcedureName())); | ||
| this->writeLine("return result"); | ||
| } | ||
| else | ||
| { | ||
| call = TEMPLATE_NOTIFICATIONCALL; | ||
| replaceAll2(call, "<name>", proc.GetProcedureName()); | ||
| this->writeLine(call); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| string PythonClientStubGenerator::class2Filename(const string &classname) | ||
| { | ||
| string result = classname; | ||
| std::transform(result.begin(), result.end(), result.begin(), ::tolower); | ||
| return result + ".py"; | ||
| } | ||
|
|
||
| string PythonClientStubGenerator::normalizeString(const string &text) | ||
| { | ||
| string result = text; | ||
| for(unsigned int i=0; i < text.length(); i++) | ||
| { | ||
| if (!((text[i] >= 'a' && text[i] <= 'z') || (text[i] >= 'A' && text[i] <= 'Z') || (text[i] >= '0' && text[i] <= '9') || text[i] == '_')) | ||
| { | ||
| result[i] = '_'; | ||
| } | ||
| } | ||
| return result; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| #ifndef PYTHON_CLIENT_STUB_GENERATOR_H | ||
| #define PYTHON_CLIENT_STUB_GENERATOR_H | ||
|
|
||
| #include "../stubgenerator.h" | ||
|
|
||
| namespace jsonrpc | ||
| { | ||
| /** | ||
| * The stub client this class generates requires jsonrpc_pyclient | ||
| * to be installed from pypi. | ||
| */ | ||
| class PythonClientStubGenerator : public StubGenerator | ||
| { | ||
| public: | ||
|
|
||
|
|
||
| PythonClientStubGenerator(const std::string& stubname, std::vector<Procedure> &procedures, std::ostream& outputstream); | ||
| PythonClientStubGenerator(const std::string& stubname, std::vector<Procedure> &procedures, const std::string filename); | ||
|
|
||
| virtual void generateStub(); | ||
|
|
||
| void generateMethod(Procedure& proc); | ||
| void generateAssignments(Procedure& proc); | ||
| void generateProcCall(Procedure &proc); | ||
| std::string generateParameterDeclarationList(Procedure &proc); | ||
| static std::string class2Filename(const std::string &classname); | ||
| static std::string normalizeString(const std::string &text); | ||
| }; | ||
| } | ||
| #endif // PYTHON_CLIENT_STUB_GENERATOR_H |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.