pluggy

This is the core framework used by the pytest, tox, and devpi projects.

Please read the docs to learn more!

A definitive example

import pluggy

hookspec = pluggy.HookspecMarker("myproject")
hookimpl = pluggy.HookimplMarker("myproject")


class MySpec:
    """A hook specification namespace."""

    @hookspec
    def myhook(self, arg1, arg2):
        """My special little hook that you can customize."""


class Plugin_1:
    """A hook implementation namespace."""

    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_1.myhook()")
        return arg1 + arg2


class Plugin_2:
    """A 2nd hook implementation namespace."""

    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_2.myhook()")
        return arg1 - arg2


# create a manager and add the spec
pm = pluggy.PluginManager("myproject")
pm.add_hookspecs(MySpec)

# register plugins
pm.register(Plugin_1())
pm.register(Plugin_2())

# call our ``myhook`` hook
results = pm.hook.myhook(arg1=1, arg2=2)
print(results)

Running this directly gets us:

$ python docs/examples/toy-example.py
inside Plugin_2.myhook()
inside Plugin_1.myhook()
[-1, 3]

Release files for pluggy 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pluggy 1.2.0
File	Size	Uploaded
pluggy-1.2.0.tar.gz	61.6 kB	Jun 21, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for pluggy 1.2.0
File	Interpreter	ABI	Platform	Reset
pluggy-1.2.0-py3-none-any.whl 17.7 kB Jun 21, 2023	Python 3	none	any	Details

Total release size: 79.3 kB

Release files / pluggy-1.2.0.tar.gz

Download URL	pluggy-1.2.0.tar.gz
Size	61.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`d12f0c4b579b15f5e054301bb226ee85eeeba08ffec228092f8defbaa3a4c4b3`
BLAKE2b-256 checksum How to use checksums	`8a428f2833655a29c4e9cb52ee8a2be04ceac61bcff4a680fb338cbd3d1e322d`
Upload date	Jun 21, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.11.4`

Release files / pluggy-1.2.0-py3-none-any.whl

Download URL	pluggy-1.2.0-py3-none-any.whl
Size	17.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c2fd55a7d7a3863cba1a013e4e2414658b1d07b6bc57b3919e0c63c9abb99849`
BLAKE2b-256 checksum How to use checksums	`51324a79112b8b87b21450b066e102d6608907f4c885ed7b04c3fdb085d4d6ae`
Upload date	Jun 21, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.11.4`