Skip to content

warn that IDOM_FEATURE_INDEX_AS_DEFAULT_KEY=1 will be the default #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 30, 2021
Merged

warn that IDOM_FEATURE_INDEX_AS_DEFAULT_KEY=1 will be the default #515

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97970d4
warn that IDOM_FEATURE_INDEX_AS_DEFAULT_KEY=1 will be the default
rmorshea Sep 30, 2021
9b58399
Merge branch 'main' into add-config-warning
rmorshea Sep 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/idom/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

from pathlib import Path
from tempfile import TemporaryDirectory
from warnings import warn

from ._option import Option as _Option

Expand Down Expand Up @@ -55,3 +56,14 @@

For more information on changes to this feature flag see: https://github.com/idom-team/idom/issues/351
"""

if not IDOM_FEATURE_INDEX_AS_DEFAULT_KEY.current:
warn(
"In the next release, the feature flag IDOM_FEATURE_INDEX_AS_DEFAULT_KEY will "
"be activated by default. To try this out before the next release simply set "
"IDOM_FEATURE_INDEX_AS_DEFAULT_KEY=1 as an environment variable. After this "
"change, you can revert to the old behavior by setting it to 0 instead. If you "
"have questions or issues with this change report them here: "
"https://github.com/idom-team/idom/issues/351",
DeprecationWarning,
)