Install

$ pip install -U magicdict

Thread Safety

FrozenMagicDict and its subclasses should be thread safe without additional locking. If any data races occurred, then that’s a bug. Please file an issue with reproducing procedure.

Usage

MagicDict should function like collections.OrderedDict except move_to_end is not defined and d[key] always returns the first item.

FrozenMagicDict is an immutable version of MagicDict.

FrozenTolerantMagicDict and TolerantMagicDict are case-insensitive versions of FrozenMagicDict and MagicDict respectively.

get_first, get_last, get_iter, and get_list: These methods are available in FrozenMagicDict and its subclasses. For more details, please read the comments of each method.

add: Method add is available in MagicDict and TolerantMagicDict. This method is used as an substitution of dic[key] = value as it can append a value to the dictionary without removing the existing one. Setting values like normal OrderedDict will clear the stored value(s) if any.

Contributing

The repository is hosted on GitLab.

License

Copyright 2020 Kaede Hoshikawa

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.