SQLAlchemy method to get ORM object as dict?

Question

Take the following code:

from sqlalchemy import create_engine
from sqlalchemy.orm import declarative_base
from sqlalchemy import Column, Integer, String
engine = create_engine('postgresql://postgres:password@localhost:5432/db', echo=True, echo_pool='debug')
Base = declarative_base()

class Item(Base):
    __tablename__ = 'items'
    id = Column(Integer, primary_key=True)
    name = Column(String)
    def __repr__(self):
       return "<Item(id=%s, name='%s')>" % (self.id, self.name)

item = Item(name="computer")

Is there a way to get a python dict of the Item with all its fields? For example, I would like to get the following returned:

item.to_dict()
{"id": None, "name": "computer"}

Or do I have to write my own method to do that?

Something like [this](https://stackoverflow.com/questions/1958219/how-to-convert-sqlalchemy-row-object-to-a-python-dict)? — Jonathan Ciapetti, Jul 28 '22 at 00:49
@JonathanCiapetti not really, those are usually from query result-sets. I've added an answer though. — David542, Jul 28 '22 at 00:57

David542 · Accepted Answer · 2022-07-28T04:30:10.120

Here would be one way to do it:

class MyBase(Base):
    __abstract__ = True
    def to_dict(self):
        return {field.name:getattr(self, field.name) for field in self.__table__.c}

class Item(MyBase):
    # as before

item = Item(name="computer")
item.to_dict()
# {'id': None, 'name': 'computer'}

Also, a lot of these usability simplifications can be found in: https://github.com/absent1706/sqlalchemy-mixins.

SQLAlchemy method to get ORM object as dict?

1 Answers1