autodocgenerator 0.8.9.9__py3-none-any.whl → 0.9.0.1__py3-none-any.whl

autodocgenerator/auto_runner/config_reader.py

@@ -1,12 +1,20 @@
 import yaml
 from autodocgenerator.factory.modules.general_modules import CustomModule, CustomModuleWithOutContext
-from ..config.config import Config, ProjectConfigSettings
+from ..config.config import Config, ProjectBuildConfig
 
 
+class StructureSettings:
+    include_intro_links = True
+    include_order = True
+    max_doc_part_size = 5_000
+
+    def load_settings(self, data: dict[str, any]):
+        for key, el in data.items():
+            setattr(self, key, el)
 
-def read_config(file_data: str) -> tuple[Config, list[CustomModule]]:
-    data = yaml.safe_load(file_data)
 
+def read_config(file_data: str) -> tuple[Config, list[CustomModule], StructureSettings]:
+    data = yaml.safe_load(file_data)
     config : Config = Config()
 
     ignore_files = data.get("ignore_files", [])
@@ -15,8 +23,8 @@ def read_config(file_data: str) -> tuple[Config, list[CustomModule]]:
     project_name = data.get("project_name")
     project_additional_info = data.get("project_additional_info", {})
 
-    project_settings = data.get("project_settings", {})
-    pcs = ProjectConfigSettings()
+    project_settings = data.get("build_settings", {})
+    pcs = ProjectBuildConfig()
     pcs.load_settings(project_settings)
     
     config.set_language(language).set_project_name(project_name).set_pcs(pcs)
@@ -31,4 +39,8 @@ def read_config(file_data: str) -> tuple[Config, list[CustomModule]]:
 
     custom_modules = [CustomModuleWithOutContext(custom_discription[1:])  if custom_discription[0] == "%" else CustomModule(custom_discription) for custom_discription in custom_discriptions]
 
-    return config, custom_modules
+    structure_settings = data.get("structure_settings", {})
+    structure_settings_object = StructureSettings()
+    structure_settings_object.load_settings(structure_settings)
+
+    return config, custom_modules, structure_settings_object

autodocgenerator/auto_runner/run_file.py

@@ -1,13 +1,17 @@
 from autodocgenerator.manage import Manager
 from autodocgenerator.factory.base_factory import DocFactory
+from autodocgenerator.factory.modules.general_modules import CustomModule, CustomModuleWithOutContext
 from autodocgenerator.factory.modules.intro import IntroLinks
 from autodocgenerator.ui.progress_base import ConsoleGtiHubProgress
-from autodocgenerator.auto_runner.config_reader import Config, read_config
+from autodocgenerator.auto_runner.config_reader import Config, read_config, StructureSettings
 from autodocgenerator.engine.models.gpt_model import GPTModel, AsyncGPTModel
 from autodocgenerator.engine.config.config import API_KEY
 
 
-def gen_doc(project_path: str, config: Config, custom_modules):
+def gen_doc(project_path: str, 
+            config: Config, 
+            custom_modules: list[CustomModule | CustomModuleWithOutContext], 
+            structure_settings: StructureSettings) -> str:
     
     sync_model = GPTModel(API_KEY, use_random=False)
     async_model = AsyncGPTModel(API_KEY)
@@ -22,10 +26,13 @@ def gen_doc(project_path: str, config: Config, custom_modules):
 
 
     manager.generate_code_file()
-    manager.generete_doc_parts(max_symbols=5000)
+    manager.generete_doc_parts(max_symbols=structure_settings.max_doc_part_size)
     manager.factory_generate_doc(DocFactory(*custom_modules))
-    manager.order_doc()
-    manager.factory_generate_doc(DocFactory(IntroLinks()))
+    if structure_settings.include_order:
+        manager.order_doc()
+    
+    if structure_settings.include_intro_links:
+        manager.factory_generate_doc(DocFactory(IntroLinks()))
     manager.clear_cache()
 
     return manager.read_file_by_file_key("output_doc")
@@ -33,12 +40,13 @@ def gen_doc(project_path: str, config: Config, custom_modules):
 if __name__ == "__main__":
     with open("autodocconfig.yml", "r", encoding="utf-8") as file:
         config_data = file.read()
