Rename subcast param of env.dict to subcast_values (#182)

Author: sloria

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 9.0.0 (unreleased)
 
+- _Backwards-incompatible_: Rename `subcast` param of `env.dict` to `subcast_values` for consistency with `subcast_keys`.
 - _Backwards-incompatible_: Remove variable proxying. Use variable expansion instead (see 8.1.0 release notes below)
   ([#175](https://github.com/sloria/environs/issues/175)).
 - _Backwards-incompatible_: Drop support for marshmallow 2 and Python 3.5,

README.md

@@ -94,7 +94,7 @@ The following are all type-casting methods of `Env`:
 - `env.float`
 - `env.decimal`
 - `env.list` (accepts optional `subcast` keyword argument)
-- `env.dict` (accepts optional `subcast` keyword argument)
+- `env.dict` (accepts optional `subcast_keys` and `subcast_values` keyword arguments)
 - `env.json`
 - `env.datetime`
 - `env.date`

environs/__init__.py

@@ -156,17 +156,17 @@ def _preprocess_list(value: typing.Union[str, typing.Iterable], **kwargs) -> typ
 
 def _preprocess_dict(
     value: typing.Union[str, typing.Mapping],
-    # TODO: Rename subcast to subcast_values and re-order arguments for next major release
-    subcast: Subcast,
+    *,
     subcast_key: typing.Optional[Subcast] = None,
+    subcast_values: typing.Optional[Subcast] = None,
     **kwargs,
 ) -> typing.Mapping:
     if isinstance(value, Mapping):
         return value
 
     return {
         (subcast_key(key.strip()) if subcast_key else key.strip()): (
-            subcast(val.strip()) if subcast else val.strip()
+            subcast_values(val.strip()) if subcast_values else val.strip()
         )
         for key, val in (item.split("=", 1) for item in value.split(",") if value)
     }

tests/test_environs.py

@@ -107,7 +107,7 @@ def test_dict(self, set_env, env):
 
     def test_dict_with_subcast(self, set_env, env):
         set_env({"DICT": "key1=1,key2=2"})
-        assert env.dict("DICT", subcast=int) == {"key1": 1, "key2": 2}
+        assert env.dict("DICT", subcast_values=int) == {"key1": 1, "key2": 2}
 
     def test_dict_without_subcast_key(self, set_env, env):
         set_env({"DICT": "1=value1,2=value2"})