Add type hints to better understand source

Question

Add type hints to better understand source

Closed this issue a month ago · 14 comments

I currently try to find out if the between() function can take a date and/or datetime object. I think it can parse both (as that's what I remember I've tested), but I am not sure. Also I do not understand the source with that tuple and int instance checking, thats confusing to me.

Could you please clarify what the accepted inputs of between() are and maybe add this as a typehint?

We're using [Polar.sh](https://polar.sh/niccokunzmann) so you can upvote and help fund this issue. We receive the funding once the issue is completed & confirmed by you. Thank you in advance for helping prioritize & fund our work.

Answer 1 · 2022-06-16T14:17:13.000Z

I think, the README file describes which kinds of data structures you can pass to the between function. I did not use type-hints, yet. The motivation behind this is to be able to pass hard-coded arguments fast without needing to put them though a datetime.date or datetime.datetime on the user side.

Answer 2 · 2022-06-16T16:34:28.000Z

Ah, now I see. I would not do that, but as long as date and datetime works, thats fine for me.

Answer 3 · 2022-06-16T20:29:01.000Z

I just want to note, that if you input an end date as date it will not be included. What I expect the code to do is to combine that with:

if type(before) is date:
    before = datetime.combine(before, datetime.max.time())
if type(after) is date:
    after = datetime.combine(after, datetime.min.time())

Answer 4 · 2022-06-18T15:29:44.000Z

yes, the end date is excluded. That should be documented this way if I remember correctly.

Answer 5 · 2022-06-18T15:31:31.000Z

It seems that combine is not present.

Python 3.9.5 (default, Nov 23 2021, 15:27:38)
[GCC 9.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> help("datetime.combine")
No Python documentation found for 'datetime.combine'.

Answer 6 · 2022-06-20T11:30:13.000Z

https://docs.python.org/3/library/datetime.html#datetime.datetime.combine

Answer 7 · 2022-06-22T08:39:30.000Z

Thanks! I could have thought about that :,)
How would you formulate this issue so that it has closing criteria? Is it "Added type hints to at(), between() and of()"?
Or would be copying over examples from the README into the docstring?

Answer 8 · 2022-06-22T18:58:46.000Z

I personally would:

Add typehints to all public functions
Think if a function should take 5 different types of variables, or if date|datetime isn't already enough
Documenting the private function would also help you to build clearer and better understandable source code.

Answer 9 · 2022-06-22T19:09:11.000Z

And I have to correct myself:

        if type(start) is date:
            start = datetime.combine(start, datetime.min.time())
        if type(end) is date:
            end = datetime.combine(end + timedelta(days=1), datetime.min.time())

Is better

Answer 10 · 2022-12-10T13:43:06.000Z

Hm. I just saw this example concerning py.typed: https://github-redirect.dependabot.com/certifi/python-certifi/issues/196 That reminded me of this issue.

Answer 11 · 2023-01-11T23:30:02.000Z

If someone likes to add type hints, this is welcome. I will support that but not do it myself at the moment.

Answer 12 · 2023-01-12T20:59:12.000Z

Why? It is so much easier to understand your own code. At least for newer code this should be done. You can also then do typechecks using pylance in vscode.

Answer 13 · 2023-01-19T12:24:43.000Z

I do it in my free time, I do not get paid and I do not see the value. Other people see value, have time. I am more in survival mode at the moment. When a basic income is secured I can gift my time. Yes, it might take me less time and it would be efficient if I did it and I would learn but under the circumstances, I choose to work on other issues.

Answer 14 · 2024-08-20T00:22:05.000Z

This is fixed in v3.0.0