Renamed AbstractComponent as ComponentBase.

Author: philthompson10

doc/sysroot.rst

@@ -123,4 +123,25 @@ The full set of command line options is:
 Writing A Component Plugin
 --------------------------
 
-TODO - describe the API
+A component plugin is a Python module that defines a sub-class of
+:py:class:`pyqtdeploy.ComponentBase`.  The sub-class must re-implement the
+:py:meth:`~pyqtdeploy.ComponentBase.build` method and may also
+re-implement the :py:meth:`~pyqtdeploy.ComponentBase.configure` method.  It
+should also include a class attribute called
+:py:attr:`~pyqtdeploy.ComponentBase.options` which is a sequence of
+:py:class:`pyqtdeploy.ComponentOption` instances that describe each of the
+component's configurable options.
+
+.. py:module:: pyqtdeploy
+
+.. py:class:: ComponentBase
+
+    .. py:attribute:: options
+
+    .. py:method:: build(sysroot)
+
+    .. py:method:: configure(sysroot)
+
+.. py:class:: ComponentOption(name, type, required=False, default=None, values=None, help=None)
+
+.. py:class:: Sysroot

pyqtdeploy/__init__.py

@@ -33,5 +33,5 @@
 from .version import PYQTDEPLOY_RELEASE
 
 
-# These are for the component plugins.
-from .sysroot import AbstractComponent, ComponentOption
+# These are for component plugins.
+from .sysroot import ComponentBase, ComponentOption

pyqtdeploy/sysroot/__init__.py

@@ -24,6 +24,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 
-# Publish the component API.
-from .abstract_component import AbstractComponent, ComponentOption
+# Publish the sub-package's API.
+from .component import ComponentBase, ComponentOption
 from .sysroot import Sysroot

pyqtdeploy/sysroot/abstract_component.py renamed to pyqtdeploy/sysroot/component.py

@@ -27,6 +27,22 @@
 from abc import ABC, abstractmethod
 
 
+class ComponentBase(ABC):
+    """ The base class for the implementation of a component plugin. """
+
+    # A sequence of ComponentOption instances describing the options that can
+    # be specified for the component in the specification file.  These are made
+    # available as attributes of the plugin instance.
+    options = []
+
+    @abstractmethod
+    def build(self, sysroot):
+        """ Build the component. """
+
+    def configure(self, sysroot):
+        """ Complete the configuration of the component. """
+
+
 class ComponentOption:
     """ Encapsulate an option for the component in the specification file. """
 
@@ -57,19 +73,3 @@ def _format_value(self, value):
             value = "'" + value + "'"
 
         return value
-
-
-class AbstractComponent(ABC):
-    """ The base class for the implementation of a component plugin. """
-
-    # A sequence of ComponentOption instances describing the options that can
-    # be specified for the component in the specification file.  These are made
-    # available as attributes of the plugin instance.
-    options = []
-
-    @abstractmethod
-    def build(self, sysroot, debug):
-        """ Build the component. """
-
-    def configure(self, sysroot):
-        """ Complete the configuration of the component. """

pyqtdeploy/sysroot/plugins/openssl.py

@@ -28,10 +28,10 @@
 import os
 import sys
 
-from ... import AbstractComponent, ComponentOption
+from ... import ComponentBase, ComponentOption
 
 
-class OpenSSLComponent(AbstractComponent):
+class OpenSSLComponent(ComponentBase):
     """ The OpenSSL component. """
 
     # The component options.

pyqtdeploy/sysroot/plugins/pip.py

@@ -24,10 +24,10 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 
-from ... import AbstractComponent, ComponentOption
+from ... import ComponentBase, ComponentOption
 
 
-class pipComponent(AbstractComponent):
+class pipComponent(ComponentBase):
     """ The pip meta-component. """
 
     # The component options.

pyqtdeploy/sysroot/plugins/pyqt3d.py

@@ -26,10 +26,10 @@
 
 import os
 
-from ... import AbstractComponent, ComponentOption
+from ... import ComponentBase, ComponentOption
 
 
-class PyQt3DComponent(AbstractComponent):
+class PyQt3DComponent(ComponentBase):
     """ The PyQt3D component. """
 
     # The component options.

pyqtdeploy/sysroot/plugins/pyqt5.py

@@ -26,10 +26,10 @@
 
 import os
 
