BugBear rule B008 Function call in default argument

[skewty]

Strict linting rules require an override for the "example code".
Perhaps a better example should be provided?

@app.post("/notification")
def post_event(event: MyRequest = XmlBody()) -> EventResult:  # noqa: B008
    logger.info(f"{event} received")
    return EventResult(message="success")

[cercide]

Thanks for pointing this out.
Does this updated example address the issue?

@app.post("/notification")
def post_event(event: Annotated[MyRequest, XmlBody()] -> EventResult:
    logger.info(f"{event} received")
    return EventResult(message="success")

[skewty]

That does it. That should probably be the suggested way in the README / documentation.

[skewty]

Perhaps use this code in the README.md file instead.

from dataclasses import dataclass, field
from typing import Annotated
from fastapi import FastAPI
from fastapi_xml import XmlAppResponse, XmlBody, XmlRoute, add_openapi_extension

@dataclass
class HelloWorld:
    # `examples` field is used for sample data in /docs Swagger UI (1st value is used)
    # `name` field allows using different name in dataclass model than in XML (tag)
    message: str = field(metadata={"examples": ["Foo"],"name": "Message", "type": "Element"})

app = FastAPI(title="FastAPI::XML", default_response_class=XmlAppResponse)
app.router.route_class = XmlRoute
add_openapi_extension(app)

@app.post("/echo", tags=["Example"])
def echo(x: Annotated[HelloWorld, XmlBody()]) -> HelloWorld:
    x.message += " For ever!"
    return x

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="127.0.0.1", port=8000)

I am thinking a more "advanced" example would be good too. One where XmlRouter is used in a separate file and where the FastAPI app is not XML only / by default.

Your comments?