summaryrefslogtreecommitdiffstats
path: root/python/mach/docs/driver.rst
blob: 8a2a99a2f5d9919e065c89ae52b17cd49ad7ae9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
.. _mach_driver:

=======
Drivers
=======

Entry Points
============

It is possible to use setuptools' entry points to load commands
directly from python packages. A mach entry point is a function which
returns a list of files or directories containing mach command
providers. e.g.:

.. code-block:: python

   def list_providers():
       providers = []
       here = os.path.abspath(os.path.dirname(__file__))
       for p in os.listdir(here):
           if p.endswith('.py'):
               providers.append(os.path.join(here, p))
       return providers

See http://pythonhosted.org/setuptools/setuptools.html#dynamic-discovery-of-services-and-plugins
for more information on creating an entry point. To search for entry
point plugins, you can call
:py:meth:`mach.main.Mach.load_commands_from_entry_point`. e.g.:

.. code-block:: python

   mach.load_commands_from_entry_point("mach.external.providers")