3.8.3rc0

Author: mborsetti

CHANGELOG.rst

@@ -39,6 +39,9 @@ Fixed
 -----
 * Fixed incorrect handling of timeout when checking if new version has been released.
 
+Internals
+---------
+* DictType hints for configuration.
 
 Version 3.8.2
 ====================

RELEASE.rst

@@ -1,3 +1,7 @@
 Fixed
 -----
 * Fixed incorrect handling of timeout when checking if new version has been released.
+
+Internals
+---------
+* DictType hints for configuration.

mypy.ini

@@ -4,7 +4,7 @@
 # File info at https://mypy.readthedocs.io/en/stable/config_file.html
 
 # Specifies the Python version used to parse and check the target program.
-python_version = 3.7
+# python_version = 3.7
 
 # Shows error codes in error messages.
 show_error_codes = True

tox.ini

@@ -6,7 +6,7 @@
 # entry point for build, test and release activities.
 
 [tox]
-minversion = 3.24.1
+minversion = 3.24.3
 envlist =
     pre-commit,
     py{310,39,38,37},
@@ -19,26 +19,26 @@ skip_missing_interpreters = true
 commands = coverage run --parallel-mode -m pytest
 deps =
     -rtests/requirements_pytest.txt
-passenv =
-    REDIS_URI
-    TELEGRAM_TOKEN
 setenv =
     PYTHONPATH = {toxinidir}
     PYTHONUTF8 = 1
+passenv =
+    REDIS_URI
+    TELEGRAM_TOKEN
 # parallel_show_output = true
+download = True
 depends =
 #     py{310,39,38,37}: pre-commit, new-install
     post: py{310,39,38,37}
 
 [testenv:pre-commit]
 # Settings defined in the top-level testenv section are automatically inherited if not overwritten
-basepython = python3.7
-deps =
-    -rtests/requirements_pre-commit.txt
-    -rdocs/requirements.txt
 commands =
     pre-commit autoupdate
     pre-commit run -a
+deps =
+    -rtests/requirements_pre-commit.txt
+    -rdocs/requirements.txt
 
 [testenv:post]
 # Post-test cleanup
@@ -54,28 +54,31 @@ skip_install = true
 
 [testenv:docs]
 # Test docs
+commands =
+    sphinx-build -W -j auto docs docs/_build
+    # TODO The below works in Windows only
+    cmd /c if %errorlevel% equ 0 start "" "file://{toxinidir}/docs/_build/index.html"
 deps =
     -rrequirements.txt
     -rdocs/requirements.txt
 allowlist_externals =
     cmd
     sphinx-build
-commands =
-    sphinx-build -W -j auto docs docs/_build
-    # TODO The below works in Windows only
-    cmd /c if %errorlevel% equ 0 start "" "file://{toxinidir}/docs/_build/index.html"
 
 [testenv:new-install]
 # Settings defined in the top-level testenv section are automatically inherited if not overwritten
 # new-install tests a clean new installation using wheel, ensuring e.g. that all packages are installed as well
-basepython = python3.7
+isolated_build = true
+# tox fails with Python 3.7 (does not run pip correctly)
+basepython = python3.8
 commands =
     pip install --upgrade pip setuptools wheel
     python setup.py bdist_wheel
     pip install --upgrade --find-links={toxinidir}/dist webchanges
     webchanges -v --clean-cache
     python -c "from pathlib import Path; dir = Path.home().joinpath('Documents').joinpath('webchanges'); [f.unlink() for f in dir.iterdir()]; dir.rmdir()"
 setenv = USERPROFILE = {env:TEMP}
+# empty list of deps to override top-level
+deps =
 download = true
 skip_install = true
-isolated_build = true

webchanges/command.py

@@ -9,7 +9,7 @@
 import traceback
 from concurrent.futures import ThreadPoolExecutor
 from pathlib import Path
-from typing import Optional, Union
+from typing import Optional, TYPE_CHECKING, Union
 
 import requests
 
@@ -24,6 +24,10 @@
 
 logger = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from .reporters import ConfigReportersList
+    from .storage import ConfigReportEmail, ConfigReportEmailSmtp, ConfigReportTelegram, ConfigReportXmpp
+
 
 class UrlwatchCommand:
     def __init__(self, urlwatcher: Urlwatch) -> None:
@@ -89,7 +93,8 @@ def edit_hooks(self) -> int:
         print(f'Saved edits in {self.urlwatch_config.hooks}')
         return 0
 
