Make typing optional (theskumar#179)

techalchemy · bbc2 · commit d93324ae9e4e · 2019-12-21T16:00:12.000+01:00
- Fall back to `collections.namedtuple` for `Binding` when typing is not present - Add import guards to all imports - Fixes theskumar#178 - Add missing coverage config to setup.cfg
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,4 @@
-include LICENSE *.md *.yml
+include LICENSE *.md *.yml *.toml
 
 include tox.ini
 recursive-include tests *.py
diff --git a/setup.cfg b/setup.cfg
@@ -33,3 +33,6 @@ source =
 
 [coverage:report]
 show_missing = True
+exclude_lines =
+    if IS_TYPE_CHECKING:
+    pragma: no cover
diff --git a/src/dotenv/__init__.py b/src/dotenv/__init__.py
@@ -1,6 +1,9 @@
-from typing import Any, Optional  # noqa
+from .compat import IS_TYPE_CHECKING
 from .main import load_dotenv, get_key, set_key, unset_key, find_dotenv, dotenv_values
 
+if IS_TYPE_CHECKING:
+    from typing import Any, Optional
+
 
 def load_ipython_extension(ipython):
     # type: (Any) -> None
diff --git a/src/dotenv/cli.py b/src/dotenv/cli.py
@@ -1,7 +1,6 @@
 import os
 import sys
 from subprocess import Popen
-from typing import Any, Dict, List  # noqa
 
 try:
     import click
@@ -10,9 +9,13 @@
                      'Run pip install "python-dotenv[cli]" to fix this.')
     sys.exit(1)
 
+from .compat import IS_TYPE_CHECKING
 from .main import dotenv_values, get_key, set_key, unset_key
 from .version import __version__
 
+if IS_TYPE_CHECKING:
+    from typing import Any, List, Dict
+
 
 @click.group()
 @click.option('-f', '--file', default=os.path.join(os.getcwd(), '.env'),
diff --git a/src/dotenv/compat.py b/src/dotenv/compat.py
@@ -1,5 +1,4 @@
 import sys
-from typing import Text  # noqa
 
 PY2 = sys.version_info[0] == 2  # type: bool
 
@@ -9,6 +8,22 @@
     from io import StringIO  # noqa
 
 
+def is_type_checking():
+    # type: () -> bool
+    try:
+        from typing import TYPE_CHECKING
+    except ImportError:  # pragma: no cover
+        return False
+    return TYPE_CHECKING
+
+
+IS_TYPE_CHECKING = is_type_checking()
+
+
+if IS_TYPE_CHECKING:
+    from typing import Text
+
+
 def to_env(text):
     # type: (Text) -> str
     """
diff --git a/src/dotenv/main.py b/src/dotenv/main.py
@@ -7,16 +7,17 @@
 import shutil
 import sys
 import tempfile
-from typing import (Dict, Iterator, List, Match, Optional,  # noqa
-                    Pattern, Union, TYPE_CHECKING, Text, IO, Tuple)
 import warnings
 from collections import OrderedDict
 from contextlib import contextmanager
 
-from .compat import StringIO, PY2, to_env
+from .compat import StringIO, PY2, to_env, IS_TYPE_CHECKING
 from .parser import parse_stream
 
-if TYPE_CHECKING:  # pragma: no cover
+if IS_TYPE_CHECKING:
+    from typing import (
+        Dict, Iterator, Match, Optional, Pattern, Union, Text, IO, Tuple
+    )
     if sys.version_info >= (3, 6):
         _PathLike = os.PathLike
     else:
@@ -278,7 +279,8 @@ def load_dotenv(dotenv_path=None, stream=None, verbose=False, override=False, **
     - *dotenv_path*: absolute or relative path to .env file.
     - *stream*: `StringIO` object with .env content.
     - *verbose*: whether to output the warnings related to missing .env file etc. Defaults to `False`.
-    - *override*: where to override the system environment variables with the variables in `.env` file. Defaults to `False`.
+    - *override*: where to override the system environment variables with the variables in `.env` file.
+                  Defaults to `False`.
     """
     f = dotenv_path or stream or find_dotenv()
     return DotEnv(f, verbose=verbose, **kwargs).set_as_environment_variables(override=override)
diff --git a/src/dotenv/parser.py b/src/dotenv/parser.py
@@ -1,9 +1,14 @@
 import codecs
 import re
-from typing import (IO, Iterator, Match, NamedTuple, Optional, Pattern,  # noqa
-                    Sequence, Text)
 
-from .compat import to_text
+from .compat import to_text, IS_TYPE_CHECKING
+
+
+if IS_TYPE_CHECKING:
+    from typing import (  # noqa:F401
+        IO, Iterator, Match, NamedTuple, Optional, Pattern, Sequence, Text,
+        Tuple
+    )
 
 
 def make_regex(string, extra_flags=0):
@@ -25,9 +30,20 @@ def make_regex(string, extra_flags=0):
 _double_quote_escapes = make_regex(r"\\[\\'\"abfnrtv]")
 _single_quote_escapes = make_regex(r"\\[\\']")
 
-Binding = NamedTuple("Binding", [("key", Optional[Text]),
-                                 ("value", Optional[Text]),
-                                 ("original", Text)])
+
+try:
+    # this is necessary because we only import these from typing
+    # when we are type checking, and the linter is upset if we
+    # re-import
+    import typing
+    Binding = typing.NamedTuple("Binding", [("key", typing.Optional[typing.Text]),
+                                            ("value", typing.Optional[typing.Text]),
+                                            ("original", typing.Text)])
+except ImportError:  # pragma: no cover
+    from collections import namedtuple
+    Binding = namedtuple("Binding", ["key",  # type: ignore
+                                     "value",
+                                     "original"])  # type: Tuple[Optional[Text], Optional[Text], Text]
 
 
 class Error(Exception):

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-include LICENSE .md .yml`
	`1`	`+include LICENSE .md .yml *.toml`
`2`	`2`
`3`	`3`	`include tox.ini`
`4`	`4`	`recursive-include tests *.py`