pyinc-docs API

Module

pyinc_docs.analysis

Static package discovery, API extraction, exports, and annotation links.

function

collect_compiler_warnings

def collect_compiler_warnings(db: Database, source: str) -> tuple[str, ...]

Collect warnings while keeping dynamic module dispatch outside a cached root.

function

compiler_warnings

def compiler_warnings(db: Database, source: str) -> tuple[str, ...]
function

decoded_source

def decoded_source(db: Database, source: str, module: str) -> tuple[str, str]

Decode one module with Python's PEP 263 rules.

function

direct_export_anchor

def direct_export_anchor(db: Database, source: str, module: str, name: str) -> tuple[str, str] | tuple[()]
function

directory_entries

def directory_entries(db: Database, path: str) -> tuple[str, tuple[tuple[str, str], ...]]

Return the tracked no-follow snapshot for one directory path.

function

linked_module_model

def linked_module_model(db: Database, source: str, module: str) -> LinkedModulePayload
function

module_api

def module_api(db: Database, source: str, module: str) -> ModuleApiPayload

Extract the successful public API without bodies or source positions.

function

module_export_surface

def module_export_surface(db: Database, source: str, module: str) -> tuple[ExportPayload, ...]
function

module_record

def module_record(db: Database, source: str, module: str) -> ModuleRecord
function

one_hop_export_anchor

def one_hop_export_anchor(db: Database, source: str, module: str, name: str) -> tuple[str, str] | tuple[()]
function

workspace_index

def workspace_index(db: Database, source: str) -> WorkspaceIndexPayload
function

workspace_layout

def workspace_layout(db: Database, source: str) -> LayoutPayload

Discover a regular package tree and assign deterministic module identities.