Open-event-server: Add static types in codebase

[iamareebjamal]

A lot of benefits can be reaped and a lot of bugs can be caught with static typing in Python using validators and linters like mypy

This is a parent issue tracking various areas where static typing can be added and is reserved for first time and new contributors

https://docs.python.org/3/library/typing.html
https://mypy.readthedocs.io/en/stable/index.html

This issue can be broken down into 2 phases

1. Add typing annotations

Add annotations in:

• [ ] Utilities
• [ ] API helpers
• [ ] SQLAlchemy Models https://github.com/dropbox/sqlalchemy-stubs
• [ ] More to come

1. Test using mypy

Once enough annotations are added and not necessarily all the points in above step are completed, we want to

• [ ] Add mypy test in CI to ensure types are passed correctly

[Dilshaad21]

@iamareebjamal can I take this issue

[iamareebjamal]

Take one part of it. Analyze the codebase and tell me which component you'd like to work on

[Dilshaad21]

I would like to work with the utils component. Then how should I begin with it?
I suppose there is only one file in utils section which is common.py

[sameshl]

@iamareebjamal I would like to take the api helpers part

[iamareebjamal]

@Dilshaad21 There are a lot of utilities in api.helpers as well unfortunately

Like this test - https://github.com/fossasia/open-event-server/blob/development/tests/all/unit/api/helpers/test_utilities.py

It is testing things from helpers but they are actually utilities.

Start with common.py and take up utilities in helpers. Anything not related to API is a utility - file utility, compression, text transforms etc

API helpers are directly related to the API, like discount code validation, etc which @sameshl can work on

[chiral-carbon]

@prateekj117 @iamareebjamal can I work on the SQLAlchemy models part?

[prateekj117]

@chiral-carbon Ok, go ahead.

[himanshupathak21061998]

@chiral-carbon If you are not working on this I want to work on this issue.
@prateekj117 I will start by adding annotation and after that, I will add mypy test

[chiral-carbon]

@himanshupathak21061998 hey, i'm still working on this.

[iamareebjamal]

@chiral-carbon 26 days have passed without any progress. Besides, this issue is huge, there is no way 2 or even 5 contributors will have conflicts or work on same area when adding static types. So, not just 1 contributor can solve this issue

[chiral-carbon]

@iamareebjamal okay.

[dinolinjob]

I would like to work on this issue @iamareebjamal

[iamareebjamal]

OK

[dinolinjob]

@iamareebjamal Is there a way to check whether the typing annotations written is correct before writing mypy test?
I have began adding typing annotations to auth.py in helpers. Any suggestions?

[iamareebjamal]

No such way

[HardikM1999]

Can I work on this issue @iamareebjamal ?

[iamareebjamal]

Yes, one more to the list

[EkanshMangal]

Hello Sir, Can I work on this issue?

[snitin315]

@EkanshMangal Yes, you can.

[iamareebjamal]

Yes, you can like the others who mentioned above and never did. So please, instead of spamming "Can I work on this issue?" on every issue, which is very annoying, pick one and send a PR, which by judging previous behaviours of commentators won't happen

[b-thebest]

Hello, Can I work on this issue.

[iamareebjamal]

Yes, please go ahead

[imrahul361]

Is anyone working on this issue?
@iamareebjamal

[iamareebjamal]

Considering it has been 6 months, no

[hari193023]

can I work on this issue?

[Shakil-786]

can I work on this?