[python-crontab] Remove from pyrightconfig (#14322)

Author: donBarbos

pyrightconfig.stricter.json

@@ -81,7 +81,6 @@
         "stubs/pycurl",
         "stubs/Pygments",
         "stubs/PyMySQL",
-        "stubs/python-crontab",
         "stubs/python-datemath",
         "stubs/python-dateutil",
         "stubs/python-http-client",

stubs/python-crontab/@tests/stubtest_allowlist.txt

@@ -2,3 +2,4 @@
 crontabs.CronTabs.__new__
 # stub does not have *args argument "args", but function doesn't actually accept positional args
 crontab.CronTab.remove_all
+crontab.OrderedVariableList.__init__

stubs/python-crontab/METADATA.toml

@@ -1,2 +1,3 @@
 version = "3.2.*"
 upstream_repository = "https://gitlab.com/doctormo/python-crontab"
+requires = ["types-croniter"]

stubs/python-crontab/crontab.pyi

@@ -1,18 +1,32 @@
 import re
 import subprocess
-from _typeshed import Incomplete
+from _typeshed import Incomplete, StrPath
 from builtins import range as _range
 from collections import OrderedDict
 from collections.abc import Callable, Generator, Iterable, Iterator
 from datetime import datetime
 from logging import Logger
 from types import TracebackType
-from typing import Any, SupportsIndex, overload
+from typing import Any, Literal, Protocol, SupportsIndex, TypeVar, overload, type_check_only
 from typing_extensions import Self, TypeAlias
 
+from croniter.croniter import croniter
 from cronlog import CronLog
 
 _User: TypeAlias = str | bool | None
+_K = TypeVar("_K")
+_V = TypeVar("_V")
+
+# cron_descriptor.Options class
+@type_check_only
+class _Options(Protocol):
+    casing_type: Literal[1, 2, 3]
+    verbose: bool
+    day_of_week_start_index_zero: bool
+    use_24hour_time_format: bool
+    locale_location: StrPath | None
+    locale_code: str | None
+    def __init__(self) -> None: ...
 
 __pkgname__: str
 ITEMREX: re.Pattern[str]
@@ -22,7 +36,7 @@ WEEK_ENUM: list[str]
 MONTH_ENUM: list[str | None]
 SPECIALS: dict[str, str]
 SPECIAL_IGNORE: list[str]
-S_INFO: list[dict[str, Any]]
+S_INFO: list[dict[str, str | int | list[str] | list[str | None]]]
 WINOS: bool
 POSIX: bool
 SYSTEMV: bool
@@ -50,7 +64,7 @@ class CronTab:
     crons: list[CronItem] | None
     filen: str | None
     cron_command: str
-    env: OrderedVariableList | None
+    env: OrderedVariableList[Incomplete, Incomplete] | None
     root: bool
     intab: str | None
     tabfile: str | None
@@ -73,13 +87,13 @@ class CronTab:
         item: CronItem,
         line: str = ...,
         read: bool = ...,
-        before: str | re.Pattern[str] | list[CronItem] | tuple[CronItem, ...] | Generator[CronItem, Any, Any] | None = ...,
+        before: str | re.Pattern[str] | list[CronItem] | tuple[CronItem, ...] | Generator[CronItem] | None = ...,
     ) -> None: ...
     def write(self, filename: str | None = ..., user: _User = ..., errors: bool = ...) -> None: ...
     def write_to_user(self, user: bool | str = ...) -> None: ...
     # Usually `kwargs` are just `now: datetime | None`, but technically this can
     # work for `CronItem` subclasses, which might define other kwargs.
-    def run_pending(self, **kwargs: Any) -> Iterator[str]: ...
+    def run_pending(self, *, now: datetime | None = ..., **kwargs: Any) -> Iterator[str]: ...
     def run_scheduler(self, timeout: int = -1, cadence: int = 60, warp: bool = False) -> Iterator[str]: ...
     def render(self, errors: bool = ..., specials: bool | None = ...) -> str: ...
     def new(
@@ -88,7 +102,7 @@ class CronTab:
         comment: str = ...,
         user: str | None = ...,
         pre_comment: bool = ...,
-        before: str | re.Pattern[str] | list[CronItem] | tuple[CronItem, ...] | Generator[CronItem, Any, Any] | None = ...,
+        before: str | re.Pattern[str] | list[CronItem] | tuple[CronItem, ...] | Generator[CronItem] | None = ...,
     ) -> CronItem: ...
     def find_command(self, command: str | re.Pattern[str]) -> Iterator[CronItem]: ...
     def find_comment(self, comment: str | re.Pattern[str]) -> Iterator[CronItem]: ...
@@ -116,7 +130,7 @@ class CronItem:
     comment: str
     command: str | None
     last_run: datetime | None
-    env: OrderedVariableList
+    env: OrderedVariableList[Incomplete, Incomplete]
     pre_comment: bool
     marker: str | None
     stdin: str | None
@@ -157,10 +171,18 @@ class CronItem:
     def frequency_at_hour(self, year: None = None, month: None = None, day: None = None, hour: None = None) -> int: ...
     def run_pending(self, now: datetime | None = ...) -> int | str: ...
     def run(self) -> str: ...
-    # TODO: use types from `croniter` module here:
-    def schedule(self, date_from: datetime | None = ...): ...
-    # TODO: use types from `cron_descriptor` here:
-    def description(self, **kw): ...
+    def schedule(self, date_from: datetime | None = ...) -> croniter: ...
+    def description(
+        self,
+        *,
+        options: _Options | None = None,
+        casing_type: Literal[1, 2, 3] = 2,
+        verbose: bool = False,
+        day_of_week_start_index_zero: bool = True,
+        use_24hour_time_format: bool = ...,
+        locale_location: StrPath | None = None,
+        locale_code: str | None = ...,
+    ) -> str | None: ...
     @property
     def log(self) -> CronLog: ...
     @property
@@ -288,11 +310,12 @@ class CronRange:
     def __gt__(self, value: object) -> bool: ...
     def __int__(self) -> int: ...
 
-# TODO: make generic
-class OrderedVariableList(OrderedDict[Incomplete, Incomplete]):
-    job: Incomplete
-    def __init__(self, *args: Any, **kw: Any) -> None: ...
+class OrderedVariableList(OrderedDict[_K, _V]):
+    job: CronItem | None
+    # You cannot actually pass `*args`, it will raise an exception,
+    # also known kwargs are added:
+    def __init__(self, *, job: CronItem | None = None, **kw: _V) -> None: ...
     @property
-    def previous(self): ...
+    def previous(self) -> Self | None: ...
     def all(self) -> Self: ...
-    def __getitem__(self, key): ...
+    def __getitem__(self, key: _K) -> _V: ...