Add type annotations #427

MartinThoma · 2021-02-01T19:13:09Z

No description provided.

coveralls · 2021-02-01T19:38:07Z

Coverage decreased (-0.3%) to 99.663% when pulling c8be406 on MartinThoma:type-annotations into 32a1400 on dbader:master.

SijmenHuizenga

Thanks a lot for doing this @MartinThoma! This looks really good. I love the types and the updated formatting 🚀

schedule/__init__.py

setup.cfg

* Added 'repeat' decorator and written a test. Increased the version by 0.0.1. * Removed the type of the given job for python 2.* compatibility. * Added some newlines to comply with FLAKE8 * Added import for 'repeat' in the code example * Added decorator docs and the ability to pass arguments to the job through the decorator * Fix FLAKE8 * Added rhagenaars to authors * Apply suggestions from code review

Partial functions for example do not have a __name__, so they need the same treatment in __str__ as in __repr__ in order to show a name-like thing.

* Added conda to installation instructions * Update installation.rst

Closes dbader#392

MartinThoma · 2021-02-10T21:57:40Z

There are 4 errors mentioned by mypy where I'm uncertain if they can be ignored:

schedule/__init__.py:251: error: Item "function" of "Optional[Callable[..., Any]]" has no attribute "args"
schedule/__init__.py:251: error: Item "None" of "Optional[Callable[..., Any]]" has no attribute "args"
schedule/__init__.py:252: error: Item "function" of "Optional[Callable[..., Any]]" has no attribute "keywords"
schedule/__init__.py:252: error: Item "None" of "Optional[Callable[..., Any]]" has no attribute "keywords"

…optional

schedule/__init__.py

SijmenHuizenga

Almost there! Just a few nitpicky comments left.

And let's add a note in the docs about mypy.

SijmenHuizenga · 2021-02-10T22:54:46Z

schedule/__init__.py

-    Can be returned from a job to unschedule itself.
-    """
-
-    pass


Let's undo these removals of pass and these formatting changes.

I undid it. However, I want to point out that the "pass" has absolutely no effect here. It's like a comment. Pass only is necessary if nothing follows, e.g. if the docstring wasn't there.

SijmenHuizenga · 2021-02-10T22:55:34Z

schedule/__init__.py

@@ -157,7 +148,7 @@ def cancel_job(self, job):
        except ValueError:
            logger.debug('Cancelling not-scheduled job "%s"', str(job))

-    def every(self, interval=1):
+    def every(self, interval: int = 1) -> "Job":


Suggested change

def every(self, interval: int = 1) -> "Job":

def every(self, interval: int = 1) -> Job:

This will only work with from __future__ import annotations as the class Job is not defined at this point. In Python < 3.8 the annotation is actually evaluated when the signature is parsed. Meaning the class "Job" would have to exist. Or we import the future annotations ... but that will also only do the trick for Python 3.7. There is no way around the quotes for Python 3.6

SijmenHuizenga · 2021-02-10T22:55:48Z

schedule/__init__.py

@@ -167,13 +158,13 @@ def every(self, interval=1):
        job = Job(interval, self)
        return job

-    def _run_job(self, job):
+    def _run_job(self, job: "Job") -> None:


Suggested change

def _run_job(self, job: "Job") -> None:

def _run_job(self, job: Job) -> None:

Same comment as above

SijmenHuizenga · 2021-02-10T22:56:31Z

schedule/__init__.py

-        self.scheduler = scheduler  # scheduler to register with
-
-    def __lt__(self, other):
+    def __init__(self, interval, scheduler: Scheduler = None):


add explicit type to interval

Done! I made it an int :-)

SijmenHuizenga

This looks good to go! Really great work @MartinThoma!!!!

MartinThoma · 2021-02-11T22:30:16Z

Thank you very much for all the support for this PR and work on schedule in general 🤗

MartinThoma force-pushed the type-annotations branch 6 times, most recently from 0f309fd to ddd3676 Compare February 1, 2021 19:30

SijmenHuizenga reviewed Feb 2, 2021

View reviewed changes

schedule/__init__.py Outdated Show resolved Hide resolved

schedule/__init__.py Show resolved Hide resolved

setup.cfg Show resolved Hide resolved

SijmenHuizenga linked an issue Feb 4, 2021 that may be closed by this pull request

Type hints #392

Closed

dbader and others added 7 commits February 8, 2021 13:40

Update GitHub button in docs

66e00d6

Fix typo in examples.rst (dbader#426)

4c20df5

Fix str of job when there is no __name__ (dbader#430)

a1c13e1

Partial functions for example do not have a __name__, so they need the same treatment in __str__ as in __repr__ in order to show a name-like thing.

Installation instructions cleanup + added conda (dbader#421)

6aa67b1

* Added conda to installation instructions * Update installation.rst

Merge remote-tracking branch 'upstream/master'

909d3e3

Merge remote-tracking branch 'upstream/master'

d8f8587

MartinThoma force-pushed the type-annotations branch 3 times, most recently from 32ea7da to 274e622 Compare February 10, 2021 21:54

Add type annotations

a3c3f80

Closes dbader#392

MartinThoma force-pushed the type-annotations branch from 274e622 to a3c3f80 Compare February 10, 2021 21:56

SijmenHuizenga added 2 commits February 10, 2021 23:06

Added type checking to github actions

068677c

set job_func type to functools.partial, make job scheduler no longer …

9fe46f3

…optional

MartinThoma commented Feb 10, 2021

View reviewed changes

schedule/__init__.py Outdated Show resolved Hide resolved

SijmenHuizenga added 3 commits February 10, 2021 23:38

Make job accept None schedule again

f598591

Fix formatting

3445c08

Fix formatting

6695bc7

SijmenHuizenga requested changes Feb 10, 2021

View reviewed changes

Add pass as requested

b410ab6

MartinThoma added 2 commits February 11, 2021 00:09

Undo formatting

402308e

Add missing interval type

c8be406

SijmenHuizenga approved these changes Feb 11, 2021

View reviewed changes

SijmenHuizenga merged commit 76ae16c into dbader:master Feb 11, 2021

MartinThoma deleted the type-annotations branch February 11, 2021 22:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add type annotations #427

Add type annotations #427

MartinThoma commented Feb 1, 2021

coveralls commented Feb 1, 2021 •

edited

Loading

SijmenHuizenga left a comment

MartinThoma commented Feb 10, 2021

SijmenHuizenga left a comment •

edited

Loading

SijmenHuizenga Feb 10, 2021

MartinThoma Feb 10, 2021

SijmenHuizenga Feb 10, 2021

MartinThoma Feb 10, 2021

SijmenHuizenga Feb 10, 2021

MartinThoma Feb 10, 2021

SijmenHuizenga Feb 10, 2021

MartinThoma Feb 10, 2021

SijmenHuizenga left a comment

MartinThoma commented Feb 11, 2021

	def every(self, interval: int = 1) -> "Job":
	def every(self, interval: int = 1) -> Job:

	def _run_job(self, job: "Job") -> None:
	def _run_job(self, job: Job) -> None:

Add type annotations #427

Add type annotations #427

Conversation

MartinThoma commented Feb 1, 2021

coveralls commented Feb 1, 2021 • edited Loading

SijmenHuizenga left a comment

Choose a reason for hiding this comment

MartinThoma commented Feb 10, 2021

SijmenHuizenga left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SijmenHuizenga left a comment

Choose a reason for hiding this comment

MartinThoma commented Feb 11, 2021

coveralls commented Feb 1, 2021 •

edited

Loading

SijmenHuizenga left a comment •

edited

Loading