# python

URL: /api/autodoc/extractors/python/
Section: extractors

--------------------------------------------------------------------------------

python - 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 Autodoc Extractors ᗢ 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 autodoc.extractors.python Python API documentation extractor. Extracts documentation from Python source files via AST parsing. No imports required - fast and reliable. View source 1 Class Classes PythonExtractor Extract Python API documentation via AST parsing. Features: - No imports (AST-only) - fast and rel… 23 Caret Right Extract Python API documentation via AST parsing. Features: No imports (AST-only) - fast and reliable Extracts modules, classes, functions, methods Type hint support Docstring extraction Signature building Alias detection Inherited member synthesis Performance: ~0.1-0.5s per file No dependencies loaded No side effects Inherits from Extractor Methods 2 extract Extract documentation from Python source. 1 list[DocElement] Caret Right def extract(self, source: Path) -> list[DocElement] Extract documentation from Python source. Parameters 1 source Path Directory or file path Returns list[DocElement] — List of DocElement objects get_output_path Get output path for element. Packages (modules from __init__.py) generate _ind… 1 Path | None Caret Right def get_output_path(self, element: DocElement) -> Path | None Get output path for element. Packages (modules from init.py) generate _index.md files to act as section indexes. With grouping enabled, modules are organized under group directories based on package hierarchy or explicit configuration. Examples (without grouping): bengal (package) → bengal/_index.md bengal.core (package) → bengal/core/_index.md bengal.core.site (module) → bengal/core/site.md Examples (with grouping, strip_prefix="bengal."): bengal.core (package) → core/_index.md bengal.cli.templates.blog (module) → templates/blog.md Parameters 1 element DocElement Returns Path | None — Path object for output location, or None if element should be skipped Internal Methods 21 Caret Right __init__ Initialize extractor. 2 None Caret Right def __init__(self, exclude_patterns: list[str] | None = None, config: dict[str, Any] | None = None) Initialize extractor. Parameters 2 exclude_patterns list[str] | None Glob patterns to exclude (e.g., "/tests/") config dict[str, Any] | None Configuration dict with include_inherited, exclude_patterns, etc. _init_grouping Initialize grouping configuration. 0 dict[str, Any] Caret Right def _init_grouping(self) -> dict[str, Any] Initialize grouping configuration. Returns dict[str, Any] — Grouping config dict with mode and prefix_map _extract_directory Extract from all Python files in directory. 1 list[DocElement] Caret Right def _extract_directory(self, directory: Path) -> list[DocElement] Extract from all Python files in directory. Parameters 1 directory Path Returns list[DocElement] _should_skip Check if file should be skipped. Handles common exclusion patterns: - Hidden d… 1 bool Caret Right def _should_skip(self, path: Path) -> bool Check if file should be skipped. Handles common exclusion patterns: Hidden directories (starting with .) Virtual environments (.venv, venv, env, .env) Site-packages (dependencies) Build artifacts (pycache, build, dist) Test files and directories Parameters 1 path Path Returns bool _extract_file Extract documentation from a single Python file. 1 list[DocElement] Caret Right def _extract_file(self, file_path: Path) -> list[DocElement] Extract documentation from a single Python file. Parameters 1 file_path Path Returns list[DocElement] _extract_module Extract module documentation. 3 DocElement | None Caret Right def _extract_module(self, tree: ast.Module, file_path: Path, source: str) -> DocElement | None Extract module documentation. Parameters 3 tree ast.Module file_path Path source str Returns DocElement | None _extract_class Extract class documentation. 3 DocElement | None Caret Right def _extract_class(self, node: ast.ClassDef, file_path: Path, parent_name: str = '') -> DocElement | None Extract class documentation. Parameters 3 node ast.ClassDef file_path Path parent_name str Returns DocElement | None _extract_function Extract function/method documentation. 3 DocElement | None Caret Right def _extract_function(self, node: ast.FunctionDef | ast.AsyncFunctionDef, file_path: Path, parent_name: str = '') -> DocElement | None Extract function/method documentation. Parameters 3 node ast.FunctionDef | ast.AsyncFunctionDef file_path Path parent_name str Returns DocElement | None _build_signature Build function signature string. 1 str Caret Right def _build_signature(self, node: ast.FunctionDef | ast.AsyncFunctionDef) -> str Build function signature string. Parameters 1 node ast.FunctionDef | ast.AsyncFunctionDef Returns str _extract_arguments Extract argument information. 1 list[dict[str, Any]] Caret Right def _extract_arguments(self, node: ast.FunctionDef | ast.AsyncFunctionDef) -> list[dict[str, Any]] Extract argument information. Parameters 1 node ast.FunctionDef | ast.AsyncFunctionDef Returns list[dict[str, Any]] _to_parsed_docstring Convert ParsedDoc to frozen ParsedDocstring. 1 ParsedDocstring | None Caret Right def _to_parsed_docstring(self, parsed: Any) -> ParsedDocstring | None Convert ParsedDoc to frozen ParsedDocstring. Parameters 1 parsed Any ParsedDoc from docstring_parser Returns ParsedDocstring | None — ParsedDocstring dataclass or None _to_parameter_info Convert arg dict to ParameterInfo. 1 ParameterInfo Caret Right def _to_parameter_info(self, arg: dict[str, Any]) -> ParameterInfo Convert arg dict to ParameterInfo. Parameters 1 arg dict[str, Any] Dict with name, annotation, default, docstring Returns ParameterInfo — ParameterInfo dataclass _has_yield Check if function contains yield statement. 1 bool Caret Right def _has_yield(self, node: ast.FunctionDef | ast.AsyncFunctionDef) -> bool Check if function contains yield statement. Parameters 1 node ast.FunctionDef | ast.AsyncFunctionDef Function AST node Returns bool — True if function is a generator _annotation_to_string Convert AST annotation to string. 1 str | None Caret Right def _annotation_to_string(self, annotation: ast.expr | None) -> str | None Convert AST annotation to string. Parameters 1 annotation ast.expr | None Returns str | None _expr_to_string Convert AST expression to string. 1 str Caret Right def _expr_to_string(self, expr: ast.expr) -> str Convert AST expression to string. Parameters 1 expr ast.expr Returns str _infer_module_name Infer module name from file path relative to source root. 1 str Caret Right def _infer_module_name(self, file_path: Path) -> str Infer module name from file path relative to source root. Parameters 1 file_path Path Returns str _get_relative_source_path Get source path relative to source root for GitHub links. 1 Path Caret Right def _get_relative_source_path(self, file_path: Path) -> Path Get source path relative to source root for GitHub links. Parameters 1 file_path Path Absolute file path Returns Path — Path relative to source root (e.g., "bengal/core/page.py") _should_include_inherited Check if inherited members should be included for element type. 1 bool Caret Right def _should_include_inherited(self, element_type: str = 'class') -> bool Check if inherited members should be included for element type. Parameters 1 element_type str Type of element ("class" or "exception") Returns bool — True if inherited members should be included _synthesize_inherited_members Add inherited members to a class element. 1 None Caret Right def _synthesize_inherited_members(self, class_elem: DocElement) -> None Add inherited members to a class element. Parameters 1 class_elem DocElement Class DocElement to augment with inherited members _detect_aliases Detect simple assignment aliases at module level. Patterns detected: - alias =… 3 dict[str, str] Caret Right def _detect_aliases(self, tree: ast.Module, module_name: str, defined_names: set[str]) -> dict[str, str] Detect simple assignment aliases at module level. Patterns detected: alias = original (ast.Name) alias = module.original (ast.Attribute) Parameters 3 tree ast.Module Module AST module_name str Current module qualified name defined_names set[str] Set of names defined in this module Returns dict[str, str] — Dict mapping alias_name -> qualified_original _extract_all_exports Extract __all__ exports if present. 1 list[str] | None Caret Right def _extract_all_exports(self, tree: ast.Module) -> list[str] | None Extract all exports if present. Parameters 1 tree ast.Module Returns list[str] | None ← Previous openapi 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: 2002
- Reading Time: 10 minutes