제 12 장 SOAP 웹 서비스

from SOAPpy import WSDL

# 다음 두 값을 환경구성해 줄 필요가 있다;
# http://www.google.com/apis/ 참조
WSDLFILE = '/path/to/copy/of/GoogleSearch.wsdl'
APIKEY = 'YOUR_GOOGLE_API_KEY'

_server = WSDL.Proxy(WSDLFILE)
def search(q):
    """구글을 검색해 {title, link, description} 형태의 리스트를 돌려준다"""
    results = _server.doGoogleSearch(
        APIKEY, q, 0, 10, False, "", False, "", "utf-8", "utf-8")
    return [{"title": r.title.encode("utf-8"),
             "link": r.URL.encode("utf-8"),
             "description": r.snippet.encode("utf-8")}
            for r in results.resultElements]

if __name__ == '__main__':
    import sys
    for r in search(sys.argv[1])[:5]:
        print r['title']
        print r['link']
        print r['description']
        print

이를 모듈로 반입하여 더 큰 프로그램에 사용하거나, 스크립트를 명령어 줄에서 실행할 수 있습니다. 명령 줄에서 검색 질의를 명령-줄 인자로 주면 URL과 타이틀 그리고 상위 다섯 개의 구글 검색 결과의 설명을 인쇄합니다.

다음은 “python”이라는 단어를 검색해 본 샘플 출력입니다.

C:\diveintopython\common\py> python search.py "python"
<b>Python</b> Programming Language
http://www.python.org/
Home page for <b>Python</b>, an interpreted, interactive, object-oriented,
extensible<br> programming language. <b>...</b> <b>Python</b>
is OSI Certified Open Source: OSI Certified.

<b>Python</b> Documentation Index
http://www.python.org/doc/
 <b>...</b> New-style classes (aka descrintro). Regular expressions. Database
API. Email Us.<br> docs@<b>python</b>.org. (c) 2004. <b>Python</b>
Software Foundation. <b>Python</b> Documentation. <b>...</b>

Download <b>Python</b> Software
http://www.python.org/download/
Download Standard <b>Python</b> Software. <b>Python</b> 2.3.3 is the
current production<br> version of <b>Python</b>. <b>...</b>
<b>Python</b> is OSI Certified Open Source:

Pythonline
http://www.pythonline.com/


Dive Into <b>Python</b>
http://diveintopython.org/
Dive Into <b>Python</b>. <b>Python</b> from novice to pro. Find:
<b>...</b> It is also available in multiple<br> languages. Read
Dive Into <b>Python</b>. This book is still being written. <b>...</b>

SOAP 웹 서비스 안으로 들어가기 전에, 세 개의 라이브러리를 설치할 필요가 있습니다: PyXML과 fpconst 그리고 SOAPpy가 그것입니다.

>>> import xml
>>> xml.__version__
'0.8.3'

>>> import fpconst
>>> fpconst.__version__
'0.6.0'

>>> import SOAPpy
>>> SOAPpy.__version__
'0.11.4'

가장 인기 있는 공개 접근 SOAP 서버는 http://www.xmethods.net/입니다. 다음 예제는 미국 우편번호를 취해 그 지역의 현재 기온을 돌려주는 데모 함수를 사용합니다.

>>> from SOAPpy import SOAPProxy            ①
>>> url = 'http://services.xmethods.net:80/soap/servlet/rpcrouter'
>>> namespace = 'urn:xmethods-Temperature'  ②
>>> server = SOAPProxy(url, namespace)      ③
>>> server.getTemp('27502')                 ④
80.0

뚜껑을 열고 들여다 보겠습니다.

디버깅을 켜려면 단순히 두 개의 플래그를 SOAPProxy에서 환경구성해 주면 됩니다.

>>> from SOAPpy import SOAPProxy
>>> url = 'http://services.xmethods.net:80/soap/servlet/rpcrouter'
>>> n = 'urn:xmethods-Temperature'
>>> server = SOAPProxy(url, namespace=n)     ①
>>> server.config.dumpSOAPOut = 1            ②
>>> server.config.dumpSOAPIn = 1
>>> temperature = server.getTemp('27502')    ③
*** Outgoing SOAP ******************************************************
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/1999/XMLSchema">
<SOAP-ENV:Body>
<ns1:getTemp xmlns:ns1="urn:xmethods-Temperature" SOAP-ENC:root="1">
<v1 xsi:type="xsd:string">27502</v1>
</ns1:getTemp>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
************************************************************************
*** Incoming SOAP ******************************************************
<?xml version='1.0' encoding='UTF-8'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>
<ns1:getTempResponse xmlns:ns1="urn:xmethods-Temperature"
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<return xsi:type="xsd:float">80.0</return>
</ns1:getTempResponse>

