Integra conservação e coeficiente H às tabelas de construção

Transfere as descrições das classes, referências de vida útil e ajustes manuais para notas nativas de rodapé, sem repetição. Preserva coeficientes salvos e aplicabilidade por exercício. Validação: 117 testes e conferência visual com três construções e cinco IPTUs.

document/evolutivo.py

@@ -252,11 +252,15 @@ def gerar_corpo_evolutivo(doc, imported, num, caracteristicas_refs=None):
     add_body_text(doc,'A depreciação física considera a vida útil consumida e o estado de conservação, pelo método de Ross-Heidecke. O valor residual integra o fator remanescente aplicado ao custo de reedição.').paragraph_format.keep_with_next = True
     depreciation_equations(doc)
     add_body_text(doc,'Os resultados apresentados são os registrados na avaliação, sem recomposição a partir dos coeficientes arredondados para exibição.')
-    construction_depreciation_notes(doc,groups)
     heading(doc,num,'Cálculo por construção e exercício',4)
     for entries in groups.values():
         add_body_text(doc,construction_name(entries[0][1],entries[0][2]))
         by_id = {row['id']: c for row,c,i in entries}
+        manual_notes = OrderedDict()
+        for row,c,i in entries:
+            note = construction_depreciation_notes(row,c).get('manual')
+            if note: manual_notes.setdefault(note,[]).append(ref(row,show_base=False))
+        manual_text = ' '.join(f"{'; '.join(references)}: {text}" for text,references in manual_notes.items())
         # One comparative calculation table per effective construction, with all
         # annual inputs together; characteristics above are grouped by changes.
         compared(doc,[row for row,c,i in entries],[
@@ -268,10 +272,12 @@ def gerar_corpo_evolutivo(doc, imported, num, caracteristicas_refs=None):
             ('BDI (%)',lambda row:pct(by_id[row['id']].get('bdi'))),
             ('Fator BDI',lambda row:fmt(1+number(by_id[row['id']]['bdi'])/100,4) if number(by_id[row['id']].get('bdi')) is not None else 'Não informado'),
             ('Vida útil consumida (%)',lambda row:pct(by_id[row['id']].get('percentualVidaUtil'))),
+            ('Estado de conservação',lambda row:conservation_code(by_id[row['id']].get('estadoConservacao'))),
+            ('Coeficiente H',lambda row:fmt(by_id[row['id']].get('coefHeidecke'),4)),
             ('Depreciação K',lambda row:fmt(by_id[row['id']].get('depreciacao'),4)),
             ('Kd',lambda row:fmt(by_id[row['id']].get('kd'),3)),
             ('Valor da construção (R$)',lambda row:currency(by_id[row['id']].get('vcalcConstSeq'))),
-        ])
+        ],notes={'Vida útil consumida (%)':manual_text} if manual_text else None)
     refs['composicao'] = heading(doc,num,'AVALIAÇÃO DO IMÓVEL OBJETO',2)
     add_body_text(doc,'Na ausência de outros ajustes, a composição corresponde a VI = (VT + VC) × Fc, em que VT é o valor territorial e VC é o custo de reedição das construções. Havendo ajustes, a sequência efetivamente salva, apresentada abaixo, prevalece sobre essa expressão simplificada.').paragraph_format.keep_with_next = True
     gerar_ajustes(doc,rows,territorial=False)
@@ -336,18 +342,30 @@ def construction_notes(doc, notes, groups):
 
 
 def construction_characteristics(doc, groups):
-    records = [['Construção / referência','Tipo / ano','Área real / de cálculo (m²)','Vida útil / residual R','Conservação / H']]
+    records = [['Construção / referência','Tipo / ano','Área real / de cálculo (m²)','Vida útil / residual R','Estado de conservação','H']]
+    record_notes = []
     for entries in groups.values():
         variants = OrderedDict()
         for row,c,i in entries:
             values = (f"{c.get('tipoConstrucao') or 'Não informado'} / {c.get('anoConstrucao') or 'Não informado'}",
                       f"{fmt(c.get('areaTotal'))} / {fmt(c.get('areaCalculada'))}",
                       f"{fmt(c.get('vidaUtil'),0)} anos / {pct(c.get('valorResidual'),True)}",
-                      f"{c.get('estadoConservacao') or 'Não informado'} / {fmt(c.get('coefHeidecke'),4)}")
-            variants.setdefault(values,[]).append((row,c,i))
-        for values,subset in variants.items():
+                      conservation_code(c.get('estadoConservacao')),fmt(c.get('coefHeidecke'),4))
+            notes = construction_depreciation_notes(row,c)
+            details = (notes.get('life',''),notes.get('state',''))
+            variants.setdefault((values,details),[]).append((row,c,i))
+        for (values,details),subset in variants.items():
             records.append([entry_scope(subset,groups,show_base=False)]+list(values))
