Skip to main content

A Python library to access dictionaries using dot notation.

Project description

PyPI Downloads PyPI GitHub stars GitHub issues GitHub last commit License Python Tests

Dottify

Dottify is a lightweight Python library that converts dictionaries into objects with attribute-style access. Instead of the usual dict["key"] syntax, you can access dictionary values using dot notation like dict.key. All access is case-sensitive, but helpful suggestions are provided when a key is missing.

Installation

Install via pip:

pip install dottify

Usage

Here’s an example of how Dottify works:

from dottify import Dottify

# Initial data
persons = {
    "Alice": {
        "age": 30,
        "city": "Paris",
        "profession": "Engineer"
    },
    "Charlie": {
        "age": 35,
        "city": "Marseille",
        "profession": "Doctor"
    }
}

# Wrap with Dottify
people = Dottify(persons)

# Merge with + operator (__add__)
new_person = {
    "Bob": {
        "age": 2,
        "city": "Lyon",
        "profession": "Designer"
    }
}
people = people + new_person

# In-place merge with += (__iadd__)
people += Dottify({
    "John": {
        "age": 27,
        "city": "Toulouse",
        "profession": "Carpenter"
    }
})

# Access by dot notation and key lookup
print(people.Alice.age)             # 30
print(people["Charlie"].city)       # Marseille
print(people.Bob.profession)        # Designer

# Index-based access (__getitem__)
print(people[3].profession)         # Carpenter (John)

# Modify attributes
people.John.profession = "Developer"
people.Bob.age = 39

# Use get() with case-insensitive fallback
print(people.get("alice", "Not Found").city)     # Paris
print(people.get("ALICIA", "Not Found"))         # Not Found

# Remove a key by name
people.remove("Bob")  # Removes Bob

# Check if a key exists
print(people.has_key("charlie"))     # False (because 'charlie' != 'Charlie')
print(people.has_key("Charlie"))     # True
print(people.has_key("unknown"))     # False

# Use len(), keys(), values(), items()
print(len(people))                   # 3 (Alice, Charlie, John)
print(list(people.keys()))           # ['Alice', 'Charlie', 'John']
print([v.city for v in people.values()])  # ['Paris', 'Marseille', 'Toulouse']
print([(k, v.age) for k, v in people.items()])  # [('Alice', 30), ('Charlie', 35), ('John', 27)]

Features

  • Converts standard and nested dictionaries into objects with attribute access.
  • Supports both dot notation (obj.key) and dictionary-style (obj["key"]) access.
  • All access is case-sensitive.
  • Friendly error messages with key suggestions (case-insensitive search).
  • Key removal with .remove("Key") is case-sensitive, but also provides suggestions if the key doesn't match.
  • Easily convert back to a standard dict using .to_dict().
  • Supports .keys(), .values(), .items(), iteration, and len() additions.
  • Well-documented and fully tested with pytest.

Tests

To run the test suite:

pytest tests/

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests on the GitHub repository.

License

Distributed under the MIT License. See LICENSE for more information.

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

dottify-1.1.2.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dottify-1.1.2-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file dottify-1.1.2.tar.gz.

File metadata

  • Download URL: dottify-1.1.2.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for dottify-1.1.2.tar.gz
Algorithm Hash digest
SHA256 55427b869a70c8f064592291085e634026afb1149af13056fff7737e85ab93d5
MD5 4dc4f1af289184a31496550b263815bb
BLAKE2b-256 4eccfedc46e62d0bd4b94b07fe56b572facd7e3cd8b083cfb37a42649c0c4fa3

See more details on using hashes here.

File details

Details for the file dottify-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: dottify-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for dottify-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d3e1fe29f5ae8374a7a85573b23362639d523e99ad56a088ce2d25a06c1f29c8
MD5 6d3250dc1b9bb196c069b38051d9c30f
BLAKE2b-256 e404bb49e67d91a7919d8c637373ec15374d0684f782e93315e439665b5ce943

See more details on using hashes here.

Supported by

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