statcatlib.checks

Generated from the docstrings. Pass seal checks to WorkingCopy.seal(checks=[...]).

checks

Seal checks: what WorkingCopy.seal runs before it writes the manifest.

A seal check is a function of the working copy's view that returns what it finds wrong, as sdmxlib.edition.Finding values. Pass checks to wc.seal(checks=[...]): any finding refuses the seal, raising SealCheckError, and leaves the working copy open to fix. seal runs none by default.

Example

from statcatlib import checks

wc.seal(checks=[checks.conf_status()])

conf_status

conf_status(
    attribute: str = "CONF_STATUS",
    public: Iterable[str] = ("F",),
) -> SealCheck

A check that refuses observations whose confidentiality status is not public.

For each dataflow whose data structure has the attribute and whose observations the edition holds, it reads them through view.registry.obs(flow) and reports one finding per observation whose attribute value is not in public. An observation with no value for the attribute is not reported.

Parameters:

Name	Type	Description	Default
attribute	str	The attribute holding the confidentiality status, by component id.	'CONF_STATUS'
public	Iterable[str]	The values that may be published: F (free) by default.	('F',)

Returns:

Type	Description
SealCheck	The check, for wc.seal(checks=[...]).