Refactor configuration object to class based

readthedocs/config/config.py

@@ -76,53 +76,39 @@ def __init__(self, key, code, error_message, source_file=None,
         super(InvalidConfig, self).__init__(message, code=code)
 
 
-class BuildConfig(dict):
+class BuildConfigBase(object):
 
     """
     Config that handles the build of one particular documentation.
 
-    Config keys can be accessed with a dictionary lookup::
-
-        >>> build_config['type']
-        'sphinx'
-
-    You need to call ``validate`` before the config is ready to use. Also
-    setting the ``output_base`` is required before using it for a build.
+    You need to call ``validate`` before the config is ready to use.
+    Also setting the ``output_base`` is required before using it for a build.
     """
 
-    BASE_INVALID_MESSAGE = 'Invalid value for base: {base}'
-    BASE_NOT_A_DIR_MESSAGE = '"base" is not a directory: {base}'
-    NAME_REQUIRED_MESSAGE = 'Missing key "name"'
-    NAME_INVALID_MESSAGE = (
-        'Invalid name "{name}". Valid values must match {name_re}')
-    TYPE_REQUIRED_MESSAGE = 'Missing key "type"'
-    CONF_FILE_REQUIRED_MESSAGE = 'Missing key "conf_file"'
-    PYTHON_INVALID_MESSAGE = '"python" section must be a mapping.'
-    PYTHON_EXTRA_REQUIREMENTS_INVALID_MESSAGE = (
-        '"python.extra_requirements" section must be a list.')
-
-    PYTHON_SUPPORTED_VERSIONS = [2, 2.7, 3, 3.5]
-    DOCKER_SUPPORTED_VERSIONS = ['1.0', '2.0', 'latest']
-
     def __init__(self, env_config, raw_config, source_file, source_position):
         self.env_config = env_config
         self.raw_config = raw_config
         self.source_file = source_file
         self.source_position = source_position
-        super(BuildConfig, self).__init__()
+        super(BuildConfigBase, self).__init__()
 
     def error(self, key, message, code):
         """Raise an error related to ``key``."""
         source = '{file} [{pos}]'.format(
             file=self.source_file,
-            pos=self.source_position)
+            pos=self.source_position
+        )
+        error_message = '{source}: {message}'.format(
+            source=source,
+            message=message
+        )
         raise InvalidConfig(
             key=key,
             code=code,
-            error_message='{source}: {message}'.format(source=source,
-                                                       message=message),
+            error_message=error_message,
             source_file=self.source_file,
-            source_position=self.source_position)
+            source_position=self.source_position
+        )
 
     @contextmanager
     def catch_validation_error(self, key):
@@ -135,7 +121,106 @@ def catch_validation_error(self, key):
                 code=error.code,
                 error_message=str(error),
                 source_file=self.source_file,