</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
************************************************************************

>>> temperature
80.0

서버에게 전송되는 XML 요청 문서는 대부분 단지 보일러플레이트일 뿐입니다. 모든 이름공간 선언은 무시됩니다; 이름공간은 모두 모든 SOAP 호출에 대하여 (비슷하거나) 같습니다. “함수 호출의 심장”은 <Body> 원소 안에 있는 이 조각입니다:

<ns1:getTemp                                 ①
  xmlns:ns1="urn:xmethods-Temperature"       ②
  SOAP-ENC:root="1">
<v1 xsi:type="xsd:string">27502</v1>         ③
</ns1:getTemp>

무엇을 무시할지 알기만 하면 XML 반환 문서도 똑 같이 이해하기 쉽습니다. <Body> 원소 안에 있는 이 조각에 집중하세요:

<ns1:getTempResponse                             ①
  xmlns:ns1="urn:xmethods-Temperature"           ②
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<return xsi:type="xsd:float">80.0</return>       ③
</ns1:getTempResponse>

다음을 생각해 보세요: 앞 두 섹션에서는 둘 다 간단한 데이터 유형인 하나의 인자와 하나의 반환 값을 가지고 간단한 원격 SOAP 메쏘드를 호출하는 법을 보여주었습니다. 이렇게 하려면 서비스 URL, 서비스 이름공간, 함수 이름, 인자 개수, 그리고 각 인자의 데이터유형을 이해하고 추적 유지해야 했습니다. 이 중에 하나가 빠지거나 잘못되면 모든 일이 어그러집니다.

별로 놀랄일은 아닙니다. 지역 함수를 호출하고 싶다면 그것이 (서비스 URL과 이름공간에 해당하는) 어느 모듈 또는 어느 패키지에 있는지 알 필요가 있습니다. 함수 이름과 인자의 개수를 올바르게 알 필요가 있습니다. 파이썬은 명시적으로 유형이 지정되지 않아도 솜씨좋게 데이터유형을 처리합니다. 그러나 여전히 얼마나 많은 인자를 건네야 하는지, 그리고 얼마나 많은 반환 값을 예상해야 하는지 알 필요가 있습니다.

큰 차이점은 내부검사입니다. 제 4 장에서 보셨듯이, 파이썬은 실행시간에 모듈과 함수에 관하여 상황을 탁월하게 알려줄 수 있습니다. 모듈 안에서 사용가능한 함수를 나열할 수 있고, 조금만 노력하면 함수 별로 선언과 인자에까지 깊이 들어갈 수 있습니다.

WSDL을 사용하면 SOAP 웹 서비스에 그렇게 할 수 있습니다. WSDL은 웹 서비스 기술 언어(“Web Services Description Language”)의 약자입니다. 다양한 웹 서비스 유형을 기술할 만큼 충분히 유연하게 설계되었지만 보통 SOAP 웹 서비스를 기술하는데 사용됩니다.

WSDL 파일은 말 그대로: 파일입니다. 더 구체적으로 말하면 XML 파일입니다. 보통 WSDL 파일에 기술된 SOAP 웹 서비스에 접근하기 위하여 여러분이 사용하는 서버와 같은 서버에 존재합니다. 물론, 그에 관하여 특별한 것은 전혀 없습니다. 이 장의 후반부에서 구글 API용으로 WSDL 파일을 내려받아 지역적으로 사용해 보겠습니다. 그렇다고 해서 지역적으로 구글(Google)을 호출하겠다는 뜻은 아닙니다; WSDL 파일은 여전히 구글 서버에 앉아있는 원격 함수를 기술합니다.

WSDL 파일에 SOAP 웹 서비스를 호출하는데 관련된 모든 것들이 기술됩니다:

다른 말로 해서, WSDL 파일은 SOAP 웹 서비스를 호출하는데 필요한 모든 것을 알려줍니다.

WSDL로 할 수 있는 가장 근본적인 일은 SOAP 제공하는 메쏘드들을 찾아내는 것입니다.

>>> from SOAPpy import WSDL          ①
>>> wsdlFile = 'http://www.xmethods.net/sd/2001/TemperatureService.wsdl')
>>> server = WSDL.Proxy(wsdlFile)    ②
>>> server.methods.keys()            ③
[u'getTemp']

