Note deprecated config options

See #2872 for information about deprecated loader and materializer config options.
dagster-io · Aug 31, 2020 · 83dbf04 · 83dbf04
1 parent 8bb5c33
commit 83dbf04
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/python_modules/libraries/dagster-dask/dagster_dask/data_frame.py b/python_modules/libraries/dagster-dask/dagster_dask/data_frame.py
@@ -229,6 +229,8 @@ def _dataframe_loader_config():
             Selector(read_fields),
             is_required=False,
         ),
+
+        # https://github.com/dagster-io/dagster/issues/2872
         **{
             field_name: Field(
                 field_config,
@@ -244,11 +246,14 @@ def dataframe_loader(_context, config):
     read_type, read_options = None, None
     if "read" in config:
         read_type, read_options = next(iter(config["read"].items()))
+
+    # https://github.com/dagster-io/dagster/issues/2872
     else:
         for key in DataFrameReadTypes:
             if key in config:
                 read_type, read_options = key, config[key]
                 warnings.warn("Specifying {key}: is deprecated. Use read:{key}: instead.".format(key=key))
+
     if not read_type:
         raise DagsterInvariantViolationError(
             "No read_type found. Expected read key in config."
@@ -288,6 +293,8 @@ def _dataframe_materializer_config():
             Selector(to_fields),
             is_required=False,
         ),
+
+        # https://github.com/dagster-io/dagster/issues/2872
         **{
             field_name: Field(
                 field_config,
@@ -304,6 +311,8 @@ def dataframe_materializer(_context, config, dask_df):
 
     if "to" in config:
         to_specs = config["to"]
+
+    # https://github.com/dagster-io/dagster/issues/2872
     else:
         to_specs = {
             to_type: to_options
@@ -313,7 +322,6 @@ def dataframe_materializer(_context, config, dask_df):
         for key in to_specs.keys():
             warnings.warn("Specifying {key}: is deprecated. Use to:{key}: instead.".format(key=key))
 
-
     for to_type, to_options in to_specs.items():
         if not to_type in DataFrameToTypes:
             check.failed("Unsupported to_type {to_type}".format(to_type=to_type))

diff --git a/python_modules/libraries/dagster-dask/dagster_dask_tests/test_data_frame.py b/python_modules/libraries/dagster-dask/dagster_dask_tests/test_data_frame.py
@@ -28,6 +28,7 @@ def test_dataframe_inputs(file_type):
     def return_df(_, input_df):
         return input_df
 
+    # https://github.com/dagster-io/dagster/issues/2872
     with pytest.warns(
         UserWarning,
         match=re.escape("Specifying {key}: is deprecated. Use read:{key}: instead.".format(key=file_type)),
@@ -67,6 +68,7 @@ def test_dataframe_outputs(file_type, read, kwargs):
     def return_df(_):
         return df
 
+    # https://github.com/dagster-io/dagster/issues/2872
     with pytest.warns(
         UserWarning,
         match=re.escape("Specifying {key}: is deprecated. Use to:{key}: instead.".format(key=file_type)),