-    def show_features(self) -> int:
+    @staticmethod
+    def show_features() -> int:
         print(f'Please see full documentation at {__docs_url__}')
         print()
         print('Supported jobs:\n')
@@ -310,9 +315,9 @@ def edit_config(self) -> int:
         return result
 
     def check_telegram_chats(self) -> None:
-        config = self.urlwatcher.config_storage.config['report'].get('telegram')
+        config: ConfigReportTelegram = self.urlwatcher.config_storage.config['report']['telegram']
 
-        bot_token = config.get('bot_token')
+        bot_token = config['bot_token']
         if not bot_token:
             print('You need to set up your bot token first (see documentation)')
             self._exit(1)
@@ -354,8 +359,8 @@ def check_test_reporter(self) -> None:
             print(f'\nSupported reporters:\n{ReporterBase.reporter_documentation()}\n')
             self._exit(1)
 
-        cfg = self.urlwatcher.config_storage.config['report'].get(name, {'enabled': False})
-        if not cfg.get('enabled', False):
+        cfg: ConfigReportersList = self.urlwatcher.config_storage.config['report'][name]  # type: ignore[misc]
+        if not cfg['enabled']:
             print(f'Reporter is not enabled/configured: {name}')
             print(f'Use {__project_name__} --edit-config to configure reporters')
             self._exit(1)
@@ -427,38 +432,38 @@ def set_error(job_state: 'JobState', message: str) -> JobState:
         self._exit(0)
 
     def check_smtp_login(self) -> None:
-        config = self.urlwatcher.config_storage.config['report']['email']
-        smtp_config = config['smtp']
+        config: ConfigReportEmail = self.urlwatcher.config_storage.config['report']['email']
+        smtp_config: ConfigReportEmailSmtp = config['smtp']
 
         success = True
 
-        if not config.get('enabled'):
+        if not config['enabled']:
             print('Please enable e-mail reporting in the config first.')
             success = False
 
-        if config.get('method') != 'smtp':
+        if config['method'] != 'smtp':
             print('Please set the method to SMTP for the e-mail reporter.')
             success = False
 
-        smtp_auth = smtp_config.get('auth')
+        smtp_auth = smtp_config['auth']
         if not smtp_auth:
             print('Authentication must be enabled for SMTP.')
             success = False
 
-        smtp_hostname = smtp_config.get('host')
+        smtp_hostname = smtp_config['host']
         if not smtp_hostname:
             print('Please configure the SMTP hostname in the config first.')
             success = False
 
-        smtp_username = smtp_config.get('user') or config['from']
+        smtp_username = smtp_config['user'] or config['from']
         if not smtp_username:
             print('Please configure the SMTP user in the config first.')
             success = False
 
         if not success:
             self._exit(1)
 
-        insecure_password = smtp_config.get('insecure_password')
+        insecure_password = smtp_config['insecure_password']
         if insecure_password:
             print('The SMTP password is set in the config file (key "insecure_password")')
         elif smtp_have_password(smtp_hostname, smtp_username):
@@ -468,8 +473,8 @@ def check_smtp_login(self) -> None:
             else:
                 smtp_set_password(smtp_hostname, smtp_username)
 
-        smtp_port = smtp_config.get('port')
-        smtp_tls = smtp_config.get('starttls')
+        smtp_port = smtp_config['port']
+        smtp_tls = smtp_config['starttls']
 
         mailer = SMTPMailer(smtp_username, smtp_hostname, smtp_port, smtp_tls, smtp_auth, insecure_password)
         print('Trying to log into the SMTP server...')
@@ -479,20 +484,20 @@ def check_smtp_login(self) -> None:
         self._exit(0)
 
     def check_xmpp_login(self) -> None:
-        xmpp_config = self.urlwatcher.config_storage.config['report']['xmpp']
+        xmpp_config: ConfigReportXmpp = self.urlwatcher.config_storage.config['report']['xmpp']
 
         success = True
 
         if not xmpp_config['enabled']:
             print('Please enable XMPP reporting in the config first.')
             success = False
 
-        xmpp_sender = xmpp_config.get('sender')
+        xmpp_sender = xmpp_config['sender']
         if not xmpp_sender:
             print('Please configure the XMPP sender in the config first.')
             success = False
 
-        if not xmpp_config.get('recipient'):
+        if not xmpp_config['recipient']:
             print('Please configure the XMPP recipient in the config first.')
             success = False
 

