gost-docx 0.1.0__tar.gz

gost_docx-0.1.0/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.3
+Name: gost-docx
+Version: 0.1.0
+Summary: Add your description here
+Author: Dmitry Klimov
+Author-email: Dmitry Klimov <dmitry.v.klimov@gmail.com>
+Requires-Dist: pandas>=2.3.2,<3.0.0
+Requires-Dist: python-docx>=1.2.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+

gost_docx-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "gost-docx"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Dmitry Klimov", email = "dmitry.v.klimov@gmail.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "pandas>=2.3.2,<3.0.0",
+    "python-docx>=1.2.0",
+]
+
+[build-system]
+requires = ["uv_build>=0.10.8,<0.11.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "gost"

gost_docx-0.1.0/src/gost/__init__.py

@@ -0,0 +1,3 @@
+from .word_builder import WordBuilder
+
+__all__ = ["WordBuilder"]

gost_docx-0.1.0/src/gost/element_factory.py

@@ -0,0 +1,24 @@
+from gost.index.head_counter import HeadCounter
+from gost.index.counter import Counter
+from gost.elements.head import Head
+from gost.elements.image import Image
+from gost.elements.text import Text
+
+
+class ElementFactory:
+    def __init__(self, character: str) -> None:
+        self.__image_counter = Counter()
+        self.__table_counter = Counter()
+        self.__head_counter = HeadCounter()
+        self.__character = character
+
+    def create_text(self, text: str) -> Text:
+        return Text(text)
+
+    def create_head(self, use_numbers: bool, text: str, level: int = 1) -> Head:
+        number = self.__head_counter.get_next(level)
+        return Head(number, use_numbers, text, level)
+
+    def create_image(self, path: str, alt: str) -> Image:
+        number = self.__image_counter.get_next()
+        return Image(number, alt, path)

gost_docx-0.1.0/src/gost/elements/element.py

@@ -0,0 +1,15 @@
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from docx.document import Document
+
+
+class ElementBase(ABC):
+    @abstractmethod
+    def render(self, document: Document) -> None:
+        pass
+
+
+class NumberedElement(ElementBase, ABC):
+    def __init__(self, number: str) -> None:
+        self.number = number

gost_docx-0.1.0/src/gost/elements/head.py

@@ -0,0 +1,32 @@
+from docx.document import Document
+
+from gost.elements.element import NumberedElement
+
+
+class Head(NumberedElement):
+    def __init__(
+            self,
+            number: str,
+            use_number: bool,
+            text: str,
+            level: int = 1,
+    ) -> None:
+        super().__init__(number)
+        self.text = text
+        self.level = level
+        self.use_number = use_number
+
+    def render(self, document: Document) -> None:
+        text = self.__prepare_render_text()
+        document.add_heading(text, level=self.level)
+
+    def __prepare_render_text(self) -> str:
+        if self.use_number:
+            text = f"{self.use_number} {self.text}"
+        else:
+            text = f"{self.text}"
+
+        if self.level == 1:
+            text = self.text.upper()
+
+        return text

gost_docx-0.1.0/src/gost/elements/image.py

@@ -0,0 +1,39 @@
+from pathlib import Path
+
+from docx.document import Document
+from docx.enum.text import WD_ALIGN_PARAGRAPH, WD_LINE_SPACING
+from docx.shared import Cm, Pt
+
+from gost.elements.element import NumberedElement
+
+
+class Image(NumberedElement):
+    def __init__(
+            self,
+            number: str,
+            path: str,
+            alt: str,
+    ) -> None:
+        """
+        Создает изображение с подписью «Рисунок number — alt».
+        """
+        super().__init__(number)
+        self.alt = alt
+        self.path = Path(path)
+
+    def render(self, document: Document) -> None:
+        if self.path.exists():
+            document.add_picture(str(self.path), width=Cm(16.5))
+            last_paragraph = document.paragraphs[-1]
+            last_paragraph.alignment = WD_ALIGN_PARAGRAPH.CENTER
+            last_paragraph.paragraph_format.first_line_indent = Cm(0)
+        else:
+            document.add_paragraph(f"[Изображение не найдено: {self.path}]")
+
+        caption = document.add_paragraph()
+        caption.alignment = WD_ALIGN_PARAGRAPH.CENTER
+        caption.paragraph_format.first_line_indent = Cm(0)
+        caption.paragraph_format.line_spacing_rule = WD_LINE_SPACING.SINGLE
+        caption.paragraph_format.space_after = Pt(6)
+        run = caption.add_run(f"Рисунок {self.number} – {self.alt}")
+        run.font.size = Pt(14)

gost_docx-0.1.0/src/gost/elements/table.py

@@ -0,0 +1,93 @@
+from typing import Optional
+
+import pandas as pd
+from docx.document import Document
+from docx.enum.table import WD_TABLE_ALIGNMENT
+from docx.enum.text import WD_ALIGN_PARAGRAPH, WD_LINE_SPACING
+from docx.shared import Cm, Pt
+
+from gost.elements.element import NumberedElement
+from gost.utils import format_value
+
+
+class Table(NumberedElement):
+    def __init__(
+            self,
+            number: str,
+            df: pd.DataFrame,
+            float_format: Optional[str] = ".1f",
+            title: Optional[str] = None,
+            show_header: bool = True,
+            show_index: bool = True,
+            bold_header: bool = False,
+            bold_index: bool = False,
+    ) -> None:
+        """Создает таблицу из DataFrame с подписью «Таблица number — title».
+
+        Подпись добавляется только при наличии title, при этом счётчик таблиц увеличивается.
+
+        Args:
+            df: Данные для отображения в таблице.
+            float_format: Формат вещественных чисел (например, «.1f»). None — без форматирования.
+            title: Заголовок таблицы. Если None, подпись и счётчик не добавляются.
+            show_header: Добавлять ли строку с именами столбцов.
+            show_index: Добавлять ли столбец с индексом DataFrame.
+            bold_header: Выделять ли заголовки столбцов жирным.
+            bold_index: Выделять ли значения индекса жирным.
+
+        Returns:
+            Текущий экземпляр WordBuilder для цепочки вызовов.
+        """
+        super().__init__(number)
+        self.df = df
+        self.float_format = float_format
+        self.title = title
+        self.show_header = show_header
+        self.show_index = show_index
+        self.bold_header = bold_header
+        self.bold_index = bold_index
+
+    def render(self, document: Document) -> None:
+        if self.title is not None:
+            caption = document.add_paragraph()
+            caption.alignment = WD_ALIGN_PARAGRAPH.JUSTIFY
+            caption.paragraph_format.first_line_indent = Cm(0)
+            caption.paragraph_format.line_spacing_rule = WD_LINE_SPACING.SINGLE
+            caption.paragraph_format.space_after = Pt(6)
+            run = caption.add_run(f"Таблица – {self.number}  {self.title}")
+            run.font.size = Pt(14)
+
+        header_rows = 1 if self.show_header else 0
+        rows = len(self.df) + header_rows
+        index_offset = 1 if self.show_index else 0
+        cols = len(self.df.columns) + index_offset
+
+        table = document.add_table(rows=rows, cols=cols)
+        table.style = "Table Grid"
+        table.alignment = WD_TABLE_ALIGNMENT.CENTER
+
+        if self.show_header:
+            if self.show_index:
+                table.cell(0, 0).text = ""
+            for j, col_name in enumerate(self.df.columns):
+                cell = table.cell(0, j + index_offset)
+                cell.text = ""
+                run = cell.paragraphs[0].add_run(format_value(col_name, self.float_format))
+                run.bold = self.bold_header
+
+        for i, (idx, row) in enumerate(self.df.iterrows()):
+            row_idx = i + header_rows
+            if self.show_index:
+                idx_cell = table.cell(row_idx, 0)
+                idx_cell.text = ""
+                run = idx_cell.paragraphs[0].add_run(str(idx))
+                run.bold = self.bold_index
+            for j, val in enumerate(row):
+                table.cell(row_idx, j + index_offset).text = format_value(val, self.float_format)
+
+        for row in table.rows:
+            for cell in row.cells:
+                for para in cell.paragraphs:
+                    para.style = "Table Text"
+
+        document.add_paragraph()

gost_docx-0.1.0/src/gost/elements/text.py

@@ -0,0 +1,13 @@
+from docx.document import Document
+
+from gost.elements.element import ElementBase
+from gost.utils import render_bold
+
+
+class Text(ElementBase):
+    def __init__(self, text: str) -> None:
+        self.text = text
+
+    def render(self, document: Document) -> None:
+        paragraph = document.add_paragraph()
+        render_bold(paragraph, self.text)

gost_docx-0.1.0/src/gost/index/counter.py

@@ -0,0 +1,45 @@
+class Counter:
+    def __init__(self, initial: int = 1) -> None:
+        self.__initial = initial - 1
+        self.current: int = self.__initial
+
+    def get_next(self) -> int:
+        self.current = self.current + 1
+        return self.current
+
+    def reset(self):
+        self.current = self.__initial
+
+
+class HeadCounter:
+    def __init__(self) -> None:
+        self.__levels_counter: dict[int, Counter] = {
+            1: Counter(),
+            2: Counter(),
+            3: Counter(),
+            4: Counter(),
+        }
+
+    def get_next(self, head_level: int) -> str:
+        self.__levels_counter[head_level].get_next()
+
+        result_number = str(self.__levels_counter[1].current)
+        if head_level > 1:
+            for level in range(2, head_level + 1):
+                result_number = result_number + '.' + str(self.__levels_counter[level].current)
+
+        return result_number
+
+    def get_current_chapter(self) -> int:
+        return self.__levels_counter[1].current
+
+    def reset(self):
+        for level in self.__levels_counter:
+            self.__levels_counter[level].reset()
+
+    def __get_currents(self) -> list[int]:
+        currents: list[int] = []
+        for level in self.__levels_counter:
+            currents.append(self.__levels_counter[level].current)
+
+        return currents

gost_docx-0.1.0/src/gost/index/index_manager.py

@@ -0,0 +1,48 @@
+from gost.index.counter import Counter, HeadCounter
+from gost.index.index_type import IndexType
+
+
+class IndexManager:
+    def __init__(
+            self,
+            character: str | None = None,
+            index_type: IndexType = IndexType.CONTINUOUS
+    ) -> None:
+        self.__character = character
+        self.__index_type = index_type
+
+        self.__head_counter = HeadCounter()
+        self.__image_counter = Counter()
+        self.__table_counter = Counter()
+
+    def get_head_index(self, level: int) -> str:
+        index = self.__head_counter.get_next(level)
+
+        if self.__character:
+            index = self.__add_character(index)
+
+        if level == 0 and self.__index_type == IndexType.CHAPTER_RELATIVE:
+            self.__reset_counters()
+        return index
+
+    def get_image_index(self):
+        index = str(self.__image_counter.get_next())
+        if self.__index_type == IndexType.CHAPTER_RELATIVE:
+            index = self.__add_chapter(index)
+
+        if self.__character:
+            index = self.__add_character(index)
+
+        return index
+
+    def __add_chapter(self, index: str) -> str:
+        current_chapter = self.__head_counter.get_current_chapter()
+        index = f"{current_chapter}.{index}"
+        return index
+
+    def __add_character(self, index: str) -> str:
+        return f"{self.__character}.{index}"
+
+    def __reset_counters(self):
+        self.__image_counter.reset()
+        self.__head_counter.reset()

gost_docx-0.1.0/src/gost/index/index_type.py

@@ -0,0 +1,11 @@
+from enum import Enum, auto
+
+
+class IndexType(Enum):
+    """Режим нумерации объектов документа (рисунков, таблиц, формул)."""
+
+    CONTINUOUS = auto()
+    """Сквозная нумерация по всему документу: 1, 2, 3, ..."""
+
+    CHAPTER_RELATIVE = auto()
+    """Нумерация относительно номера текущей главы: 1.1, 1.2, 2.1, ..."""

gost_docx-0.1.0/src/gost/styles.py

@@ -0,0 +1,81 @@
+from docx.document import Document
+from docx.enum.style import WD_STYLE_TYPE
+from docx.enum.text import WD_ALIGN_PARAGRAPH, WD_LINE_SPACING
+from docx.oxml.ns import qn
+from docx.shared import Cm, Pt, RGBColor
+
+
+def apply_gost_styles(doc: Document) -> None:
+    """Configure GOST 7.32-2001 paragraph and heading styles on *doc* in-place."""
+    _apply_section(doc)
+    _apply_normal_style(doc)
+    _apply_table_text_style(doc)
+    _apply_heading_styles(doc)
+
+def _apply_section(doc: Document) -> None:
+    # Page margins per ГОСТ 7.32-2001: left ≥ 30mm, right ≥ 10mm, top ≥ 20mm, bottom ≥ 20mm
+    section = doc.sections[0]
+    section.left_margin = Cm(3.0)
+    section.right_margin = Cm(1.5)
+    section.top_margin = Cm(2.0)
+    section.bottom_margin = Cm(2.0)
+
+def _apply_normal_style(doc: Document) -> None:
+    normal = doc.styles["Normal"]
+    normal.font.name = "Times New Roman"
+    normal.font.size = Pt(14)
+    normal.paragraph_format.alignment = WD_ALIGN_PARAGRAPH.JUSTIFY
+    normal.paragraph_format.line_spacing_rule = WD_LINE_SPACING.ONE_POINT_FIVE
+    normal.paragraph_format.first_line_indent = Cm(1.25)
+    normal.paragraph_format.space_before = Pt(0)
+    normal.paragraph_format.space_after = Pt(0)
+
+
+def _apply_table_text_style(doc: Document) -> None:
+    table_text = doc.styles.add_style("Table Text", WD_STYLE_TYPE.PARAGRAPH)
+    table_text.font.name = "Times New Roman"
+    table_text.font.size = Pt(12)
+    table_text.paragraph_format.alignment = WD_ALIGN_PARAGRAPH.LEFT
+    table_text.paragraph_format.first_line_indent = Cm(0)
+    table_text.paragraph_format.space_before = Pt(0)
+    table_text.paragraph_format.space_after = Pt(0)
+
+
+def _apply_heading_styles(doc: Document) -> None:
+    # (style_name, centered, font_size, space_before)
+    heading_configs = [
+        ("Heading 1", True,  Pt(14), Pt(0)),
+        ("Heading 2", False, Pt(14), Pt(0)),
+        ("Heading 3", False, Pt(14), Pt(0)),
+        ("Heading 4", False, Pt(14), Pt(0)),
+    ]
+    for style_name, centered, font_size, space_before in heading_configs:
+        s = doc.styles[style_name]
+        s.font.name = "Times New Roman"
+        _remove_theme_font_overrides(s)
+        s.font.size = font_size
+        s.font.bold = True
+        s.font.italic = False
+        s.font.color.rgb = RGBColor(0, 0, 0)
+        s.paragraph_format.alignment = (
+            WD_ALIGN_PARAGRAPH.CENTER if centered else WD_ALIGN_PARAGRAPH.LEFT
+        )
+        s.paragraph_format.line_spacing_rule = WD_LINE_SPACING.ONE_POINT_FIVE
+        s.paragraph_format.first_line_indent = Cm(0) if centered else Cm(1.25)
+        s.paragraph_format.space_before = space_before
+        s.paragraph_format.space_after = Pt(0)
+        _remove_bottom_border(s)
+
+
+def _remove_theme_font_overrides(style) -> None:
+    rPr = style.element.get_or_add_rPr()
+    rFonts = rPr.find(qn("w:rFonts"))
+    if rFonts is not None:
+        for attr in [qn("w:asciiTheme"), qn("w:hAnsiTheme"), qn("w:eastAsiaTheme"), qn("w:cstheme")]:
+            rFonts.attrib.pop(attr, None)
+
+
+def _remove_bottom_border(style) -> None:
+    pPr = style.element.get_or_add_pPr()
+    for pBdr in pPr.findall(qn("w:pBdr")):
+        pPr.remove(pBdr)

gost_docx-0.1.0/src/gost/utils.py

@@ -0,0 +1,21 @@
+import re
+from typing import Optional
+
+
+def format_value(val, float_format: Optional[str]) -> str:
+    if isinstance(val, float):
+        if float_format:
+            return f"{val:{float_format}}"
+        return str(val)
+    return str(val)
+
+
+def render_bold(paragraph, text: str) -> None:
+    """Parse **bold** fragments into Word runs."""
+    parts = re.split(r"(\*\*[^*]+\*\*)", text)
+    for part in parts:
+        if part.startswith("**") and part.endswith("**"):
+            run = paragraph.add_run(part[2:-2])
+            run.bold = True
+        else:
+            paragraph.add_run(part)

gost_docx-0.1.0/src/gost/word_builder.py

@@ -0,0 +1,39 @@
+from pathlib import Path
+
+from docx import Document
+
+from .elements.element import ElementBase
+from .styles import apply_gost_styles
+
+
+class WordBuilder:
+    def __init__(self) -> None:
+        """
+        Инициализирует документ с полями по ГОСТ 7.32-2001 и применяет стили.
+        """
+        self.__document = Document()
+        self.__is_rendered = False
+        self.__figure_counter = 0
+        self.__table_counter = 0
+        self.__elements: list[ElementBase] = []
+
+        apply_gost_styles(self.__document)
+
+    def add_element(self, element: ElementBase) -> None:
+        self.__elements.append(element)
+
+    def save(self, path: Path) -> None:
+        """Сохраняет документ в файл формата .docx.
+
+        Args:
+            path: Путь к итоговому файлу.
+        """
+        if not self.__is_rendered:
+            self.__render_elements()
+            self.__is_rendered = True
+
+        self.__document.save(str(path))
+
+    def __render_elements(self):
+        for element in self.__elements:
+            element.render(self.__document)