Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion example/main.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from fastapi import FastAPI
from webservice import soap
from .webservice import soap

app = FastAPI()

Expand All @@ -8,4 +8,5 @@

if __name__ == "__main__":
import uvicorn

uvicorn.run("main:app")
8 changes: 4 additions & 4 deletions example/schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
from fastapi_soap.models import BodyContent


class Operands(BodyContent, tag='Operands'):
operands: list[float] = element(tag='Operand')
class Operands(BodyContent, tag="Operands"):
operands: list[float] = element(tag="Operand")


class Result(BodyContent, tag='Result'):
value: float
class Result(BodyContent, tag="Result"):
value: float = element(tag="value")
8 changes: 3 additions & 5 deletions example/webservice.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@
from fastapi_soap.response import SoapResponse
from fastapi_soap.routes import SoapRouter

from schema import Operands, Result
from .schema import Operands, Result

soap = SoapRouter(name='Calculator', prefix='/Calculator')
soap = SoapRouter(name="Calculator", prefix="/Calculator")


@soap.operation(
name='SumOperation', request_model=Operands, response_model=Result
)
@soap.operation(name="SumOperation", request_model=Operands, response_model=Result)
def sum_operation(body: Operands = XMLBody(Operands)):
result = sum(body.operands)

Expand Down
28 changes: 14 additions & 14 deletions fastapi_soap/models.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
from typing import Generic, Optional, TypeVar

from pydantic_xml import BaseGenericXmlModel, BaseXmlModel, element
from pydantic_xml import BaseXmlModel, element


class SoapHeader(
BaseXmlModel,
tag='Header',
ns='soap',
tag="Header",
ns="soap",
):
"""Soap header abstract definition.

Expand Down Expand Up @@ -45,24 +45,24 @@ class EmptyContent(BodyContent):
"""Helper model for empty requests."""


class FaultResponse(BodyContent, tag='Fault'):
class FaultResponse(BodyContent, tag="Fault"):
"""Soap Fault response model."""

faultcode: str = element()
faultstring: str = element()


BodyContentType = TypeVar(
'BodyContentType', bound=BodyContent | FaultResponse | BaseXmlModel
"BodyContentType", bound=BodyContent | FaultResponse | BaseXmlModel
)
"""Generic type for body content. Accepts a BodyContent or a FaultResponse"""


class SoapBody(
BaseGenericXmlModel,
BaseXmlModel,
Generic[BodyContentType],
tag='Body',
ns='soap',
tag="Body",
ns="soap",
):
"""Soap body abstract model definition.

Expand Down Expand Up @@ -101,20 +101,20 @@ class GetPersonOperation(BaseXmlModel, tag="GetPerson"):
call: Optional[BodyContentType]


HeaderType = TypeVar('HeaderType', bound=SoapHeader)
HeaderType = TypeVar("HeaderType", bound=SoapHeader)
"""Generic type for SoapHeader model"""

BodyType = TypeVar('BodyType', bound=SoapBody)
BodyType = TypeVar("BodyType", bound=SoapBody)
"""Generic type for Body model"""


class SoapEnvelope(
BaseGenericXmlModel,
BaseXmlModel,
Generic[HeaderType, BodyType],
tag='Envelope',
ns='soap',
tag="Envelope",
ns="soap",
nsmap={
'soap': 'http://schemas.xmlsoap.org/soap/envelope/',
"soap": "http://schemas.xmlsoap.org/soap/envelope/",
},
):
"""Soap Envelope abstract definition.
Expand Down
8 changes: 4 additions & 4 deletions fastapi_soap/response.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
class SoapResponse(Response):
"""FastAPI Response that renders a Soap XML response."""

media_type = 'text/xml'
media_type = "text/xml"

def __init__(
self,
Expand Down Expand Up @@ -54,14 +54,14 @@ def some_operation_function(...):
def render(self, content: Any) -> str | bytes:
if isinstance(content, BaseXmlModel):
if not self._envelope_wrap:
return content.to_xml(encoding='UTF-8', standalone=True)
return content.to_xml(encoding="UTF-8", standalone=True)

envelope_model = SoapEnvelope[
self._soap_header.__class__, SoapBody[content.__class__]
]
envelope: envelope_model = envelope_model(
envelope: envelope_model = envelope_model( # type: ignore
header=self._soap_header, body=SoapBody(call=content)
)
return envelope.to_xml(encoding='UTF-8', standalone=True)
return envelope.to_xml(encoding="UTF-8", standalone=True)

return content if not isinstance(content, str) else content.encode()
30 changes: 14 additions & 16 deletions fastapi_soap/routes.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ class SoapRoute(APIRoute):
to FastAPI app.
"""

async def exception_response(
self, fault, status_code: int = 500
) -> Response:
async def exception_response(self, fault, status_code: int = 500) -> Response:
return SoapResponse(fault, status_code=status_code)

def get_route_handler(self) -> Callable:
Expand All @@ -33,15 +31,13 @@ async def custom_route_handler(request: Request) -> Response:

except FaultException as fault:
return await self.exception_response(
FaultResponse(
faultcode=fault.code, faultstring=fault.detail
)
FaultResponse(faultcode=fault.code, faultstring=fault.detail)
)
except Exception as exc:
return await self.exception_response(
FaultResponse(
faultcode='server',
faultstring=f'Internal Error: {exc}',
faultcode="server",
faultstring=f"Internal Error: {exc}",
)
)

Expand Down Expand Up @@ -83,13 +79,15 @@ def __init__(self, *args, name: str, **kwargs) -> None:
self._name = name

self._methods = {}
self.add_api_route(
'/', self._generate_wsdl, methods=['GET'], status_code=200
)
self.add_api_route("/", self._generate_wsdl, methods=["GET"], status_code=200)

def _generate_wsdl(self, request: Request):
wsdl = generate_wsdl(self._name, self._methods, url=self.prefix, request=request)
return SoapResponse(dump_etree(wsdl), envelope_wrap=False)
wsdl = generate_wsdl(
self._name, self._methods, url=self.prefix, request=request
)
etree = dump_etree(wsdl)
print(etree)
return SoapResponse(etree, envelope_wrap=False)

def operation(
self,
Expand Down Expand Up @@ -120,12 +118,12 @@ def sum(...):

def decorator(func: DecoratedCallable) -> DecoratedCallable:
self._methods.update(
{name: {'request': request_model, 'response': response_model}}
{name: {"request": request_model, "response": response_model}}
)
self.add_api_route(
f'/{name}',
f"/{name}",
func,
methods=['POST'],
methods=["POST"],
response_class=SoapResponse,
status_code=status_code,
)
Expand Down
Loading