-    if len(records)>1: table(doc,records,[1.6,1.6,1.2,1.1,1.5],font_size=7)
+            record_notes.append((len(records)-1,details))
+    if len(records)>1:
+        obj = table(doc,records,[1.8,1.6,1.2,1.1,.9,.65],auto_fit=False)
+        seen = set()
+        for index,details in record_notes:
+            for column,text in zip((3,4),details):
+                if text and text not in seen:
+                    add_footnote(doc,obj.cell(index,column).paragraphs[0],text)
+                    seen.add(text)
+        fit_table_to_page(doc,obj,notes=seen)
     area_records = [['Construção / referência','Tipo de área','Área real (m²)','Coeficiente','Parcela equivalente (m²)']]
     for entries in groups.values():
         areas = OrderedDict()
@@ -454,22 +472,29 @@ def construction_bdi_notes(doc, groups):
         table(doc,records,[2.3,3.2,1],font_size=7)
 
 
-def construction_depreciation_notes(doc,groups):
+def conservation_code(value):
+    text = str(value or '').strip()
+    match = re.match(r'^([A-I])(?:\s*[-–—]|$)',text,re.I)
+    return match[1].upper() if match else text or 'Não informado'
+
+
+def construction_depreciation_notes(row,c):
     from backend.app.evo_documentation import public_reason
-    notes = OrderedDict()
-    for entries in groups.values():
-        for row,c,i in entries:
-            saved = ((source(row).get('construcao') or {}).get('avaliacao') or {}).get('referenciasCalculo') or content_for(source(row))['referencias']
-            life = next((item for item in saved.get('vidaUtilTipos',[]) if item.get('tipo')==c.get('tipoConstrucao')),None)
-            if life:
-                notes.setdefault(f"Referência de vida útil para {life['tipo']}: {life.get('vidaUtil','não informada')} anos. A vida consumida considera a idade no ano de referência, limitada a 100%, ou o ajuste manual registrado.",[]).append((row,c,i))
-            state = next((item for item in saved.get('estadosConservacao',[]) if item.get('estado')==c.get('estadoConservacao')),None)
-            if state and state.get('descricao'): notes.setdefault(f"{c['estadoConservacao']}: {state['descricao']}",[]).append((row,c,i))
-            if c.get('percentualVidaUtilManualAtivo') or c.get('percentualVidaUtilAjusteManual'):
-                reason = public_reason(c,'percentualVidaUtilJustificativa')
-                text = f"Ajuste manual de vida consumida: padrão {pct(c.get('percentualVidaUtilPadrao'))}; adotado {pct(c.get('percentualVidaUtil'))}. " + (reason or 'A justificativa pública não está disponível no arquivo.')
-                notes.setdefault(text,[]).append((row,c,i))
-    construction_notes(doc,notes,groups)
+    notes = {}
+    saved = ((source(row).get('construcao') or {}).get('avaliacao') or {}).get('referenciasCalculo') or {}
+    fallback = content_for(source(row))['referencias']
+    life = next((item for item in saved.get('vidaUtilTipos',fallback.get('vidaUtilTipos',[])) if item.get('tipo')==c.get('tipoConstrucao')),None)
+    if life:
+        notes['life'] = f"Referência de vida útil para {life['tipo']}: {life.get('vidaUtil','não informada')} anos. A vida consumida considera a idade no ano de referência, limitada a 100%, ou o ajuste manual registrado. R é o valor residual, expresso em percentual no quadro."
+    raw = str(c.get('estadoConservacao') or '').strip()
+    state = next((item for item in saved.get('estadosConservacao',fallback.get('estadosConservacao',[])) if str(item.get('estado','')).strip().casefold()==raw.casefold()),None)
+    if raw:
+        notes['state'] = f"{raw}: {state['descricao']}" if state and state.get('descricao') else f"Estado de conservação registrado: {raw}. A descrição técnica desta classe não foi preservada no arquivo."
+        notes['state'] += ' H é o coeficiente de conservação adotado no cálculo de Ross-Heidecke; o valor registrado consta no quadro.'
+    if c.get('percentualVidaUtilManualAtivo') or c.get('percentualVidaUtilAjusteManual'):
+        reason = public_reason(c,'percentualVidaUtilJustificativa')
+        notes['manual'] = f"Ajuste manual de vida consumida: padrão {pct(c.get('percentualVidaUtilPadrao'))}; adotado {pct(c.get('percentualVidaUtil'))}. " + (reason or 'A justificativa pública não está disponível no arquivo.')
+    return notes
 
 
 def reducer_metrics(rows,territorial):

tests/test_conservation_notes.py