좋습니다. 그래서 이 SOAP 서버는 getTemp 메쏘드 하나를 제공하는군요. 그러나 어떻게 호출할까요? WSDL 프록시 객체는 그 방법 역시 알려줄 수 있습니다.

>>> callInfo = server.methods['getTemp']  ①
>>> callInfo.inparams                     ②
[<SOAPpy.wstools.WSDLTools.ParameterInfo instance at 0x00CF3AD0>]
>>> callInfo.inparams[0].name             ③
u'zipcode'
>>> callInfo.inparams[0].type             ④
(u'http://www.w3.org/2001/XMLSchema', u'string')

WSDL에서도 함수의 반환 값을 들여다 볼 수 있습니다.

>>> callInfo.outparams            ①
[<SOAPpy.wstools.WSDLTools.ParameterInfo instance at 0x00CF3AF8>]
>>> callInfo.outparams[0].name    ②
u'return'
>>> callInfo.outparams[0].type
(u'http://www.w3.org/2001/XMLSchema', u'float')

모두 하나로 조립해서, WSDL 프록시를 통하여 SOAP 웹 서비스를 호출해 보겠습니다.

>>> from SOAPpy import WSDL
>>> wsdlFile = 'http://www.xmethods.net/sd/2001/TemperatureService.wsdl')
>>> server = WSDL.Proxy(wsdlFile)               ①
>>> server.getTemp('90210')                     ②
66.0
>>> server.soapproxy.config.dumpSOAPOut = 1     ③
>>> server.soapproxy.config.dumpSOAPIn = 1
>>> temperature = server.getTemp('90210')
*** Outgoing SOAP ******************************************************
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/1999/XMLSchema">
<SOAP-ENV:Body>
<ns1:getTemp xmlns:ns1="urn:xmethods-Temperature" SOAP-ENC:root="1">
<v1 xsi:type="xsd:string">90210</v1>
</ns1:getTemp>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
************************************************************************
*** Incoming SOAP ******************************************************
<?xml version='1.0' encoding='UTF-8'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>
<ns1:getTempResponse xmlns:ns1="urn:xmethods-Temperature"
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<return xsi:type="xsd:float">66.0</return>
</ns1:getTempResponse>

</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
************************************************************************

>>> temperature
66.0

구글(Google)은 프로그램적으로 구글 검색 결과에 접근하는데 사용할 SOAP API를 제공합니다. 이를 사용하려면 구글 웹 서비스에 로그인할 필요가 있습니다.

개발자 키와 구글 WSDL 파일을 잘 아는 곳에 확보하면 구글 웹 서비스를 맛볼 수 있습니다.

>>> from SOAPpy import WSDL
>>> server = WSDL.Proxy('/path/to/your/GoogleSearch.wsdl') ①
>>> server.methods.keys()                                  ②
[u'doGoogleSearch', u'doGetCachedPage', u'doSpellingSuggestion']
>>> callInfo = server.methods['doGoogleSearch']
>>> for arg in callInfo.inparams:                          ③
...     print arg.name.ljust(15), arg.type
key             (u'http://www.w3.org/2001/XMLSchema', u'string')
q               (u'http://www.w3.org/2001/XMLSchema', u'string')
start           (u'http://www.w3.org/2001/XMLSchema', u'int')
maxResults      (u'http://www.w3.org/2001/XMLSchema', u'int')
filter          (u'http://www.w3.org/2001/XMLSchema', u'boolean')
restrict        (u'http://www.w3.org/2001/XMLSchema', u'string')
safeSearch      (u'http://www.w3.org/2001/XMLSchema', u'boolean')
lr              (u'http://www.w3.org/2001/XMLSchema', u'string')
ie              (u'http://www.w3.org/2001/XMLSchema', u'string')
oe              (u'http://www.w3.org/2001/XMLSchema', u'string')

다음에 doGoogleSearch에 건네지는 모든 매개변수들을 간략하게 요약해 놓았습니다:

>>> from SOAPpy import WSDL
>>> server = WSDL.Proxy('/path/to/your/GoogleSearch.wsdl')
>>> key = 'YOUR_GOOGLE_API_KEY'
>>> results = server.doGoogleSearch(key, 'mark', 0, 10, False, "",
...     False, "", "utf-8", "utf-8")             ①
>>> len(results.resultElements)                  ②
10
>>> results.resultElements[0].URL                ③
'http://diveintomark.org/'
>>> results.resultElements[0].title
'dive into <b>mark</b>'

