interface-meta

1.3.0 · maintenance · verified Thu Apr 09

`interface_meta` is a Python library (current version 1.3.0) that provides a robust way to expose extensible APIs. It focuses on enforcing method signatures and ensuring consistent documentation for subclasses, making it suitable for plugin architectures. The library is currently in maintenance, with its last release in April 2022.

Warnings

gotcha The library heavily relies on metaclasses, which can be complex and might introduce unexpected behavior if not fully understood. Misuse or incorrect configuration of `InterfaceMeta` attributes (e.g., `INTERFACE_EXPLICIT_OVERRIDES`, `INTERFACE_RAISE_ON_VIOLATION`) can lead to subtle bugs or silent failures in API enforcement.
Fix: Thoroughly review the `InterfaceMeta` configuration attributes (`INTERFACE_EXPLICIT_OVERRIDES`, `INTERFACE_RAISE_ON_VIOLATION`, `INTERFACE_SKIPPED_NAMES`) to match desired enforcement strictness. Test interface implementations rigorously to ensure they adhere to the defined contracts. Consider enabling `INTERFACE_RAISE_ON_VIOLATION=True` during development for stricter checking.
gotcha Limited official documentation might make it challenging to troubleshoot advanced usage or deeply understand internal mechanics beyond the provided examples. The GitHub README explicitly states 'full documentation will come at some point.'
Fix: Rely on the examples in the GitHub repository and source code for detailed understanding. Be prepared to experiment and validate behavior through testing. Consult related projects or prior art mentioned in the README (e.g., `pure_interface`, `python-interface`) for conceptual guidance, though their implementations will differ.
deprecated The library's last release was in April 2022, suggesting it is in maintenance mode rather than active development. While functional, it might not receive frequent updates for new Python features or community best practices.
Fix: Be aware that new features or critical bug fixes may not be actively developed. Plan for potential internal modifications or consider alternative, more actively maintained interface enforcement libraries if long-term active development and bleeding-edge Python compatibility are paramount for your project.

Install

pip install interface-meta Install stable version

Imports

InterfaceMeta
```
from interface_meta import InterfaceMeta
```
The primary metaclass `InterfaceMeta` is directly available under the top-level package.

Quickstart

This quickstart demonstrates defining an interface using `InterfaceMeta` with abstract properties and methods, and then creating a conforming implementation. It highlights how to set interface-specific configurations for method signature enforcement and documentation.

from abc import abstractproperty
from interface_meta import InterfaceMeta

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):
        """A descriptive name."""
        raise NotImplementedError

    def say_hello(self):
        """Say hello."""
        return f"Hello, I am {self.name}!"

class MyImplementation(MyInterface):
    def __init__(self):
        super().__init__()
        self._name = "My Implementation"

    @property
    def name(self):
        return self._name

# Example usage:
instance = MyImplementation()
print(instance.say_hello())
print(f"Instance name: {instance.name}")

view raw JSON →