keep current address parsing behaviour for Python3.12

Author: e3rd

.github/workflows/run-unittest.yml

@@ -5,7 +5,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", 3.11, 3.12, 3.13]
+        # python-version: ["3.10", 3.11, 3.12, 3.13]
+        # TODO
+        python-version: [3.11, 3.12]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
@@ -15,7 +17,8 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install M2Crypto
+          pip install M2Crypto  # TODO remove when tests are updated
+          pip install cryptography
           pip install -e .
       - name: Run tests
         run: python3 test_.py

README.md

@@ -1,6 +1,6 @@
 # Envelope
 
-[![Build Status](https://github.com/CZ-NIC/envelope/actions/workflows/run-unittest.yml/badge.svg)](https://github.com/CZ-NIC/envelope/actions) [![Downloads](https://pepy.tech/badge/envelope)](https://pepy.tech/project/envelope)
+[![Build Status](https://github.com/CZ-NIC/envelope/actions/workflows/run-unittest.yml/badge.svg)](https://github.com/CZ-NIC/envelope/actions) [![Downloads](https://static.pepy.tech/badge/envelope)](https://pepy.tech/project/envelope)
 
 Quick layer over [python-gnupg](https://bitbucket.org/vinay.sajip/python-gnupg/src), [M2Crypto](https://m2crypto.readthedocs.io/), [smtplib](https://docs.python.org/3/library/smtplib.html), [magic](https://pypi.org/project/python-magic/) and [email](https://docs.python.org/3/library/email.html?highlight=email#module-email) handling packages. Their common use cases merged into a single function. Want to sign a text and tired of forgetting how to do it right? You do not need to know everything about GPG or S/MIME, you do not have to bother with importing keys. Do not hassle with reconnecting to an SMTP server. Do not study various headers meanings to let your users unsubscribe via a URL.
 You insert a message, attachments and inline images and receive signed and/or encrypted output to the file or to your recipients' e-mail.
@@ -77,7 +77,7 @@ Envelope.load(path="message.eml").attachments()
     ```
     * Or just download the project and launch `python3 -m envelope`
 * If planning to sign/encrypt with GPG, assure you have it on the system with `sudo apt install gpg` and possibly see [Configure your GPG](#configure-your-gpg) tutorial.
-* If planning to use S/MIME, you should ensure some prerequisites: `sudo apt install swig build-essential python3-dev libssl-dev && pip3 install M2Crypto`
+* If planning to use S/MIME, you might be required to ensure some [prerequisites](https://cryptography.io/en/latest/installation/), ex: `sudo apt install build-essential libssl-dev libffi-dev python3-dev cargo pkg-config`
 * If planning to send e-mails, prepare SMTP credentials or visit [Configure your SMTP](#configure-your-smtp) tutorial.
 * If your e-mails are to be received outside your local domain, visit [DMARC](#dmarc) section.
 * Package [python-magic](https://pypi.org/project/python-magic/) is used as a dependency. Due to a [well-known](https://github.com/ahupp/python-magic/blob/master/COMPAT.md) name clash with the [file-magic](https://pypi.org/project/file-magic/) package, in case you need to use the latter, don't worry to run `pip uninstall python-magic && pip install file-magic` after installing envelope which is fully compatible with both projects. Both use `libmagic` under the hood which is probably already installed. However, if it is not, [install](https://github.com/ahupp/python-magic?tab=readme-ov-file#installation) `sudo apt install libmagic1`.

envelope/address.py

@@ -2,6 +2,7 @@
 import logging
 from os import environ
 import re
+import sys
 from .utils import assure_list
 
 environ['PY3VE_IGNORE_UPDATER'] = '1'
@@ -11,6 +12,23 @@
 logger = logging.getLogger(__name__)
 
 
+def _getaddresses(*args):
+    # NOTE Python finally changed the old way of parsing wrong addresses.
+    # We might start using strict=True (default) in the future.
+    if sys.version_info <= (3, 11):
+        return getaddresses(*args)
+    return getaddresses(*args, strict=False)
+
+
+def _parseaddr(*args):
+    # NOTE Python finally changed the old way of parsing wrong addresses.
+    # We might start using strict=True (default) in the future.
+    # README should reflect that.
+    if sys.version_info <= (3, 11):
+        return parseaddr(*args)
+    return parseaddr(*args, strict=False)
+
+
 class Address(str):
     """
         You can safely access the `self.name` property to access the real name and `self.address` to access the e-mail address.
@@ -37,7 +55,7 @@ class Address(str):
 
     def __new__(cls, displayed_email=None, name=None, address=None):
         if displayed_email:
-            v = parseaddr(cls.remedy(displayed_email))
+            v = _parseaddr(cls.remedy(displayed_email))
             name, address = v[0] or name, v[1] or address
         if name:
             displayed_email = f"{name} <{address}>"
@@ -143,7 +161,7 @@ def parse(cls, email_or_list, single=False, allow_false=False):
         if allow_false and email_or_list is False:
             return False
 
-        addrs = getaddresses(cls.remedy(x) for x in assure_list(email_or_list))
+        addrs = _getaddresses(cls.remedy(x) for x in assure_list(email_or_list))
         addresses = [Address(name=real_name, address=address)
                      for real_name, address in addrs if not (real_name == address == "")]
         if single:

envelope/envelope.py

@@ -8,25 +8,23 @@
 import sys
 from tempfile import NamedTemporaryFile
 from unittest import mock
-import warnings
-from base64 import b64decode, b64encode
+from base64 import b64decode
 from configparser import ConfigParser
 from copy import deepcopy
 from email import message_from_bytes
 from email.header import decode_header
 from email.generator import Generator
 from email.message import EmailMessage, Message
 from email.parser import BytesParser
-from email.utils import make_msgid, formatdate, getaddresses
-from getpass import getpass
+from email.utils import make_msgid, formatdate
 from itertools import chain
-from os import environ, urandom
+from os import environ
 from pathlib import Path
 from quopri import decodestring
 from types import GeneratorType
-from typing import Literal, Union, List, Set, Optional, Any
+from typing import Literal, Union, Optional, Any
 
-from .address import Address
+from .address import Address, _getaddresses
 from .attachment import Attachment
 from .constants import ISSUE_LINK, smime_import_error, gnupg, CRLF, AUTO, PLAIN, HTML, SIMULATION, SAFE_LOCALE
 from .message import _Message
@@ -35,7 +33,6 @@
 from .utils import AutoSubmittedHeader, Fetched, is_gpg_importable_key, assure_list, assure_fetched, get_mimetype
 
 
-
 __doc__ = """Quick layer over python-gnupg, M2Crypto, smtplib, magic and email handling packages.
 Their common use cases merged into a single function. Want to sign a text and tired of forgetting how to do it right?
 You do not need to know everything about GPG or S/MIME, you do not have to bother with importing keys.
@@ -320,14 +317,14 @@ def __init__(self, message=None, from_=None, to=None, subject=None, headers=None
         # that explicitly states we have no from header
         self._from: Union[Address, False, None] = None  # e-mail From header
         self._from_addr: Optional[Address] = None  # SMTP envelope MAIL FROM address
-        self._to: List[Address] = []
-        self._cc: List[Address] = []
-        self._bcc: List[Address] = []
-        self._reply_to: List[Address] = []
+        self._to: list[Address] = []
+        self._cc: list[Address] = []
+        self._bcc: list[Address] = []
+        self._reply_to: list[Address] = []
         self._subject: Union[str, None] = None
         self._subject_encrypted: Union[str, bool] = True
         self._smtp = None
-        self._attachments: List[Attachment] = []
+        self._attachments: list[Attachment] = []
         self._mime = AUTO
         self._nl2br = AUTO
         self._headers = EmailMessage()  # object for storing headers the most standard way possible
@@ -336,7 +333,7 @@ def __init__(self, message=None, from_=None, to=None, subject=None, headers=None
         # variables defined while processing
         self._status: bool = False  # whether we successfully encrypted/signed/send
         self._processed: bool = False  # prevent the user from mistakenly call .sign().send() instead of .signature().send()
-        self._result: List[Union[str, EmailMessage, Message]] = []  # text output for str() conversion
+        self._result: list[Union[str, EmailMessage, Message]] = []  # text output for str() conversion
         self._result_cache: Optional[str] = None
         self._result_cache_hash: Optional[int] = None
         self._smtp = SMTPHandler()
@@ -407,32 +404,32 @@ def _parse_addresses(registry, email_or_more):
         if addresses:
             registry += (a for a in Address.parse(addresses) if a not in registry)
 
-    def to(self, email_or_more=None) -> Union["Envelope", List[Address]]:
+    def to(self, email_or_more=None) -> Union["Envelope", list[Address]]:
         """ Multiple addresses may be given in a string, delimited by comma (or semicolon).
          (The same is valid for `to`, `cc`, `bcc` and `reply-to`.)
 
-            :param email_or_more: str|Tuple[str]|List[str]|Generator[str]|Set[str]|Frozenset[str]
+            :param email_or_more: str|Tuple[str]|list[str]|Generator[str]|Set[str]|Frozenset[str]
              Set e-mail address/es. If None, we are reading.
-            return: Envelope if `email_or_more` set or List[Address] if not set
+            return: Envelope if `email_or_more` set or list[Address] if not set
         """
         if email_or_more is None:
             return self._to
         self._parse_addresses(self._to, email_or_more)
         return self
 
-    def cc(self, email_or_more=None) -> Union["Envelope", List[Address]]:
+    def cc(self, email_or_more=None) -> Union["Envelope", list[Address]]:
         if email_or_more is None:
             return self._cc
         self._parse_addresses(self._cc, email_or_more)
         return self
 
-    def bcc(self, email_or_more=None) -> Union["Envelope", List[Address]]:
+    def bcc(self, email_or_more=None) -> Union["Envelope", list[Address]]:
         if email_or_more is None:
             return self._bcc
         self._parse_addresses(self._bcc, email_or_more)
         return self
 
-    def reply_to(self, email_or_more=None) -> Union["Envelope", List[Address]]:
+    def reply_to(self, email_or_more=None) -> Union["Envelope", list[Address]]:
         if email_or_more is None:
             return self._reply_to
         self._parse_addresses(self._reply_to, email_or_more)
@@ -586,7 +583,7 @@ def subject(self, subject=None, encrypted: Union[str, bool] = None) -> Union["En
             self._subject_encrypted = encrypted
         return self
 
-    def mime(self, subtype=AUTO, nl2br: Literal["auto"] | bool=AUTO):
+    def mime(self, subtype=AUTO, nl2br: Literal["auto"] | bool = AUTO):
         """
         Ignored if `Content-Type` header put to the message.
         @type subtype: str Set contents mime subtype: "auto" (default), "html" or "plain" for plain text.
@@ -1084,7 +1081,6 @@ def _gpg_import_or_fail(self, key):
         else:
             raise ValueError(f"Could not import key starting: {key[:80]}...")
 
-
     def _get_gnupg_home(self, for_help=False):
         s = self._gpg if type(self._gpg) is str else None
         if for_help:
@@ -1127,14 +1123,16 @@ def _send_now(self, email, encrypt, encrypted_subject, send):
             email["Message-ID"] = make_msgid()
 
         if send and send != SIMULATION:
+            recipients = list(map(str, set(self._to + self._cc + self._bcc)))
             with mock.patch.object(Generator, '_handle_multipart_signed', Generator._handle_multipart):
                 # https://github.com/python/cpython/issues/99533 and #19
                 failures = self._smtp.send_message(email,
                                                    from_addr=self._from_addr,
-                                                   to_addrs=list(map(str, set(self._to + self._cc + self._bcc))))
+                                                   to_addrs=recipients)
             if failures:
                 logger.warning(f"Unable to send to all recipients: {repr(failures)}.")
             elif failures is False:
+                # TODO add here and test, logger.warning(f"Sending {recipients}, Message-ID: {email["Message-ID"]}")
                 return False
         else:
             if send != SIMULATION:
@@ -1234,7 +1232,7 @@ def _encrypt_gpg_now(self, message, encrypt, sign_fingerprint):
             return False
 
     def _gpg_list_keys(self, secret=False):
-        return ((key, address) for key in self._gnupg.list_keys(secret) for _, address in getaddresses(key["uids"]))
+        return ((key, address) for key in self._gnupg.list_keys(secret) for _, address in _getaddresses(key["uids"]))
 
     def _gpg_verify(self, signature: bytes, data: bytes):
         """ Allows verifying detached GPG signature.
@@ -1248,7 +1246,7 @@ def _gpg_verify(self, signature: bytes, data: bytes):
             fp.seek(0)
             return bool(self._gnupg.verify_data(fp.name, data))
 
-    def _get_decipherers(self) -> Set[str]:
+    def _get_decipherers(self) -> set[str]:
         """
         :return: Set of e-mail addresses
         """
@@ -1297,7 +1295,6 @@ def smime_sign_only(self, email, sign):
 
         return signed_email
 
-    
     def smime_sign_encrypt(self, email, sign, encrypt):
         from cryptography.hazmat.primitives.serialization import load_pem_private_key, pkcs7
         from cryptography.x509 import load_pem_x509_certificate
@@ -1345,7 +1342,7 @@ def smime_sign_encrypt(self, email, sign, encrypt):
                 raise ValueError("failed to load certificate from file")
 
             recipient_certs.append(c)
-        
+
         try:
             pubkey = load_pem_x509_certificate(pubkey)
         except ValueError as e:
@@ -1358,7 +1355,6 @@ def smime_sign_encrypt(self, email, sign, encrypt):
         for recip in recipient_certs:
             envelope_builder = envelope_builder.add_recipient(recip)
 
-
         options = [pkcs7.PKCS7Options.Binary]
         encrypted_email = envelope_builder.encrypt(serialization.Encoding.SMIME, options)
         return encrypted_email
@@ -1369,7 +1365,6 @@ def smime_encrypt_only(self, email, encrypt):
         from cryptography.x509 import load_pem_x509_certificate
         from cryptography.hazmat.primitives import serialization
 
-
         if self._cert:
             certificates = [self._cert]
         else:
@@ -1394,16 +1389,15 @@ def smime_encrypt_only(self, email, encrypt):
 
         return encrypted_email
 
-
-    def _encrypt_smime_now(self, email, sign, encrypt: Union[None, bool, bytes, List[bytes]]):
+    def _encrypt_smime_now(self, email, sign, encrypt: Union[None, bool, bytes, list[bytes]]):
         """
 
         :type encrypt: Can be None, False, bytes or list[bytes]
         """
 
         # passphrase has to be bytes
         if (self._passphrase is not None):
-            self._passphrase = self._passphrase.encode('utf-8')    
+            self._passphrase = self._passphrase.encode('utf-8')
 
         if sign is not None and type(sign) != bool:
             sign = assure_fetched(sign, bytes)
@@ -1419,8 +1413,6 @@ def _encrypt_smime_now(self, email, sign, encrypt: Union[None, bool, bytes, List
 
         return output
 
-
-
     def _compose_gpg_signed(self, email, text, micalg=None):
         msg_payload = email
         email = EmailMessage()
@@ -1598,7 +1590,7 @@ def _prepare_email(self, plain: bytes, html: bytes, encrypt_gpg: bool, sign_gpg:
                 email["Subject"] = self._subject
         return email
 
-    def recipients(self, *, clear=False) -> Union[Set[Address], 'Envelope']:
+    def recipients(self, *, clear=False) -> Union[set[Address], 'Envelope']:
         """ Return set of all recipients – To, Cc, Bcc
             :param: clear If true, all To, Cc and Bcc recipients are removed and the object is returned.
 
@@ -1630,7 +1622,7 @@ def _report(self) -> Union[dict, None]:
         raise NotImplemented("Current multipart/report has not been impemented."
                              f"Please post current message as a new issue at {ISSUE_LINK}")
 
-    def attachments(self, name=None, inline=None) -> Union[Attachment, List[Attachment], bool]:
+    def attachments(self, name=None, inline=None) -> Union[Attachment, list[Attachment], bool]:
         """ Access the attachments.
             XX make available from CLI too
                 --attachments(-inline)(-enclosed) [name]

setup.py

@@ -32,8 +32,7 @@
     long_description_content_type="text/markdown",
     install_requires=install_requires,
     extras_require={
-        "smime": ["M2Crypto",  # need to have: `sudo apt install swig`
-                  "cryptography>=43"]
+        "smime": ["cryptography>=43"]
     },
     entry_points={
         'console_scripts': [