@@ -0,0 +1,79 @@
+import copy
+import unittest
+
+from docx import Document
+from docx.opc.constants import RELATIONSHIP_TYPE as RT
+from docx.oxml import parse_xml
+from docx.oxml.ns import qn
+
+from document.evolutivo import construction_characteristics, construction_groups
+from test_evo_adjustments import body
+from test_evolutivo_documento import fixture, resolved, all_text
+
+
+def notes(doc):
+    root = parse_xml(doc.part.part_related_by(RT.FOOTNOTES).blob)
+    return [''.join(n.itertext(qn('w:t'))) for n in root if int(n.get(qn('w:id'))) > 0]
+
+
+class ConservationNotesTests(unittest.TestCase):
+    def data(self):
+        data = fixture((2021, 2022))
+        for year in data['anos']:
+            year['construcao']['avaliacao']['referenciasCalculo'] = {
+                'vidaUtilTipos': [{'tipo': 'GALPOES (DEPOSITOS)', 'vidaUtil': 70}],
+                'estadosConservacao': [{'estado': 'C - regular', 'coeficiente': .0252,
+                                        'descricao': 'Descrição histórica da classe regular.'}]}
+            year['construcao']['construcoes'][0].update(estadoConservacao='C - regular', coefHeidecke=.0317)
+        return data
+
+    def test_codes_and_saved_coefficients_in_tables_descriptions_only_in_notes(self):
+        imported = resolved(self.data())
+        before = copy.deepcopy(imported)
+        doc = body(imported)
+        characteristics = next(t for t in doc.tables if t.cell(0, 1).text == 'Tipo / ano')
+        self.assertEqual([c.text for c in characteristics.rows[0].cells][-2:], ['Estado de conservação', 'H'])
+        self.assertEqual([c.text for c in characteristics.rows[1].cells][-2:], ['C', '0,0317'])
+        calculation = next(t for t in doc.tables if any(r.cells[0].text == 'Coeficiente H' for r in t.rows))
+        for label, expected in [('Estado de conservação', 'C'), ('Coeficiente H', '0,0317')]:
+            row = next(r for r in calculation.rows if r.cells[0].text == label)
+            self.assertEqual([c.text for c in row.cells[1:]], [expected, expected])
+        self.assertNotIn('Descrição histórica', all_text(doc))
+        self.assertNotIn('Referência de vida útil para', all_text(doc))
+        self.assertNotIn('Ajuste manual de vida consumida', all_text(doc))
+        footnotes = notes(doc)
+        self.assertEqual(sum('Descrição histórica da classe regular.' in text for text in footnotes), 1)
+        self.assertTrue(any('70 anos' in text and 'R é o valor residual' in text for text in footnotes))
+        self.assertTrue(any('IPTU 2022; IPTU 2023' in text and 'padrão 50,00%; adotado 40,00%' in text for text in footnotes))
+        self.assertNotIn('SEGREDO INTERNO', ' '.join(footnotes))
+        self.assertEqual(imported, before)
+
+    def test_shared_class_is_explained_once_and_historical_changes_keep_their_scope(self):
+        data = self.data()
+        for year in data['anos']:
+            second = copy.deepcopy(year['construcao']['construcoes'][0])
+            second.update(id='segundo', seq=2, nome='Galpão B')
+            year['construcao']['construcoes'].append(second)
+        data['anos'][1]['construcao']['avaliacao']['referenciasCalculo']['estadosConservacao'][0]['descricao'] = 'Caracterização revista no segundo exercício.'
+        doc = Document()
+        construction_characteristics(doc, construction_groups(resolved(data)['avaliacoes']))
+        self.assertEqual(len(doc.tables[0].rows), 5)
+        for index in (1, 3):
+            self.assertIn('IPTU 2022', doc.tables[0].cell(index, 0).text)
+            self.assertIn('IPTU 2023', doc.tables[0].cell(index + 1, 0).text)
+        self.assertEqual(sum('Descrição histórica' in text for text in notes(doc)), 1)
+        self.assertEqual(sum('Caracterização revista' in text for text in notes(doc)), 1)
+
+    def test_unknown_state_keeps_original_label_without_borrowing_catalog_description(self):
+        data = self.data()
+        for year in data['anos']:
+            year['construcao']['construcoes'][0]['estadoConservacao'] = 'C - classificação especial'
+        doc = Document()
+        construction_characteristics(doc, construction_groups(resolved(data)['avaliacoes']))
+        self.assertIn('C - classificação especial', ' '.join(notes(doc)))
+        self.assertNotIn('Descrição histórica', ' '.join(notes(doc)))
+        self.assertIn('não foi preservada', ' '.join(notes(doc)))
+
+
+if __name__ == '__main__':
+    unittest.main()