results 객체는 실제 검색 결과 그 이상이 담겨 있습니다. 검색 자체에 대한 정보도 담겨 있는데, 예를 들면 얼마나 걸렸는가 그리고 결과는 얼마나 많은가 등의 정보가 있습니다 (물론 검색 결과는 10개가 반환되었을지라도 말입니다). 구글 웹 인터페이스는 이 정보를 보여주며, 역시 프로그램적으로 그에 접근할 수 있습니다.

>>> results.searchTime                     ①
0.224919
>>> results.estimatedTotalResultsCount     ②
29800000
>>> results.directoryCategories            ③
[<SOAPpy.Types.structType item at 14367400>:
 {'fullViewableName':
  'Top/Arts/Literature/World_Literature/American/19th_Century/Twain,_Mark',
  'specialEncoding': ''}]
>>> results.directoryCategories[0].fullViewableName
'Top/Arts/Literature/World_Literature/American/19th_Century/Twain,_Mark'

이 장을 통하여 보셨듯이, SOAP는 여러 레이어가 관련됩니다. HTTP 레이어가 있는데, SOAP는 XML 문서를 HTTP 서버에 보내고 받기 때문입니다. 그래서 제 11 장, HTTP 웹 서비스 에서 배운 모든 디버깅 테크닉이 여기에서 제 역할을 합니다. import httplib를 한 다음 httplib.HTTPConnection.debuglevel = 1로 설정하면 아래에서 오고가는 HTTP 흐름을 볼 수 있습니다.

아래의 HTTP 레이어를 올라서면 수 많은 것들이 잘못될 수 있습니다. SOAPpy는 SOAP 구문을 여러분으로부터 가려주는 놀라운 일을 하지만 그 의미는 일이 잘못되었을 때 문제가 어디에 있는지 찾아내기가 어려울 수 있다는 뜻이기도 합니다.

다음은 본인이 SOAP 웹 서비스를 사용하면서 흔히 저지른 실수와 그 때문에 발생하는 에러의 예들입니다.

>>> from SOAPpy import SOAPProxy
>>> url = 'http://services.xmethods.net:80/soap/servlet/rpcrouter'
>>> server = SOAPProxy(url)                                        ①
>>> server.getTemp('27502')                                        ②
<Fault SOAP-ENV:Server.BadTargetObjectURI:
Unable to determine object id from call: is the method element namespaced?>
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
  File "c:\python23\Lib\site-packages\SOAPpy\Client.py", line 453, in __call__
    return self.__r_call(*args, **kw)
  File "c:\python23\Lib\site-packages\SOAPpy\Client.py", line 475, in __r_call
    self.__hd, self.__ma)
  File "c:\python23\Lib\site-packages\SOAPpy\Client.py", line 389, in __call
    raise p
SOAPpy.Types.faultType: <Fault SOAP-ENV:Server.BadTargetObjectURI:
Unable to determine object id from call: is the method element namespaced?>

SOAP 서비스의 기본 원소들을 제대로 환경구성하지 못하는 것은 WSDL이 풀고자 하는 문제중의 하나입니다. WSDL 파일에는 서비스 URL과 이름공간이 포함되어 있으므로, 잘못될 수 없습니다. 물론, 여전히 잘못될 것이 있습니다.

>>> wsdlFile = 'http://www.xmethods.net/sd/2001/TemperatureService.wsdl'
>>> server = WSDL.Proxy(wsdlFile)
>>> temperature = server.getTemp(27502)                                ①
<Fault SOAP-ENV:Server: Exception while handling service request:
services.temperature.TempService.getTemp(int) -- no signature match>   ②
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
  File "c:\python23\Lib\site-packages\SOAPpy\Client.py", line 453, in __call__
    return self.__r_call(*args, **kw)
  File "c:\python23\Lib\site-packages\SOAPpy\Client.py", line 475, in __r_call
    self.__hd, self.__ma)
  File "c:\python23\Lib\site-packages\SOAPpy\Client.py", line 389, in __call
    raise p
SOAPpy.Types.faultType: <Fault SOAP-ENV:Server: Exception while handling service request:
services.temperature.TempService.getTemp(int) -- no signature match>

원격 함수가 실제로 돌려주는 것과 다르게 반환 값의 개수를 예상하는 파이썬 코드를 작성하는 것도 가능합니다.

>>> wsdlFile = 'http://www.xmethods.net/sd/2001/TemperatureService.wsdl'
>>> server = WSDL.Proxy(wsdlFile)
>>> (city, temperature) = server.getTemp(27502)  ①
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
TypeError: unpack non-sequence

구글 웹 서비스는 어떤가? 본인은 흔히 어플리케이션 키를 제대로 설정하는 일을 잊어버리는 실수를 저지릅니다.

