About

Whatami is an attempt to abstract configurability and experiment
identifiability in a convenient way. It does so by leveraging object
introspection and defining a simple, flexible and consistent API
that python objects can adhere to, even if they were not originally
designed to do it.

It works this way:

Objects provide their own ids based on parameters=value dictionaries.
They do so by returning an instance of the What class from
a method called “what()”.

Optionally, this package provides a whatable decorator to provide automatic
creation of What objects from objects dictionaries, slots and properties.
All attributes will be considered part of the configuration, except for those
whose names start or end by ‘_’.

The id strings

They aim to look like they would be generated if __repr__ in python was always implemented
taking into account recursion and exposing only result-changing parameters. They pretty much
look like python function calls with nested parameters expanded to look like python calls
themselves.

Example

Whatami is simple but powerful. This example just shows its surface and
better docs are coming, but in the meantime, just check the docstrings
and unit tests.

# Objects of this class provide a configuration (`What` object)classDuckedConfigurable(object):def__init__(self,quantity,name,company=None,verbose=True):self.quantity=quantityself.name=nameself.company=companyself.verbose=verbosedefwhat(self):returnWhat('ducked',{'quantity':self.quantity,'name':self.name,'company':self.company})duckedc=DuckedConfigurable(33,'salty-lollypops',verbose=False)# The configuration id string sorts by key alphanumeric order, helping id consistencyprintduckedc.what().id()# ducked(company=None,name='salty-lollypops',quantity=33)# Using the whatable decorator makes objects gain a what() method;# in this case, what() is infered automatically@whatableclassCompany(object):def__init__(self,name,city,verbose=True):super(Company,self).__init__()self.name=nameself.city=cityself._verbose=verbose# not part of configself.social_reason_='%s S.A., %s'%(name,city)# not part of configcc=Company(name='Chupa Chups',city='Barcelona')print(cc.what().id())# Company(city='Barcelona',name='Chupa Chups')# Ultimately, we can nest whatables...duckedc=DuckedConfigurable(33,'salty-lollypops',company=cc,verbose=False)printduckedc.what().id()# ducked(company=Company(city='Barcelona',name='Chupa Chups'),name='salty-lollypops',quantity=33)# We can also decorate functions and partials - use with caution@whatabledefbuy(company,price=2**32,currency='euro'):return'%s is now mine for %g%s'%(company.name,price,currency)printbuy.what().id()# buy(currency='euro',price=4294967296)

Versioning

Since release 4.0.0 whatami uses semantic versioning, where a major version bump
happens also if the default id strings can be generated differently, even if no API
actually changes.