.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+-   repo: https://github.com/ambv/black
+    rev: 18.6b4
+    hooks:
+    -   id: black
+        args: [--safe, --quiet]
+        language_version: python3.6
+-   repo: https://github.com/asottile/blacken-docs
+    rev: v0.2.0
+    hooks:
+    -   id: blacken-docs
+        additional_dependencies: [black==18.6b4]
+        language_version: python3.6
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v1.3.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: flake8
+-   repo: local
+    hooks:
+    -   id: rst
+        name: rst
+        entry: rst-lint --encoding utf-8
+        files: ^(CHANGELOG.rst|HOWTORELEASE.rst|README.rst|changelog/.*)$
+        language: python
+        additional_dependencies: [pygments, restructuredtext_lint]
+        python_version: python3.6
+-   repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.0.0
+    hooks:
+    -   id: rst-backticks

.travis.yml

@@ -4,7 +4,7 @@ language: python
 jobs:
   include:
     - python: '3.6'
-      env: TOXENV=check
+      env: TOXENV=linting
     - python: '3.6'
       env: TOXENV=docs
     - python: '2.7'

CHANGELOG.rst

@@ -1,3 +1,32 @@
+pluggy 0.8.0 (2018-10-15)
+=========================
+
+Features
+--------
+
+- `#177 <https://github.com/pytest-dev/pluggy/issues/177>`_: Add ``get_hookimpls()`` method to hook callers.
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#165 <https://github.com/pytest-dev/pluggy/issues/165>`_: Add changelog in long package description and documentation.
+
+
+- `#172 <https://github.com/pytest-dev/pluggy/issues/172>`_: Add a test exemplifying the opt-in nature of spec defined args.
+
+
+- `#57 <https://github.com/pytest-dev/pluggy/issues/57>`_: Encapsulate hook specifications in a type for easier introspection.
+
+
+=========
+Changelog
+=========
+
+.. towncrier release notes start
+
+
 pluggy 0.7.1 (2018-07-28)
 =========================
 
@@ -69,8 +98,9 @@ pluggy 0.7.0 (Unreleased)
 
 * `#160 <https://github.com/pytest-dev/pluggy/issues/160>`_: We discovered a deployment issue so this version was never released to PyPI, only the tag exists.
 
-0.6.0
------
+pluggy 0.6.0 (2017-11-24)
+=========================
+
 - Add CI testing for the features, release, and master
   branches of ``pytest`` (PR `#79`_).
 - Document public API for ``_Result`` objects passed to wrappers
@@ -98,8 +128,9 @@ pluggy 0.7.0 (Unreleased)
 .. _#103: https://github.com/pytest-dev/pluggy/pull/103
 
 
-0.5.2
------
+pluggy 0.5.2 (2017-09-06)
+=========================
+
 - fix bug where ``firstresult`` wrappers were being sent an incorrectly configured
   ``_Result`` (a list was set instead of a single value). Add tests to check for
   this as well as ``_Result.force_result()`` behaviour. Thanks to `@tgoodlet`_
@@ -116,8 +147,9 @@ pluggy 0.7.0 (Unreleased)
 .. _#80: https://github.com/pytest-dev/pluggy/pull/80
 
 
-0.5.1
------
+pluggy 0.5.1 (2017-08-29)
+=========================
+
 - fix a bug and add tests for case where ``firstresult`` hooks return
   ``None`` results. Thanks to `@RonnyPfannschmidt`_ and `@tgoodlet`_
   for the issue (`#68`_) and PR (`#69`_) respectively.
@@ -126,8 +158,9 @@ pluggy 0.7.0 (Unreleased)
 .. _#68: https://github.com/pytest-dev/pluggy/issues/68
 
 
-0.5.0
------
+pluggy 0.5.0 (2017-08-28)
+=========================
+
 - fix bug where callbacks for historic hooks would not be called for
   already registered plugins.  Thanks `@vodik`_ for the PR
   and `@hpk42`_ for further fixes.
@@ -185,8 +218,9 @@ pluggy 0.7.0 (Unreleased)
 .. _#14: https://github.com/pytest-dev/pluggy/issues/14
 
 
-0.4.0
------
+pluggy 0.4.0 (2016-09-25)
+=========================
+
 - add ``has_plugin(name)`` method to pluginmanager.  thanks `@nicoddemus`_.
 
 - fix `#11`_: make plugin parsing more resilient against exceptions
@@ -202,14 +236,16 @@ pluggy 0.7.0 (Unreleased)
 .. _#4: https://github.com/pytest-dev/pluggy/issues/4
 
 
-0.3.1
------
+pluggy 0.3.1 (2015-09-17)
+=========================
+
 - avoid using deprecated-in-python3.5 getargspec method. Thanks
   `@mdboom`_.
 
 
-0.3.0
------
+pluggy 0.3.0 (2015-05-07)
+=========================
+
 initial release
 
 .. contributors

HOWTORELEASE.rst

@@ -21,4 +21,3 @@ Release Procedure
 #. Make sure it is `available on PyPI <https://pypi.org/project/pluggy>`_.
 
 #. Merge the PR into ``master``, either manually or using GitHub's web interface.
-

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 holger krekel (rather uses bitbucket/hpk42) 
+Copyright (c) 2015 holger krekel (rather uses bitbucket/hpk42)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

README.rst

@@ -1,14 +1,15 @@
+====================================================
 pluggy - A minimalist production ready plugin system
 ====================================================
-|pypi| |anaconda| |versions| |travis| |appveyor|
 
