review_metadata

review_metadata(path)

Report the metadata a package still needs, with the call that fills it.

Lists every field that still blocks validate_salmon_datapackage(path, require_iris=True), and prints the exact :func:set_sdp_dataset / :func:set_sdp_table / :func:set_sdp_column / :func:set_sdp_code call that fills it. Replace the <...> placeholder in the printed call with the real value and paste it – the paste is the audit trail, just as it is for :func:accept_suggestion.

This is the companion to :func:review_semantics, and it sees something that review structurally cannot: a slot with no candidates at all. :func:review_semantics builds its queue from retrieved suggestions, so a field nothing was found for never appears there. :func:review_metadata builds its list from the package’s own required-field rules, so an empty shortlist and a full one look the same to it.

What it reports:

  • unresolved MISSING DESCRIPTION: / MISSING METADATA: / REVIEW REQUIRED: placeholders in any metadata field;
  • schema-required fields (constraints.required) that are blank – a column the file does not have counts as blank in every row;
  • any schema-declared IRI field swept by strict validation in dataset.csv, tables.csv, column_dictionary.csv or codes.csv still carrying an unresolved REVIEW: marker. These also appear in :func:review_semantics, which has their candidates; they are listed here too because this is the scan that promises to name everything blocking strict validation, and a package left part-decided is the common case. Dictionary fields stay confined to that validator’s fixed six; the other metadata files use *_iri;
  • measurement columns missing term_iri, property_iri, entity_iri or unit_iri;
  • tables.csv rows with a blank observation_unit_iri.

It never contacts an LLM, and under the shipped schema settings it never contacts a network: the SDP schema it reads constraints.required from is the copy bundled with metasalmonpy. When set_sdp_schema_source() or set_sdp_schema_base_url(), or METASALMONPY_SDP_SCHEMA_SOURCE or METASALMONPY_SDP_SCHEMA_BASE_URL, selects a different schema, it reads that one, as the package writers do: from this process’s cache once they have loaded it, and otherwise by loading it as they would.

Returns

Name Type Description
MetadataReview One row per unfilled field, empty when nothing is outstanding.
Back to top