>>> from SOAPpy import WSDL
>>> server = WSDL.Proxy(r'/path/to/local/GoogleSearch.wsdl')
>>> results = server.doGoogleSearch('foo', 'mark', 0, 10, False, "", ①
...     False, "", "utf-8", "utf-8")
<Fault SOAP-ENV:Server:                                              ②
 Exception from service object: Invalid authorization key: foo:
 <SOAPpy.Types.structType detail at 14164616>:
 {'stackTrace':
  'com.google.soap.search.GoogleSearchFault: Invalid authorization key: foo
   at com.google.soap.search.QueryLimits.lookUpAndLoadFromINSIfNeedBe(
     QueryLimits.java:220)
   at com.google.soap.search.QueryLimits.validateKey(QueryLimits.java:127)
   at com.google.soap.search.GoogleSearchService.doPublicMethodChecks(
     GoogleSearchService.java:825)
   at com.google.soap.search.GoogleSearchService.doGoogleSearch(
     GoogleSearchService.java:121)
   at sun.reflect.GeneratedMethodAccessor13.invoke(Unknown Source)
   at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
   at java.lang.reflect.Method.invoke(Unknown Source)
   at org.apache.soap.server.RPCRouter.invoke(RPCRouter.java:146)
   at org.apache.soap.providers.RPCJavaProvider.invoke(
     RPCJavaProvider.java:129)
   at org.apache.soap.server.http.RPCRouterServlet.doPost(
     RPCRouterServlet.java:288)
   at javax.servlet.http.HttpServlet.service(HttpServlet.java:760)
   at javax.servlet.http.HttpServlet.service(HttpServlet.java:853)
   at com.google.gse.HttpConnection.runServlet(HttpConnection.java:237)
   at com.google.gse.HttpConnection.run(HttpConnection.java:195)
   at com.google.gse.DispatchQueue$WorkerThread.run(DispatchQueue.java:201)
Caused by: com.google.soap.search.UserKeyInvalidException: Key was of wrong size.
   at com.google.soap.search.UserKey.<init>(UserKey.java:59)
   at com.google.soap.search.QueryLimits.lookUpAndLoadFromINSIfNeedBe(
     QueryLimits.java:217)
   ... 14 more
'}>
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
  File "c:\python23\Lib\site-packages\SOAPpy\Client.py", line 453, in __call__
    return self.__r_call(*args, **kw)
  File "c:\python23\Lib\site-packages\SOAPpy\Client.py", line 475, in __r_call
    self.__hd, self.__ma)
  File "c:\python23\Lib\site-packages\SOAPpy\Client.py", line 389, in __call
    raise p
SOAPpy.Types.faultType: <Fault SOAP-ENV:Server: Exception from service object:
Invalid authorization key: foo:
<SOAPpy.Types.structType detail at 14164616>:
{'stackTrace':
  'com.google.soap.search.GoogleSearchFault: Invalid authorization key: foo
   at com.google.soap.search.QueryLimits.lookUpAndLoadFromINSIfNeedBe(
     QueryLimits.java:220)
   at com.google.soap.search.QueryLimits.validateKey(QueryLimits.java:127)
   at com.google.soap.search.GoogleSearchService.doPublicMethodChecks(
     GoogleSearchService.java:825)
   at com.google.soap.search.GoogleSearchService.doGoogleSearch(
     GoogleSearchService.java:121)
   at sun.reflect.GeneratedMethodAccessor13.invoke(Unknown Source)
   at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
   at java.lang.reflect.Method.invoke(Unknown Source)
   at org.apache.soap.server.RPCRouter.invoke(RPCRouter.java:146)
   at org.apache.soap.providers.RPCJavaProvider.invoke(
     RPCJavaProvider.java:129)
   at org.apache.soap.server.http.RPCRouterServlet.doPost(
     RPCRouterServlet.java:288)
   at javax.servlet.http.HttpServlet.service(HttpServlet.java:760)
   at javax.servlet.http.HttpServlet.service(HttpServlet.java:853)
   at com.google.gse.HttpConnection.runServlet(HttpConnection.java:237)
   at com.google.gse.HttpConnection.run(HttpConnection.java:195)
   at com.google.gse.DispatchQueue$WorkerThread.run(DispatchQueue.java:201)
Caused by: com.google.soap.search.UserKeyInvalidException: Key was of wrong size.
   at com.google.soap.search.UserKey.<init>(UserKey.java:59)
   at com.google.soap.search.QueryLimits.lookUpAndLoadFromINSIfNeedBe(
     QueryLimits.java:217)
   ... 14 more
'}>