Source code for pib_cli.support.user_configuration.bases.version_legacy_base

"""LegacyUserVersionIntermediateBase class."""

import os
from typing import Any, Type

from pib_cli import config

from . import command_selector_base
from .version_base import UserConfigurationVersionBase


class LegacyUserVersionIntermediateBase(UserConfigurationVersionBase):
  """An intermediate base class for older json schemas."""

  version: str
  selector: Type[command_selector_base.CommandSelectorBase]

  def get_project_name(self) -> str:
    """Return the project name from the configuration.

    :returns: The configured project name
    :raises: KeyError
    """

    project_name = os.getenv(config.ENV_OVERRIDE_PROJECT_NAME, None)

    if project_name:
      return project_name
    raise KeyError(config.ERROR_PROJECT_NAME_NOT_SET)

  def get_documentation_root(self) -> str:
    """Return the documentation folder from the configuration.

    :returns: The configured project name
    """

    documentation_folder = os.getenv(
        config.ENV_OVERRIDE_DOCUMENTATION_ROOT,
        config.DEFAULT_DOCUMENTATION_FOLDER_NAME,
    )

    return documentation_folder

  def get_command_definitions(self) -> Any:
    """Return the CLI command definitions from the configuration."""

    return self.configuration