audit_field_catalog.py File Reference

Go to the source code of this file.

Namespaces
namespace	audit_field_catalog

Functions
dict	audit_field_catalog.compiled_eulerian ()
	Canonical name to layout for every compiled Eulerian catalog entry.
set	audit_field_catalog.compiled_particle ()
	Canonical names of every compiled particle catalog entry.
set	audit_field_catalog.compiled_layouts ()
	Layout vocabulary the header defines.
str	audit_field_catalog.page_section (str heading)
	One @section body from the catalog page.
tuple	audit_field_catalog.documented_eulerian (str section)
	Field-to-layout mapping the inventory section publishes.
set	audit_field_catalog.documented_particle (str section)
	Particle field names the inventory section publishes.
set	audit_field_catalog.documented_layouts ()
	Layout vocabulary the layout section tabulates.
int	audit_field_catalog.main ()
	Fail when the published catalog inventory and the compiled catalog disagree.

Variables
	audit_field_catalog.REPO_ROOT = Path(__file__).resolve().parents[2]
str	audit_field_catalog.EULERIAN_CATALOG = REPO_ROOT / "src" / "field_catalog.c"
str	audit_field_catalog.PARTICLE_CATALOG = REPO_ROOT / "src" / "particle_field_catalog.c"
str	audit_field_catalog.LAYOUT_HEADER = REPO_ROOT / "include" / "field_catalog.h"
str	audit_field_catalog.PAGE = REPO_ROOT / "docs" / "pages" / "56_Field_Identity_and_Layout_Catalog.md"
dict	audit_field_catalog.GROUP_LAYOUTS
	audit_field_catalog.ENTRY_RE
	audit_field_catalog.PARTICLE_ENTRY_RE = re.compile(r'PARTICLE_FIELD_ENTRY\(\s*PARTICLE_FIELD_ID_\w+\s*,\s*"([^"]+)"')
	audit_field_catalog.LAYOUT_ENUM_RE = re.compile(r"^\s*(FIELD_LAYOUT_\w+)", re.M)
	audit_field_catalog.BACKTICKED_RE = re.compile(r"`([A-Za-z_][A-Za-z0-9_]*)`")