overrides
A decorator to automatically detect mismatch when overriding a method. See http://stackoverflow.com/questions/1167617/in-python-how-do-i-indicate-im-overriding-a-method
All checks are done when a class or a method is created and not when a method is executed or an instance of a class is created. This means that performance implications are minimal.
Note: Version 2.8.0 is the last one that supports Python 2.7. Versions after that work with Python >= 3.6.
Why explicit overrides?
Overrides without explicit indicator for them are weak. They leave room for problems that happen during the evolution of a codebase.
(create) Accidental overriding in a subclass when a method to a superclass is added (or vice versa).
(modify) Rename of a superclass method without subclass method rename (or vice versa).
(delete) Deleting of a superclass method without detecting in subclass that the method is not anymore overriding anything (or vice versa).
These might happen for example when overriding a method in a module that does not live in your codebase, or when merging changes done by someone else to the codebase without having access to your subclass.
Installation
$ pip install overridesUsage
from overrides import overrides
class SuperClass:
def method(self):
"""This is the doc for a method and will be shown in subclass method too!"""
return 2
class SubClass(SuperClass):
@overrides
def method(self):
return 1Enforcing usage
from overrides import EnforceOverrides, final, overrides
class SuperClass(EnforceOverrides):
@final
def method(self):
"""This is the doc for a method and will be shown in subclass method too!"""
return 2
def method2(self):
"""This is the doc for a method and will be shown in subclass method too!"""
return 2
@staticmethod
def method3():
"""This is the doc for a method and will be shown in subclass method too!"""
return 2
# THIS FAILS
class SubClass1(SuperClass):
def method(self): # <-- overriding a final method
return 1
# THIS FAILS
class SubClass2(SuperClass):
def method2(self): # <-- @overrides decorator missing
return 1
# THIS ONE IS OK
class SubClass3(SuperClass):
@overrides
def method2(self):
return 1
# ENSURE THAT @classmethod AND @staticmethod ARE PLACED AT THE TOP
class SubClass4(SuperClass):
@staticmethod
@overrides
def method3():
return 12 maintainers
Metadata
2 maintainers
Release files for overrides 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| overrides-3.1.0.tar.gz | 11.1 kB | Details |
Release files / overrides-3.1.0.tar.gz
| Download URL | overrides-3.1.0.tar.gz |
|---|---|
| Size | 11.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
30f761124579e59884b018758c4d7794914ef02a6c038621123fec49ea7599c6
|
|
BLAKE2b-256 checksum How to use checksums |
ffb110f69c00947518e6676bbd43e739733048de64b8dd998e9c2d5a71f44c5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.7.3
|
