# contracts URL: /api/rendering/plugins/directives/contracts/ Section: directives -------------------------------------------------------------------------------- contracts - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy Plugins Directives ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module rendering.plugins.directives.contracts Directive contract system for nesting validation. Provides DirectiveContract to define valid parent-child relationships between directives, catching invalid nesting at parse time rather than producing silent failures or broken HTML. Architecture: Contracts are defined as class-level constants on BengalDirective subclasses. The base class validates contracts automatically during parsing, emitting warnings for violations. Related: bengal/rendering/plugins/directives/base.py: BengalDirective validates contracts RFC: plan/active/rfc-directive-system-v2.md (Issue 7: No nested directive validation) Example: class StepDirective(BengalDirective): CONTRACT = DirectiveContract(requires_parent=("steps",)) # This produces a warning at parse time: # :::{step} # Orphaned step - not inside :::{steps} # ::: View source 3 Classes Classes DirectiveContract dataclass Defines valid nesting relationships for a directive. This is the KEY FEATURE that solves the neste… 3 Caret Right Defines valid nesting relationships for a directive. This is the KEY FEATURE that solves the nested directive validation problem. Contracts are checked at parse time to catch invalid nesting early. Attributes Name Type Description requires_parent tuple[str, ...] This directive MUST be inside one of these parent types. Empty tuple means can appear anywhere (root-level OK). requires_children tuple[str, ...] This directive MUST contain at least one of these types. Empty tuple means no required children. min_children int Minimum count of required_children types. max_children int Maximum children (0 = unlimited). Example - StepDirective (must be inside steps): CONTRACT = DirectiveContract( requires_parent=("steps",), ) Example - StepsDirective (must contain steps): CONTRACT = DirectiveContract( requires_children=("step",), min_children=1, allowed_children=("step",), ) Example - TabSetDirective (tabs with items): CONTRACT = DirectiveContract( requires_children=("tab_item",), min_children=1, ) allowed_children tuple[str, ...] Only these child types are allowed (whitelist). Empty tuple means any children allowed. disallowed_children tuple[str, ...] These child types are NOT allowed (blacklist). Takes precedence over allowed_children. Methods 2 Tag has_parent_requirement property True if this directive requires a specific parent. bool Caret Right def has_parent_requirement(self) -> bool True if this directive requires a specific parent. Returns bool Tag has_child_requirement property True if this directive requires specific children. bool Caret Right def has_child_requirement(self) -> bool True if this directive requires specific children. Returns bool Internal Methods 1 Caret Right __post_init__ Validate contract configuration. 0 None Caret Right def __post_init__(self) -> None Validate contract configuration. ContractViolation dataclass Represents a contract violation found during parsing. Collected violations can be: - Logged as war… 1 Caret Right Represents a contract violation found during parsing. Collected violations can be: Logged as warnings (default) Raised as errors (strict mode) Reported in health checks Attributes Name Type Description directive str The directive type that was validated violation_type str Type of violation (for structured logging) message str Human-readable description expected list[str] | int | None What was expected (list, int, or description) found list[str] | str | int | None What was actually found location str | None Source location (e.g., "content/guide.md:45") Methods 1 to_log_dict Convert to structured log format. Note: Uses 'detail' instead of 'message' to … 0 dict[str, Any] Caret Right def to_log_dict(self) -> dict[str, Any] Convert to structured log format. Note: Uses 'detail' instead of 'message' to avoid conflict with BengalLogger's positional 'message' argument. Returns dict[str, Any] — Dict suitable for structured logging kwargs ContractValidator Validates directive nesting against contracts. Used by BengalDirective.parse() to check: 1. Parent… 2 Caret Right Validates directive nesting against contracts. Used by BengalDirective.parse() to check: Parent context is valid (if requires_parent specified) Children meet requirements (if requires_children specified) Children types are allowed (if allowed_children specified) Example usage in BengalDirective: def parse(self, block, m, state): # ... parse content ... # Validate parent if self.CONTRACT: parent_type = self._get_parent_type(state) violations = ContractValidator.validate_parent( self.CONTRACT, self.TOKEN_TYPE, parent_type ) for v in violations: self.logger.warning(v.violation_type, **v.to_log_dict()) # ... parse children ... # Validate children if self.CONTRACT: violations = ContractValidator.validate_children( self.CONTRACT, self.TOKEN_TYPE, children ) for v in violations: self.logger.warning(v.violation_type, **v.to_log_dict()) Methods 2 validate_parent staticmethod Validate that the directive is inside a valid parent. 4 list[ContractViolation] Caret Right def validate_parent(contract: DirectiveContract, directive_type: str, parent_type: str | None, location: str | None = None) -> list[ContractViolation] Validate that the directive is inside a valid parent. Parameters 4 contract DirectiveContract The directive's contract directive_type str The directive being validated (e.g., "step") parent_type str | None The parent directive type (None if at root) location str | None Source location for error messages Returns list[ContractViolation] — List of violations (empty if valid) validate_children staticmethod Validate that children meet contract requirements. 4 list[ContractViolation] Caret Right def validate_children(contract: DirectiveContract, directive_type: str, children: list[dict[str, Any]], location: str | None = None) -> list[ContractViolation] Validate that children meet contract requirements. Parameters 4 contract DirectiveContract The directive's contract directive_type str The directive being validated (e.g., "steps") children list[dict[str, Any]] Parsed child tokens location str | None Source location for error messages Returns list[ContractViolation] — List of violations (empty if valid) ← Previous container Next → data_table List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 1686 - Reading Time: 8 minutes