-    config, custom_modules = read_config(config_data)
+    config, custom_modules, structure_settings = read_config(config_data)
 
     output_doc = gen_doc(
         ".",
         config,
-        custom_modules
+        custom_modules,
+        structure_settings
     )
 
     

autodocgenerator/config/config.py

@@ -4,7 +4,7 @@ from ..factory.base_factory import DocFactory
 from ..factory.modules.intro import IntroLinks
 
 
-class ProjectConfigSettings:
+class ProjectBuildConfig:
     save_logs = False
     log_level = -1
     def load_settings(self, data: dict[str, any]):
@@ -22,14 +22,14 @@ class Config:
         self.language: str = "en"
         self.project_name: str = ""
         self.project_additional_info: dict = {}
-        self.pcs: ProjectConfigSettings = ProjectConfigSettings()
+        self.pbc: ProjectBuildConfig = ProjectBuildConfig()
 
     def set_language(self, language: str):
         self.language = language
         return self
     
-    def set_pcs(self, pcs: ProjectConfigSettings):
-        self.pcs = pcs
+    def set_pcs(self, pcs: ProjectBuildConfig):
+        self.pbc = pcs
         return self
     
     def set_project_name(self, name: str):

autodocgenerator/engine/config/config.py

@@ -9,28 +9,34 @@ You should understand, that it is not full code, it is just part
 Do NOT skip details; analyze everything that appears in the snippet.
 """
 
-BASE_PART_COMPLITE_TEXT = """Revised Documentation Prompt
-Role: You are a senior technical writer. Input: You will receive a specific code snippet representing a fragment of a larger system.
-Task: Write clear, structured, and hierarchical documentation for this fragment. Length: 0.7–1k characters (keep it tight).
-
-Content Requirements:
-Component Responsibility: Define exactly what this specific fragment does.
-Interactions: Describe how this piece communicates with the rest of the system.
-Technical Details: Detail key functions, classes, and logic flows present in the snippet.
-Data Flow: Outline inputs, outputs, side effects, and logic assumptions.
-
-Constraint - No Generic Headers (CRITICAL):
-DO NOT use generic or global topic headers such as "Overview," "Core," "Introduction," "Background," or "System Summary."
-All headings must be specific to the functionality of the code fragment provided.
-
-Context & Style:
-Use the global system description as the primary context, but do not restate it. Focus exclusively on the fragment.
-Write for developers who are new to the codebase.
-Maintain high technical accuracy and a concise, professional tone.
-
-Formatting:
-Use Markdown for structure.
-Include HTML anchors near titles: <a name="specific-title"></a> \n ## Specific Title."""
+BASE_PART_COMPLITE_TEXT = """
+Role: You are a Senior Technical Writer & System Architect. Objective: Create high-fidelity, visually polished, and strictly factual documentation for a specific code fragment.
+
+1. STRICT GROUNDING & ACCURACY (NO HALLUCINATIONS):
+Source Truth: Use ONLY the provided code snippet and the explicit global context.
+Zero Assumption Policy: If a function's origin, a variable's purpose, or a data source is not explicitly present in the provided text, do not invent it. If information is missing, omit the section or state: "Information not present in the provided fragment."
+Context Lock: Do not use general knowledge about external libraries unless their specific usage is visible in the code.
+
+2. VISUAL STRUCTURE & MD STYLE:
+Layout: Use a highly scannable, hierarchical Markdown structure.
+Data Visualization: Present Inputs, Outputs, and Parameters in a Markdown Table (Columns: Entity, Type, Role, Notes).
+Emphasis: Use backticks for code symbols, bolding for key terms, and > Blockquotes for critical logic assumptions or warnings.
+Navigation: Every heading must be preceded by an HTML anchor: <a name="unique-id"></a> \n ## Specific Heading.
+
+3. CONTENT REQUIREMENTS (0.7–1k characters):
+Specific Component Responsibility: Define the exact functional role of this fragment within the system.
+Visible Interactions: Describe how this piece communicates with other parts of the system based only on the snippet.
+Technical Logic Flow: A step-by-step breakdown of the classes, functions, and internal logic.
+Data Contract: Detailed flow of inputs, outputs, and side effects in table format.
+
+4. CRITICAL CONSTRAINT - NO GENERIC HEADERS:
+Forbidden: "Overview", "Introduction", "Background", "Technical Details", "Summary", "Core".
+Required: Use headers that describe the specific functionality (e.g., ## [Component Name] Request Validation or ## Stream Processing Pipeline).
+
+5. TONE & STYLE:
+Professional, technical, and laconic.
+Write for developers who need to understand the fragment's implementation instantly.
+Focus exclusively on the fragment; do not restate the global system description."""
 
 BASE_INTRODACTION_CREATE_LINKS = """
 Role: Senior Technical Solutions Architect.

autodocgenerator/manage.py

@@ -13,7 +13,7 @@ from .factory.modules.general_modules import CustomModule
 from .ui.progress_base import BaseProgress, LibProgress
 from .ui.logging import BaseLogger, BaseLoggerTemplate, InfoLog, ErrorLog, WarningLog, FileLoggerTemplate
 from .preprocessor.settings import ProjectSettings
-from .auto_runner.config_reader import ProjectConfigSettings
+from .auto_runner.config_reader import ProjectBuildConfig
 from .postprocessor.sorting import get_order, split_text_by_anchors
 from .config.config import Config
 
@@ -44,7 +44,7 @@ class Manager:
         self.async_model = async_model
 
         self.logger = BaseLogger()
-        self.logger.set_logger(FileLoggerTemplate(self.get_file_path("logs"), log_level=self.config.pcs.log_level))
+        self.logger.set_logger(FileLoggerTemplate(self.get_file_path("logs"), log_level=self.config.pbc.log_level))
 
         cache_path = os.path.join(self.project_directory, self.CACHE_FOLDER_NAME)
 
@@ -120,6 +120,6 @@ class Manager:
             file.write(result)
 
     def clear_cache(self):
-        if not self.config.pcs.save_logs:
+        if not self.config.pbc.save_logs:
             os.remove(self.get_file_path("logs"))
         

autodocgenerator/preprocessor/spliter.py

@@ -40,13 +40,13 @@ def split_data(data: str, max_symbols: int) -> list[str]:
 
     return split_objects
 
-def write_docs_by_parts(part_id: int, part: str, model: Model, prev_info: str = None, language: str = "en"):
+def write_docs_by_parts(part: str, model: Model, prev_info: str = None, language: str = "en"):
     logger = BaseLogger()
     logger.log(InfoLog("Generating documentation for a part..."))
     prompt = [
             {
                 "role": "system",
-                "content": f"For the following task use language {language}. your part id is {part_id}"
+                "content": f"For the following task use language {language}"
             },
             {
                 "role": "system",
@@ -89,10 +89,7 @@ async def async_write_docs_by_parts(part: str, async_model: AsyncModel, global_i
                 "role": "system",
                 "content": BASE_PART_COMPLITE_TEXT
             },
-            # {
-                # "role": "system",
-                # "content": global_info
-            # },
+           
             {
                 "role": "user",
                 "content": part
@@ -102,7 +99,7 @@ async def async_write_docs_by_parts(part: str, async_model: AsyncModel, global_i
         if prev_info is not None:
             prompt.append({
                     "role": "system",
-                    "content": f"it is last part of documentation that you have write before{prev_info}"
+                    "content": f"it is last part of documentation that you have write before {prev_info}"
                 })
 
         prompt.append({
@@ -134,7 +131,7 @@ def gen_doc_parts(full_code_mix, max_symbols, model: Model, language, progress_b
     
     all_result = ""
     for i, el in enumerate(splited_data):
-        result = write_docs_by_parts(i + 1, el, model, result, language)
+        result = write_docs_by_parts(el, model, result, language)
         all_result += result
         all_result += "\n\n"
 

autodocgenerator/ui/progress_base.py

@@ -57,7 +57,7 @@ class ConsoleGtiHubProgress(BaseProgress):
     def __init__(self):
         super().__init__()
         self.curr_task = None
-        self.gen_task = ConsoleTask("General Progress", 5)
+        self.gen_task = ConsoleTask("General Progress", 4)
 
     def create_new_subtask(self, name: str, total_len: int):
         self.curr_task = ConsoleTask(name, total_len)