Providers private package (AnalogJ#1689)

* Prepare context manager

* Prepare tests

* Move providers in a private package

* Remove self.action state

* Fix tests

* Better types

* Update documentation

* Thread safety

* Implement cleanup(), fully document deprecation

* Fix issue

* Update lockfile

* Fix deprecation

* Document

* Define complete _private package

* Fix mocks

* Cleanup and prepare deprecation messages

src/lexicon/__init__.py

@@ -1,4 +1,26 @@
-"""
-lexicon - a DNS provider agnostic api to manipulate records.
-"""
-__author__ = "Jason Kulatunga"
+import sys
+import warnings
+from types import ModuleType
+
+from lexicon._private import cli as _cli
+from lexicon._private import discovery as _discovery
+from lexicon._private import parser as _parser
+
+
+class DeprecatedModule(ModuleType):
+    def __init__(self, module: ModuleType, name: str):
+        super().__init__(name)
+        self._module = module
+
+    def __getattr__(self, item):
+        warnings.warn(
+            f"Module {self.__name__} is deprecated and will be removed in Lexicon 4>=",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return getattr(self._module, item)
+
+
+sys.modules["lexicon.cli"] = DeprecatedModule(_cli, "lexicon.cli")
+sys.modules["lexicon.parser"] = DeprecatedModule(_parser, "lexicon.parser")
+sys.modules["lexicon.discovery"] = DeprecatedModule(_discovery, "lexicon.discovery")

src/lexicon/cli.py → src/lexicon/_private/cli.py

@@ -4,12 +4,12 @@
 import logging
 import os
 import sys
-from typing import Dict, List, Optional, Union
 import warnings
+from typing import Dict, List, Optional, Union
 
+from lexicon._private.parser import generate_cli_main_parser
 from lexicon.client import Client
 from lexicon.config import ConfigResolver
-from lexicon.parser import generate_cli_main_parser
 
 logger = logging.getLogger(__name__)
 

src/lexicon/discovery.py → src/lexicon/_private/discovery.py

@@ -3,24 +3,26 @@
 * what are the providers installed, and available
 * what is the version of Lexicon
 """
+import importlib
 import pkgutil
 import re
+from types import ModuleType
 from typing import Dict
 
 try:
     from importlib.metadata import Distribution, PackageNotFoundError
 except ModuleNotFoundError:
     from importlib_metadata import Distribution, PackageNotFoundError  # type: ignore[assignment]
 
-from lexicon import providers
+from lexicon._private import providers as _providers
 
 
 def find_providers() -> Dict[str, bool]:
     """Find all providers registered in Lexicon, and their availability"""
     providers_list = sorted(
         {
             modname
-            for (_, modname, _) in pkgutil.iter_modules(providers.__path__)  # type: ignore
+            for (_, modname, _) in pkgutil.iter_modules(_providers.__path__)  # type: ignore
             if modname != "base"
         }
     )
@@ -36,6 +38,10 @@ def find_providers() -> Dict[str, bool]:
         }
 
 
+def load_provider_module(provider_name: str) -> ModuleType:
+    return importlib.import_module(f"{_providers.__name__}.{provider_name}")
+
+
 def lexicon_version() -> str:
     """Retrieve current Lexicon version"""
     try:

src/lexicon/parser.py → src/lexicon/_private/parser.py

@@ -1,11 +1,14 @@
 """Parsers definition for the Lexicon command-line interface"""
 import argparse
-import importlib
 import os
 from typing import Type
 
-from lexicon import discovery
-from lexicon.providers.base import Provider
+from lexicon._private.discovery import (
+    find_providers,
+    lexicon_version,
+    load_provider_module,
+)
+from lexicon.interfaces import Provider
 
 
 def generate_base_provider_parser() -> argparse.ArgumentParser:
@@ -63,7 +66,7 @@ def generate_cli_main_parser() -> argparse.ArgumentParser:
         "--version",
         help="show the current version of lexicon",
         action="version",
-        version=f"%(prog)s {discovery.lexicon_version()}",
+        version=f"%(prog)s {lexicon_version()}",
     )
     parser.add_argument("--delegated", help="specify the delegated domain")
     parser.add_argument(
@@ -78,8 +81,8 @@ def generate_cli_main_parser() -> argparse.ArgumentParser:
     )
     subparsers.required = True
 
-    for provider, available in discovery.find_providers().items():
-        provider_module = importlib.import_module("lexicon.providers." + provider)
+    for provider, available in find_providers().items():
+        provider_module = load_provider_module(provider)
         provider_class: Type[Provider] = getattr(provider_module, "Provider")
 
         subparser = subparsers.add_parser(

src/lexicon/providers/aliyun.py → src/lexicon/_private/providers/aliyun.py

@@ -13,7 +13,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/aurora.py → src/lexicon/_private/providers/aurora.py

@@ -11,7 +11,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/auto.py → src/lexicon/_private/providers/auto.py

@@ -1,5 +1,4 @@
 """Module provider for auto"""
-import importlib
 import logging
 import pkgutil
 import re
@@ -10,8 +9,9 @@
 import tldextract  # type: ignore
 
 from lexicon import config as helper_config
-from lexicon import providers
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon._private import providers
+from lexicon._private.discovery import load_provider_module
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 
@@ -21,9 +21,7 @@ def _get_available_providers():
     for _, modname, _ in pkgutil.iter_modules(providers.__path__):
         if modname not in ("base", "auto"):
             try:
-                available_providers[modname] = importlib.import_module(
-                    "lexicon.providers." + modname
-                )
+                available_providers[modname] = load_provider_module(modname)
             except ImportError:
                 LOGGER.warning(
                     "Warning, the provider %s cannot be loaded due "

src/lexicon/providers/azure.py → src/lexicon/_private/providers/azure.py

@@ -19,7 +19,7 @@
 from cryptography.hazmat.primitives import hashes
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/cloudflare.py → src/lexicon/_private/providers/cloudflare.py

@@ -7,7 +7,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/cloudns.py → src/lexicon/_private/providers/cloudns.py

@@ -5,7 +5,7 @@
 
 import requests
 
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/cloudxns.py → src/lexicon/_private/providers/cloudxns.py

@@ -10,7 +10,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/conoha.py → src/lexicon/_private/providers/conoha.py

@@ -7,7 +7,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/constellix.py → src/lexicon/_private/providers/constellix.py

@@ -27,7 +27,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/ddns.py → src/lexicon/_private/providers/ddns.py

@@ -8,7 +8,7 @@
 from cryptography.hazmat.primitives import hashes
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 # dnspython is an optional dependency of lexicon; do not throw an ImportError if
 # the dependency is unmet.

src/lexicon/providers/digitalocean.py → src/lexicon/_private/providers/digitalocean.py

@@ -6,7 +6,7 @@
 
 import requests
 
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/dinahosting.py → src/lexicon/_private/providers/dinahosting.py

@@ -8,7 +8,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/directadmin.py → src/lexicon/_private/providers/directadmin.py

@@ -8,7 +8,7 @@
 from requests.auth import HTTPBasicAuth
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/dnsimple.py → src/lexicon/_private/providers/dnsimple.py

@@ -7,7 +7,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/dnsmadeeasy.py → src/lexicon/_private/providers/dnsmadeeasy.py

@@ -13,7 +13,7 @@
 from urllib3.util.retry import Retry  # type: ignore
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/dnspark.py → src/lexicon/_private/providers/dnspark.py

@@ -7,7 +7,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/dnspod.py → src/lexicon/_private/providers/dnspod.py

@@ -6,7 +6,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/dnsservices.py → src/lexicon/_private/providers/dnsservices.py

@@ -7,7 +7,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/dreamhost.py → src/lexicon/_private/providers/dreamhost.py

@@ -9,7 +9,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/duckdns.py → src/lexicon/_private/providers/duckdns.py

@@ -28,7 +28,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 try:
     import dns.name

src/lexicon/providers/dynu.py → src/lexicon/_private/providers/dynu.py

@@ -7,7 +7,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/easydns.py → src/lexicon/_private/providers/easydns.py

@@ -7,7 +7,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/easyname.py → src/lexicon/_private/providers/easyname.py

@@ -7,7 +7,7 @@
 from bs4 import BeautifulSoup, Tag  # type: ignore
 from requests import Response, Session
 
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/euserv.py → src/lexicon/_private/providers/euserv.py

@@ -13,7 +13,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/exoscale.py → src/lexicon/_private/providers/exoscale.py

@@ -5,7 +5,7 @@
 
 import requests
 
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/flexibleengine.py → src/lexicon/_private/providers/flexibleengine.py

@@ -7,7 +7,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)
 

src/lexicon/providers/gandi.py → src/lexicon/_private/providers/gandi.py

@@ -34,7 +34,7 @@
 import requests
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 try:
     import xmlrpclib  # type: ignore

src/lexicon/providers/gehirn.py → src/lexicon/_private/providers/gehirn.py

@@ -10,7 +10,7 @@
 from requests.auth import HTTPBasicAuth
 
 from lexicon.exceptions import AuthenticationError
-from lexicon.providers.base import Provider as BaseProvider
+from lexicon.interfaces import Provider as BaseProvider
 
 LOGGER = logging.getLogger(__name__)