+|pypi| |anaconda| |versions| |travis| |appveyor| |gitter| |black|
 
 This is the core framework used by the `pytest`_, `tox`_, and `devpi`_ projects.
 
 Please `read the docs`_ to learn more!
 
 A definitive example
-********************
+====================
 .. code-block:: python
 
     import pluggy
@@ -20,6 +21,7 @@ A definitive example
     class MySpec(object):
         """A hook specification namespace.
         """
+
         @hookspec
         def myhook(self, arg1, arg2):
             """My special little hook that you can customize.
@@ -29,6 +31,7 @@ A definitive example
     class Plugin_1(object):
         """A hook implementation namespace.
         """
+
         @hookimpl
         def myhook(self, arg1, arg2):
             print("inside Plugin_1.myhook()")
@@ -38,6 +41,7 @@ A definitive example
     class Plugin_2(object):
         """A 2nd hook implementation namespace.
         """
+
         @hookimpl
         def myhook(self, arg1, arg2):
             print("inside Plugin_2.myhook()")
@@ -52,23 +56,35 @@ A definitive example
     pm.register(Plugin_1())
     pm.register(Plugin_2())
 
-    # call our `myhook` hook
+    # call our ``myhook`` hook
     results = pm.hook.myhook(arg1=1, arg2=2)
     print(results)
 
 
 .. badges
+
 .. |pypi| image:: https://img.shields.io/pypi/v/pluggy.svg
     :target: https://pypi.org/pypi/pluggy
+
 .. |versions| image:: https://img.shields.io/pypi/pyversions/pluggy.svg
     :target: https://pypi.org/pypi/pluggy
+
 .. |travis| image:: https://img.shields.io/travis/pytest-dev/pluggy/master.svg
     :target: https://travis-ci.org/pytest-dev/pluggy
+
 .. |appveyor| image:: https://img.shields.io/appveyor/ci/pytestbot/pluggy/master.svg
     :target: https://ci.appveyor.com/project/pytestbot/pluggy
+
 .. |anaconda| image:: https://anaconda.org/conda-forge/pluggy/badges/version.svg
     :target: https://anaconda.org/conda-forge/pluggy
 
+.. |gitter| image:: https://badges.gitter.im/pytest-dev/pluggy.svg
+    :alt: Join the chat at https://gitter.im/pytest-dev/pluggy
+    :target: https://gitter.im/pytest-dev/pluggy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/ambv/black
+
 .. links
 .. _pytest:
     http://pytest.org

appveyor.yml

@@ -1,7 +1,7 @@
 environment:
   matrix:
   # note: please use "tox --listenvs" to populate the build matrix below
-  - TOXENV: "check"
+  - TOXENV: "linting"
   - TOXENV: "docs"
   - TOXENV: "py27-pytestrelease"
   - TOXENV: "py34-pytestrelease"
@@ -32,3 +32,7 @@ build: false  # Not a C# project, build stuff at the test step instead.
 
 test_script:
   - C:\Python35\python -m tox
+
+# We don't deploy anything on tags with AppVeyor, we use Travis instead, so we
+# might as well save resources
+skip_tags: true

docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

docs/conf.py

@@ -3,57 +3,54 @@
 
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.coverage',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.coverage",
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
 
-dist = pkg_resources.get_distribution('pluggy')
+dist = pkg_resources.get_distribution("pluggy")
 project = dist.project_name
-copyright = u'2016, Holger Krekel'
-author = 'Holger Krekel'
+copyright = u"2016, Holger Krekel"
+author = "Holger Krekel"
 
 release = dist.version
 # The short X.Y version.
-version = u'.'.join(dist.version.split('.')[:2])
+version = u".".join(dist.version.split(".")[:2])
 
 
 language = None
 
-pygments_style = 'sphinx'
-html_logo = '_static/img/plug.png'
-html_theme = 'alabaster'
+pygments_style = "sphinx"
+html_logo = "_static/img/plug.png"
+html_theme = "alabaster"
 html_theme_options = {
     # 'logo': 'img/plug.png',
     # 'logo_name': 'true',
-    'description': 'The `pytest` plugin system',
-    'github_user': 'pytest-dev',
-    'github_repo': 'pluggy',
-    'github_button': 'true',
-    'github_banner': 'true',
-    'page_width': '1080px',
-    'fixed_sidebar': 'false',
+    "description": "The `pytest` plugin system",
+    "github_user": "pytest-dev",
+    "github_repo": "pluggy",
+    "github_button": "true",
+    "github_banner": "true",
+    "page_width": "1080px",
+    "fixed_sidebar": "false",
 }
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'pluggy', u'pluggy Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "pluggy", u"pluggy Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -62,10 +59,16 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'pluggy', u'pluggy Documentation',
-     author, 'pluggy', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "pluggy",
+        u"pluggy Documentation",
+        author,
+        "pluggy",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}

docs/examples/eggsample-spam/eggsample_spam.py

@@ -1,5 +1,6 @@
 import eggsample
 
+
 @eggsample.hookimpl
 def eggsample_add_ingredients(ingredients):
     """Here the caller expects us to return a list."""
@@ -9,12 +10,13 @@ def eggsample_add_ingredients(ingredients):
         spam = ["splendiferous spam", "magnificent spam"]
     return spam
 
+
 @eggsample.hookimpl
 def eggsample_prep_condiments(condiments):
     """Here the caller passes a mutable object, so we mess with it directly."""
     try:
         del condiments["steak sauce"]
     except KeyError:
         pass
-    condiments['spam sauce'] = 42
+    condiments["spam sauce"] = 42
     return f"Now this is what I call a condiments tray!"