-                source_position=self.source_position)
+                source_position=self.source_position
+            )
+
+    def validate(self):
+        raise NotImplementedError()
+
+    @property
+    def base(self):
+        raise NotImplementedError()
+
+    def output_base(self):
+        raise NotImplementedError()
+
+    @property
+    def name(self):
+        raise NotImplementedError()
+
+    @property
+    def version(self):
+        raise NotImplementedError()
+
+    @property
+    def type(self):
+        raise NotImplementedError()
+
+    @property
+    def pip_install(self):
+        raise NotImplementedError()
+
+    @property
+    def install_project(self):
+        raise NotImplementedError()
+
+    @property
+    def extra_requirements(self):
+        raise NotImplementedError()
+
+    @property
+    def python_interpreter(self):
+        raise NotImplementedError()
+
+    @property
+    def python_version(self):
+        raise NotImplementedError()
+
+    @property
+    def python_full_version(self):
+        raise NotImplementedError()
+
+    @property
+    def use_system_site_packages(self):
+        raise NotImplementedError()
+
+    @property
+    def use_conda(self):
+        raise NotImplementedError()
+
+    @property
+    def conda_file(self):
+        raise NotImplementedError()
+
+    @property
+    def requirements_file(self):
+        raise NotImplementedError()
+
+    @property
+    def formats(self):
+        """Documentation formats to be built."""
+        raise NotImplementedError()
+
+    @property
+    def build(self):
+        raise NotImplementedError()
+
+
+class BuildConfig(BuildConfigBase, dict):
+
+    """
+    Version 1 of the configuration file.
+
+    Config keys can be accessed with a dictionary lookup::
+
+        >>> build_config['type']
+        'sphinx'
+    """
+
+    BASE_INVALID_MESSAGE = 'Invalid value for base: {base}'
+    BASE_NOT_A_DIR_MESSAGE = '"base" is not a directory: {base}'
+    NAME_REQUIRED_MESSAGE = 'Missing key "name"'
+    NAME_INVALID_MESSAGE = (
+        'Invalid name "{name}". Valid values must match {name_re}')
+    TYPE_REQUIRED_MESSAGE = 'Missing key "type"'
+    CONF_FILE_REQUIRED_MESSAGE = 'Missing key "conf_file"'
+    PYTHON_INVALID_MESSAGE = '"python" section must be a mapping.'
+    PYTHON_EXTRA_REQUIREMENTS_INVALID_MESSAGE = (
+        '"python.extra_requirements" section must be a list.')
+
+    PYTHON_SUPPORTED_VERSIONS = [2, 2.7, 3, 3.5]
+    DOCKER_SUPPORTED_VERSIONS = ['1.0', '2.0', 'latest']
+
 
     def get_valid_types(self):  # noqa
         return (
@@ -432,6 +517,92 @@ def validate_formats(self):
 
         return True
 
+    @property
+    def version(self):  # noqa
+        return '1'
+
+    @property
+    def name(self):  # noqa
+        return self['name']
+
+    @property
+    def base(self):  # noqa
+        return self['base']
+
+    @property
+    def output_base(self):  # noqa
+        return self['output_base']
+
+    @property
+    def type(self):  # noqa
+        return self['type']
+
+    @property
+    def formats(self):  # noqa
+        return self['formats']
+
+    @property
+    def python(self):  # noqa
+        return self['python']
+
+    @property
+    def build(self):  # noqa
+        return self['build']
+
+    @property
+    def pip_install(self):  # noqa
+        return self['python']['pip_install']
+
+    @property
+    def install_project(self):  # noqa
+        return None
+
+    @property
+    def extra_requirements(self):  # noqa
+        return self['python']['extra_requirements']
+
+    @property
+    def python_interpreter(self):  # noqa
+        ver = self.python_full_version
+        return 'python{0}'.format(ver)
+
+    @property
+    def python_version(self):  # noqa
+        return self['python']['version']
+
+    @property
+    def python_full_version(self):  # noqa
+        ver = self.python_version
+        if ver in [2, 3]:
+            # Get the highest version of the major series version if user only
+            # gave us a version of '2', or '3'
+            ver = max(
+                version
+                for version in self.get_valid_python_versions()
+                if version < ver + 1
+            )
+        return ver
+
+    @property
+    def use_system_site_packages(self):  # noqa
+        return self['python']['use_system_site_packages']
+
+    @property
+    def use_conda(self):  # noqa
+        return 'conda' in self
+
+    @property
+    def conda_file(self):  # noqa
+        return self['conda']['file']
+
+    @property
+    def requirements_file(self):  # noqa
+        return self['requirements_file']
+
+    @property
+    def build_image(self):  # noqa
+        return self['build']['image']
+
 
 class ProjectConfig(list):
 
@@ -442,11 +613,6 @@ def validate(self):
         for build in self:
             build.validate()
 
-    def set_output_base(self, directory):
-        """Set a common ``output_base`` for each configuration build."""
-        for build in self:
-            build['output_base'] = os.path.abspath(directory)
-
 
 def load(path, env_config):
     """