Add type hints (#546)

Author: bmwant

environ/environ.py

@@ -19,6 +19,7 @@
 import re
 import sys
 import warnings
+from typing import Union, TypeVar, List, Tuple, Dict
 from urllib.parse import (
     parse_qs,
     ParseResult,
@@ -217,7 +218,7 @@ def __call__(self, var, cast=None, default=NOTSET, parse_default=False):
     def __contains__(self, var):
         return var in self.ENVIRON
 
-    def str(self, var, default=NOTSET, multiline=False):
+    def str(self, var, default: Union[str, NoValue] = NOTSET, multiline=False) -> str:
         """
         :rtype: str
         """
@@ -226,7 +227,7 @@ def str(self, var, default=NOTSET, multiline=False):
             return re.sub(r'(\\r)?\\n', r'\n', value)
         return value
 
-    def bytes(self, var, default=NOTSET, encoding='utf8'):
+    def bytes(self, var, default: Union[bytes, NoValue] = NOTSET, encoding='utf8') -> bytes:
         """
         :rtype: bytes
         """
@@ -235,19 +236,19 @@ def bytes(self, var, default=NOTSET, encoding='utf8'):
             return value.encode(encoding)
         return value
 
-    def bool(self, var, default=NOTSET):
+    def bool(self, var, default: Union[bool, NoValue] = NOTSET) -> bool:
         """
         :rtype: bool
         """
         return self.get_value(var, cast=bool, default=default)
 
-    def int(self, var, default=NOTSET):
+    def int(self, var, default: Union[int, NoValue] = NOTSET) -> int:
         """
         :rtype: int
         """
         return self.get_value(var, cast=int, default=default)
 
-    def float(self, var, default=NOTSET):
+    def float(self, var, default: Union[float, NoValue] = NOTSET) -> float:
         """
         :rtype: float
         """
@@ -259,7 +260,7 @@ def json(self, var, default=NOTSET):
         """
         return self.get_value(var, cast=json.loads, default=default)
 
-    def list(self, var, cast=None, default=NOTSET):
+    def list(self, var, cast=None, default=NOTSET) -> List:
         """
         :rtype: list
         """
@@ -269,7 +270,7 @@ def list(self, var, cast=None, default=NOTSET):
             default=default
         )
 
-    def tuple(self, var, cast=None, default=NOTSET):
+    def tuple(self, var, cast=None, default=NOTSET) -> Tuple:
         """
         :rtype: tuple
         """
@@ -279,13 +280,13 @@ def tuple(self, var, cast=None, default=NOTSET):
             default=default
         )
 
-    def dict(self, var, cast=dict, default=NOTSET):
+    def dict(self, var, cast=dict, default=NOTSET) -> Dict:
         """
         :rtype: dict
         """
         return self.get_value(var, cast=cast, default=default)
 
-    def url(self, var, default=NOTSET):
+    def url(self, var, default=NOTSET) -> ParseResult:
         """
         :rtype: urllib.parse.ParseResult
         """
@@ -296,7 +297,7 @@ def url(self, var, default=NOTSET):
             parse_default=True
         )
 
-    def db_url(self, var=DEFAULT_DATABASE_ENV, default=NOTSET, engine=None):
+    def db_url(self, var=DEFAULT_DATABASE_ENV, default=NOTSET, engine=None) -> Dict:
         """Returns a config dictionary, defaulting to DATABASE_URL.
 
         The db method is an alias for db_url.
@@ -310,7 +311,7 @@ def db_url(self, var=DEFAULT_DATABASE_ENV, default=NOTSET, engine=None):
 
     db = db_url
 
-    def cache_url(self, var=DEFAULT_CACHE_ENV, default=NOTSET, backend=None):
+    def cache_url(self, var=DEFAULT_CACHE_ENV, default=NOTSET, backend=None) -> Dict:
         """Returns a config dictionary, defaulting to CACHE_URL.
 
         The cache method is an alias for cache_url.
@@ -324,7 +325,7 @@ def cache_url(self, var=DEFAULT_CACHE_ENV, default=NOTSET, backend=None):
 
     cache = cache_url
 
-    def email_url(self, var=DEFAULT_EMAIL_ENV, default=NOTSET, backend=None):
+    def email_url(self, var=DEFAULT_EMAIL_ENV, default=NOTSET, backend=None) -> Dict:
         """Returns a config dictionary, defaulting to EMAIL_URL.
 
         The email method is an alias for email_url.
@@ -338,7 +339,7 @@ def email_url(self, var=DEFAULT_EMAIL_ENV, default=NOTSET, backend=None):
 
     email = email_url
 
-    def search_url(self, var=DEFAULT_SEARCH_ENV, default=NOTSET, engine=None):
+    def search_url(self, var=DEFAULT_SEARCH_ENV, default: Union[Dict, NoValue] = NOTSET, engine=None) -> Dict:
         """Returns a config dictionary, defaulting to SEARCH_URL.
 
         :rtype: dict
@@ -348,8 +349,8 @@ def search_url(self, var=DEFAULT_SEARCH_ENV, default=NOTSET, engine=None):
             engine=engine
         )
 
-    def channels_url(self, var=DEFAULT_CHANNELS_ENV, default=NOTSET,
-                     backend=None):
+    def channels_url(self, var=DEFAULT_CHANNELS_ENV, default: Union[Dict, NoValue] = NOTSET,
+                     backend=None) -> Dict:
         """Returns a config dictionary, defaulting to CHANNELS_URL.
 
         :rtype: dict
@@ -361,7 +362,7 @@ def channels_url(self, var=DEFAULT_CHANNELS_ENV, default=NOTSET,
 
     channels = channels_url
 
-    def path(self, var, default=NOTSET, **kwargs):
+    def path(self, var, default: Union['Path', NoValue] = NOTSET, **kwargs) -> 'Path':
         """
         :rtype: Path
         """