https://github.com/drgrib/dotmap

Dot access dictionary with dynamic hierarchy creation and ordered iteration
https://github.com/drgrib/dotmap

dictionaries maps python python2 python3

Last synced: 23 days ago
JSON representation

Dot access dictionary with dynamic hierarchy creation and ordered iteration

• Host: GitHub
• URL: https://github.com/drgrib/dotmap
• Owner: drgrib
• License: mit
• Created: 2015-08-11T20:56:21.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-01-23T18:20:01.000Z (10 months ago)
• Last Synced: 2024-10-07T20:54:27.480Z (27 days ago)
• Topics: dictionaries, maps, python, python2, python3
• Language: Python
• Homepage:
• Size: 128 KB
• Stars: 465
• Watchers: 11
• Forks: 44
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# DotMap

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate?business=N2GLXLS5KBFBY&item_name=Chris+Redford&currency_code=USD)

# Install

```

pip3 install dotmap

```

## Upgrade

Get updates for current installation

```

pip3 install --upgrade dotmap

```

# Features

`DotMap` is a dot-access `dict` subclass that

-   has dynamic hierarchy creation (autovivification)

-   can be initialized with keys

-   easily initializes from `dict`

-   easily converts to `dict`

-   is ordered by insertion

The key feature is exactly what you want: dot-access

```python

from dotmap import DotMap

m = DotMap()

m.name = 'Joe'

print('Hello ' + m.name)

# Hello Joe

```

However, `DotMap` is a `dict` and you can treat it like a `dict` as needed

```python

print(m['name'])

# Joe

m.name += ' Smith'

m['name'] += ' Jr'

print(m.name)

# Joe Smith Jr

```

It also has fast, automatic hierarchy (which can be deactivated by initializing with `DotMap(_dynamic=False)`)

```python

m = DotMap()

m.people.steve.age = 31

```

And key initialization

```python

m = DotMap(a=1, b=2)

```

You can initialize it from `dict` and convert it to `dict`

```python

d = {'a':1, 'b':2}

m = DotMap(d)

print(m)

# DotMap(a=1, b=2)

print(m.toDict())

# {'a': 1, 'b': 2}

```

And it has iteration that is ordered by insertion

```python

m = DotMap()

m.people.john.age = 32

m.people.john.job = 'programmer'

m.people.mary.age = 24

m.people.mary.job = 'designer'

m.people.dave.age = 55

m.people.dave.job = 'manager'

for k, v in m.people.items():

	print(k, v)

print

# john DotMap(age=32, job='programmer')

# mary DotMap(age=24, job='designer')

# dave DotMap(age=55, job='manager')

```

It also has automatic counter initialization

```python

m = DotMap()

for i in range(7):

	m.counter += 1

print(m.counter)

# 7

```

And automatic addition initializations of any other type

```python

m = DotMap()

m.quote += 'lions'

m.quote += ' and tigers'

m.quote += ' and bears'

m.quote += ', oh my'

print(m.quote)

# lions and tigers and bears, oh my

```

There is also built-in `pprint` as `dict` or `json` for debugging a large `DotMap`

```python

m.pprint()

# {'people': {'dave': {'age': 55, 'job': 'manager'},

#             'john': {'age': 32, 'job': 'programmer'},

#             'mary': {'age': 24, 'job': 'designer'}}}

m.pprint(pformat='json')

# {

#     "people": {

#         "dave": {

#	      "age": 55,

#	      "job": "manager"

# 	  },

# 	  "john": {

#	      "age": 32,

#	      "job": "programmer"

# 	  },

# 	  "mary": {

#	      "age": 24,

#	      "job": "designer"

# 	  }

#     }

# }

```

And many other features involving dots and dictionaries that will be immediately intuitive when used.