CODEWITHSUNDEEP
pythonfastapipydantic
Ajeet Mishra
Ajeet Mishra

Reputation: 382

Unhashable type in FastAPI request

I am writing a post-api using fastapi. The required request-format is:

{
   "leadid":LD123,
   "parties":[
      {
         "uid":123123,
         "cust_name":"JOhn Doe",
      }, ...]}

The fastapi code in python is:

class Customer(BaseModel):
    UID: str
    CustName: str

class PackageIn(BaseModel): 
    lead_id: str
    parties: Set[Customer]
    # threshold: Optional[int] = 85

app = FastAPI()

@app.post('/')
async def nm_v2(package:PackageIn):
    return {"resp":"Response"}

When I visit the SwaggerUI to submit the response, the error is "422 Error: Unprocessable Entity". Also, the SwaggerUI doc states

{
  "detail": [
    {
      "loc": [
        "body"
      ],
      "msg": "unhashable type: 'Customer'",
      "type": "type_error"
    }
  ]
}

I do not know how to create this dict() structure for request payload without creating a separate pydantic based class called Customer. Pl tell me how to rectify the error.

Upvotes: 16

Views: 13908

Answers (2)

Ryabchenko Alexander
Ryabchenko Alexander

Reputation: 12330

after https://github.com/pydantic/pydantic/pull/1881 you can add frozen = True to make yor object hashable (note instances will not be allowed to mutate)

class Customer(BaseModel)::
    UID: str
    CustName: str

    class Config:
        frozen = True

Upvotes: 10

Alexey Sherchenkov
Alexey Sherchenkov

Reputation: 503

Pytdantic BaseClass is not hashable. There is a discussion about this feature, i guess it will not be implemented. There is workaround in the discussion, for your case you can try this:

from pydantic import BaseModel
from typing import Set


class MyBaseModel(BaseModel):
    def __hash__(self):  # make hashable BaseModel subclass
        return hash((type(self),) + tuple(self.__dict__.values()))


class Customer(MyBaseModel):  # Use hashable sublclass for your model
    UID: str
    CustName: str


class PackageIn(BaseModel):
    lead_id: str
    parties: Set[Customer]
    # threshold: Optional[int] = 85

data = {
    "lead_id": 'LD123',
    "parties": [
       {
           "UID": 123123,
           "CustName": "JOhn Doe",
       }]}

PackageIn.parse_obj(data) # This part fastapi will make on post request, just for test

> <PackageIn lead_id='LD123' parties={<Customer UID='123123' CustName='JOhn Doe'>}>

Upvotes: 19

Related Questions