Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Hybrid attributes

Project description

Travis CI Status Codecov Status Documentation

Hybrid-Attributes implements a hybrid_property and hybrid_method descriptor, which call the underlying function both in a class and instance context.

Assume you have a class like:

class Foo:
    @classmethod
    def spam(self):
        return 'spam'

    @property
    def eggs(self):
        return 'eggs'

    def ham(self):
        return 'ham'

You can get the values returned by calling .spam() on the class, accessing ‘.eggs’ or calling .ham() on an instance:

>>> Foo.spam()
'spam'
>>> foo = Foo()
>>> foo.eggs
'eggs'
>>> foo.ham()
'ham'

If you access these in a different context, .spam() will still be called with the class as first argument, .eggs will return a property object only useful for introspection and .ham() will raise an exception because there is no instance for it to be called with.

Hybrid-Attributes are different. They don’t care about the object are accessed through, the underlying function will always be called with whatever object it’s being accessed on. As an example, take this class:

class HybridFoo:
    @hybrid_property
    def spam(self):
        return 'spam'

    @hybrid_method
    def eggs(self):
        return 'eggs'

You can access the property and call the method on the class or on an instance:

>>> Foo.spam
'spam'
>>> Foo.eggs()
'eggs'
>>> foo = Foo()
>>> foo.spam
'spam'
>>> foo.eggs

Hybrid-Attributes is BSD licensed and available for Python 3.4 and later.

Project details


Download files

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

Files for hybrid-attributes, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size hybrid_attributes-0.1.0-py2.py3-none-any.whl (5.0 kB) File type Wheel Python version 3.5 Upload date Hashes View
Filename, size hybrid-attributes-0.1.0.tar.gz (11.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page