| Name | interface-meta JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | |
| Summary | `interface_meta` provides a convenient way to expose an extensible API with enforced method signatures and consistent documentation. |
| upload_time | 2022-04-04 01:12:46 |
| maintainer | |
| docs_url | None |
| author | Matthew Wardrop |
| requires_python | >=3.7,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# InterfaceMeta
[](https://pypi.org/project/interface_meta/)
[](https://github.com/matthewwardrop/interface_meta/actions?query=workflow%3A%22Run+Tox+Tests%22)
[](https://codecov.io/gh/matthewwardrop/interface_meta)
[](https://github.com/psf/black)
`interface_meta` provides a convenient way to expose an extensible API with
enforced method signatures and consistent documentation.
- **Documentation:** See below (full documentation will come at some point).
- **Source:** https://github.com/matthewwardrop/interface_meta
- **Bug reports:** https://github.com/matthewwardrop/interface_meta/issues
## Overview
This library has been extracted (with some modifications) from
[`omniduct`](https://github.com/airbnb/omniduct), a library also principally
written by this author, where it was central to the extensible plugin
architecture. It places an emphasis on the functionality required to create a
well-documented extensible plugin system, whereby the act of subclassing is
sufficient to register the plugin and ensure compliance to the parent API. As
such, this library boasts the following features:
- All subclasses of an interface must conform to the parent's API.
- Hierarchical runtime property existence and method signature checking. Methods
are permitted to add additional *optional* arguments, but otherwise must
conform to the API of their parent class (which themselves may have extended
the API of the interface).
- Subclass definition time hooks (e.g. for registration of subclasses into a
library of plugins, etc).
- Optional requirement for methods in subclasses to explicity decorate methods
with an `override` decorator when replacing methods on an interface, making
it clearer as to when a class is introducing new methods versus replacing
those that form the part of the interface API.
- Generation of clear docstrings on implementations that stitches together the
base interface documentation with any downstream extensions and quirks.
- Support for extracting the quirks documentation for a method from other method
docstrings, in the event that subclass implementations are done in an internal
method.
- Compatibility with ABCMeta from the standard library.
## Example code
```python
from abc import abstractmethod, abstractproperty
from interface_meta import InterfaceMeta, override, quirk_docs
class MyInterface(metaclass=InterfaceMeta):
"""
An example interface.
"""
INTERFACE_EXPLICIT_OVERRIDES = True
INTERFACE_RAISE_ON_VIOLATION = False
INTERFACE_SKIPPED_NAMES = {'__init__'}
def __init__(self):
"""
MyInterface constructor.
"""
pass
@abstractproperty
def name(self):
"""
The name of this interface.
"""
pass
@quirk_docs(method='_do_stuff')
def do_stuff(self, a, b, c=1):
"""
Do things with the parameters.
"""
return self._do_stuff(a, b, c)
@abstractmethod
def _do_stuff(self, a, b, c):
pass
class MyImplementation(MyInterface):
"""
This implementation of the example interface works nicely.
"""
@quirk_docs(method='_init', mro=False)
def __init__(self, a):
"""
MyImplementation constructor.
"""
self._init(a)
def _init(self, a):
"""
In this instance, we do nothing with a.
"""
pass
@property
@override
def name(self):
return "Peter"
@override
def _do_stuff(self, a, b, c):
"""
In this implementation, we sum the parameters.
"""
return a + b + c
```
Running `help(MyImplementation)` reveals how the documentation is generated:
```python
class MyImplementation(MyInterface)
| This implementation of the example interface works nicely.
|
| Method resolution order:
| MyImplementation
| MyInterface
| builtins.object
|
| Methods defined here:
|
| __init__(self, a)
| MyImplementation constructor.
|
| In this instance, we do nothing with a.
|
| do_stuff(self, a, b, c=1)
| Do things with the parameters.
|
| MyImplementation Quirks:
| In this implementation, we sum the parameters.
...
```
## Related projects and prior art
This library is released into an already crowded space, and the author would
like to recognise some of the already wonderful work done by others. The primary
difference between this and other libraries is typically these other libraries
focus more on abstracting interface definitions and compliance, and less on the
documentation and plugin registration work. While this work overlaps with these
projects, its approach is sufficiently different (in the author's opinion)
to warrant a separate library.
- [`pure_interface`](https://github.com/seequent/pure_interface)
- [`python-interface`](https://github.com/ssanderson/interface)
`python-interface` has an emphasis on ensuring that implementations of various
interfaces *strictly* adhere to the methods and properties associated with
the interface, and that helpful errors are raised when this is violated.
By
comparison this library focusses on functional comformance to parent classes,
whereby methods on subclasses are allowed to include additional parameters. It
also focusses on ensuring that documentation for such quirks in method signatures are correctly composed into the final documentation rendered for that method.
Raw data
{
"_id": null,
"home_page": "",
"name": "interface-meta",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Matthew Wardrop",
"author_email": "mpwardrop@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4d/75/10526292b332f3479c246750a96f6ec11a28e297839a9c25583b2aadc119/interface_meta-1.3.0.tar.gz",
"platform": null,
"description": "# InterfaceMeta\n\n[](https://pypi.org/project/interface_meta/)\n\n\n[](https://github.com/matthewwardrop/interface_meta/actions?query=workflow%3A%22Run+Tox+Tests%22)\n[](https://codecov.io/gh/matthewwardrop/interface_meta)\n[](https://github.com/psf/black)\n\n`interface_meta` provides a convenient way to expose an extensible API with\nenforced method signatures and consistent documentation.\n\n- **Documentation:** See below (full documentation will come at some point).\n- **Source:** https://github.com/matthewwardrop/interface_meta\n- **Bug reports:** https://github.com/matthewwardrop/interface_meta/issues\n\n## Overview\n\nThis library has been extracted (with some modifications) from\n[`omniduct`](https://github.com/airbnb/omniduct), a library also principally\nwritten by this author, where it was central to the extensible plugin\narchitecture. It places an emphasis on the functionality required to create a\nwell-documented extensible plugin system, whereby the act of subclassing is\nsufficient to register the plugin and ensure compliance to the parent API. As\nsuch, this library boasts the following features:\n\n- All subclasses of an interface must conform to the parent's API.\n- Hierarchical runtime property existence and method signature checking. Methods\n are permitted to add additional *optional* arguments, but otherwise must\n conform to the API of their parent class (which themselves may have extended\n the API of the interface).\n- Subclass definition time hooks (e.g. for registration of subclasses into a\n library of plugins, etc).\n- Optional requirement for methods in subclasses to explicity decorate methods\n with an `override` decorator when replacing methods on an interface, making\n it clearer as to when a class is introducing new methods versus replacing\n those that form the part of the interface API.\n- Generation of clear docstrings on implementations that stitches together the\n base interface documentation with any downstream extensions and quirks.\n- Support for extracting the quirks documentation for a method from other method\n docstrings, in the event that subclass implementations are done in an internal\n method.\n- Compatibility with ABCMeta from the standard library.\n\n## Example code\n\n```python\nfrom abc import abstractmethod, abstractproperty\nfrom interface_meta import InterfaceMeta, override, quirk_docs\n\nclass MyInterface(metaclass=InterfaceMeta):\n \"\"\"\n An example interface.\n \"\"\"\n\n INTERFACE_EXPLICIT_OVERRIDES = True\n INTERFACE_RAISE_ON_VIOLATION = False\n INTERFACE_SKIPPED_NAMES = {'__init__'}\n\n def __init__(self):\n \"\"\"\n MyInterface constructor.\n \"\"\"\n pass\n\n @abstractproperty\n def name(self):\n \"\"\"\n The name of this interface.\n \"\"\"\n pass\n\n @quirk_docs(method='_do_stuff')\n def do_stuff(self, a, b, c=1):\n \"\"\"\n Do things with the parameters.\n \"\"\"\n return self._do_stuff(a, b, c)\n\n @abstractmethod\n def _do_stuff(self, a, b, c):\n pass\n\nclass MyImplementation(MyInterface):\n \"\"\"\n This implementation of the example interface works nicely.\n \"\"\"\n\n @quirk_docs(method='_init', mro=False)\n def __init__(self, a):\n \"\"\"\n MyImplementation constructor.\n \"\"\"\n self._init(a)\n\n def _init(self, a):\n \"\"\"\n In this instance, we do nothing with a.\n \"\"\"\n pass\n\n @property\n @override\n def name(self):\n return \"Peter\"\n\n @override\n def _do_stuff(self, a, b, c):\n \"\"\"\n In this implementation, we sum the parameters.\n \"\"\"\n return a + b + c\n```\n\nRunning `help(MyImplementation)` reveals how the documentation is generated:\n\n```python\nclass MyImplementation(MyInterface)\n | This implementation of the example interface works nicely.\n |\n | Method resolution order:\n | MyImplementation\n | MyInterface\n | builtins.object\n |\n | Methods defined here:\n |\n | __init__(self, a)\n | MyImplementation constructor.\n |\n | In this instance, we do nothing with a.\n |\n | do_stuff(self, a, b, c=1)\n | Do things with the parameters.\n |\n | MyImplementation Quirks:\n | In this implementation, we sum the parameters.\n ...\n```\n\n## Related projects and prior art\n\nThis library is released into an already crowded space, and the author would\nlike to recognise some of the already wonderful work done by others. The primary\ndifference between this and other libraries is typically these other libraries\nfocus more on abstracting interface definitions and compliance, and less on the\ndocumentation and plugin registration work. While this work overlaps with these\nprojects, its approach is sufficiently different (in the author's opinion)\nto warrant a separate library.\n\n- [`pure_interface`](https://github.com/seequent/pure_interface)\n- [`python-interface`](https://github.com/ssanderson/interface)\n\n`python-interface` has an emphasis on ensuring that implementations of various\ninterfaces *strictly* adhere to the methods and properties associated with\nthe interface, and that helpful errors are raised when this is violated.\n\nBy\ncomparison this library focusses on functional comformance to parent classes,\nwhereby methods on subclasses are allowed to include additional parameters. It\nalso focusses on ensuring that documentation for such quirks in method signatures are correctly composed into the final documentation rendered for that method.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "`interface_meta` provides a convenient way to expose an extensible API with enforced method signatures and consistent documentation.",
"version": "1.3.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "e9442570eb0d2225e53b40d21823b37a",
"sha256": "de35dc5241431886e709e20a14d6597ed07c9f1e8b4bfcffde2190ca5b700ee8"
},
"downloads": -1,
"filename": "interface_meta-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9442570eb0d2225e53b40d21823b37a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 14854,
"upload_time": "2022-04-04T01:12:45",
"upload_time_iso_8601": "2022-04-04T01:12:45.183313Z",
"url": "https://files.pythonhosted.org/packages/02/3f/a6ec28c88e2d8e54d32598a1e0b5208a4baa72a8e7f6e241beab5731eb9d/interface_meta-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "f4146b96c76148ae7604bd624c3ff083",
"sha256": "8a4493f8bdb73fb9655dcd5115bc897e207319e36c8835f39c516a2d7e9d79a1"
},
"downloads": -1,
"filename": "interface_meta-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "f4146b96c76148ae7604bd624c3ff083",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 15007,
"upload_time": "2022-04-04T01:12:46",
"upload_time_iso_8601": "2022-04-04T01:12:46.517904Z",
"url": "https://files.pythonhosted.org/packages/4d/75/10526292b332f3479c246750a96f6ec11a28e297839a9c25583b2aadc119/interface_meta-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-04-04 01:12:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "interface-meta"
}
