dvt-core 1.11.0b4__py3-none-any.whl

dvt/config/project.py

@@ -0,0 +1,893 @@
+import os
+from copy import deepcopy
+from dataclasses import dataclass, field
+from itertools import chain
+from typing import Any, Dict, List, Mapping, Optional, TypeVar, Union
+
+from dvt import deprecations
+from dvt.clients.checked_load import (
+    checked_load,
+    issue_deprecation_warnings_for_failures,
+)
+from dvt.clients.yaml_helper import load_yaml_text
+from dvt.config.selectors import SelectorDict
+from dvt.config.utils import normalize_warn_error_options
+from dvt.constants import (
+    DBT_PROJECT_FILE_NAME,
+    DEPENDENCIES_FILE_NAME,
+    DVT_PROJECT_FILE_NAME,
+    PACKAGE_LOCK_HASH_KEY,
+    PACKAGES_FILE_NAME,
+)
+from dvt.contracts.project import PackageConfig
+from dvt.contracts.project import Project as ProjectContract
+from dvt.contracts.project import ProjectFlags, ProjectPackageMetadata, SemverString
+from dvt.exceptions import (
+    DbtExclusivePropertyUseError,
+    DbtProjectError,
+    DbtRuntimeError,
+    ProjectContractBrokenError,
+    ProjectContractError,
+)
+from dvt.flags import get_flags
+from dvt.graph import SelectionSpec
+from dvt.node_types import NodeType
+from dvt.utils import MultiDict, coerce_dict_str, md5
+from dvt.version import get_installed_version
+from typing_extensions import Protocol, runtime_checkable
+
+from dbt.adapters.contracts.connection import QueryComment
+from dbt_common.clients.system import load_file_contents, path_exists
+from dbt_common.dataclass_schema import ValidationError
+from dbt_common.exceptions import SemverError
+from dbt_common.helper_types import NoValue
+from dbt_common.semver import VersionSpecifier, versions_compatible
+
+from .renderer import DbtProjectYamlRenderer, PackageRenderer
+from .selectors import (
+    SelectorConfig,
+    selector_config_from_data,
+    selector_data_from_root,
+)
+
+INVALID_VERSION_ERROR = """\
+This version of dbt is not supported with the '{package}' package.
+  Installed version of dbt: {installed}
+  Required version of dbt for '{package}': {version_spec}
+Check for a different version of the '{package}' package, or run dbt again with \
+--no-version-check
+"""
+
+
+IMPOSSIBLE_VERSION_ERROR = """\
+The package version requirement can never be satisfied for the '{package}
+package.
+  Required versions of dbt for '{package}': {version_spec}
+Check for a different version of the '{package}' package, or run dbt again with \
+--no-version-check
+"""
+
+MALFORMED_PACKAGE_ERROR = """\
+The packages.yml file in this project is malformed. Please double check
+the contents of this file and fix any errors before retrying.
+
+You can find more information on the syntax for this file here:
+https://docs.getdbt.com/docs/package-management
+
+Validator Error:
+{error}
+"""
+
+
+@runtime_checkable
+class IsFQNResource(Protocol):
+    fqn: List[str]
+    resource_type: NodeType
+    package_name: str
+
+
+def _load_yaml(path, validate: bool = False):
+    contents = load_file_contents(path)
+    if validate:
+        result, failures = checked_load(contents)
+        issue_deprecation_warnings_for_failures(failures=failures, file=path)
+        return result
+    else:
+        return load_yaml_text(contents)
+
+
+def load_yml_dict(file_path):
+    ret = {}
+    if path_exists(file_path):
+        ret = _load_yaml(file_path) or {}
+    return ret
+
+
+def package_and_project_data_from_root(project_root):
+    packages_yml_dict = load_yml_dict(f"{project_root}/{PACKAGES_FILE_NAME}")
+    dependencies_yml_dict = load_yml_dict(f"{project_root}/{DEPENDENCIES_FILE_NAME}")
+
+    if "packages" in packages_yml_dict and "packages" in dependencies_yml_dict:
+        msg = "The 'packages' key cannot be specified in both packages.yml and dependencies.yml"
+        raise DbtProjectError(msg)
+    if "projects" in packages_yml_dict:
+        msg = "The 'projects' key cannot be specified in packages.yml"
+        raise DbtProjectError(msg)
+
+    packages_specified_path = PACKAGES_FILE_NAME
+    packages_dict = {}
+    if "packages" in dependencies_yml_dict:
+        packages_dict["packages"] = dependencies_yml_dict["packages"]
+        packages_specified_path = DEPENDENCIES_FILE_NAME
+    else:  # don't check for "packages" here so we capture invalid keys in packages.yml
+        packages_dict = packages_yml_dict
+
+    return packages_dict, packages_specified_path
+
+
+def package_config_from_data(
+    packages_data: Dict[str, Any],
+    unrendered_packages_data: Optional[Dict[str, Any]] = None,
+) -> PackageConfig:
+    if not packages_data:
+        packages_data = {"packages": []}
+
+    # this depends on the two lists being in the same order
+    if unrendered_packages_data:
+        unrendered_packages_data = deepcopy(unrendered_packages_data)
+        for i in range(0, len(packages_data.get("packages", []))):
+            packages_data["packages"][i]["unrendered"] = unrendered_packages_data["packages"][i]
+
+    if PACKAGE_LOCK_HASH_KEY in packages_data:
+        packages_data.pop(PACKAGE_LOCK_HASH_KEY)
+    try:
+        PackageConfig.validate(packages_data)
+        packages = PackageConfig.from_dict(packages_data)
+    except ValidationError as e:
+        raise DbtProjectError(MALFORMED_PACKAGE_ERROR.format(error=str(e.message))) from e
+    return packages
+
+
+def _parse_versions(versions: Union[List[str], str]) -> List[VersionSpecifier]:
+    """Parse multiple versions as read from disk. The versions value may be any
+    one of:
+        - a single version string ('>0.12.1')
+        - a single string specifying multiple comma-separated versions
+            ('>0.11.1,<=0.12.2')
+        - an array of single-version strings (['>0.11.1', '<=0.12.2'])
+
+    Regardless, this will return a list of VersionSpecifiers
+    """
+    if isinstance(versions, str):
+        versions = versions.split(",")
+    return [VersionSpecifier.from_version_string(v) for v in versions]
+
+
+def _all_source_paths(*args: List[str]) -> List[str]:
+    paths = chain(*args)
+    # Strip trailing slashes since the path is the same even though the name is not
+    stripped_paths = map(lambda s: s.rstrip("/"), paths)
+    return list(set(stripped_paths))
+
+
+T = TypeVar("T")
+
+
+def flag_or(flag: Optional[T], value: Optional[T], default: T) -> T:
+    if flag is None:
+        return value_or(value, default)
+    else:
+        return flag
+
+
+def value_or(value: Optional[T], default: T) -> T:
+    if value is None:
+        return default
+    else:
+        return value
+
+
+def load_raw_project(project_root: str, validate: bool = False) -> Dict[str, Any]:
+    from dbt_common.events.functions import fire_event
+    from dbt_common.events.types import Note
+
+    project_root = os.path.normpath(project_root)
+
+    # Try new filename first (dvt_project.yml)
+    dvt_project_path = os.path.join(project_root, DVT_PROJECT_FILE_NAME)
+    dbt_project_path = os.path.join(project_root, DBT_PROJECT_FILE_NAME)
+
+    if path_exists(dvt_project_path):
+        project_yaml_filepath = dvt_project_path
+    elif path_exists(dbt_project_path):
+        # TODO: Use DbtProjectFileDeprecated event once protobuf is regenerated
+        fire_event(
+            Note(
+                msg="The `dbt_project.yml` filename is deprecated. "
+                "Please rename your project file to `dvt_project.yml`."
+            )
+        )
+        project_yaml_filepath = dbt_project_path
+    else:
+        raise DbtProjectError(
+            f"No {DVT_PROJECT_FILE_NAME} or {DBT_PROJECT_FILE_NAME} found at {project_root}. "
+            f"Please create a project configuration file."
+        )
+
+    project_dict = _load_yaml(project_yaml_filepath, validate=validate)
+
+    if validate:
+        from dvt.jsonschemas.jsonschemas import jsonschema_validate, project_schema
+
+        jsonschema_validate(
+            schema=project_schema(), json=project_dict, file_path=project_yaml_filepath
+        )
+
+    if not isinstance(project_dict, dict):
+        raise DbtProjectError(f"Project file does not parse to a dictionary")
+
+    if "tests" in project_dict and "data_tests" not in project_dict:
+        project_dict["data_tests"] = project_dict.pop("tests")
+
+    return project_dict
+
+
+def _query_comment_from_cfg(
+    cfg_query_comment: Union[QueryComment, NoValue, str, None]
+) -> QueryComment:
+    if not cfg_query_comment:
+        return QueryComment(comment="")
+
+    if isinstance(cfg_query_comment, str):
+        return QueryComment(comment=cfg_query_comment)
+
+    if isinstance(cfg_query_comment, NoValue):
+        return QueryComment()
+
+    return cfg_query_comment
+
+
+def validate_version(dbt_version: List[VersionSpecifier], project_name: str):
+    """Ensure this package works with the installed version of dbt."""
+    installed = get_installed_version()
+    if not versions_compatible(*dbt_version):
+        msg = IMPOSSIBLE_VERSION_ERROR.format(
+            package=project_name, version_spec=[x.to_version_string() for x in dbt_version]
+        )
+        raise DbtProjectError(msg)
+
+    if not versions_compatible(installed, *dbt_version):
+        msg = INVALID_VERSION_ERROR.format(
+            package=project_name,
+            installed=installed.to_version_string(),
+            version_spec=[x.to_version_string() for x in dbt_version],
+        )
+        raise DbtProjectError(msg)
+
+
+def _get_required_version(
+    project_dict: Dict[str, Any],
+    verify_version: bool,
+) -> List[VersionSpecifier]:
+    dbt_raw_version: Union[List[str], str] = ">=0.0.0"
+    required = project_dict.get("require-dbt-version")
+    if required is not None:
+        dbt_raw_version = required
+
+    try:
+        dbt_version = _parse_versions(dbt_raw_version)
+    except SemverError as e:
+        raise DbtProjectError(str(e)) from e
+
+    if verify_version:
+        # no name is also an error that we want to raise
+        if "name" not in project_dict:
+            raise DbtProjectError(
+                'Required "name" field not present in project',
+            )
+        validate_version(dbt_version, project_dict["name"])
+
+    return dbt_version
+
+
+@dataclass
+class RenderComponents:
+    project_dict: Dict[str, Any] = field(metadata=dict(description="The project dictionary"))
+    packages_dict: Dict[str, Any] = field(metadata=dict(description="The packages dictionary"))
+    selectors_dict: Dict[str, Any] = field(metadata=dict(description="The selectors dictionary"))
+
+
+@dataclass
+class PartialProject(RenderComponents):
+    # This class includes the project_dict, packages_dict, selectors_dict, etc from RenderComponents
+    profile_name: Optional[str] = field(
+        metadata=dict(description="The unrendered profile name in the project, if set")
+    )
+    project_name: Optional[str] = field(
+        metadata=dict(
+            description=(
+                "The name of the project. This should always be set and will not be rendered"
+            )
+        )
+    )
+    project_root: str = field(
+        metadata=dict(description="The root directory of the project"),
+    )
+    verify_version: bool = field(
+        metadata=dict(description=("If True, verify the dbt version matches the required version"))
+    )
+    packages_specified_path: str = field(
+        metadata=dict(description="The filename where packages were specified")
+    )
+
+    def render_profile_name(self, renderer) -> Optional[str]:
+        if self.profile_name is None:
+            return None
+        return renderer.render_value(self.profile_name)
+
+    def get_rendered(
+        self,
+        renderer: DbtProjectYamlRenderer,
+    ) -> RenderComponents:
+        rendered_project = renderer.render_project(self.project_dict, self.project_root)
+        rendered_packages = renderer.render_packages(
+            self.packages_dict, self.packages_specified_path
+        )
+        rendered_selectors = renderer.render_selectors(self.selectors_dict)
+
+        return RenderComponents(
+            project_dict=rendered_project,
+            packages_dict=rendered_packages,
+            selectors_dict=rendered_selectors,
+        )
+
+    # Called by Project.from_project_root which first calls PartialProject.from_project_root
+    def render(self, renderer: DbtProjectYamlRenderer) -> "Project":
+        try:
+            rendered = self.get_rendered(renderer)
+            return self.create_project(rendered)
+        except DbtProjectError as exc:
+            if exc.path is None:
+                # Try to find which project file exists for better error messages
+                dvt_project_path = os.path.join(self.project_root, DVT_PROJECT_FILE_NAME)
+                dbt_project_path = os.path.join(self.project_root, DBT_PROJECT_FILE_NAME)
+                if path_exists(dvt_project_path):
+                    exc.path = dvt_project_path
+                else:
+                    exc.path = dbt_project_path
+            raise
+
+    def render_package_metadata(self, renderer: PackageRenderer) -> ProjectPackageMetadata:
+        packages_data = renderer.render_data(self.packages_dict)
+        packages_config = package_config_from_data(packages_data, self.packages_dict)
+        if not self.project_name:
+            raise DbtProjectError(
+                "Package defined in project configuration file must have a name!"
+            )
+        return ProjectPackageMetadata(self.project_name, packages_config.packages)
+
+    def check_config_path(
+        self, project_dict, deprecated_path, expected_path=None, default_value=None
+    ):
+        if deprecated_path in project_dict:
+            if expected_path in project_dict:
+                msg = (
+                    "{deprecated_path} and {expected_path} cannot both be defined. The "
+                    "`{deprecated_path}` config has been deprecated in favor of `{expected_path}`. "
+                    "Please update your project configuration to reflect this change."
+                )
+                raise DbtProjectError(
+                    msg.format(deprecated_path=deprecated_path, expected_path=expected_path)
+                )
+            # this field is no longer supported, but many projects may specify it with the default value
+            # if so, let's only raise this deprecation warning if they set a custom value
+            if not default_value or project_dict[deprecated_path] != default_value:
+                kwargs = {"deprecated_path": deprecated_path}
+                if expected_path:
+                    kwargs.update({"exp_path": expected_path})
+                deprecations.warn(f"project-config-{deprecated_path}", **kwargs)
+
+    def create_project(self, rendered: RenderComponents) -> "Project":
+        unrendered = RenderComponents(
+            project_dict=self.project_dict,
+            packages_dict=self.packages_dict,
+            selectors_dict=self.selectors_dict,
+        )
+        dbt_version = _get_required_version(
+            rendered.project_dict,
+            verify_version=self.verify_version,
+        )
+
+        self.check_config_path(rendered.project_dict, "source-paths", "model-paths")
+        self.check_config_path(rendered.project_dict, "data-paths", "seed-paths")
+        self.check_config_path(rendered.project_dict, "log-path", default_value="logs")
+        self.check_config_path(rendered.project_dict, "target-path", default_value="target")
+
+        try:
+            ProjectContract.validate(rendered.project_dict)
+            cfg = ProjectContract.from_dict(rendered.project_dict)
+        except ValidationError as e:
+            raise ProjectContractError(e) from e
+        # name/version are required in the Project definition, so we can assume
+        # they are present
+        name = cfg.name
+        version = cfg.version
+        # this is added at project_dict parse time and should always be here
+        # once we see it.
+        if cfg.project_root is None:
+            raise DbtProjectError("cfg must have a project root!")
+        else:
+            project_root = cfg.project_root
+        # this is only optional in the sense that if it's not present, it needs
+        # to have been a cli argument.
+        profile_name = cfg.profile
+        # these are all the defaults
+
+        # `source_paths` is deprecated but still allowed. Copy it into
+        # `model_paths` to simlify logic throughout the rest of the system.
+        model_paths: List[str] = value_or(
+            cfg.model_paths if "model-paths" in rendered.project_dict else cfg.source_paths,
+            ["models"],
+        )
+        macro_paths: List[str] = value_or(cfg.macro_paths, ["macros"])
+        # `data_paths` is deprecated but still allowed. Copy it into
+        # `seed_paths` to simlify logic throughout the rest of the system.
+        seed_paths: List[str] = value_or(
+            cfg.seed_paths if "seed-paths" in rendered.project_dict else cfg.data_paths, ["seeds"]
+        )
+        test_paths: List[str] = value_or(cfg.test_paths, ["tests"])
+        analysis_paths: List[str] = value_or(cfg.analysis_paths, ["analyses"])
+        snapshot_paths: List[str] = value_or(cfg.snapshot_paths, ["snapshots"])
+        function_paths: List[str] = value_or(cfg.function_paths, ["functions"])
+
+        all_source_paths: List[str] = _all_source_paths(
+            model_paths,
+            seed_paths,
+            snapshot_paths,
+            analysis_paths,
+            macro_paths,
+            test_paths,
+            function_paths,
+        )
+
+        docs_paths: List[str] = value_or(cfg.docs_paths, all_source_paths)
+        asset_paths: List[str] = value_or(cfg.asset_paths, [])
+        global_flags = get_flags()
+
+        flag_target_path = str(global_flags.TARGET_PATH) if global_flags.TARGET_PATH else None
+        target_path: str = flag_or(flag_target_path, cfg.target_path, "target")
+        log_path: str = str(global_flags.LOG_PATH)
+
+        clean_targets: List[str] = value_or(cfg.clean_targets, [target_path])
+        packages_install_path: str = value_or(cfg.packages_install_path, "dbt_packages")
+        # in the default case we'll populate this once we know the adapter type
+        # It would be nice to just pass along a Quoting here, but that would
+        # break many things
+        quoting: Dict[str, Any] = {}
+        if cfg.quoting is not None:
+            quoting = cfg.quoting.to_dict(omit_none=True)
+
+        dispatch: List[Dict[str, Any]]
+        models: Dict[str, Any]
+        seeds: Dict[str, Any]
+        snapshots: Dict[str, Any]
+        sources: Dict[str, Any]
+        data_tests: Dict[str, Any]
+        unit_tests: Dict[str, Any]
+        metrics: Dict[str, Any]
+        semantic_models: Dict[str, Any]
+        saved_queries: Dict[str, Any]
+        exposures: Dict[str, Any]
+        functions: Dict[str, Any]
+        vars_value: VarProvider
+        dbt_cloud: Dict[str, Any]
+
+        dispatch = cfg.dispatch
+        models = cfg.models
+        seeds = cfg.seeds
+        snapshots = cfg.snapshots
+        sources = cfg.sources
+        # the `tests` config is deprecated but still allowed. Copy it into
+        # `data_tests` to simplify logic throughout the rest of the system.
+        data_tests = cfg.data_tests if "data_tests" in rendered.project_dict else cfg.tests
+        unit_tests = cfg.unit_tests
+        metrics = cfg.metrics
+        semantic_models = cfg.semantic_models
+        saved_queries = cfg.saved_queries
+        exposures = cfg.exposures
+        functions = cfg.functions
+        if cfg.vars is None:
+            vars_dict: Dict[str, Any] = {}
+        else:
+            vars_dict = cfg.vars
+
+        vars_value = VarProvider(vars_dict)
+        # There will never be any project_env_vars when it's first created
+        project_env_vars: Dict[str, Any] = {}
+        on_run_start: List[str] = value_or(cfg.on_run_start, [])
+        on_run_end: List[str] = value_or(cfg.on_run_end, [])
+
+        query_comment = _query_comment_from_cfg(cfg.query_comment)
+        packages: PackageConfig = package_config_from_data(
+            rendered.packages_dict, unrendered.packages_dict
+        )
+        selectors = selector_config_from_data(rendered.selectors_dict)
+        manifest_selectors: Dict[str, Any] = {}
+        if rendered.selectors_dict and rendered.selectors_dict["selectors"]:
+            # this is a dict with a single key 'selectors' pointing to a list
+            # of dicts.
+            manifest_selectors = SelectorDict.parse_from_selectors_list(
+                rendered.selectors_dict["selectors"]
+            )
+        dbt_cloud = cfg.dbt_cloud
+        flags: Dict[str, Any] = cfg.flags
+
+        project = Project(
+            project_name=name,
+            version=version,
+            project_root=project_root,
+            profile_name=profile_name,
+            model_paths=model_paths,
+            macro_paths=macro_paths,
+            seed_paths=seed_paths,
+            test_paths=test_paths,
+            analysis_paths=analysis_paths,
+            docs_paths=docs_paths,
+            asset_paths=asset_paths,
+            target_path=target_path,
+            snapshot_paths=snapshot_paths,
+            function_paths=function_paths,
+            clean_targets=clean_targets,
+            log_path=log_path,
+            packages_install_path=packages_install_path,
+            packages_specified_path=self.packages_specified_path,
+            quoting=quoting,
+            models=models,
+            on_run_start=on_run_start,
+            on_run_end=on_run_end,
+            dispatch=dispatch,
+            seeds=seeds,
+            snapshots=snapshots,
+            dbt_version=dbt_version,
+            packages=packages,
+            manifest_selectors=manifest_selectors,
+            selectors=selectors,
+            query_comment=query_comment,
+            sources=sources,
+            data_tests=data_tests,
+            unit_tests=unit_tests,
+            metrics=metrics,
+            semantic_models=semantic_models,
+            saved_queries=saved_queries,
+            exposures=exposures,
+            functions=functions,
+            vars=vars_value,
+            config_version=cfg.config_version,
+            unrendered=unrendered,
+            project_env_vars=project_env_vars,
+            restrict_access=cfg.restrict_access,
+            dbt_cloud=dbt_cloud,
+            flags=flags,
+        )
+        # sanity check - this means an internal issue
+        project.validate()
+        return project
+
+    @classmethod
+    def from_dicts(
+        cls,
+        project_root: str,
+        project_dict: Dict[str, Any],
+        packages_dict: Dict[str, Any],
+        selectors_dict: Optional[Dict[str, Any]],
+        *,
+        verify_version: bool = False,
+        packages_specified_path: str = PACKAGES_FILE_NAME,
+    ):
+        """Construct a partial project from its constituent dicts."""
+        project_name = project_dict.get("name")
+        profile_name = project_dict.get("profile")
+
+        # Create a PartialProject
+        return cls(
+            profile_name=profile_name,
+            project_name=project_name,
+            project_root=project_root,
+            project_dict=project_dict,
+            packages_dict=packages_dict,
+            selectors_dict=selectors_dict,  # type: ignore
+            verify_version=verify_version,
+            packages_specified_path=packages_specified_path,
+        )
+
+    @classmethod
+    def from_project_root(
+        cls, project_root: str, *, verify_version: bool = False, validate: bool = False
+    ) -> "PartialProject":
+        project_root = os.path.normpath(project_root)
+        project_dict = load_raw_project(project_root, validate=validate)
+        (
+            packages_dict,
+            packages_specified_path,
+        ) = package_and_project_data_from_root(project_root)
+        selectors_dict = selector_data_from_root(project_root)
+
+        return cls.from_dicts(
+            project_root=project_root,
+            project_dict=project_dict,
+            selectors_dict=selectors_dict,
+            packages_dict=packages_dict,
+            verify_version=verify_version,
+            packages_specified_path=packages_specified_path,
+        )
+
+
+class VarProvider:
+    """Var providers are tied to a particular Project."""
+
+    def __init__(self, vars: Dict[str, Dict[str, Any]]) -> None:
+        self.vars = vars
+
+    def vars_for(self, node: IsFQNResource, adapter_type: str) -> Mapping[str, Any]:
+        # in v2, vars are only either project or globally scoped
+        merged = MultiDict([self.vars])
+        merged.add(self.vars.get(node.package_name, {}))
+        return merged
+
+    def to_dict(self):
+        return self.vars
+
+
+# The Project class is included in RuntimeConfig, so any attribute
+# additions must also be set where the RuntimeConfig class is created
+@dataclass
+class Project:
+    project_name: str
+    version: Optional[Union[SemverString, float]]
+    project_root: str
+    profile_name: Optional[str]
+    model_paths: List[str]
+    macro_paths: List[str]
+    seed_paths: List[str]
+    test_paths: List[str]
+    analysis_paths: List[str]
+    docs_paths: List[str]
+    asset_paths: List[str]
+    target_path: str
+    snapshot_paths: List[str]
+    function_paths: List[str]
+    clean_targets: List[str]
+    log_path: str
+    packages_install_path: str
+    packages_specified_path: str
+    quoting: Dict[str, Any]
+    models: Dict[str, Any]
+    on_run_start: List[str]
+    on_run_end: List[str]
+    dispatch: List[Dict[str, Any]]
+    seeds: Dict[str, Any]
+    snapshots: Dict[str, Any]
+    sources: Dict[str, Any]
+    data_tests: Dict[str, Any]
+    unit_tests: Dict[str, Any]
+    metrics: Dict[str, Any]
+    semantic_models: Dict[str, Any]
+    saved_queries: Dict[str, Any]
+    exposures: Dict[str, Any]
+    functions: Dict[str, Any]
+    vars: VarProvider
+    dbt_version: List[VersionSpecifier]
+    packages: PackageConfig
+    manifest_selectors: Dict[str, Any]
+    selectors: SelectorConfig
+    query_comment: QueryComment
+    config_version: int
+    unrendered: RenderComponents
+    project_env_vars: Dict[str, Any]
+    restrict_access: bool
+    dbt_cloud: Dict[str, Any]
+    flags: Dict[str, Any]
+
+    @property
+    def all_source_paths(self) -> List[str]:
+        return _all_source_paths(
+            self.model_paths,
+            self.seed_paths,
+            self.snapshot_paths,
+            self.analysis_paths,
+            self.macro_paths,
+            self.test_paths,
+            self.function_paths,
+        )
+
+    @property
+    def generic_test_paths(self):
+        generic_test_paths = []
+        for test_path in self.test_paths:
+            generic_test_paths.append(os.path.join(test_path, "generic"))
+        return generic_test_paths
+
+    @property
+    def fixture_paths(self):
+        fixture_paths = []
+        for test_path in self.test_paths:
+            fixture_paths.append(os.path.join(test_path, "fixtures"))
+        return fixture_paths
+
+    def __str__(self):
+        cfg = self.to_project_config(with_packages=True)
+        return str(cfg)
+
+    def __eq__(self, other):
+        if not (isinstance(other, self.__class__) and isinstance(self, other.__class__)):
+            return False
+        return self.to_project_config(with_packages=True) == other.to_project_config(
+            with_packages=True
+        )
+
+    def to_project_config(self, with_packages=False):
+        """Return a dict representation of the config that could be written to
+        disk with `yaml.safe_dump` to get this configuration.
+
+        :param with_packages bool: If True, include the serialized packages
+            file in the root.
+        :returns dict: The serialized profile.
+        """
+        result = deepcopy(
+            {
+                "name": self.project_name,
+                "version": self.version,
+                "project-root": self.project_root,
+                "profile": self.profile_name,
+                "model-paths": self.model_paths,
+                "macro-paths": self.macro_paths,
+                "seed-paths": self.seed_paths,
+                "test-paths": self.test_paths,
+                "analysis-paths": self.analysis_paths,
+                "docs-paths": self.docs_paths,
+                "asset-paths": self.asset_paths,
+                "target-path": self.target_path,
+                "snapshot-paths": self.snapshot_paths,
+                "clean-targets": self.clean_targets,
+                "log-path": self.log_path,
+                "quoting": self.quoting,
+                "models": self.models,
+                "on-run-start": self.on_run_start,
+                "on-run-end": self.on_run_end,
+                "dispatch": self.dispatch,
+                "seeds": self.seeds,
+                "snapshots": self.snapshots,
+                "sources": self.sources,
+                "data_tests": self.data_tests,
+                "unit_tests": self.unit_tests,
+                "metrics": self.metrics,
+                "semantic-models": self.semantic_models,
+                "saved-queries": self.saved_queries,
+                "exposures": self.exposures,
+                "functions": self.functions,
+                "vars": self.vars.to_dict(),
+                "require-dbt-version": [v.to_version_string() for v in self.dbt_version],
+                "restrict-access": self.restrict_access,
+                "dbt-cloud": self.dbt_cloud,
+                "flags": self.flags,
+            }
+        )
+        if self.query_comment:
+            result["query-comment"] = self.query_comment.to_dict(omit_none=True)
+
+        if with_packages:
+            result.update(self.packages.to_dict(omit_none=True))
+
+        return result
+
+    def validate(self):
+        try:
+            ProjectContract.validate(self.to_project_config())
+        except ValidationError as e:
+            raise ProjectContractBrokenError(e) from e
+
+    # Called by:
+    # RtConfig.load_dependencies => RtConfig.load_projects => RtConfig.new_project => Project.from_project_root
+    # RtConfig.from_args => RtConfig.collect_parts => load_project => Project.from_project_root
+    @classmethod
+    def from_project_root(
+        cls,
+        project_root: str,
+        renderer: DbtProjectYamlRenderer,
+        *,
+        verify_version: bool = False,
+        validate: bool = False,
+    ) -> "Project":
+        partial = PartialProject.from_project_root(
+            project_root, verify_version=verify_version, validate=validate
+        )
+        return partial.render(renderer)
+
+    def hashed_name(self):
+        return md5(self.project_name)
+
+    def get_selector(self, name: str) -> Union[SelectionSpec, bool]:
+        if name not in self.selectors:
+            raise DbtRuntimeError(
+                f"Could not find selector named {name}, expected one of {list(self.selectors)}"
+            )
+        return self.selectors[name]["definition"]
+
+    def get_default_selector_name(self) -> Union[str, None]:
+        """This function fetch the default selector to use on `dbt run` (if any)
+        :return: either a selector if default is set or None
+        :rtype: Union[SelectionSpec, None]
+        """
+        for selector_name, selector in self.selectors.items():
+            if selector["default"] is True:
+                return selector_name
+
+        return None
+
+    def get_macro_search_order(self, macro_namespace: str):
+        for dispatch_entry in self.dispatch:
+            if dispatch_entry["macro_namespace"] == macro_namespace:
+                return dispatch_entry["search_order"]
+        return None
+
+    @property
+    def project_target_path(self):
+        # If target_path is absolute, project_root will not be included
+        return os.path.join(self.project_root, self.target_path)
+
+
+def read_project_flags(project_dir: str, profiles_dir: str) -> ProjectFlags:
+    try:
+        project_flags: Dict[str, Any] = {}
+        # Read project_flags from dvt_project.yml (or dbt_project.yml for backward compatibility)
+        # Flags are instantiated before the project, so we don't
+        # want to throw an error for non-existence of project file here
+        # because it breaks things.
+        project_root = os.path.normpath(project_dir)
+        dvt_project_path = os.path.join(project_root, DVT_PROJECT_FILE_NAME)
+        dbt_project_path = os.path.join(project_root, DBT_PROJECT_FILE_NAME)
+
+        if path_exists(dvt_project_path) or path_exists(dbt_project_path):
+            try:
+                project_dict = load_raw_project(project_root)
+                if "flags" in project_dict:
+                    project_flags = project_dict.pop("flags")
+            except Exception:
+                # This is probably a yaml load error.The error will be reported
+                # later, when the project loads.
+                pass
+
+        from dvt.config.profile import read_profile
+
+        profile = read_profile(profiles_dir)
+        profile_project_flags: Optional[Dict[str, Any]] = {}
+        if profile:
+            profile_project_flags = coerce_dict_str(profile.get("config", {}))
+
+        if project_flags and profile_project_flags:
+            raise DbtProjectError(
+                "Do not specify both 'config' in profiles.yml and 'flags' in project file. "
+                "Using 'config' in profiles.yml is deprecated."
+            )
+
+        if profile_project_flags:
+            # This can't use WARN_ERROR or WARN_ERROR_OPTIONS because they're in
+            # the config that we're loading. Uses special "buffer" method and fired after flags are initialized in preflight.
+            deprecations.buffer("project-flags-moved")
+            project_flags = profile_project_flags
+
+        if project_flags is not None:
+            # handle collapsing `include` and `error` as well as collapsing `exclude` and `warn`
+            # for warn_error_options
+            warn_error_options = project_flags.get("warn_error_options", {})
+            normalize_warn_error_options(warn_error_options)
+
+            ProjectFlags.validate(project_flags)
+            return ProjectFlags.from_dict(project_flags)
+    except (DbtProjectError, DbtExclusivePropertyUseError) as exc:
+        # We don't want to eat the DbtProjectError for UserConfig to ProjectFlags or
+        # DbtConfigError for warn_error_options munging
+        raise exc
+    except (DbtRuntimeError, ValidationError):
+        pass
+    return ProjectFlags()