webchanges/handler.py

@@ -13,7 +13,7 @@
 from datetime import datetime
 from pathlib import Path
 from types import TracebackType
-from typing import Any, ContextManager, Dict, Iterable, List, Optional, Type, TYPE_CHECKING, Union
+from typing import ContextManager, Iterable, List, Optional, Type, TYPE_CHECKING, Union
 
 from .filters import FilterBase
 from .jobs import NotModifiedError
@@ -22,13 +22,13 @@
 try:
     from zoneinfo import ZoneInfo
 except ImportError:
-    from backports import zoneinfo as ZoneInfo  # type: ignore[no-redef]
+    from backports.zoneinfo import ZoneInfo  # type: ignore[no-redef]
 
 # https://stackoverflow.com/questions/39740632
 if TYPE_CHECKING:
     from .jobs import JobBase
     from .main import Urlwatch
-    from .storage import CacheStorage
+    from .storage import CacheStorage, Config
 
 logger = logging.getLogger(__name__)
 
@@ -196,7 +196,7 @@ def _generate_diff(self, tz: Optional[str] = None) -> str:
         if tz:
             tz_info = ZoneInfo(tz)
         else:
-            tz_info = None
+            tz_info = None  # type: ignore[assignment]
         timestamp_old = (
             datetime.fromtimestamp(self.old_timestamp).astimezone(tz=tz_info).strftime('%a, %d %b %Y %H:%M:%S %z')
         )
@@ -295,7 +295,7 @@ def __init__(self, urlwatch_config: Urlwatch) -> None:
         """
         self.start = time.perf_counter()
 
-        self.config: Dict[str, Any] = urlwatch_config.config_storage.config
+        self.config: Config = urlwatch_config.config_storage.config
         self.job_states: List[JobState] = []
 
     def _result(self, verb: str, job_state: JobState) -> None:
@@ -358,7 +358,7 @@ def get_filtered_job_states(self, job_states: List[JobState]) -> Iterable[JobSta
         for job_state in job_states:
             if (
                 not any(
-                    job_state.verb == verb and not self.config['display'][verb]
+                    job_state.verb == verb and not self.config['display'][verb]  # type: ignore[misc]
                     for verb in ('unchanged', 'new', 'error')
                 )
                 and job_state.verb != 'changed,no_report'

webchanges/jobs.py

@@ -32,6 +32,7 @@
 # https://stackoverflow.com/questions/39740632
 if TYPE_CHECKING:
     from .handler import JobState
+    from .storage import Config
 
 # required to suppress warnings with 'ssl_no_verify: true'
 requests.packages.urllib3.disable_warnings(InsecureRequestWarning)  # type: ignore[no-untyped-call]
@@ -353,7 +354,7 @@ def _set_defaults(self, defaults: Optional[Dict[str, Any]]) -> None:
                             if hasattr(self, key) and subkey not in getattr(self, key):
                                 getattr(self, key)[subkey] = subvalue
 
-    def with_defaults(self, config: Dict[str, Dict[str, Any]]) -> 'JobBase':
+    def with_defaults(self, config: Config) -> 'JobBase':
         """Obtain a Job object that also contains defaults from the configuration.
 
         :param config: The configuration as a dict.
@@ -362,7 +363,7 @@ def with_defaults(self, config: Dict[str, Dict[str, Any]]) -> 'JobBase':
         job_with_defaults = copy.deepcopy(self)
         cfg = config.get('job_defaults')
         if isinstance(cfg, dict):
-            job_with_defaults._set_defaults(cfg.get(self.__kind__))
+            job_with_defaults._set_defaults(cfg.get(self.__kind__))  # type: ignore[arg-type]
             job_with_defaults._set_defaults(cfg.get('all'))
         return job_with_defaults
 

webchanges/mailer.py

@@ -6,6 +6,7 @@
 import subprocess
 from email import policy
 from email.message import EmailMessage
+from pathlib import Path
 from typing import Optional, Union
 
 try:
@@ -109,7 +110,7 @@ def send(self, msg: Optional[EmailMessage]) -> None:
 class SendmailMailer(Mailer):
     """The Mailer class to use sendmail executable."""
 
-    def __init__(self, sendmail_path: str) -> None:
+    def __init__(self, sendmail_path: Union[str, Path]) -> None:
         self.sendmail_path = sendmail_path
 
     def send(self, msg: Union[EmailMessage]) -> None: