You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

482 lines
15 KiB

4 years ago
  1. Metadata-Version: 2.1
  2. Name: pluggy
  3. Version: 0.13.1
  4. Summary: plugin and hook calling mechanisms for python
  5. Home-page: https://github.com/pytest-dev/pluggy
  6. Author: Holger Krekel
  7. Author-email: holger@merlinux.eu
  8. License: MIT license
  9. Platform: unix
  10. Platform: linux
  11. Platform: osx
  12. Platform: win32
  13. Classifier: Development Status :: 4 - Beta
  14. Classifier: Intended Audience :: Developers
  15. Classifier: License :: OSI Approved :: MIT License
  16. Classifier: Operating System :: POSIX
  17. Classifier: Operating System :: Microsoft :: Windows
  18. Classifier: Operating System :: MacOS :: MacOS X
  19. Classifier: Topic :: Software Development :: Testing
  20. Classifier: Topic :: Software Development :: Libraries
  21. Classifier: Topic :: Utilities
  22. Classifier: Programming Language :: Python :: Implementation :: CPython
  23. Classifier: Programming Language :: Python :: Implementation :: PyPy
  24. Classifier: Programming Language :: Python :: 2
  25. Classifier: Programming Language :: Python :: 2.7
  26. Classifier: Programming Language :: Python :: 3
  27. Classifier: Programming Language :: Python :: 3.4
  28. Classifier: Programming Language :: Python :: 3.5
  29. Classifier: Programming Language :: Python :: 3.6
  30. Classifier: Programming Language :: Python :: 3.7
  31. Classifier: Programming Language :: Python :: 3.8
  32. Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
  33. Requires-Dist: importlib-metadata (>=0.12) ; python_version < "3.8"
  34. Provides-Extra: dev
  35. Requires-Dist: pre-commit ; extra == 'dev'
  36. Requires-Dist: tox ; extra == 'dev'
  37. ====================================================
  38. pluggy - A minimalist production ready plugin system
  39. ====================================================
  40. |pypi| |conda-forge| |versions| |travis| |appveyor| |gitter| |black| |codecov|
  41. This is the core framework used by the `pytest`_, `tox`_, and `devpi`_ projects.
  42. Please `read the docs`_ to learn more!
  43. A definitive example
  44. ====================
  45. .. code-block:: python
  46. import pluggy
  47. hookspec = pluggy.HookspecMarker("myproject")
  48. hookimpl = pluggy.HookimplMarker("myproject")
  49. class MySpec(object):
  50. """A hook specification namespace.
  51. """
  52. @hookspec
  53. def myhook(self, arg1, arg2):
  54. """My special little hook that you can customize.
  55. """
  56. class Plugin_1(object):
  57. """A hook implementation namespace.
  58. """
  59. @hookimpl
  60. def myhook(self, arg1, arg2):
  61. print("inside Plugin_1.myhook()")
  62. return arg1 + arg2
  63. class Plugin_2(object):
  64. """A 2nd hook implementation namespace.
  65. """
  66. @hookimpl
  67. def myhook(self, arg1, arg2):
  68. print("inside Plugin_2.myhook()")
  69. return arg1 - arg2
  70. # create a manager and add the spec
  71. pm = pluggy.PluginManager("myproject")
  72. pm.add_hookspecs(MySpec)
  73. # register plugins
  74. pm.register(Plugin_1())
  75. pm.register(Plugin_2())
  76. # call our ``myhook`` hook
  77. results = pm.hook.myhook(arg1=1, arg2=2)
  78. print(results)
  79. Running this directly gets us::
  80. $ python docs/examples/toy-example.py
  81. inside Plugin_2.myhook()
  82. inside Plugin_1.myhook()
  83. [-1, 3]
  84. .. badges
  85. .. |pypi| image:: https://img.shields.io/pypi/v/pluggy.svg
  86. :target: https://pypi.org/pypi/pluggy
  87. .. |versions| image:: https://img.shields.io/pypi/pyversions/pluggy.svg
  88. :target: https://pypi.org/pypi/pluggy
  89. .. |travis| image:: https://img.shields.io/travis/pytest-dev/pluggy/master.svg
  90. :target: https://travis-ci.org/pytest-dev/pluggy
  91. .. |appveyor| image:: https://img.shields.io/appveyor/ci/pytestbot/pluggy/master.svg
  92. :target: https://ci.appveyor.com/project/pytestbot/pluggy
  93. .. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pluggy.svg
  94. :target: https://anaconda.org/conda-forge/pytest
  95. .. |gitter| image:: https://badges.gitter.im/pytest-dev/pluggy.svg
  96. :alt: Join the chat at https://gitter.im/pytest-dev/pluggy
  97. :target: https://gitter.im/pytest-dev/pluggy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
  98. .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
  99. :target: https://github.com/ambv/black
  100. .. |codecov| image:: https://codecov.io/gh/pytest-dev/pluggy/branch/master/graph/badge.svg
  101. :target: https://codecov.io/gh/pytest-dev/pluggy
  102. :alt: Code coverage Status
  103. .. links
  104. .. _pytest:
  105. http://pytest.org
  106. .. _tox:
  107. https://tox.readthedocs.org
  108. .. _devpi:
  109. http://doc.devpi.net
  110. .. _read the docs:
  111. https://pluggy.readthedocs.io/en/latest/
  112. =========
  113. Changelog
  114. =========
  115. .. towncrier release notes start
  116. pluggy 0.13.1 (2019-11-21)
  117. ==========================
  118. Trivial/Internal Changes
  119. ------------------------
  120. - `#236 <https://github.com/pytest-dev/pluggy/pull/236>`_: Improved documentation, especially with regard to references.
  121. pluggy 0.13.0 (2019-09-10)
  122. ==========================
  123. Trivial/Internal Changes
  124. ------------------------
  125. - `#222 <https://github.com/pytest-dev/pluggy/issues/222>`_: Replace ``importlib_metadata`` backport with ``importlib.metadata`` from the
  126. standard library on Python 3.8+.
  127. pluggy 0.12.0 (2019-05-27)
  128. ==========================
  129. Features
  130. --------
  131. - `#215 <https://github.com/pytest-dev/pluggy/issues/215>`_: Switch from ``pkg_resources`` to ``importlib-metadata`` for entrypoint detection for improved performance and import time. This time with ``.egg`` support.
  132. pluggy 0.11.0 (2019-05-07)
  133. ==========================
  134. Bug Fixes
  135. ---------
  136. - `#205 <https://github.com/pytest-dev/pluggy/issues/205>`_: Revert changes made in 0.10.0 release breaking ``.egg`` installs.
  137. pluggy 0.10.0 (2019-05-07)
  138. ==========================
  139. Features
  140. --------
  141. - `#199 <https://github.com/pytest-dev/pluggy/issues/199>`_: Switch from ``pkg_resources`` to ``importlib-metadata`` for entrypoint detection for improved performance and import time.
  142. pluggy 0.9.0 (2019-02-21)
  143. =========================
  144. Features
  145. --------
  146. - `#189 <https://github.com/pytest-dev/pluggy/issues/189>`_: ``PluginManager.load_setuptools_entrypoints`` now accepts a ``name`` parameter that when given will
  147. load only entry points with that name.
  148. ``PluginManager.load_setuptools_entrypoints`` also now returns the number of plugins loaded by the
  149. call, as opposed to the number of all plugins loaded by all calls to this method.
  150. Bug Fixes
  151. ---------
  152. - `#187 <https://github.com/pytest-dev/pluggy/issues/187>`_: Fix internal ``varnames`` function for PyPy3.
  153. pluggy 0.8.1 (2018-11-09)
  154. =========================
  155. Trivial/Internal Changes
  156. ------------------------
  157. - `#166 <https://github.com/pytest-dev/pluggy/issues/166>`_: Add ``stacklevel=2`` to implprefix warning so that the reported location of warning is the caller of PluginManager.
  158. pluggy 0.8.0 (2018-10-15)
  159. =========================
  160. Features
  161. --------
  162. - `#177 <https://github.com/pytest-dev/pluggy/issues/177>`_: Add ``get_hookimpls()`` method to hook callers.
  163. Trivial/Internal Changes
  164. ------------------------
  165. - `#165 <https://github.com/pytest-dev/pluggy/issues/165>`_: Add changelog in long package description and documentation.
  166. - `#172 <https://github.com/pytest-dev/pluggy/issues/172>`_: Add a test exemplifying the opt-in nature of spec defined args.
  167. - `#57 <https://github.com/pytest-dev/pluggy/issues/57>`_: Encapsulate hook specifications in a type for easier introspection.
  168. pluggy 0.7.1 (2018-07-28)
  169. =========================
  170. Deprecations and Removals
  171. -------------------------
  172. - `#116 <https://github.com/pytest-dev/pluggy/issues/116>`_: Deprecate the ``implprefix`` kwarg to ``PluginManager`` and instead
  173. expect users to start using explicit ``HookimplMarker`` everywhere.
  174. Features
  175. --------
  176. - `#122 <https://github.com/pytest-dev/pluggy/issues/122>`_: Add ``.plugin`` member to ``PluginValidationError`` to access failing plugin during post-mortem.
  177. - `#138 <https://github.com/pytest-dev/pluggy/issues/138>`_: Add per implementation warnings support for hookspecs allowing for both
  178. deprecation and future warnings of legacy and (future) experimental hooks
  179. respectively.
  180. Bug Fixes
  181. ---------
  182. - `#110 <https://github.com/pytest-dev/pluggy/issues/110>`_: Fix a bug where ``_HookCaller.call_historic()`` would call the ``proc``
  183. arg even when the default is ``None`` resulting in a ``TypeError``.
  184. - `#160 <https://github.com/pytest-dev/pluggy/issues/160>`_: Fix problem when handling ``VersionConflict`` errors when loading setuptools plugins.
  185. Improved Documentation
  186. ----------------------
  187. - `#123 <https://github.com/pytest-dev/pluggy/issues/123>`_: Document how exceptions are handled and how the hook call loop
  188. terminates immediately on the first error which is then delivered
  189. to any surrounding wrappers.
  190. - `#136 <https://github.com/pytest-dev/pluggy/issues/136>`_: Docs rework including a much better introduction and comprehensive example
  191. set for new users. A big thanks goes out to @obestwalter for the great work!
  192. Trivial/Internal Changes
  193. ------------------------
  194. - `#117 <https://github.com/pytest-dev/pluggy/issues/117>`_: Break up the main monolithic package modules into separate modules by concern
  195. - `#131 <https://github.com/pytest-dev/pluggy/issues/131>`_: Automate ``setuptools`` wheels building and PyPi upload using TravisCI.
  196. - `#153 <https://github.com/pytest-dev/pluggy/issues/153>`_: Reorganize tests more appropriately by modules relating to each
  197. internal component/feature. This is in an effort to avoid (future)
  198. duplication and better separation of concerns in the test set.
  199. - `#156 <https://github.com/pytest-dev/pluggy/issues/156>`_: Add ``HookImpl.__repr__()`` for better debugging.
  200. - `#66 <https://github.com/pytest-dev/pluggy/issues/66>`_: Start using ``towncrier`` and a custom ``tox`` environment to prepare releases!
  201. pluggy 0.7.0 (Unreleased)
  202. =========================
  203. * `#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.
  204. pluggy 0.6.0 (2017-11-24)
  205. =========================
  206. - Add CI testing for the features, release, and master
  207. branches of ``pytest`` (PR `#79`_).
  208. - Document public API for ``_Result`` objects passed to wrappers
  209. (PR `#85`_).
  210. - Document and test hook LIFO ordering (PR `#85`_).
  211. - Turn warnings into errors in test suite (PR `#89`_).
  212. - Deprecate ``_Result.result`` (PR `#88`_).
  213. - Convert ``_Multicall`` to a simple function distinguishing it from
  214. the legacy version (PR `#90`_).
  215. - Resolve E741 errors (PR `#96`_).
  216. - Test and bug fix for unmarked hook collection (PRs `#97`_ and
  217. `#102`_).
  218. - Drop support for EOL Python 2.6 and 3.3 (PR `#103`_).
  219. - Fix ``inspect`` based arg introspection on py3.6 (PR `#94`_).
  220. .. _#79: https://github.com/pytest-dev/pluggy/pull/79
  221. .. _#85: https://github.com/pytest-dev/pluggy/pull/85
  222. .. _#88: https://github.com/pytest-dev/pluggy/pull/88
  223. .. _#89: https://github.com/pytest-dev/pluggy/pull/89
  224. .. _#90: https://github.com/pytest-dev/pluggy/pull/90
  225. .. _#94: https://github.com/pytest-dev/pluggy/pull/94
  226. .. _#96: https://github.com/pytest-dev/pluggy/pull/96
  227. .. _#97: https://github.com/pytest-dev/pluggy/pull/97
  228. .. _#102: https://github.com/pytest-dev/pluggy/pull/102
  229. .. _#103: https://github.com/pytest-dev/pluggy/pull/103
  230. pluggy 0.5.2 (2017-09-06)
  231. =========================
  232. - fix bug where ``firstresult`` wrappers were being sent an incorrectly configured
  233. ``_Result`` (a list was set instead of a single value). Add tests to check for
  234. this as well as ``_Result.force_result()`` behaviour. Thanks to `@tgoodlet`_
  235. for the PR `#72`_.
  236. - fix incorrect ``getattr`` of ``DeprecationWarning`` from the ``warnings``
  237. module. Thanks to `@nicoddemus`_ for the PR `#77`_.
  238. - hide ``pytest`` tracebacks in certain core routines. Thanks to
  239. `@nicoddemus`_ for the PR `#80`_.
  240. .. _#72: https://github.com/pytest-dev/pluggy/pull/72
  241. .. _#77: https://github.com/pytest-dev/pluggy/pull/77
  242. .. _#80: https://github.com/pytest-dev/pluggy/pull/80
  243. pluggy 0.5.1 (2017-08-29)
  244. =========================
  245. - fix a bug and add tests for case where ``firstresult`` hooks return
  246. ``None`` results. Thanks to `@RonnyPfannschmidt`_ and `@tgoodlet`_
  247. for the issue (`#68`_) and PR (`#69`_) respectively.
  248. .. _#69: https://github.com/pytest-dev/pluggy/pull/69
  249. .. _#68: https://github.com/pytest-dev/pluggy/issues/68
  250. pluggy 0.5.0 (2017-08-28)
  251. =========================
  252. - fix bug where callbacks for historic hooks would not be called for
  253. already registered plugins. Thanks `@vodik`_ for the PR
  254. and `@hpk42`_ for further fixes.
  255. - fix `#17`_ by considering only actual functions for hooks
  256. this removes the ability to register arbitrary callable objects
  257. which at first glance is a reasonable simplification,
  258. thanks `@RonnyPfannschmidt`_ for report and pr.
  259. - fix `#19`_: allow registering hookspecs from instances. The PR from
  260. `@tgoodlet`_ also modernized the varnames implementation.
  261. - resolve `#32`_: split up the test set into multiple modules.
  262. Thanks to `@RonnyPfannschmidt`_ for the PR and `@tgoodlet`_ for
  263. the initial request.
  264. - resolve `#14`_: add full sphinx docs. Thanks to `@tgoodlet`_ for
  265. PR `#39`_.
  266. - add hook call mismatch warnings. Thanks to `@tgoodlet`_ for the
  267. PR `#42`_.
  268. - resolve `#44`_: move to new-style classes. Thanks to `@MichalTHEDUDE`_
  269. for PR `#46`_.
  270. - add baseline benchmarking/speed tests using ``pytest-benchmark``
  271. in PR `#54`_. Thanks to `@tgoodlet`_.
  272. - update the README to showcase the API. Thanks to `@tgoodlet`_ for the
  273. issue and PR `#55`_.
  274. - deprecate ``__multicall__`` and add a faster call loop implementation.
  275. Thanks to `@tgoodlet`_ for PR `#58`_.
  276. - raise a comprehensible error when a ``hookimpl`` is called with positional
  277. args. Thanks to `@RonnyPfannschmidt`_ for the issue and `@tgoodlet`_ for
  278. PR `#60`_.
  279. - fix the ``firstresult`` test making it more complete
  280. and remove a duplicate of that test. Thanks to `@tgoodlet`_
  281. for PR `#62`_.
  282. .. _#62: https://github.com/pytest-dev/pluggy/pull/62
  283. .. _#60: https://github.com/pytest-dev/pluggy/pull/60
  284. .. _#58: https://github.com/pytest-dev/pluggy/pull/58
  285. .. _#55: https://github.com/pytest-dev/pluggy/pull/55
  286. .. _#54: https://github.com/pytest-dev/pluggy/pull/54
  287. .. _#46: https://github.com/pytest-dev/pluggy/pull/46
  288. .. _#44: https://github.com/pytest-dev/pluggy/issues/44
  289. .. _#42: https://github.com/pytest-dev/pluggy/pull/42
  290. .. _#39: https://github.com/pytest-dev/pluggy/pull/39
  291. .. _#32: https://github.com/pytest-dev/pluggy/pull/32
  292. .. _#19: https://github.com/pytest-dev/pluggy/issues/19
  293. .. _#17: https://github.com/pytest-dev/pluggy/issues/17
  294. .. _#14: https://github.com/pytest-dev/pluggy/issues/14
  295. pluggy 0.4.0 (2016-09-25)
  296. =========================
  297. - add ``has_plugin(name)`` method to pluginmanager. thanks `@nicoddemus`_.
  298. - fix `#11`_: make plugin parsing more resilient against exceptions
  299. from ``__getattr__`` functions. Thanks `@nicoddemus`_.
  300. - fix issue `#4`_: specific ``HookCallError`` exception for when a hook call
  301. provides not enough arguments.
  302. - better error message when loading setuptools entrypoints fails
  303. due to a ``VersionConflict``. Thanks `@blueyed`_.
  304. .. _#11: https://github.com/pytest-dev/pluggy/issues/11
  305. .. _#4: https://github.com/pytest-dev/pluggy/issues/4
  306. pluggy 0.3.1 (2015-09-17)
  307. =========================
  308. - avoid using deprecated-in-python3.5 getargspec method. Thanks
  309. `@mdboom`_.
  310. pluggy 0.3.0 (2015-05-07)
  311. =========================
  312. initial release
  313. .. contributors
  314. .. _@hpk42: https://github.com/hpk42
  315. .. _@tgoodlet: https://github.com/goodboy
  316. .. _@MichalTHEDUDE: https://github.com/MichalTHEDUDE
  317. .. _@vodik: https://github.com/vodik
  318. .. _@RonnyPfannschmidt: https://github.com/RonnyPfannschmidt
  319. .. _@blueyed: https://github.com/blueyed
  320. .. _@nicoddemus: https://github.com/nicoddemus
  321. .. _@mdboom: https://github.com/mdboom