Upload metodologia.py

document/anexos/metodologia.py

@@ -1,103 +1,295 @@
 """
-Gerador do Anexo de Metodologia.
-Gera a seção de metodologia a partir dos dados do modelo (.dai).
+Gerador da seção de Metodologia de Avaliação.
+Gera as sub-seções de Aplicação, Variáveis e Equação a partir dos dados do modelo (.dai).
 """
-from typing import Optional
+import json
+import re
+from typing import Optional, List, Tuple, Dict
+
 from docx import Document
-from docx.shared import Pt
+from docx.shared import Pt, Inches, Cm, RGBColor
+from docx.enum.text import WD_ALIGN_PARAGRAPH
 
 from models.model_data import ModelData
+from document.numbering import NumeradorSecoes
 from document.formatters import (
     add_body_text,
     add_placeholder_text,
-    add_subsection_title,
-    add_simple_table,
+    add_subsubsection_title,
+    add_bullet_text,
+    criar_paragrafo_formatado,
+)
+from config.settings import BASE_DIR
+
+
+# ---------------------------------------------------------------------------
+# Textos parametrizados da seção "Aplicação Método Comparativo"
+# ---------------------------------------------------------------------------
+
+_TEXTO_APLICACAO_P1_ANTES_DATAS = (
+    "Efetuou-se uma pesquisa junto às imobiliárias e às transações através das "
+    "guias de ITBI (Imposto sobre a Transmissão de Bens Imóveis), sendo utilizadas "
+    "aquelas em que houve convergência entre o valor declarado e o estimado pela "
+    "Secretaria Municipal da Fazenda. Formou-se, então, uma amostragem aleatória "
+    "constituída por {n_amostras} imóveis com características e localização próximas "
+    "ao avaliando e que foram ofertados ou comercializados no mercado imobiliário entre "
+)
+
+_TEXTO_APLICACAO_P1_DEPOIS_DATAS = (
+    ". No caso de eventual "
+    "existência de edificações nos dados da amostra, estas foram desconsideradas "
+    "na medida em que, na data da coleta do dado, os imóveis foram ofertados ou "
+    "negociados como territoriais. Ver ANEXO I - BANCO DE DADOS."
+)
+
+_TEXTO_APLICACAO_P2 = (
+    "Os elementos amostrais tomados como referência, embora comparáveis ao imóvel "
+    "avaliando, possuem características distintas devido à típica heterogeneidade do "
+    "produto oferecido pelo mercado de imóveis. Torna-se imprescindível, então, a "
+    "homogeneização dos dados amostrais. Entende-se por homogeneização o tratamento "
+    "dispensado aos dados objetivando retirar as discrepâncias existentes entre as "
+    "características de cada imóvel tomado como referência as do imóvel avaliando. "
+    "A fim de que se alcance um grau maior de precisão nos trabalhos avaliatórios a "
+    "NBR 14653-2:2011, Norma Brasileira de Avaliação de Bens - Imóveis Urbanos, "
+    "recomenda que a homogeneização deve ser baseada em processos de inferência "
+    "estatística, ao invés de utilizar fatores determinísticos e ponderações de ordem "
+    "subjetiva, que implicam em uma sensível perda do nível de precisão dos trabalhos "
+    "avaliatórios."
 )
 
