Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Type hints #25

Open
aaronsteers opened this issue May 12, 2021 · 5 comments
Open

Type hints #25

aaronsteers opened this issue May 12, 2021 · 5 comments
Labels
enhancement New feature or request

Comments

@aaronsteers
Copy link

aaronsteers commented May 12, 2021

Hi, I'm curious if you would accept a PR to add type hints throughout this library. I have run into numerous cases where I sent a dict or object when the vice versa was needed. Is this something you would be amenable to reviewing if I were to create a PR?

In building out the singer-sdk, I've mostly avoided dependencies on this library just because I was not confident on how types should be handled. If I had confidence in expected data types we could put more load on this library, rather than reinventing the wheel.

Thanks!

@Samira-El Samira-El added the enhancement New feature or request label May 14, 2021
@Samira-El
Copy link
Collaborator

Hey Aaron.

That would be great, type hints are cool and definitely make dev life's easier! I would also suggest adding a CI check using mypy.

@aaronsteers
Copy link
Author

@Samira-El - Awesome! And since this is going to be a large code review, any objections to an incremental approach? Perhaps I can do it all in one go, but if it gets too unwieldy I was thinking I might focus first on catalog and bookmarks.

@Samira-El
Copy link
Collaborator

An incremental approach sounds good and makes review easier for us!

@aaronsteers
Copy link
Author

aaronsteers commented May 15, 2021

I got more done than I expected. 😅 #26

@aaronsteers
Copy link
Author

@Samira-El - This is ready for review: #26

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants