FIX for "No module named 'public'" during installation (#242)

* Move __version__ to __init__.py

This should solve issue #241, in which setuptools < 46.4.0 tries to
naively import smtp.py (due to version being specified as "attr:
aiosmtpd.smtp.__version__" and barfs when encountering "from public
import public"

Moving __version__ to __init__.py seems to be the wisest -- and most
semantically accurate -- decision. Not only can setuptools < 46.4.0
simply do a naive import of __init__.py (which contains no deps), but
this signifies the version number applies to the _whole_ aiosmtpd
package instead of just the smtp.py module.

This impacts the following files
  * setup.cfg -- scan inside aiosmtpd instead of aiosmtpd.smtp
  * smtp.py -- it now needs to import
  * conf.py -- no longer scan smtp.py; import from __init__ instead

* Add Compatibility Test

In this case, ensure __version__ from __init__.py is exact same object
as __version__ from smtp.py

* Update NEWS.rst

Author: manfred-kaiser

aiosmtpd/__init__.py

@@ -0,0 +1,4 @@
+# Copyright 2014-2021 The aiosmtpd Developers
+# SPDX-License-Identifier: Apache-2.0
+
+__version__ = "1.3.0a4"

aiosmtpd/docs/NEWS.rst

@@ -19,6 +19,11 @@ Fixed/Improved
 * ``authenticator`` system improves on ``auth_callback`` by enabling the called function
   to see the SMTP Session and other info.
   (``auth_callback`` will be deprecated in 2.0)
+* ``__version__`` is now an attribute in ``__init__.py``,
+  and can be imported from the 'plain' ``aiosmtpd`` module.
+  (It gets reimported to ``aiosmtpd.smtp``,
+  so programs relying on ``aiosmtpd.smtp.__version__`` should still work.)
+  (Closes #241)
 
 
 1.2.4 (2021-01-24)

aiosmtpd/docs/conf.py

@@ -12,17 +12,16 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
-import re
 import datetime
-
+import re
+import sys
 from pathlib import Path
 
+from aiosmtpd import __version__
+
 try:
     # noinspection PyPackageRequirements
-    from colorama import (  # pytype: disable=import-error
-        init as colorama_init,
-    )
+    from colorama import init as colorama_init  # pytype: disable=import-error
 
     colorama_init()
 except ImportError:
@@ -77,15 +76,6 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-__version__ = None
-with open("../smtp.py") as fp:
-    for line in fp:
-        m = RE__VERSION.match(line.strip())
-        if m:
-            __version__ = m.group("ver")
-            break
-if __version__ is None:
-    raise RuntimeError("No __version__ found in aiosmtpd/smtp.py!")
 release = __version__
 version = __version__
 

aiosmtpd/smtp.py

@@ -13,6 +13,7 @@
 import collections
 import asyncio.sslproto as sslproto
 
+from aiosmtpd import __version__
 from base64 import b64decode, b64encode
 from email._header_value_parser import get_addr_spec, get_angle_addr
 from email.errors import HeaderParseError
@@ -66,8 +67,8 @@ class _DataState(enum.Enum):
     "AuthCallbackType",
     "AuthMechanismType",
     "MISSING",
+    "__version__",
 ]  # Will be added to by @public
-__version__ = '1.3.0a3'
 __ident__ = 'Python SMTP {}'.format(__version__)
 log = logging.getLogger('mail.log')
 

aiosmtpd/tests/test_server.py

@@ -8,9 +8,10 @@
 import socket
 import unittest
 
+from aiosmtpd import __version__ as init_version
 from aiosmtpd.controller import asyncio, Controller, _FakeServer
 from aiosmtpd.handlers import Sink
-from aiosmtpd.smtp import SMTP as Server
+from aiosmtpd.smtp import SMTP as Server, __version__ as smtp_version
 from contextlib import ExitStack
 from functools import wraps
 from smtplib import SMTP
@@ -203,3 +204,9 @@ def hijacker(*args, **kwargs):
             self.assertIsNone(cont._thread_exception)
             excm = str(cm.exception)
             self.assertEqual("Unknown Error, failed to init SMTP server", excm)
+
+
+class TestCompat(unittest.TestCase):
+
+    def test_version(self):
+        assert smtp_version is init_version

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = aiosmtpd
-version = attr: aiosmtpd.smtp.__version__
+version = attr: aiosmtpd.__version__
 description = aiosmtpd - asyncio based SMTP server
 long_description =
     This is a server for SMTP and related protocols, similar in utility to the