From 02b85cb781997145beef244de74f27ed036477f3 Mon Sep 17 00:00:00 2001 From: Kshitij Aranke Date: Fri, 7 Feb 2025 16:52:56 +0000 Subject: [PATCH] Revert "Add `doc_blocks` to manifest for nodes and columns (#11224)" This reverts commit d71f309c1e31c15a455046b570f27b0b9a84f7ef. --- .../unreleased/Features-20250122-170328.yaml | 6 - core/dbt/artifacts/resources/v1/components.py | 2 - .../resources/v1/source_definition.py | 1 - core/dbt/parser/manifest.py | 65 +---- schemas/dbt/manifest/v12.json | 234 ------------------ .../functional/artifacts/expected_manifest.py | 50 ---- .../configs/test_contract_configs.py | 71 +----- .../functional/docs/test_good_docs_blocks.py | 44 +--- tests/unit/contracts/graph/test_manifest.py | 1 - tests/unit/contracts/graph/test_nodes.py | 2 - .../unit/contracts/graph/test_nodes_parsed.py | 16 -- 11 files changed, 16 insertions(+), 476 deletions(-) delete mode 100644 .changes/unreleased/Features-20250122-170328.yaml diff --git a/.changes/unreleased/Features-20250122-170328.yaml b/.changes/unreleased/Features-20250122-170328.yaml deleted file mode 100644 index ce95d99402c..00000000000 --- a/.changes/unreleased/Features-20250122-170328.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: Features -body: Add doc_blocks to manifest for nodes and columns -time: 2025-01-22T17:03:28.866522Z -custom: - Author: aranke - Issue: 11000 11001 diff --git a/core/dbt/artifacts/resources/v1/components.py b/core/dbt/artifacts/resources/v1/components.py index 6f3781b06c0..8eb43f35d8e 100644 --- a/core/dbt/artifacts/resources/v1/components.py +++ b/core/dbt/artifacts/resources/v1/components.py @@ -68,7 +68,6 @@ class ColumnInfo(AdditionalPropertiesMixin, ExtensibleDbtClassMixin): tags: List[str] = field(default_factory=list) _extra: Dict[str, Any] = field(default_factory=dict) granularity: Optional[TimeGranularity] = None - doc_blocks: List[str] = field(default_factory=list) @dataclass @@ -198,7 +197,6 @@ class ParsedResource(ParsedResourceMandatory): unrendered_config_call_dict: Dict[str, Any] = field(default_factory=dict) relation_name: Optional[str] = None raw_code: str = "" - doc_blocks: List[str] = field(default_factory=list) def __post_serialize__(self, dct: Dict, context: Optional[Dict] = None): dct = super().__post_serialize__(dct, context) diff --git a/core/dbt/artifacts/resources/v1/source_definition.py b/core/dbt/artifacts/resources/v1/source_definition.py index f827d114942..e09095fa0af 100644 --- a/core/dbt/artifacts/resources/v1/source_definition.py +++ b/core/dbt/artifacts/resources/v1/source_definition.py @@ -74,4 +74,3 @@ class SourceDefinition(ParsedSourceMandatory): created_at: float = field(default_factory=lambda: time.time()) unrendered_database: Optional[str] = None unrendered_schema: Optional[str] = None - doc_blocks: List[str] = field(default_factory=list) diff --git a/core/dbt/parser/manifest.py b/core/dbt/parser/manifest.py index 627ad034c2f..023c5db9300 100644 --- a/core/dbt/parser/manifest.py +++ b/core/dbt/parser/manifest.py @@ -10,7 +10,6 @@ from typing import Any, Callable, Dict, List, Mapping, Optional, Set, Tuple, Type, Union import msgpack -from jinja2.nodes import Call import dbt.deprecations import dbt.exceptions @@ -116,7 +115,6 @@ from dbt.parser.sources import SourcePatcher from dbt.parser.unit_tests import process_models_for_unit_test from dbt.version import __version__ -from dbt_common.clients.jinja import parse from dbt_common.clients.system import make_directory, path_exists, read_json, write_file from dbt_common.constants import SECRET_ENV_PREFIX from dbt_common.dataclass_schema import StrEnum, dbtClassMixin @@ -1242,7 +1240,7 @@ def process_docs(self, config: RuntimeConfig): self.manifest, config.project_name, ) - _process_docs_for_node(ctx, node, self.manifest) + _process_docs_for_node(ctx, node) for source in self.manifest.sources.values(): if source.created_at < self.started_at: continue @@ -1252,7 +1250,7 @@ def process_docs(self, config: RuntimeConfig): self.manifest, config.project_name, ) - _process_docs_for_source(ctx, source, self.manifest) + _process_docs_for_source(ctx, source) for macro in self.manifest.macros.values(): if macro.created_at < self.started_at: continue @@ -1659,54 +1657,13 @@ def _check_manifest(manifest: Manifest, config: RuntimeConfig) -> None: DocsContextCallback = Callable[[ResultNode], Dict[str, Any]] -def _get_doc_blocks(description: str, manifest: Manifest, node_package: str) -> List[str]: - ast = parse(description) - doc_blocks: List[str] = [] - - if not hasattr(ast, "body"): - return doc_blocks - - for statement in ast.body: - for node in statement.nodes: - if ( - isinstance(node, Call) - and hasattr(node, "node") - and hasattr(node, "args") - and node.node.name == "doc" - ): - doc_args = [arg.value for arg in node.args] - - if len(doc_args) == 1: - package, name = None, doc_args[0] - elif len(doc_args) == 2: - package, name = doc_args - else: - continue - - if not manifest.metadata.project_name: - continue - - resolved_doc = manifest.resolve_doc( - name, package, manifest.metadata.project_name, node_package - ) - - if resolved_doc: - doc_blocks.append(resolved_doc.unique_id) - - return doc_blocks - - # node and column descriptions def _process_docs_for_node( context: Dict[str, Any], node: ManifestNode, - manifest: Manifest, ): - node.doc_blocks = _get_doc_blocks(node.description, manifest, node.package_name) node.description = get_rendered(node.description, context) - for column_name, column in node.columns.items(): - column.doc_blocks = _get_doc_blocks(column.description, manifest, node.package_name) column.description = get_rendered(column.description, context) @@ -1714,16 +1671,18 @@ def _process_docs_for_node( def _process_docs_for_source( context: Dict[str, Any], source: SourceDefinition, - manifest: Manifest, ): - source.doc_blocks = _get_doc_blocks(source.description, manifest, source.package_name) - source.description = get_rendered(source.description, context) - - source.source_description = get_rendered(source.source_description, context) + table_description = source.description + source_description = source.source_description + table_description = get_rendered(table_description, context) + source_description = get_rendered(source_description, context) + source.description = table_description + source.source_description = source_description for column in source.columns.values(): - column.doc_blocks = _get_doc_blocks(column.description, manifest, source.package_name) - column.description = get_rendered(column.description, context) + column_desc = column.description + column_desc = get_rendered(column_desc, context) + column.description = column_desc # macro argument descriptions @@ -2081,7 +2040,7 @@ def process_node(config: RuntimeConfig, manifest: Manifest, node: ManifestNode): _process_sources_for_node(manifest, config.project_name, node) _process_refs(manifest, config.project_name, node, config.dependencies) ctx = generate_runtime_docs_context(config, node, manifest, config.project_name) - _process_docs_for_node(ctx, node, manifest) + _process_docs_for_node(ctx, node) def write_semantic_manifest(manifest: Manifest, target_path: str) -> None: diff --git a/schemas/dbt/manifest/v12.json b/schemas/dbt/manifest/v12.json index 0be0a978588..c19549cc0f4 100644 --- a/schemas/dbt/manifest/v12.json +++ b/schemas/dbt/manifest/v12.json @@ -622,12 +622,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -736,12 +730,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "root_path": { "anyOf": [ { @@ -1679,12 +1667,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -1793,12 +1775,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -2345,12 +2321,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -2459,12 +2429,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -3151,12 +3115,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -3265,12 +3223,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -3976,12 +3928,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -4090,12 +4036,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -5396,12 +5336,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -5510,12 +5444,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -6062,12 +5990,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -6176,12 +6098,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -7063,12 +6979,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -7177,12 +7087,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -8268,12 +8172,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -8375,12 +8273,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": false, @@ -8654,12 +8546,6 @@ { "type": "string" }, - { - "type": "array", - "items": { - "type": "string" - } - }, { "type": "null" } @@ -10017,12 +9903,6 @@ { "type": "string" }, - { - "type": "array", - "items": { - "type": "string" - } - }, { "type": "null" } @@ -10591,12 +10471,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -10705,12 +10579,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "root_path": { "anyOf": [ { @@ -11648,12 +11516,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -11762,12 +11624,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -12314,12 +12170,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -12428,12 +12278,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -13120,12 +12964,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -13234,12 +13072,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -13945,12 +13777,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -14059,12 +13885,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -15365,12 +15185,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -15479,12 +15293,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -16031,12 +15839,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -16145,12 +15947,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -17032,12 +16828,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -17146,12 +16936,6 @@ "type": "string", "default": "" }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } - }, "language": { "type": "string", "default": "sql" @@ -18228,12 +18012,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": true, @@ -18335,12 +18113,6 @@ } ], "default": null - }, - "doc_blocks": { - "type": "array", - "items": { - "type": "string" - } } }, "additionalProperties": false, @@ -18412,12 +18184,6 @@ { "type": "string" }, - { - "type": "array", - "items": { - "type": "string" - } - }, { "type": "null" } diff --git a/tests/functional/artifacts/expected_manifest.py b/tests/functional/artifacts/expected_manifest.py index 8ef9cd3c9be..02db1905443 100644 --- a/tests/functional/artifacts/expected_manifest.py +++ b/tests/functional/artifacts/expected_manifest.py @@ -316,7 +316,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "first_name": { "name": "first_name", @@ -327,7 +326,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "email": { "name": "email", @@ -338,7 +336,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "ip_address": { "name": "ip_address", @@ -349,7 +346,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "updated_at": { "name": "updated_at", @@ -360,7 +356,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, }, "contract": {"checksum": None, "enforced": False, "alias_types": True}, @@ -378,7 +373,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "latest_version": None, "time_spine": None, "freshness": None, - "doc_blocks": [], }, "model.test.second_model": { "compiled_path": os.path.join(compiled_model_path, "second_model.sql"), @@ -422,7 +416,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "first_name": { "name": "first_name", @@ -433,7 +426,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "email": { "name": "email", @@ -444,7 +436,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "ip_address": { "name": "ip_address", @@ -455,7 +446,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "updated_at": { "name": "updated_at", @@ -466,7 +456,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, }, "contract": {"checksum": None, "enforced": False, "alias_types": True}, @@ -484,7 +473,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "latest_version": None, "time_spine": None, "freshness": None, - "doc_blocks": [], }, "seed.test.seed": { "build_path": None, @@ -518,7 +506,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "first_name": { "name": "first_name", @@ -529,7 +516,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "email": { "name": "email", @@ -540,7 +526,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "ip_address": { "name": "ip_address", @@ -551,7 +536,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "updated_at": { "name": "updated_at", @@ -562,7 +546,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, }, "docs": {"node_color": None, "show": True}, @@ -571,7 +554,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "relation_name": relation_name_node_format.format( project.database, my_schema_name, "seed" ), - "doc_blocks": [], }, "test.test.not_null_model_id.d01cc630e6": { "alias": "not_null_model_id", @@ -625,7 +607,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "checksum": {"name": "none", "checksum": ""}, "unrendered_config": unrendered_test_config, "contract": {"checksum": None, "enforced": False, "alias_types": True}, - "doc_blocks": [], }, "snapshot.test.snapshot_seed": { "alias": "snapshot_seed", @@ -672,7 +653,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "unique_id": "snapshot.test.snapshot_seed", "unrendered_config": unrendered_snapshot_config, - "doc_blocks": [], }, "test.test.test_nothing_model_.5d38568946": { "alias": "test_nothing_model_", @@ -725,7 +705,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): }, "checksum": {"name": "none", "checksum": ""}, "unrendered_config": unrendered_test_config, - "doc_blocks": [], }, "test.test.unique_model_id.67b76558ff": { "alias": "unique_model_id", @@ -779,7 +758,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): }, "checksum": {"name": "none", "checksum": ""}, "unrendered_config": unrendered_test_config, - "doc_blocks": [], }, }, "sources": { @@ -795,7 +773,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], } }, "config": { @@ -840,7 +817,6 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False): "unrendered_config": {}, "unrendered_database": None, "unrendered_schema": "{{ var('test_schema') }}", - "doc_blocks": [], }, }, "exposures": { @@ -1030,7 +1006,6 @@ def expected_references_manifest(project): "constraints": [], "time_spine": None, "freshness": None, - "doc_blocks": [], }, "model.test.ephemeral_summary": { "alias": "ephemeral_summary", @@ -1047,7 +1022,6 @@ def expected_references_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": ["doc.test.summary_first_name"], }, "ct": { "description": "The number of instances of the first name", @@ -1058,7 +1032,6 @@ def expected_references_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": ["doc.test.summary_count"], }, }, "config": get_rendered_model_config(materialized="table", group="test_group"), @@ -1106,7 +1079,6 @@ def expected_references_manifest(project): "constraints": [], "time_spine": None, "freshness": None, - "doc_blocks": ["doc.test.ephemeral_summary"], }, "model.test.view_summary": { "alias": "view_summary", @@ -1123,7 +1095,6 @@ def expected_references_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": ["doc.test.summary_first_name"], }, "ct": { "description": "The number of instances of the first name", @@ -1134,7 +1105,6 @@ def expected_references_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": ["doc.test.summary_count"], }, }, "config": get_rendered_model_config(), @@ -1178,7 +1148,6 @@ def expected_references_manifest(project): "constraints": [], "time_spine": None, "freshness": None, - "doc_blocks": ["doc.test.view_summary"], }, "seed.test.seed": { "alias": "seed", @@ -1194,7 +1163,6 @@ def expected_references_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "first_name": { "name": "first_name", @@ -1205,7 +1173,6 @@ def expected_references_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "email": { "name": "email", @@ -1216,7 +1183,6 @@ def expected_references_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "ip_address": { "name": "ip_address", @@ -1227,7 +1193,6 @@ def expected_references_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "updated_at": { "name": "updated_at", @@ -1238,7 +1203,6 @@ def expected_references_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, }, "config": get_rendered_seed_config(), @@ -1263,7 +1227,6 @@ def expected_references_manifest(project): "checksum": checksum_file(seed_path), "unrendered_config": get_unrendered_seed_config(), "relation_name": '"{0}"."{1}".seed'.format(project.database, my_schema_name), - "doc_blocks": [], }, "snapshot.test.snapshot_seed": { "alias": "snapshot_seed", @@ -1305,7 +1268,6 @@ def expected_references_manifest(project): "unrendered_config": get_unrendered_snapshot_config( target_schema=alternate_schema ), - "doc_blocks": [], }, }, "sources": { @@ -1320,7 +1282,6 @@ def expected_references_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": ["doc.test.column_info"], } }, "config": { @@ -1364,7 +1325,6 @@ def expected_references_manifest(project): "unrendered_config": {}, "unrendered_database": None, "unrendered_schema": "{{ var('test_schema') }}", - "doc_blocks": ["doc.test.table_info"], }, }, "exposures": { @@ -1595,7 +1555,6 @@ def expected_versions_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "ct": { "description": "The number of instances of the first name", @@ -1606,7 +1565,6 @@ def expected_versions_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, }, "config": get_rendered_model_config( @@ -1657,7 +1615,6 @@ def expected_versions_manifest(project): "latest_version": 2, "time_spine": None, "freshness": None, - "doc_blocks": [], }, "model.test.versioned_model.v2": { "alias": "versioned_model_v2", @@ -1674,7 +1631,6 @@ def expected_versions_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, "extra": { "description": "", @@ -1685,7 +1641,6 @@ def expected_versions_manifest(project): "tags": [], "constraints": [], "granularity": None, - "doc_blocks": [], }, }, "config": get_rendered_model_config( @@ -1732,7 +1687,6 @@ def expected_versions_manifest(project): "latest_version": 2, "time_spine": None, "freshness": None, - "doc_blocks": [], }, "model.test.ref_versioned_model": { "alias": "ref_versioned_model", @@ -1792,7 +1746,6 @@ def expected_versions_manifest(project): "latest_version": None, "time_spine": None, "freshness": None, - "doc_blocks": [], }, "test.test.unique_versioned_model_v1_first_name.6138195dec": { "alias": "unique_versioned_model_v1_first_name", @@ -1846,7 +1799,6 @@ def expected_versions_manifest(project): }, "checksum": {"name": "none", "checksum": ""}, "unrendered_config": unrendered_test_config, - "doc_blocks": [], }, "test.test.unique_versioned_model_v1_count.0b4c0b688a": { "alias": "unique_versioned_model_v1_count", @@ -1900,7 +1852,6 @@ def expected_versions_manifest(project): }, "checksum": {"name": "none", "checksum": ""}, "unrendered_config": unrendered_test_config, - "doc_blocks": [], }, "test.test.unique_versioned_model_v2_first_name.998430d28e": { "alias": "unique_versioned_model_v2_first_name", @@ -1954,7 +1905,6 @@ def expected_versions_manifest(project): }, "checksum": {"name": "none", "checksum": ""}, "unrendered_config": unrendered_test_config, - "doc_blocks": [], }, }, "exposures": { diff --git a/tests/functional/configs/test_contract_configs.py b/tests/functional/configs/test_contract_configs.py index 86649015e6a..179b0058a8d 100644 --- a/tests/functional/configs/test_contract_configs.py +++ b/tests/functional/configs/test_contract_configs.py @@ -2,7 +2,6 @@ import pytest -from dbt.artifacts.resources.v1.components import ColumnInfo from dbt.exceptions import ParsingError, ValidationError from dbt.tests.util import ( get_artifact, @@ -11,7 +10,6 @@ run_dbt_and_capture, write_file, ) -from dbt_common.contracts.constraints import ColumnLevelConstraint, ConstraintType my_model_sql = """ {{ @@ -333,74 +331,9 @@ def test__model_contract_true(self, project): assert contract_actual_config.enforced is True - expected_columns = { - "id": ColumnInfo( - name="id", - description="hello", - meta={}, - data_type="integer", - doc_blocks=[], - constraints=[ - ColumnLevelConstraint( - type=ConstraintType.not_null, - name=None, - expression=None, - warn_unenforced=True, - warn_unsupported=True, - to=None, - to_columns=[], - ), - ColumnLevelConstraint( - type=ConstraintType.primary_key, - name=None, - expression=None, - warn_unenforced=True, - warn_unsupported=True, - to=None, - to_columns=[], - ), - ColumnLevelConstraint( - type=ConstraintType.check, - name=None, - expression="(id > 0)", - warn_unenforced=True, - warn_unsupported=True, - to=None, - to_columns=[], - ), - ], - quote=True, - tags=[], - _extra={}, - granularity=None, - ), - "color": ColumnInfo( - name="color", - description="", - doc_blocks=[], - meta={}, - data_type="string", - constraints=[], - quote=None, - tags=[], - _extra={}, - granularity=None, - ), - "date_day": ColumnInfo( - name="date_day", - description="", - doc_blocks=[], - meta={}, - data_type="date", - constraints=[], - quote=None, - tags=[], - _extra={}, - granularity=None, - ), - } + expected_columns = "{'id': ColumnInfo(name='id', description='hello', meta={}, data_type='integer', constraints=[ColumnLevelConstraint(type=, name=None, expression=None, warn_unenforced=True, warn_unsupported=True, to=None, to_columns=[]), ColumnLevelConstraint(type=, name=None, expression=None, warn_unenforced=True, warn_unsupported=True, to=None, to_columns=[]), ColumnLevelConstraint(type=, name=None, expression='(id > 0)', warn_unenforced=True, warn_unsupported=True, to=None, to_columns=[])], quote=True, tags=[], _extra={}, granularity=None), 'color': ColumnInfo(name='color', description='', meta={}, data_type='string', constraints=[], quote=None, tags=[], _extra={}, granularity=None), 'date_day': ColumnInfo(name='date_day', description='', meta={}, data_type='date', constraints=[], quote=None, tags=[], _extra={}, granularity=None)}" - assert expected_columns == my_model_columns + assert expected_columns == str(my_model_columns) # compiled fields aren't in the manifest above because it only has parsed fields manifest_json = get_artifact(project.project_root, "target", "manifest.json") diff --git a/tests/functional/docs/test_good_docs_blocks.py b/tests/functional/docs/test_good_docs_blocks.py index 60f39b6e35e..e1ed96c5eb7 100644 --- a/tests/functional/docs/test_good_docs_blocks.py +++ b/tests/functional/docs/test_good_docs_blocks.py @@ -58,8 +58,6 @@ description: The user's first name - name: last_name description: "{{ doc('test', 'my_model_doc__last_name') }}" - - name: tricky - description: "{{ doc('my_model_doc__id') }} The user's first name {{ doc('test', 'my_model_doc__last_name') }}" """ @@ -84,7 +82,6 @@ def test_valid_doc_ref(self, project): model_data = manifest["nodes"]["model.test.model"] assert model_data["description"] == "My model is just a copy of the seed" - assert model_data["doc_blocks"] == ["doc.test.my_model_doc"] assert { "name": "id", @@ -95,7 +92,6 @@ def test_valid_doc_ref(self, project): "quote": None, "tags": [], "granularity": None, - "doc_blocks": ["doc.test.my_model_doc__id"], } == model_data["columns"]["id"] assert { @@ -107,7 +103,6 @@ def test_valid_doc_ref(self, project): "quote": None, "tags": [], "granularity": None, - "doc_blocks": [], } == model_data["columns"]["first_name"] assert { @@ -119,25 +114,9 @@ def test_valid_doc_ref(self, project): "quote": None, "tags": [], "granularity": None, - "doc_blocks": ["doc.test.my_model_doc__last_name"], } == model_data["columns"]["last_name"] - assert { - "name": "tricky", - "description": "The user ID number The user's first name The user's last name", - "data_type": None, - "constraints": [], - "meta": {}, - "quote": None, - "tags": [], - "granularity": None, - "doc_blocks": [ - "doc.test.my_model_doc__id", - "doc.test.my_model_doc__last_name", - ], - } == model_data["columns"]["tricky"] - - assert len(model_data["columns"]) == 4 + assert len(model_data["columns"]) == 3 class TestGoodDocsBlocksAltPath: @@ -167,7 +146,6 @@ def test_alternative_docs_path(self, project): model_data = manifest["nodes"]["model.test.model"] assert model_data["description"] == "Alt text about the model" - assert model_data["doc_blocks"] == ["doc.test.my_model_doc"] assert { "name": "id", @@ -178,7 +156,6 @@ def test_alternative_docs_path(self, project): "quote": None, "tags": [], "granularity": None, - "doc_blocks": ["doc.test.my_model_doc__id"], } == model_data["columns"]["id"] assert { @@ -190,7 +167,6 @@ def test_alternative_docs_path(self, project): "quote": None, "tags": [], "granularity": None, - "doc_blocks": [], } == model_data["columns"]["first_name"] assert { @@ -202,22 +178,6 @@ def test_alternative_docs_path(self, project): "quote": None, "tags": [], "granularity": None, - "doc_blocks": ["doc.test.my_model_doc__last_name"], } == model_data["columns"]["last_name"] - assert { - "name": "tricky", - "description": "The user ID number with alternative text The user's first name The user's last name in this other file", - "data_type": None, - "constraints": [], - "meta": {}, - "quote": None, - "tags": [], - "granularity": None, - "doc_blocks": [ - "doc.test.my_model_doc__id", - "doc.test.my_model_doc__last_name", - ], - } == model_data["columns"]["tricky"] - - assert len(model_data["columns"]) == 4 + assert len(model_data["columns"]) == 3 diff --git a/tests/unit/contracts/graph/test_manifest.py b/tests/unit/contracts/graph/test_manifest.py index 9b6c056e802..526f46c7884 100644 --- a/tests/unit/contracts/graph/test_manifest.py +++ b/tests/unit/contracts/graph/test_manifest.py @@ -82,7 +82,6 @@ "compiled_path", "patch_path", "docs", - "doc_blocks", "checksum", "unrendered_config", "unrendered_config_call_dict", diff --git a/tests/unit/contracts/graph/test_nodes.py b/tests/unit/contracts/graph/test_nodes.py index 665b4dfe573..0648fe1174d 100644 --- a/tests/unit/contracts/graph/test_nodes.py +++ b/tests/unit/contracts/graph/test_nodes.py @@ -209,7 +209,6 @@ def basic_compiled_dict(): "config_call_dict": {}, "access": "protected", "constraints": [], - "doc_blocks": [], } @@ -530,7 +529,6 @@ def basic_compiled_schema_test_dict(): }, "unrendered_config_call_dict": {}, "config_call_dict": {}, - "doc_blocks": [], } diff --git a/tests/unit/contracts/graph/test_nodes_parsed.py b/tests/unit/contracts/graph/test_nodes_parsed.py index 0b275fb5ac9..75d451b9956 100644 --- a/tests/unit/contracts/graph/test_nodes_parsed.py +++ b/tests/unit/contracts/graph/test_nodes_parsed.py @@ -207,7 +207,6 @@ def base_parsed_model_dict(): "config_call_dict": {}, "access": AccessType.Protected.value, "constraints": [], - "doc_blocks": [], } @@ -316,7 +315,6 @@ def complex_parsed_model_dict(): "meta": {}, "tags": [], "constraints": [], - "doc_blocks": [], }, }, "checksum": { @@ -332,7 +330,6 @@ def complex_parsed_model_dict(): "config_call_dict": {}, "access": AccessType.Protected.value, "constraints": [], - "doc_blocks": [], } @@ -541,7 +538,6 @@ def basic_parsed_seed_dict(): "unrendered_config": {}, "unrendered_config_call_dict": {}, "config_call_dict": {}, - "doc_blocks": [], } @@ -636,7 +632,6 @@ def complex_parsed_seed_dict(): "meta": {}, "tags": [], "constraints": [], - "doc_blocks": [], } }, "meta": {"foo": 1000}, @@ -649,7 +644,6 @@ def complex_parsed_seed_dict(): }, "unrendered_config_call_dict": {}, "config_call_dict": {}, - "doc_blocks": [], } @@ -850,7 +844,6 @@ def base_parsed_hook_dict(): "unrendered_config": {}, "unrendered_config_call_dict": {}, "config_call_dict": {}, - "doc_blocks": [], } @@ -932,7 +925,6 @@ def complex_parsed_hook_dict(): "meta": {}, "tags": [], "constraints": [], - "doc_blocks": [], }, }, "index": 13, @@ -946,7 +938,6 @@ def complex_parsed_hook_dict(): }, "unrendered_config_call_dict": {}, "config_call_dict": {}, - "doc_blocks": [], } @@ -1092,7 +1083,6 @@ def basic_parsed_schema_test_dict(): "unrendered_config": {}, "unrendered_config_call_dict": {}, "config_call_dict": {}, - "doc_blocks": [], } @@ -1168,7 +1158,6 @@ def complex_parsed_schema_test_dict(): "meta": {}, "tags": [], "constraints": [], - "doc_blocks": [], }, }, "column_name": "id", @@ -1183,7 +1172,6 @@ def complex_parsed_schema_test_dict(): "unrendered_config": {"materialized": "table", "severity": "WARN"}, "unrendered_config_call_dict": {}, "config_call_dict": {}, - "doc_blocks": [], } @@ -1579,7 +1567,6 @@ def basic_timestamp_snapshot_dict(): }, "unrendered_config_call_dict": {}, "config_call_dict": {}, - "doc_blocks": [], } @@ -1685,7 +1672,6 @@ def basic_check_snapshot_dict(): }, "unrendered_config_call_dict": {}, "config_call_dict": {}, - "doc_blocks": [], } @@ -1895,7 +1881,6 @@ def basic_parsed_source_definition_dict(): "enabled": True, }, "unrendered_config": {}, - "doc_blocks": [], } @@ -1928,7 +1913,6 @@ def complex_parsed_source_definition_dict(): "freshness": {"warn_after": {"period": "hour", "count": 1}, "error_after": {}}, "loaded_at_field": "loaded_at", "unrendered_config": {}, - "doc_blocks": [], }