+_TEXTO_APLICACAO_P3 = (
+    "O mercado imobiliário não se vincula diretamente a índices econômicos e não "
+    "segue um mesmo padrão em toda a cidade. Sendo assim, o comportamento das "
+    "variáveis explicativas do valor apresenta oscilações diferenciadas em regiões "
+    "distintas e em determinados intervalos de tempo, as quais podem contribuir de "
+    "forma variada no preço final dos imóveis, de acordo com suas peculiaridades. "
+    "Portanto, empregou-se a regressão múltipla para a homogeneização dos dados. "
+    "Esta é a técnica adequada quando se deseja estudar o comportamento de uma "
+    "variável, dita dependente, em relação a outras variáveis, ditas independentes, "
+    "que são responsáveis por sua formação."
+)
+
+_TEXTO_VARIAVEIS_INTRO = (
+    "Como variável dependente utilizou-se o valor unitário do imóvel, expresso em "
+    "Reais por metro quadrado (R$/m²). Como variáveis independentes, foram utilizadas "
+    "as respectivas características decorrentes de aspectos físicos, de localização "
+    "dos imóveis e valorização imobiliária da zona onde se localizam os mesmos."
+)
+
+_TEXTO_VARIAVEIS_LISTA = (
+    "As variáveis independentes que se mostraram mais significativas, a nível "
+    "estatístico, para a formação do valor do imóvel em análise foram:"
+)
+
+
+# ---------------------------------------------------------------------------
+# Funções auxiliares
+# ---------------------------------------------------------------------------
+
+def _carregar_descricoes_variaveis() -> Dict:
+    """Carrega descrições das variáveis do JSON de configuração."""
+    caminho = BASE_DIR / "config" / "variaveis_descricoes.json"
+    try:
+        with open(caminho, 'r', encoding='utf-8') as f:
+            return json.load(f)
+    except (FileNotFoundError, json.JSONDecodeError):
+        return {}
 
-def gerar_anexo_metodologia(doc: Document, modelo: Optional[ModelData], num_secao: str = "") -> None:
+
+def _extrair_anos_variaveis(variaveis: List[str]) -> Tuple[List[int], Optional[int], List[str]]:
+    """
+    Separa variáveis de ano das demais.
+
+    Returns:
+        (anos, ap_ano, outras) onde:
+        - anos: lista ordenada de anos (de variáveis aYYYY)
+        - ap_ano: ano de variável APYYYY (ou None)
+        - outras: variáveis que não são de ano
+    """
+    anos = []
+    ap_ano = None
+    outras = []
+
+    for v in variaveis:
+        if re.fullmatch(r"a(20\d{2}|2100)", v):
+            anos.append(int(v[1:]))
+        elif re.fullmatch(r"AP(20\d{2}|2100)", v):
+            ap_ano = int(v[2:])
+        else:
+            outras.append(v)
+
+    return sorted(anos), ap_ano, outras
+
+
+def _gerar_bloco_ano(doc: Document, anos: List[int], ap_ano: Optional[int]) -> None:
+    """
+    Gera o bloco especial da variável ANO com título bold e bullets por ano.
+    """
+    colchetes = [f"[{ano}]" for ano in anos]
+    if ap_ano:
+        colchetes.append(f"[AP{ap_ano}]")
+
+    # Título + descrição no mesmo parágrafo (bold + non-bold)
+    titulo = f"Ano {', '.join(colchetes[:-1])} e {colchetes[-1]}:"
+    descricao = (
+        " variáveis do tipo dicotômicas que identificam o ano em que cada "
+        "elemento foi pesquisado, ou seja, corresponde à época em que foi "
+        "coletada a informação de preço."
+    )
+    _adicionar_paragrafo_variavel(doc, titulo, descricao)
+
+    # Bullets individuais por ano
+    for ano in anos:
+        add_bullet_text(doc, f"[{ano}] = 1, se o dado é de {ano};")
+
+    if ap_ano:
+        add_bullet_text(doc, f"[AP{ap_ano}] = 1, se o dado é a partir de {ap_ano};")
+
+    # Linha final com ano base
+    ano_base = min(anos) - 1
+    add_bullet_text(
+        doc,
+        f"{', '.join(colchetes[:-1])} e {colchetes[-1]} = 0, se o dado é de {ano_base}."
+    )
+
+
+def _adicionar_paragrafo_variavel(doc: Document, titulo: str, descricao: str) -> None:
+    """
+    Cria parágrafo com título em negrito e descrição não-bold.
     """
