https://github.com/mrogaski/pygopher-interfaces

Go-style interfaces for Python
https://github.com/mrogaski/pygopher-interfaces

interfaces python

Last synced: 3 months ago
JSON representation

Go-style interfaces for Python

• Host: GitHub
• URL: https://github.com/mrogaski/pygopher-interfaces
• Owner: mrogaski
• License: mit
• Created: 2021-04-10T17:38:16.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-04T03:30:54.000Z (over 1 year ago)
• Last Synced: 2025-09-19T19:14:33.485Z (7 months ago)
• Topics: interfaces, python
• Language: Python
• Homepage: https://pygopher-interfaces.readthedocs.io/en/latest/
• Size: 101 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
pygopher-interfaces

===================

.. rubric:: Go-style interfaces for Python

|status| |pypi| |license| |documentation| |coverage| |analysis|

Interfaces in the Go programming language are a bit different than those found in Java or C++, as they

are `implicit `_.  This means that there is no explicit "implements" relationship

between the interface definition and an implementation of the defined interface.  A type implements an interface by

implementing all of the methods defined.  When we wish to define an interface in Python, we typically use abstract

base classes to define them because we can enforce implementation of methods.  This requires us to use inheritance,

which couples the interface and the implementation.

This package emulates Go-style interfaces by creating an ``Interface`` metaclass that can be used to construct Python

classes that override ``issubclass`` to test whether a class implements the methods of the interface class, rather than

whether it inherits from the interface class.

This is a tiny package that emulates on of my favorite features of Go.

Installation

------------

.. code-block:: console

    pip install pygopher-interfaces

    # or:

    # pipenv install pygopher-interfaces

    # poetry add pygopher-interfaces

Usage

-----

To create an interface class, use the ``Interface`` metaclass.

.. code-block:: python

    from pygopher.interfaces import Interface

    class RepositoryInterface(metaclass=Interface):

        def get(account_id: int) -> Account:

            raise NotImplementedError

        def add(account: Account):

            raise NotImplementedError

    class MysqlRepository:

        def get(account_id: int) -> Account:

            ...

        def add(account: Account):

            ...

    >>> issubclass(MysqlRepository, RepositoryInterface)

    True

.. |status| image:: https://github.com/mrogaski/pygopher-interfaces/workflows/CI/badge.svg?branch=main

    :alt: Status

    :target: https://github.com/mrogaski/pygopher-interfaces/actions?workflow=CI

.. |pypi| image:: https://img.shields.io/pypi/pyversions/pygopher-interfaces

    :alt: PyPI - Python Version

    :target: https://pypi.org/project/pygopher-interfaces/

.. |license| image:: https://img.shields.io/pypi/l/pygopher-interfaces

    :alt: PyPI - License

    :target: https://github.com/mrogaski/pygopher-interfaces/blob/main/LICENSE

.. |documentation| image:: https://img.shields.io/readthedocs/pygopher-interfaces

    :alt: Read the Docs

    :target: https://pygopher-interfaces.readthedocs.io/en/latest/

.. |coverage| image:: https://codecov.io/gh/mrogaski/pygopher-interfaces/branch/main/graph/badge.svg?token=cu6sNIlaWt

    :alt: Test Coverage

    :target: https://codecov.io/gh/mrogaski/pygopher-interfaces

.. |analysis| image:: https://app.codacy.com/project/badge/Grade/0516015cd3f94d66b7a7c8203255b6de

    :alt: Code Quality

    :target: https://www.codacy.com/gh/mrogaski/pygopher-interfaces/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mrogaski/pygopher-interfaces&utm_campaign=Badge_Grade