Replace deprecated implprefix from pluggy with HookimplMarker

docs/plugins.rst

@@ -23,10 +23,15 @@ Then, in your package implement one or more of the plugin :ref:`hooks` provided
 by PyPOM. The following example will take a screenshot whenever a page or
 region has finished loading::
 
+
+  from pypom import hookimpl
+
+  @hookimpl
   def pypom_after_wait_for_page_to_load(page):
       page.selenium.get_screenshot_as_file(page.__class__.__name__ + '.png')
 
 
+  @hookimpl
   def pypom_after_wait_for_region_to_load(region):
       region.root.screenshot(region.__class__.__name__ + '.png')
 

src/pypom/__init__.py

@@ -1,6 +1,7 @@
 from .page import Page  # noqa
 from .region import Region  # noqa
 
+import pluggy
 import selenium  # noqa
 
 # register selenium support
@@ -16,3 +17,5 @@
     from .splinter_driver import register as registerSplinter
 
     registerSplinter()
+
+hookimpl = pluggy.HookimplMarker("pypom")

src/pypom/newsfragments/90.bugfix

@@ -0,0 +1,18 @@
+Replace use of ``implprefix`` with ``HookimplMarker`` due to deprecation.
+
+Existing PyPOM plugins will need to be updated to import the `hookimpl` and use
+it to decorate hook implementations rather than rely on the prefix of the
+function names.
+
+Before::
+
+  def pypom_after_wait_for_page_to_load(page):
+      pass
+
+After::
+
+  from pypom import hookimpl
+
+  @hookimpl
+  def pypom_after_wait_for_page_to_load(page):
+      pass

src/pypom/view.py

@@ -18,7 +18,7 @@ def __init__(self, driver, timeout, pm=None):
         self.timeout = timeout
         self.pm = pm
         if self.pm is None:
-            self.pm = PluginManager("pypom", implprefix="pypom_")
+            self.pm = PluginManager("pypom")
             self.pm.add_hookspecs(hooks)
             self.pm.load_setuptools_entrypoints("pypom.plugin")
             self.pm.check_pending()

tests/test_plugin.py

@@ -2,16 +2,18 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-from pypom import Region
+from pypom import Region, hookimpl
 
 
 def test_after_wait_for_page_to_load(page):
     log = []
 
     class Plugin:
+        @hookimpl
         def pypom_after_wait_for_page_to_load(self, page):
             log.append(1)
 
+        @hookimpl
         def pypom_after_wait_for_region_to_load(self, region):
             log.append(2)