-from ... import AbstractComponent, ComponentOption
+from ... import ComponentBase, ComponentOption
 
 
-class PyQt5Component(AbstractComponent):
+class PyQt5Component(ComponentBase):
     """ The PyQt5 component. """
 
     # The component options.

pyqtdeploy/sysroot/plugins/pyqtchart.py

@@ -26,10 +26,10 @@
 
 import os
 
-from ... import AbstractComponent, ComponentOption
+from ... import ComponentBase, ComponentOption
 
 
-class PyQtChartComponent(AbstractComponent):
+class PyQtChartComponent(ComponentBase):
     """ The PyQtChart component. """
 
     # The component options.

pyqtdeploy/sysroot/plugins/pyqtdatavisualization.py

@@ -26,10 +26,10 @@
 
 import os
 
-from ... import AbstractComponent, ComponentOption
+from ... import ComponentBase, ComponentOption
 
 
-class PyQtDataVisualizationComponent(AbstractComponent):
+class PyQtDataVisualizationComponent(ComponentBase):
     """ The PyQtDataVisualization component. """
 
     # The component options.

pyqtdeploy/sysroot/plugins/pyqtpurchasing.py

@@ -26,10 +26,10 @@
 
 import os
 
-from ... import AbstractComponent, ComponentOption
+from ... import ComponentBase, ComponentOption
 
 
-class PyQtPurchasingComponent(AbstractComponent):
+class PyQtPurchasingComponent(ComponentBase):
     """ The PyQtPurchasing component. """
 
     # The component options.

pyqtdeploy/sysroot/plugins/python/python.py

@@ -28,12 +28,12 @@
 import shutil
 import sys
 
-from .... import AbstractComponent, ComponentOption
+from .... import ComponentBase, ComponentOption
 
 from .configure_python import configure_python
 
 
-class PythonComponent(AbstractComponent):
+class PythonComponent(ComponentBase):
     """ The host and target Python component. """
 
     # The component options.

pyqtdeploy/sysroot/plugins/qscintilla.py

@@ -26,10 +26,10 @@
 
 import os
 
-from ... import AbstractComponent, ComponentOption
+from ... import ComponentBase, ComponentOption
 
 
-class QScintillaComponent(AbstractComponent):
+class QScintillaComponent(ComponentBase):
     """ The QScintilla component. """
 
     # The component options.

pyqtdeploy/sysroot/plugins/qt5.py

@@ -27,10 +27,10 @@
 import os
 import sys
 
-from ... import AbstractComponent, ComponentOption
+from ... import ComponentBase, ComponentOption
 
 
-class Qt5Component(AbstractComponent):
+class Qt5Component(ComponentBase):
     """ The Qt5 component. """
 
     # The component options.

pyqtdeploy/sysroot/plugins/sip.py

@@ -26,10 +26,10 @@
 
 import os
 
-from ... import AbstractComponent, ComponentOption
+from ... import ComponentBase, ComponentOption
 
 
-class SIPComponent(AbstractComponent):
+class SIPComponent(ComponentBase):
     """ The SIP component. """
 
     # The component options.

pyqtdeploy/sysroot/specification.py

@@ -32,7 +32,7 @@
 from collections import OrderedDict
 
 from ..user_exception import UserException
-from .abstract_component import AbstractComponent
+from .component import ComponentBase
 
 
 class Specification:
@@ -114,7 +114,7 @@ def __init__(self, spec_file, plugin_dirs, target):
                         self._parse_options(config, options, component,
                                 spec_file)
 
-                    if cls is AbstractComponent:
+                    if cls is ComponentBase:
                         break
 
                 unused = config.keys()
@@ -198,7 +198,7 @@ def _plugin_from_module(self, fq_name, plugin_module):
 
         for component_type in plugin_module.__dict__.values():
             if isinstance(component_type, type):
-                if issubclass(component_type, AbstractComponent):
+                if issubclass(component_type, ComponentBase):
                     # Make sure the type is defined in the plugin and not
                     # imported by it.  Allow for a plugin implemented as a
                     # sub-package.
@@ -287,7 +287,7 @@ def show_options(self, components, message_handler):
                         if widths[1] < name_len:
                             widths[1] = name_len
 
-                if cls is AbstractComponent:
+                if cls is ComponentBase:
                     break
 
             options[component.name] = component_options