Open-event-server: Deduplicate marshmallow schema by using marshmallow-sqlalchemy

[iamareebjamal]

There is a lot of repetition between sqlalchemy models and marshmallow schema

Use https://marshmallow-sqlalchemy.readthedocs.io to remove this duplication

This is a parent issue and new contributors can take an API component and send contributions converting their schemas

[Soniyanayak51]

Hi, I would like to work on this issue. This will be my first pull request here. Can you help me with where to start?

[iamareebjamal]

Take a look at codebase and marshmallow schema files. Read about the above mentioned library and tell which component will you start working on here

[Soniyanayak51]

@iamareebjamal I am willing towork on any of the schemas but I am not able to figure out the repetitions. I see that models serialize the data. Can you give an example?

[iamareebjamal]

Can you please take a look at the library I have linked in the issue and read about its usage. The issue will become apparent

[Soniyanayak51]

@iamareebjamal I went through the library. I need to rewrite the models and schemas using marshmallow-sqlalchemy but I am unable to find the repetiton. As per the documentation we still need to deserialize after the schema class. Sorry I am new but could you show me an example?

[iamareebjamal]

You don't need to rewrite the models. Just the schema

https://github.com/fossasia/open-event-server/blob/b8f136eee28e884409068d7bf348e6a89f77c27f/app/models/event.py#L44-L180

https://github.com/fossasia/open-event-server/blob/b8f136eee28e884409068d7bf348e6a89f77c27f/app/api/schema/events.py#L44-L288

Can you see the repetition now?

[AnirbanBanik1998]

I would like to work on this issue @iamareebjamal @prateekj117

[kushthedude]

Go ahead

On Tue, 15 Oct, 2019, 11:08 Anirban Banik, [e-mail] wrote:

I would like to work on this issue @iamareebjamal
https://github.com/iamareebjamal @prateekj117
https://github.com/prateekj117

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
https://github.com/fossasia/open-event-server/issues/6467?email_source=notifications&email_token=AKQMTLSA6SBYGQHVE2GKXHDQOVJOBA5CNFSM4I2RGXO2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEBHPKLA#issuecomment-542045484,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AKQMTLX3RTUDMK3B5SGIPF3QOVJOBANCNFSM4I2RGXOQ
.

[AnirbanBanik1998]

@kushthedude @iamareebjamal @prateekj117 I am working on the event schemas.

[codedsun]

@iamareebjamal @prateekj117 taking this up

[Fik-shun]

@iamareebjamal Hey! I'd like to take this issue.
So basically i just have to remove the entire marshmallow schema(repeated) and put the sqlalchemy model there
eg -> model = Event
under Meta class in EventSchemaPublic.
And similarly for other API components.
Right?

[iamareebjamal]

If it works, yes

[diru1100]

Can I explore a bit and work on this, if there's still more to do?

[Ranjit1312]

@iamareebjamal :
Hi,
If this issue is till open, can I work on this ?

[iamareebjamal]

Yes

[Ranjit1312]

@iamareebjamal :

As per the latest update on: https://marshmallow-sqlalchemy.readthedocs.io/en/latest/

For the model Book relationship with model Author, there are changes required in the Schema of Author and Book as well.

Models:

class Author(Base):
    __tablename__ = "authors"
    id = sa.Column(sa.Integer, primary_key=True)
    name = sa.Column(sa.String, nullable=False)

    def __repr__(self):
        return "<Author(name={self.name!r})>".format(self=self)


class Book(Base):
    __tablename__ = "books"
    id = sa.Column(sa.Integer, primary_key=True)
    title = sa.Column(sa.String)
    author_id = sa.Column(sa.Integer, sa.ForeignKey("authors.id"))
    author = relationship("Author", backref=backref("books"))

Schema:

class AuthorSchema(SQLAlchemyAutoSchema):
    class Meta:
        model = Author
        include_relationships = True # 
        load_instance = True


class BookSchema(SQLAlchemyAutoSchema):
    class Meta:
        model = Book
        include_fk = True #
        load_instance = True

[DiptoChakrabarty]

Hey would like to contribute to this

[meprogemur]

Hey, I want to work on this. Can I contribute?