Deprecation Notices

This page tracks all active and resolved deprecations in ndict-tools.

Symbol

Deprecated in

Removed in

Migration

DictPaths

1.0.0

1.2.0

Use CompactPathsView or nd.compact_paths().

from_dict (free function)

1.1.0

1.5.0 (planned)

Use NestedDictionary.from_dict(data, default_setup={...}).

Active deprecations

from_dict free function

Deprecated since version 1.1.0: The free function from_dict (importable from ndict_tools.tools) is deprecated. It will be removed in 1.5.0 (issue issue #81).

Calling it emits a DeprecationWarning with an explicit removal notice.

Migrate to the classmethod available on all three public classes:

# Before — deprecated since 1.1.0, removed in 1.5.0
from ndict_tools.tools import from_dict
nd = from_dict(data, NestedDictionary, default_setup={...})

# After
nd = NestedDictionary.from_dict(data, default_setup={...})

Resolved deprecations

DictPaths

Deprecated since version 1.0.0.

Removed in version 1.2.0: DictPaths was deprecated in 1.0.0 and removed in 1.2.0 (issue issue #49).

Use CompactPathsView or call compact_paths() on any NestedDictionary instance.

# Before — removed in 1.2.0
from ndict_tools import DictPaths

# After
from ndict_tools import CompactPathsView
cpaths = nd.compact_paths()