Error on random kwargs in setup_anndata (#1439)

* error on random kwargs in setup_anndata * release note * remove labels for totalvi * change message to be consistent w python Co-authored-by: Adam Gayoso <[email protected]>
scverse · Mar 15, 2022 · b213388 · b213388
1 parent 6bbdeec
commit b213388
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 1 deletion.
diff --git a/docs/release_notes/v0.15.2.rst b/docs/release_notes/v0.15.2.rst
@@ -0,0 +1,20 @@
+New in 0.15.2 (2022-MM-DD)
+--------------------------
+
+
+Changes
+~~~~~~~
+
+Bug fixes
+~~~~~~~~~~
+- Errors when arbitrary kwargs are passed into ``setup_anndata()`` (`#1439`_).
+
+Contributors
+~~~~~~~~~~~~
+- `@jjhong922`_
+- `@adamgayoso`_
+
+.. _`@jjhong922`: https://github.com/jjhong922
+.. _`@adamgayoso`: https://github.com/adamgayoso
+
+.. _`#1439`: https://github.com/YosefLab/scvi-tools/pull/1439
diff --git a/scvi/data/_manager.py b/scvi/data/_manager.py
@@ -131,6 +131,11 @@ def register_fields(
                 "Existing AnnData object registered with this Manager instance."
             )
 
+        if source_registry is None and transfer_kwargs:
+            raise TypeError(
+                f"register_fields() got unexpected keyword arguments {transfer_kwargs} passed without a source_registry."
+            )
+
         self._validate_anndata_object(adata)
         field_registries = self._registry[_constants._FIELD_REGISTRIES_KEY]
 

diff --git a/tests/dataset/test_anndata.py b/tests/dataset/test_anndata.py
@@ -98,6 +98,11 @@ def test_transfer_fields():
     m.get_latent_representation(a2)
     assert a2.obs["_scvi_batch"].all() == 1
 
+    # test that error is thrown if an arbitrary kwarg is passed into setup_anndata
+    a = scvi.data.synthetic_iid()
+    with pytest.raises(TypeError):
+        scvi.model.SCVI.setup_anndata(a, batch="batch")
+
 
 def test_clobber_same_model():
     adata = scvi.data.synthetic_iid()

diff --git a/tests/models/test_models.py b/tests/models/test_models.py
@@ -393,7 +393,6 @@ def test_save_load_model(cls, adata, save_path, prefix=None, legacy=False):
             cls.setup_anndata(
                 adata,
                 batch_key="batch",
-                labels_key="labels",
                 protein_expression_obsm_key="protein_expression",
                 protein_names_uns_key="protein_names",
             )