The default type of a component option is now str.

Author: philthompson10

doc/riverbank/static/riverbank.css

@@ -15,3 +15,11 @@ h2 a:visited {
 .classtable {
     width: 100%;
 }
+
+th.field-name {
+    background: none;
+}
+
+th.head {
+    background: lightgray;
+}

doc/sysroot.rst

@@ -120,7 +120,7 @@ The full set of command line options is:
     configured.
 
 
-Writing A Component Plugin
+Writing a Component Plugin
 --------------------------
 
 A component plugin is a Python module that defines a sub-class of
@@ -130,18 +130,52 @@ 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.
+component's configurable options.  It does not matter what the name of the
+class is.
 
 .. py:module:: pyqtdeploy
 
 .. py:class:: ComponentBase
 
+    This is the base class of all component plugins.
+
     .. py:attribute:: options
 
+        This class attribute is a sequence of
+        :py:class:`~pyqtdeploy.ComponentOption` instances describing the
+        component's configurable options.
+
     .. py:method:: build(sysroot)
 
+        This abstract method is re-implemented to build the component.
+
+        :param Sysroot sysroot:  the sysroot being built.
+
     .. py:method:: configure(sysroot)
 
-.. py:class:: ComponentOption(name, type, required=False, default=None, values=None, help=None)
+        This method is re-implemented to configure the component.  A component
+        will always be configured even if it does not get built.
+
+        :param Sysroot sysroot:  the sysroot being configured.
+
+.. py:class:: ComponentOption(name, type=str, required=False, default=None, values=None, help='')
+
+    This class implements an option used to configure the component.  An option
+    can be specified as an attribute of the component's object in the sysroot
+    specification file.  An instance of the component plugin will contain an
+    attribute for each option whose value is that specified in the sysroot
+    specification file (or an appropriate default if it was omitted).
+
+    :param str name: the name of the option.
+    :param type type: the type of the option (either ``bool``, ``int``,
+        ``list`` or ``str``).
+    :param bool required: ``True`` if a value for the option is required.
+    :param default: the default value of the option.
+    :param values: the possible values of the option.
+    :param str help: the help text displayed by the
+        :option:`--options <pyqtdeploy-sysroot --options>` option of
+        :program:`pyqtdeploy-sysroot`.
 
 .. py:class:: Sysroot
+
+    This class encapsulates a sysroot as seen by a component plugin.

pyqtdeploy/sysroot/component.py

@@ -46,7 +46,7 @@ def configure(self, sysroot):
 class ComponentOption:
     """ Encapsulate an option for the component in the specification file. """
 
-    def __init__(self, name, type, required=False, default=None, values=None, help=None):
+    def __init__(self, name, type=str, required=False, default=None, values=None, help=''):
         """ Initialise the object. """
 
         self.name = name

pyqtdeploy/sysroot/plugins/openssl.py

@@ -36,9 +36,9 @@ class OpenSSLComponent(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('python_source', str,
+        ComponentOption('python_source',
                 help="The archive of the Python source code containing patches to build OpenSSL on macOS."),
-        ComponentOption('source', str, required=True,
+        ComponentOption('source', required=True,
                 help="The archive containing the OpenSSL source code."),
     ]
 

pyqtdeploy/sysroot/plugins/pip.py

@@ -32,7 +32,7 @@ class pipComponent(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('packages', list, required=True,
+        ComponentOption('packages', type=list, required=True,
                 help="The packages to be installed by pip."),
     ]
 

pyqtdeploy/sysroot/plugins/pyqt3d.py

@@ -34,7 +34,7 @@ class PyQt3DComponent(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('source', str, required=True,
+        ComponentOption('source', required=True,
                 help="The archive containing the PyQt3D source code."),
     ]
 

pyqtdeploy/sysroot/plugins/pyqt5.py

@@ -34,11 +34,11 @@ class PyQt5Component(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('disabled_features', list,
+        ComponentOption('disabled_features', type=list,
                 help="The features that are disabled."),
-        ComponentOption('modules', list, required=True,
+        ComponentOption('modules', type=list, required=True,
                 help="The extension modules to be built."),
-        ComponentOption('source', str, required=True,
+        ComponentOption('source', required=True,
                 help="The archive containing the PyQt5 source code."),
     ]
 

pyqtdeploy/sysroot/plugins/pyqtchart.py

@@ -34,7 +34,7 @@ class PyQtChartComponent(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('source', str, required=True,
+        ComponentOption('source', required=True,
                 help="The archive containing the PyQtChart source code."),
     ]
 

pyqtdeploy/sysroot/plugins/pyqtdatavisualization.py

@@ -34,7 +34,7 @@ class PyQtDataVisualizationComponent(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('source', str, required=True,
+        ComponentOption('source', required=True,
                 help="The archive containing the PyQtDataVisualization source code."),
     ]
 

pyqtdeploy/sysroot/plugins/pyqtpurchasing.py

@@ -34,7 +34,7 @@ class PyQtPurchasingComponent(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('source', str, required=True,
+        ComponentOption('source', required=True,
                 help="The archive containing the PyQtPurchasing source code."),
     ]
 

pyqtdeploy/sysroot/plugins/python/python.py

@@ -38,13 +38,13 @@ class PythonComponent(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('build_host_from_source', bool,
+        ComponentOption('build_host_from_source', type=bool,
                 help="Build the host Python from source code rather than use an existing installation."),
-        ComponentOption('build_target_from_source', bool,
+        ComponentOption('build_target_from_source', type=bool,
                 help="Build the target Python from source code rather than use an existing installation."),
-        ComponentOption('dynamic_loading', bool,
+        ComponentOption('dynamic_loading', type=bool,
                 help="Set to enable support for the dynamic loading of extension modules when building from source."),
-        ComponentOption('source', str, required=True,
+        ComponentOption('source', required=True,
                 help="The archive containing the Python source code."),
     ]
 

pyqtdeploy/sysroot/plugins/qscintilla.py

@@ -34,7 +34,7 @@ class QScintillaComponent(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('source', str, required=True,
+        ComponentOption('source', required=True,
                 help="The archive containing the QScintilla source code."),
     ]
 

pyqtdeploy/sysroot/plugins/qt5.py

@@ -35,21 +35,21 @@ class Qt5Component(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('configure_options', list,
+        ComponentOption('configure_options', type=list,
                 help="The additional options to be passed to 'configure' when building from source."),
-        ComponentOption('disabled_features', list,
+        ComponentOption('disabled_features', type=list,
                 help="The features that are disabled when building from source."),
-        ComponentOption('qt_dir', str,
+        ComponentOption('qt_dir',
                 help="The pathname of the directory containing an existing Qt5 installation to use. If it is not specified then the installation will be built from source."),
-        ComponentOption('ssl', str,
+        ComponentOption('ssl',
                 values=['openssl-linked', 'openssl-runtime',
                         'securetransport'],
                 help="Enable SSL support."),
-        ComponentOption('skip', list,
+        ComponentOption('skip', type=list,
                 help="The Qt modules to skip when building from source."),
-        ComponentOption('source', str,
+        ComponentOption('source',
                 help="The archive containing the Qt5 source code if an existing installation is not to be used."),
-        ComponentOption('static_msvc_runtime', bool,
+        ComponentOption('static_msvc_runtime', type=bool,
                 help="Set if the MSVC runtime should be statically linked."),
     ]
 

pyqtdeploy/sysroot/plugins/sip.py

@@ -34,7 +34,7 @@ class SIPComponent(ComponentBase):
 
     # The component options.
     options = [
-        ComponentOption('source', str, required=True,
+        ComponentOption('source', required=True,
                 help="The archive containing the SIP source code."),
     ]