Skip to main content

An ordered, one-to-many mapping.

Project description

https://codecov.io/gl/futursolo/magicdict/branch/master/graph/badge.svg https://gitlab.com/futursolo/magicdict/badges/master/build.svg

An ordered, one-to-many mapping.

Thread Safety

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

Usage

MagicDict should function like a collections.OrderedDict except move_to_end is not defined and the item selection always returns the first item. It it is not, submit an issue.

FrozenMagicDict is an immutable version of MagicDict. Also, compared to MagicDict, FrozenMagicDict is lockless. Hence, when an action is available in both dictionaries, FrozenMagicDict is usually faster.

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

get_first, get_last, get_iter, and get_list: These methods are available in FrozenMagicDict and its subclasses to get the elements. 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 instead of dic[“key”] = “value” as it can append a value to the dictionary without removing the former one. Setting values like normal OrderedDict will clear the stored value(s) if any.

Contributing

The repository is hosted on GitLab.

License

Copyright 2018 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

magicdict-1.0.0.tar.gz (13.7 kB view hashes)

Uploaded Source

Built Distribution

magicdict-1.0.0-py3-none-any.whl (15.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page