Skip to content

Models

Models for the code generation module.

GenConfig dataclass

Configuration settings for the 'gen' command.

Source code in src/codemap/gen/models.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@dataclass
class GenConfig:
	"""Configuration settings for the 'gen' command."""

	# Fields without default values
	max_content_length: int
	use_gitignore: bool
	output_dir: Path
	semantic_analysis: bool
	lod_level: LODLevel

	# Fields with default values
	include_tree: bool = True
	include_entity_graph: bool = True
	mermaid_entities: list[str] = field(default_factory=list)
	mermaid_relationships: list[str] = field(default_factory=list)
	mermaid_show_legend: bool = True
	mermaid_remove_unconnected: bool = False

__init__ 

__init__(
	max_content_length: int,
	use_gitignore: bool,
	output_dir: Path,
	semantic_analysis: bool,
	lod_level: LODLevel,
	include_tree: bool = True,
	include_entity_graph: bool = True,
	mermaid_entities: list[str] = list(),
	mermaid_relationships: list[str] = list(),
	mermaid_show_legend: bool = True,
	mermaid_remove_unconnected: bool = False,
) -> None

max_content_length instance-attribute 

max_content_length: int

use_gitignore instance-attribute 

use_gitignore: bool

output_dir instance-attribute 

output_dir: Path

semantic_analysis instance-attribute 

semantic_analysis: bool

lod_level instance-attribute 

lod_level: LODLevel

include_tree class-attribute instance-attribute 

include_tree: bool = True

include_entity_graph class-attribute instance-attribute 

include_entity_graph: bool = True

mermaid_entities class-attribute instance-attribute 

mermaid_entities: list[str] = field(default_factory=list)

mermaid_relationships class-attribute instance-attribute 

mermaid_relationships: list[str] = field(
	default_factory=list
)

mermaid_show_legend class-attribute instance-attribute 

mermaid_show_legend: bool = True

mermaid_remove_unconnected class-attribute instance-attribute 

mermaid_remove_unconnected: bool = False