more test coverage

Author: caronc

apprise/plugins/aprs.py

@@ -286,7 +286,7 @@ def __init__(self, targets=None, locale=None, delay=None, **kwargs):
             except (TypeError, ValueError):
                 msg = f"Unsupported APRS-IS delay ({delay}) specified. "
                 self.logger.warning(msg)
-                raise TypeError(msg)
+                raise TypeError(msg) from None
 
         # Bump up our request_rate
         self.request_rate_per_sec += self.delay

apprise/plugins/base.py

@@ -712,7 +712,7 @@ def _apply_overflow(
 
                 # Detect padding and prepare template
                 digits = len(str(count))
-                template = " [{:0%d}/{:0%d}]" % (digits, digits)
+                template = f" [{{:0{digits}d}}/{{:0{digits}d}}]"
 
                 # Update our counter
                 overflow_display_count_width = 4 + (digits * 2)

apprise/plugins/burstsms.py

@@ -226,7 +226,7 @@ def __init__(
                     " invalid."
                 )
                 self.logger.warning(msg)
-                raise TypeError(msg)
+                raise TypeError(msg) from None
 
         # Prepare Batch Mode Flag
         self.batch = (
@@ -343,15 +343,17 @@ def send(self, body, title="", notify_type=NotifyType.INFO, **kwargs):
 
                 else:
                     self.logger.info(
-                        "Sent Burst SMS notification to %d target(s)."
-                        % len(self.targets[index : index + batch_size])
+                        "Sent Burst SMS notification to "
+                        f"{len(self.targets[index : index + batch_size])} "
+                        "target(s)."
                     )
 
             except requests.RequestException as e:
                 self.logger.warning(
-                    "A Connection error occurred sending Burst SMS "
-                    "notification to %d target(s)."
-                    % len(self.targets[index : index + batch_size])
+                    f"A Connection error occurred sending Burst SMS "
+                    "notification to "
+                    f"{len(self.targets[index : index + batch_size])} "
+                    "target(s)."
                 )
                 self.logger.debug(f"Socket Exception: {e!s}")
 

apprise/plugins/custom_form.py

@@ -318,7 +318,9 @@ def send(
                                 if attachment.name
                                 else f"file{no:03}.dat"
                             ),
-                            open(attachment.path, "rb"),
+                            # file handle is safely closed in `finally`; inline
+                            # open is intentional
+                            open(attachment.path, "rb"),  # noqa: SIM115
                             attachment.mimetype,
                         ),
                     ))