-    Gera o conteúdo do Anexo de Metodologia.
-    
+    p = doc.add_paragraph()
+    p.alignment = WD_ALIGN_PARAGRAPH.JUSTIFY
+    p.paragraph_format.space_after = Pt(6)
+    p.paragraph_format.left_indent = Inches(0.3)
+    p.paragraph_format.first_line_indent = Cm(1.25)
+
+    run_titulo = p.add_run(titulo)
+    run_titulo.bold = True
+    run_titulo.font.size = Pt(11)
+    run_titulo.font.name = 'Arial'
+
+    run_desc = p.add_run(f" {descricao}")
+    run_desc.bold = False
+    run_desc.font.size = Pt(11)
+    run_desc.font.name = 'Arial'
+
+
+# ---------------------------------------------------------------------------
+# Geradores de sub-seções
+# ---------------------------------------------------------------------------
+
+def _gerar_aplicacao(doc: Document, modelo: ModelData, num: Optional[NumeradorSecoes]) -> None:
+    """Gera sub-seção 3.2.1 - Aplicação Método Comparativo."""
+    numero = num.subsubsecao() if num else ""
+    add_subsubsection_title(doc, numero, "Aplicação Método Comparativo")
+
+    # Primeiro parágrafo com placeholders de data em vermelho
+    texto_antes = _TEXTO_APLICACAO_P1_ANTES_DATAS.format(n_amostras=modelo.n_amostras)
+    texto_depois = _TEXTO_APLICACAO_P1_DEPOIS_DATAS
+
+    p = doc.add_paragraph()
+    p.alignment = WD_ALIGN_PARAGRAPH.JUSTIFY
+    p.paragraph_format.space_after = Pt(6)
+    p.paragraph_format.left_indent = Inches(0.3)
+    p.paragraph_format.first_line_indent = Cm(1.25)
+
+    run_antes = p.add_run(texto_antes)
+    run_antes.font.size = Pt(11)
+    run_antes.font.name = 'Arial'
+
+    run_inicio = p.add_run("INICIO")
+    run_inicio.font.size = Pt(11)
+    run_inicio.font.name = 'Arial'
+    run_inicio.font.color.rgb = RGBColor(255, 0, 0)
+
+    run_e = p.add_run(" e ")
+    run_e.font.size = Pt(11)
+    run_e.font.name = 'Arial'
+
+    run_fim = p.add_run("FIM")
+    run_fim.font.size = Pt(11)
+    run_fim.font.name = 'Arial'
+    run_fim.font.color.rgb = RGBColor(255, 0, 0)
+
+    run_depois = p.add_run(texto_depois)
+    run_depois.font.size = Pt(11)
+    run_depois.font.name = 'Arial'
+
+    add_body_text(doc, _TEXTO_APLICACAO_P2)
+    add_body_text(doc, _TEXTO_APLICACAO_P3)
+
+
+def _gerar_variaveis(doc: Document, modelo: ModelData, num: Optional[NumeradorSecoes]) -> None:
+    """Gera sub-seção 3.2.2 - Variáveis."""
+    numero = num.subsubsecao() if num else ""
+    add_subsubsection_title(doc, numero, "Variáveis")
+
+    add_body_text(doc, _TEXTO_VARIAVEIS_INTRO)
+    add_body_text(doc, _TEXTO_VARIAVEIS_LISTA)
+
+    descricoes = _carregar_descricoes_variaveis()
+    anos, ap_ano, outras_variaveis = _extrair_anos_variaveis(modelo.variaveis)
+
+    # Bloco ANO (se houver variáveis de ano)
+    if anos or ap_ano:
+        _gerar_bloco_ano(doc, anos, ap_ano)
+
+    # Demais variáveis
+    for var in outras_variaveis:
+        info = descricoes.get(var)
+        if info:
+            _adicionar_paragrafo_variavel(doc, f"{info['titulo']}:", info['descricao'])
+        else:
+            _adicionar_paragrafo_variavel(doc, f"{var}:", "[Descrição não disponível]")
+
+
+def _gerar_equacao(doc: Document, modelo: ModelData, num: Optional[NumeradorSecoes]) -> None:
+    """Gera sub-seção 3.2.3 - Equação Modelo Estatístico."""
+    numero = num.subsubsecao() if num else ""
+    add_subsubsection_title(doc, numero, "Equação Modelo Estatístico")
+
+    add_body_text(doc, "O modelo de regressão que melhor se ajustou aos dados da amostra é transcrito a seguir:")
+
+    if modelo.equacao:
+        criar_paragrafo_formatado(
+            doc, modelo.equacao, tamanho=10,
+            alinhamento=WD_ALIGN_PARAGRAPH.JUSTIFY,
+            espaco_antes=6, espaco_depois=6,
+        )
+
+    add_body_text(doc, "Os resultados estatísticos e a planilha de cálculo são exibidos no Anexo II.")
+
+
+# ---------------------------------------------------------------------------
+# Função principal
+# ---------------------------------------------------------------------------
+
+def gerar_anexo_metodologia(
+    doc: Document,
+    modelo: Optional[ModelData],
+    num: Optional[NumeradorSecoes] = None,
+) -> None:
+    """
+    Gera o conteúdo da seção Metodologia de Avaliação.
+
     Args:
         doc: Documento DOCX
         modelo: Dados do modelo carregado do .dai
-        num_secao: Número da seção para títulos
+        num: Numerador de seções para integrar com a numeração do documento
     """
     if modelo is None:
         add_placeholder_text(doc, "[Modelo não selecionado - inserir metodologia manualmente]")
         return
