Skip to main content

mapperr for mapping across dict and object, recursively

Project description

mapperr - mapping across dictionary and class object, recursively

If you are using python for implementing protocols, cache management, nosql or sql database manupilation with the object oriented concepts in your code, mapperr can handle your object in your way, easily.

Installation

via pip

pip3 install mapperr

via direct setup

pip3 install setuptools
python3 setup.py sdist bdist_wheel
pip3 install dist/mapperr-0.0.1-py3-none-any.whl

Usage

Your classes' attributes are needed to be annotated with their types like int, str, Book, List[Book]. Parameterized constructors are not suitable, you can use it with plain objects which has most trash work. You can also fill your required options with param op_required as string list.

to_obj( dict_data: dict, destination_class: Type ) -> object

to_dict( obj: object ) -> dict

from typing import List
from pprint import pprint
from mapperr import to_dict, to_obj

class Book:
    _id: int
    title: str
    op_required: list = ['_id', 'title']

class BookShelf:
    code: str
    books: List[Book]

class Library:
    name: str
    book_shelfs: List[BookShelf]


def retrieve_library_from_the_source() -> dict:
    return {
        "name" : "Hogwarts Library",
        "book_shelfs" : [
            {
                "code" : "A1",
                "books" : [
                    {
                    "_id" : 0,
                    "title" : "Defence Against the Dark Arts"
                    },
                    {
                    "_id" : 1,
                    "title" : "Potions"
                    },
                ]
            },
            {
                "code" : "A2",
                "books" : [
                    {
                    "_id" : 3,
                    "title" : "Charms"
                    },
                    {
                    "_id" : 4,
                    "title" : "Herbology"
                    },
                ]
            }
        ]
    }

def send_library_to_the_source(data: dict):
    pprint(data)


lib: Library = to_obj(retrieve_library_from_the_source(), Library)

new_book = Book()
new_book._id = 5
new_book.title = "Alchemy"

lib.book_shelfs[0].books.append(new_book)

send_library_to_the_source( to_dict(lib) )

You can add your recursive type definitions into your class by using string variables.

class Person:
    name: str
    identity: int
    mother: 'Person'
    father: 'Person'
    friends: List['Person']

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

mapperr-0.2.1.tar.gz (5.5 kB view details)

Uploaded Source

File details

Details for the file mapperr-0.2.1.tar.gz.

File metadata

  • Download URL: mapperr-0.2.1.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for mapperr-0.2.1.tar.gz
Algorithm Hash digest
SHA256 b9a5a7a742e58ece40f9f361ff8adcf3dc93a7c9df99f1fa7a90571b235610bf
MD5 8b7ebdb56db847ffcb91ce1e0258e003
BLAKE2b-256 fd96e3aab7ee288d06c8b4410ef29c800f1fbddd9a075b200e15c236b194be74

See more details on using hashes here.

Supported by

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