diff --git a/snakebids/core/datasets.py b/snakebids/core/datasets.py index e6a9d2ff..d5b76886 100644 --- a/snakebids/core/datasets.py +++ b/snakebids/core/datasets.py @@ -9,6 +9,7 @@ import attr import more_itertools as itx from cached_property import cached_property +from deprecation import deprecated from typing_extensions import TypedDict import snakebids.utils.sb_itertools as sb_it @@ -200,6 +201,15 @@ def __setitem__(self, _: Any, __: Any): ) @cached_property + @deprecated( + details=""" + The behaviour of path will change in an upcoming release, where it + refer instead to the root path of the dataset. Please access component paths + using :attr:`Dataset[\\].path ` + """, + deprecated_in="0.8.0", + admonition="warning", + ) def path(self): """Dict mapping :class:`BidsComponents ` names to \ their ``paths``. @@ -211,6 +221,16 @@ def input_path(self): return self.path @cached_property + @deprecated( + details=""" + The behaviour of zip_lists will change in an upcoming release, where it will + refer instead to the consensus of entity groups across all components in the + dataset. Please access component zip_lists using + :attr:`Dataset[\\].zip_lists ` + """, + deprecated_in="0.8.0", + admonition="warning", + ) def zip_lists(self): """Dict mapping :class:`BidsComponents ` names to \ their ``zip_lists`` @@ -222,6 +242,16 @@ def input_zip_lists(self): return self.zip_lists @cached_property + @deprecated( + details=""" + The behaviour of entities will change in the 1.0 release, where it will refer + instead to the union of all entity-values across all components in the dataset. + Please access component entity lists using + :attr:`Dataset[\\].entities ` + """, + deprecated_in="0.8.0", + admonition="warning", + ) def entities(self): """Dict mapping :class:`BidsComponents ` names to \ to their :attr:`entities ` @@ -233,6 +263,16 @@ def input_lists(self): return self.entities @cached_property + @deprecated( + details=""" + The behaviour of wildcards will change in an upcoming release, where it will + refer instead to the union of all entity-wildcard mappings across all components + in the dataset. Please access component entity lists using + :attr:`Dataset[\\].wildcards ` + """, + deprecated_in="0.8.0", + admonition="warning", + ) def wildcards(self): """Dict mapping :class:`BidsComponents ` names to \ their :attr:`wildcards `