-    
-    # Informações do modelo
-    add_subsection_title(doc, "", "Modelo Utilizado")
-    add_body_text(doc, f"Modelo: {modelo.nome}")
-    
-    if modelo.n_amostras:
-        add_body_text(doc, f"Número de amostras: {modelo.n_amostras}")
-    
-    if modelo.n_variaveis:
-        add_body_text(doc, f"Número de variáveis: {modelo.n_variaveis}")
-    
-    # Variáveis do modelo
-    if modelo.variaveis:
-        add_subsection_title(doc, "", "Variáveis do Modelo")
-        for var in modelo.variaveis:
-            add_body_text(doc, f"• {var}")
-    
-    # Equação
-    if modelo.equacao:
-        add_subsection_title(doc, "", "Equação do Modelo")
-        add_body_text(doc, modelo.equacao)
-    
-    # Coeficientes
-    if not modelo.tabelas_coef.empty:
-        add_subsection_title(doc, "", "Coeficientes")
-        _adicionar_tabela_coeficientes(doc, modelo)
-    
-    # Estatísticas do modelo
-    if modelo.modelos_resumos:
-        add_subsection_title(doc, "", "Indicadores Estatísticos")
-        _adicionar_resumo_modelo(doc, modelo)
-
-
-def _adicionar_tabela_coeficientes(doc: Document, modelo: ModelData) -> None:
-    """Adiciona tabela de coeficientes."""
-    df = modelo.tabelas_coef
-    
-    # Preparar dados para tabela
-    headers = ["Variável"] + [str(col) for col in df.columns.tolist()]
-    dados = [headers]
-    
-    for idx, row in df.iterrows():
-        linha = [str(idx)] + [f"{v:.4f}" if isinstance(v, float) else str(v) for v in row.values]
-        dados.append(linha)
-    
-    add_simple_table(doc, dados, header_row=True)
-
-
-def _adicionar_resumo_modelo(doc: Document, modelo: ModelData) -> None:
-    """Adiciona resumo estatístico do modelo."""
-    resumo = modelo.modelos_resumos
-    
-    indicadores = []
-    
-    if 'r2' in resumo:
-        indicadores.append(f"R² = {resumo['r2']:.4f}")
-    
-    if 'r2_ajustado' in resumo:
-        indicadores.append(f"R² ajustado = {resumo['r2_ajustado']:.4f}")
-    
-    if 'fc' in resumo:
-        indicadores.append(f"Fc = {resumo['fc']:.2f}")
-    
-    if 'sig' in resumo:
-        indicadores.append(f"Significância = {resumo['sig']:.4f}")
-    
-    if 'n' in resumo:
-        indicadores.append(f"n = {resumo['n']}")
-    
-    if 'k' in resumo:
-        indicadores.append(f"k = {resumo['k']}")
-    
-    for ind in indicadores:
-        add_body_text(doc, f"• {ind}")
+
+    # Parágrafo introdutório sobre o método
+    add_body_text(
+        doc,
+        "Utilizou-se na avaliação do imóvel o Método Comparativo de Dados de Mercado, "
+        "definido como aquele pelo qual o valor de um bem é determinado por comparação "
+        "com outros de características semelhantes, através de tratamento técnico dos "
+        "atributos dos elementos comparáveis, constituintes da amostra utilizada."
+    )
+
+    _gerar_aplicacao(doc, modelo, num)
+    _gerar_variaveis(doc, modelo, num)
+    _gerar_equacao(doc, modelo, num)