search

mindflayer / python-mocket

a socket mock framework - for all kinds of socket animals, web-clients included
BSD 3-Clause "New" or "Revised" License
281 stars 42 forks source link

Add type hints to improve codebase readability and enable static type checking #203

Open Niraj-Kamdar opened 1 year ago

Niraj-Kamdar commented 1 year ago

I propose adding type hints to the mocket Python package to enhance code readability and maintainability. Type hints provide several benefits, including improved developer productivity, enhanced code documentation, and the ability to catch potential errors using static type-checking tools like Mypy.

mindflayer commented 1 year ago

Hi @Niraj-Kamdar, I am not sure if I got your proposal right. Are you volunteering to add type hints to the project?

mindflayer commented 1 year ago

No answers to my question, closing it.

Niraj-Kamdar commented 1 year ago

Hey @mindflayer Sorry for the late reply here. My proposal is for adding type hints in general, I would love to help here though when I get free time but currently, I have too much on my plate to help out with this. I would appreciate if you can keep this issue open so others or me can eventually take this and add type-hints to the mocket.

Kilo59 commented 5 months ago

@mindflayer Closing this issue signals that

  1. You don't plan to add type annotations.
  2. You aren't willing to accept contributions that add these.

Can you re-open this issue if one or both of these are untrue?

mindflayer commented 5 months ago

@mindflayer Closing this issue signals that

1. You don't plan to add type annotations.

2. You aren't willing to accept contributions that add these.

Can you re-open this issue if one or both of these are untrue?

I am the only maintainer of Mocket, and I think it's worth keeping non-bug issues open only if I am confident it's something I have time for, or at least if I know someone is willing to help with. Having a backlog of stuff just for the sake of it it's pointless. So, allow me to bounce back the question: is anyone willing to contribute with adding type hints?

Kilo59 commented 5 months ago

So, allow me to bounce back the question: is anyone willing to contribute with adding type hints?

@mindflayer

Yes. The only thing that gives me pause about taking on this work is the fact that this issue was closed. Which makes it ambiguous as to whether an annotation PR would be accepted.

mindflayer commented 5 months ago

Well, alright then! 👍

mindflayer commented 4 weeks ago

Hi @Kilo59, are you still planning to continue with this task?