@@ -365,7 +367,7 @@ def send(
 
         url = f"{schema}://{self.host}"
         if isinstance(self.port, int):
-            url += ":%d" % self.port
+            url += f":{self.port}"
 
         url += self.fullpath
 

apprise/plugins/custom_json.py

@@ -281,7 +281,7 @@ def send(
 
         url = f"{schema}://{self.host}"
         if isinstance(self.port, int):
-            url += ":%d" % self.port
+            url += f":{self.port}"
 
         url += self.fullpath
 

apprise/plugins/custom_xml.py

@@ -372,7 +372,7 @@ def send(
 
         url = f"{schema}://{self.host}"
         if isinstance(self.port, int):
-            url += ":%d" % self.port
+            url += f":{self.port}"
 
         url += self.fullpath
         payload = re_table.sub(lambda x: re_map[x.group()], self.payload)

apprise/plugins/dbus.py

@@ -208,9 +208,9 @@ class NotifyDBus(NotifyBase):
                 "default": DBusUrgency.NORMAL,
             },
             "priority": {
-                # Apprise uses 'priority' everywhere; it's just a nice consistent
-                # feel to be able to use it here as well. Just map the
-                # value back to 'priority'
+                # Apprise uses 'priority' everywhere; it's just a nice
+                # consistent feel to be able to use it here as well. Just map
+                # the value back to 'priority'
                 "alias_of": "urgency",
             },
             "x": {
@@ -284,7 +284,7 @@ def __init__(
                     " invalid."
                 )
                 self.logger.warning(msg)
-                raise TypeError(msg)
+                raise TypeError(msg) from None
         else:
             self.x_axis = None
             self.y_axis = None

apprise/plugins/discord.py

@@ -162,8 +162,8 @@ class NotifyDiscord(NotifyBase):
             "url": {
                 "alias_of": "href",
             },
-            # Send a message to the specified thread within a webhook's channel.
-            # The thread will automatically be unarchived.
+            # Send a message to the specified thread within a webhook's
+            # channel. The thread will automatically be unarchived.
             "thread": {
                 "name": _("Thread ID"),
                 "type": "string",
@@ -352,7 +352,7 @@ def send(
                         ]
 
                         # Remove entry from head of fields
-                        fields = fields[self.discord_max_fields :]
+                        fields = fields[self.discord_max_fields:]
 
             else:
                 # not markdown
@@ -495,7 +495,13 @@ def _send(self, payload, attach=None, params=None, rate_limit=1, **kwargs):
 
             # Open our attachment path if required:
             if attach:
-                files = {"file": (attach.name, open(attach.path, "rb"))}
+                files = {
+                    "file": (
+                        attach.name,
+                        # file handle is safely closed in `finally`; inline
+                        # open is intentional
+                        open(attach.path, "rb"),  # noqa: SIM115
+                    )}
 
             else:
                 headers["Content-Type"] = "application/json; charset=utf-8"

apprise/plugins/email/__init__.py

@@ -41,18 +41,14 @@
 charset.add_charset("utf-8", charset.QP, charset.QP, "utf-8")
 
 __all__ = [
-    # Reference
-    "NotifyEmail",
-    # Pretty Good Privacy
+    "EMAIL_TEMPLATES",
+    "PGP_SUPPORT",
+    "SECURE_MODES",
+    "AppriseEmailException",
     "ApprisePGPController",
     "ApprisePGPException",
-    # Other
-    "AppriseEmailException",
     "EmailMessage",
+    "NotifyEmail",
     "SecureMailMode",
-    "SECURE_MODES",
     "WebBaseLogin",
-    # Additional entries that may be useful to some developers
-    "EMAIL_TEMPLATES",
-    "PGP_SUPPORT",
 ]

apprise/plugins/email/base.py

@@ -34,6 +34,7 @@
 from email.utils import formataddr, make_msgid
 import re
 import smtplib
+from typing import Optional
 
 from ...common import NotifyFormat, NotifyType
 from ...conversion import convert_between
@@ -229,7 +230,7 @@ def __init__(
         super().__init__(**kwargs)
 
         # Acquire Email 'To'
-        self.targets = list()
+        self.targets = []
 
         # Acquire Carbon Copies
         self.cc = set()
@@ -457,14 +458,13 @@ def apply_email_defaults(self, secure_mode=None, port=None, **kwargs):
 
         for i in range(len(templates.EMAIL_TEMPLATES)):  # pragma: no branch
             self.logger.trace(
-                "Scanning %s against %s"
-                % (from_addr, templates.EMAIL_TEMPLATES[i][0])
-            )
+                f"Scanning {from_addr} "
+                f"against {templates.EMAIL_TEMPLATES[i][0]}")
             match = templates.EMAIL_TEMPLATES[i][1].match(from_addr)
             if match:
                 self.logger.info(
-                    "Applying %s Defaults" % templates.EMAIL_TEMPLATES[i][0],
-                )
+                    f"Applying {templates.EMAIL_TEMPLATES[i][0]} Defaults")
+
                 # the secure flag can not be altered if defined in the template
                 self.secure = templates.EMAIL_TEMPLATES[i][2].get(
                     "secure", self.secure
@@ -692,7 +692,7 @@ def url(self, privacy=False, *args, **kwargs):
             # Handle our Carbon Copy Addresses
             params["cc"] = ",".join([
                 formataddr(
-                    (self.names[e] if e in self.names else False, e),
+                    (self.names.get(e, False), e),
                     # Swap comma for it's escaped url code (if detected) since
                     # we're using that as a delimiter
                     charset="utf-8",
@@ -704,7 +704,7 @@ def url(self, privacy=False, *args, **kwargs):
             # Handle our Blind Carbon Copy Addresses
             params["bcc"] = ",".join([
                 formataddr(
-                    (self.names[e] if e in self.names else False, e),
+                    (self.names.get(e, False), e),
                     # Swap comma for it's escaped url code (if detected) since
                     # we're using that as a delimiter
                     charset="utf-8",
@@ -716,8 +716,8 @@ def url(self, privacy=False, *args, **kwargs):
             # Handle our Reply-To Addresses
             params["reply"] = ",".join([
                 formataddr(
-                    (self.names[e] if e in self.names else False, e),
-                    # Swap comma for it's escaped url code (if detected) since
+                    (self.names.get(e, False), e),
+                    # Swap comma for its escaped url code (if detected) since
                     # we're using that as a delimiter
                     charset="utf-8",
                 ).replace(",", "%2C")
@@ -927,16 +927,16 @@ def prepare_emails(
         body,
         from_addr,
         to,
-        cc=set(),
-        bcc=set(),
-        reply_to=set(),
+        cc: Optional[set] = None,
+        bcc: Optional[set] = None,
+        reply_to: Optional[set] = None,
         # Providing an SMTP Host helps improve Email Message-ID
         # and avoids getting flagged as spam
         smtp_host=None,
         # Can be either 'html' or 'text'
         notify_format=NotifyFormat.HTML,
         attach=None,
-        headers=dict(),
+        headers: Optional[dict] = None,
         # Names can be a dictionary
         names=None,
         # Pretty Good Privacy Support; Pass in an
@@ -970,17 +970,28 @@ def prepare_emails(
 
                    Pass in an ApprisePGPController() if you wish to use this
         """
-
         if not to:
             # There is no one to email; we're done
             msg = "There are no Email recipients to notify"
             logger.warning(msg)
-            raise AppriseEmailException(msg)
+            raise AppriseEmailException(msg) from None
 
         elif pgp and not _pgp.PGP_SUPPORT:
             msg = "PGP Support unavailable; install PGPy library"
             logger.warning(msg)
-            raise AppriseEmailException(msg)
+            raise AppriseEmailException(msg) from None
+
+        if headers is None:
+            headers = {}
+
+        if cc is None:
+            cc = set()
+
+        if bcc is None:
+            bcc = set()
+
+        if reply_to is None:
+            reply_to = set()
 
         if not names:
             # Prepare a empty dictionary to prevent errors/warnings
@@ -999,13 +1010,13 @@ def prepare_emails(
             to_name, to_addr = emails.pop(0)
 
             # Strip target out of cc list if in To or Bcc
-            _cc = cc - bcc - set([to_addr])
+            _cc = cc - bcc - {to_addr}
 
             # Strip target out of bcc list if in To
-            _bcc = bcc - set([to_addr])
+            _bcc = bcc - {to_addr}
 
             # Strip target out of reply_to list if in To
-            _reply_to = reply_to - set([to_addr])
+            _reply_to = reply_to - {to_addr}
 
             # Format our cc addresses to support the Name field
             _cc = [
@@ -1124,8 +1135,8 @@ def prepare_emails(
                 # Store Autocrypt header (DeltaChat Support)
                 base.add_header(
                     "Autocrypt",
-                    "addr=%s; prefer-encrypt=mutual"
-                    % formataddr((False, to_addr), charset="utf-8"),
+                    f"addr={formataddr((False, to_addr), charset='utf-8')}; "
+                    "prefer-encrypt=mutual"
                 )
 
                 # Set Encryption Info Part
@@ -1159,6 +1170,6 @@ def prepare_emails(
 
             yield EmailMessage(
                 recipient=to_addr,
-                to_addrs=[to_addr] + list(_cc) + list(_bcc),
+                to_addrs=[to_addr, *list(_cc), *list(_bcc)],
                 body=base.as_string(),
             )