Skip to main content

@overrides and @final implementation for Python

Project description

StrictParent

Python is built to be as dynamic and permissive as possible. However, especially in case of larger applications it is beneficial to establish stricter principles. StrictParent helps you to make your Python classes more structured and enforcing contracts while still leaving the opportunity to break the rules if necessary.

Light-weight and dependency free 😊

Installation

pip install strictparent

Requires Python 3.6+.

Features

  • StrictParent -- parent class for all your custom classes using these features
  • @final -- makes a method finalized, raises InheritanceError if subclasses try to override this method
  • @overrides -- decorator for methods, states that this subclass method is overriding a method in parent class. If parent class does not have such a method, raises an InheritanceError. Also, if a subclass is overriding a parent class method without making it explicit by using this decorator, an exception is risen.
  • @force_override -- decorator for overriding finalized parent class methods.

All the decorators can be used for inline classes as well.

The purpose of this approach is to make the code more understandable and to protect the developer against accidentally overriding a method, which served an important role in the parent class. However all methods can still be overridden if explicitly stated by @force_override decorator. This way we can write more readable code without loosing any freedom.

StrictParent has no metaclass, so your do not have to face any trouble regarding metaclass conflicts.

from strictparent import StrictParent, final, overrides


class Parent(StrictParent):

    def overrideable_method(self):
        return 'I do not mind being overridden'

    @final
    def final_method(self):
        return 'Knowledge & vision arose in me: this is the last birth. There is now no further becoming.'


class ObedientChild(Parent):

    @overrides  # It is now easy to see, that the method has a meaning in the `Parent` class
    def overrideable_method(self):
        return 'Hey'

    @force_override  # Finalized methods can be overridden if explicitly stated
    def final_method(self):
        return 'I am aware I have broken the convention'


class RebelChild(Parent):

    @overrides  # Will raise an exception, because `Parent` class has no such method
    def my_heretic_method(self):
        return 'I claim to be be authentic, but I am just a faker'

    # Will raise an exception, because `@overrides` decorator is missing
    def overrideable_method(self):
        return 'I am hiding my lineage'

    # Will raise an exception, because `final_method` has been finalized in `Parent` class
    def final_method(self):
        return 'I am against the machine!'

Using with built-in decorators

You can combine the custom decorators with the built-in @classmethod, @staticmethod, and @property decorators. The custom decorator must be the final wrapper, so add it to the top of all the other decorators:

@final
@overrides
@classmethod
def overrideable_method(self):
    pass

Please let us know if there are any other features that should be added to this package.

Contributing

There is no need for a virtual environment since you do not need to install any dependencies.

Running tests

Being in the root directory:

cd strictparent/
./tests.py

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 strictparent, version 3.3.2
Filename, size File type Python version Upload date Hashes
Filename, size strictparent-3.3.2-py3-none-any.whl (6.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size strictparent-3.3.2.tar.gz (4.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page