Merge branch 'master' into python_requires-no-upper-bound

changelog.txt

@@ -16,6 +16,11 @@ Added
 
 - Added support to run aggregate operations in parallel (#642, #644).
 
+Changed
++++++++
+- Deprecated configuaration key 'flow.environment_modules' (#651).
+- Deprecated configuration key 'flow.import_packaged_environments' (#651).
+
 Removed
 +++++++
 

flow/__init__.py

@@ -8,6 +8,8 @@
 
 .. _signac: https://signac.io/
 """
+import warnings
+
 from . import environment, errors, hooks, scheduling, testing
 from .aggregates import aggregator, get_aggregate_id
 from .environment import get_environment
@@ -44,10 +46,25 @@
 ]
 
 
-if _get_config_value(
+_import_packaged_environments = _get_config_value(
     "import_packaged_environments",
-    default=_FLOW_CONFIG_DEFAULTS["import_packaged_environments"],
-):
+    default=None,  # Use None to determine if this is being used or not.
+)
+
+if _import_packaged_environments is None:
+    _import_packaged_environments = _FLOW_CONFIG_DEFAULTS[
+        "import_packaged_environments"
+    ]
+else:
+    warnings.warn(
+        "The configuration key flow.import_packaged_environments will be removed in signac-flow "
+        "version 0.21. To remove this warning, remove the flow.import_packaged_environments key "
+        "from your signac configuration. In the future, environments provided by signac-flow will "
+        "always be imported.",
+        FutureWarning,
+    )
+
+if _import_packaged_environments:
     from . import environments  # noqa: F401
 
     __all__.append("environments")

flow/environment.py

@@ -14,6 +14,7 @@
 import os
 import re
 import socket
+import warnings
 from functools import lru_cache
 
 from signac.common import config
@@ -60,6 +61,11 @@ def setup(py_modules, **attrs):
     configuration. Once registered, the environment is automatically
     imported when the :meth:`~flow.get_environment` function is called.
     """
+    warnings.warn(
+        "The configuration key flow.environment_modules will be removed in signac-flow version "
+        "0.21. Users should manually import user-defined environments instead.",
+        FutureWarning,
+    )
     import setuptools
     from setuptools.command.install import install
 
@@ -517,6 +523,12 @@ def _import_configured_environments():
                 logger.warning(error)
     except KeyError:
         pass
+    else:
+        warnings.warn(
+            "The configuration key flow.environment_modules will be removed in signac-flow version "
+            "0.21. Users should manually import user-defined environments instead.",
+            FutureWarning,
+        )
 
 
 def registered_environments(import_configured=True):