models
Data models for extracted documentation.
Classes
class
@dataclass
class ArgInfo
Represents a function/method argument.
Methods
def
def signature_str(self) -> str
Return the argument as it would appear in a signature.
class
@dataclass
class FunctionDoc
Documentation extracted from a function or method.
Methods
def
@property
def signature(self) -> str
Build a readable function signature string.
class
@dataclass
class ClassDoc
Documentation extracted from a class.
Methods
def
@property
def signature(self) -> str
Build a readable class signature string.
class
@dataclass
class ModuleDoc
Documentation extracted from a single Python module (file).
Methods
def
@property
def is_empty(self) -> bool
Check if the module has any documented items.
class
@dataclass
class ProjectDoc
Aggregated documentation for an entire project.
Methods
def
@property
def module_count(self) -> int
Returns the total number of modules in the module collection.
Args:
None
Returns:
The total count of modules as an integer.
Raises:
AttributeError: If the module collection is not initialized.
def
@property
def function_count(self) -> int
Returns the total number of functions across all modules.
Args:
self: The object instance.
Returns:
The total number of functions as an integer.
Raises:
AttributeError: If the object instance does not have a 'modules' attribute.
def
@property
def class_count(self) -> int
Returns the total number of classes across all modules in the system.
Args:
self: The current object instance.
Returns:
The total count of classes as an integer.
Raises:
AttributeError: If the object instance does not have a 'modules' attribute.