https://github.com/zincware/supercharge

Expand Python Super Capabilities
https://github.com/zincware/supercharge

Last synced: 10 months ago
JSON representation

Expand Python Super Capabilities

• Host: GitHub
• URL: https://github.com/zincware/supercharge
• Owner: zincware
• License: epl-2.0
• Created: 2022-01-03T12:43:38.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-04T16:42:36.000Z (over 4 years ago)
• Last Synced: 2025-06-13T23:05:55.158Z (12 months ago)
• Language: Python
• Size: 20.5 KB
• Stars: 0
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
|build| |license| |code style| |coverage| |colab-badge|

Supercharge

-----------

This package allows you to automatically run code before and after a given class method.

Furthermore, this behaviour can be enforced on child classes as well.

Supercharge is available via:

.. code-block::

    pip install supercharge

Example

=======

.. code-block:: py

    from supercharge import Charge

    class HelloWorld:

        def __init__(self):

            self.run_prepared = False

            self.run_state = False

        @Charge

        def run(self):

            if self.run_prepared:

                print("running ...")

        @run.enter

        def pre_run(self):

            self.run_prepared = True

        @run.exit

        def post_run(self):

            self.run_state = True

If this is behaviour is desired in subclassed runs one must use the `Base` class.

.. code-block:: py

    from supercharge import Charge, Base

    class HelloWorld(Base):

        def __init__(self):

            self.run_prepared = False

            self.run_state = False

        @Charge

        def run(self):

            raise NotImplementedError

        @run.enter

        def pre_run(self):

            self.run_prepared = True

        @run.exit

        def post_run(self):

            self.run_state = True

    class Child(HelloWorld):

        def run(self):

            if self.run_prepared:

                print("running ...")

Noticeable Alternatives

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

Using supercharge might not always be the best way to go. In many scenarios an easier way

to achieve a similar functionality can be

.. code-block:: py

    class HelloWorld:

        def __init__(self):

            self.run_prepared = False

            self.run_state = False

        def run(self):

            self.pre_run()

            self.base_run()

            self.post_run()

        def base_run(self):

            raise NotImplementedError

        def pre_run(self):

            self.run_prepared = True

        def post_run(self):

            self.run_state = True

    class Child(HelloWorld):

        def base_run(self):

            if self.run_prepared:

                print("running ...")

where you call `Child.run()` and overwrite `Child.base_run()`.

.. badges

.. |build| image:: https://github.com/zincware/supercharge/actions/workflows/pytest.yaml/badge.svg

    :alt: Build tests passing

    :target: https://github.com/zincware/py-test/blob/readme_badges/

.. |license| image:: https://img.shields.io/badge/License-EPL-purple.svg?style=flat

    :alt: Project license

    :target: https://www.eclipse.org/legal/epl-2.0/faq.php

.. |code style| image:: https://img.shields.io/badge/code%20style-black-black

    :alt: Code style: black

    :target: https://github.com/psf/black/

    

.. |coverage| image:: https://coveralls.io/repos/github/zincware/supercharge/badge.svg

    :alt: Code coverage

    :target: https://coveralls.io/github/zincware/supercharge

.. |colab-badge| image:: https://colab.research.google.com/assets/colab-badge.svg

    :alt: Open Example in Google Colab

    :target: https://colab.research.google.com/github/zincware/supercharge/blob/main/examples/introduction.ipynb