Pular para conteúdo

change_versions

BaseChangeVersionsBuilder

Builder base para montagem de trocas de versões do caso.

Diferente de change-files, aqui lista vazia é válida, pois a API aceita items=[] para gerar o card com indicativo 'n'.

Source code in pldpro_sdk/models/change_versions.py 
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
class BaseChangeVersionsBuilder:
    """
    Builder base para montagem de trocas de versões do caso.

    Diferente de change-files, aqui lista vazia é válida, pois a API aceita
    items=[] para gerar o card com indicativo 'n'.
    """

    def __init__(self) -> None:
        self._items: list[ChangeVersionItem] = []

    def add_version(
        self,
        mes: int,
        ano: int,
        versao: str,
    ) -> "BaseChangeVersionsBuilder":
        self._items.append(
            ChangeVersionItem.create(
                mes=mes,
                ano=ano,
                versao=versao,
            )
        )
        return self

    def extend(
        self,
        items: Iterable[ChangeVersionItem],
    ) -> "BaseChangeVersionsBuilder":
        self._items.extend(items)
        return self

    def clear(self) -> "BaseChangeVersionsBuilder":
        self._items.clear()
        return self

    def items(self) -> list[ChangeVersionItem]:
        return list(self._items)

    def _validate_common_item(self, item: ChangeVersionItem) -> None:
        if item.mes < 1 or item.mes > 12:
            raise ValueError(f"Mês inválido para versão '{item.versao}': {item.mes}")

        if item.ano < 1:
            raise ValueError(f"Ano inválido para versão '{item.versao}': {item.ano}")

        if item.versao is None or not item.versao.strip():
            raise ValueError("versao é obrigatória.")

    def _build_duplicate_key(self, item: ChangeVersionItem) -> tuple[int, int]:
        return (item.ano, item.mes)

    def validate(self) -> None:
        duplicates: set[tuple[int, int]] = set()

        for item in self._items:
            self._validate_common_item(item)

            duplicate_key = self._build_duplicate_key(item)
            if duplicate_key in duplicates:
                raise ValueError(
                    f"Registro duplicado para competência {item.mes}/{item.ano}"
                )

            duplicates.add(duplicate_key)

    def build_items(self) -> list[ChangeVersionItem]:
        self.validate()
        return sorted(
            self.items(),
            key=lambda item: (item.ano, item.mes, normalize_version(item.versao)),
        )

    def build(self) -> TrocaVersaoRequest:
        built_items = self.build_items()
        return TrocaVersaoRequest(
            items=[item.to_api_model() for item in built_items]
        )

ChangeVersionItem dataclass

Representa uma troca lógica de versão do caso.

O SDK usa essa estrutura para abstrair o payload esperado pela API, sem expor ao consumidor a necessidade de conhecer os cards legados TROCAVRS / NOVRS.

Source code in pldpro_sdk/models/change_versions.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
@dataclass(frozen=True)
class ChangeVersionItem:
    """
    Representa uma troca lógica de versão do caso.

    O SDK usa essa estrutura para abstrair o payload esperado pela API,
    sem expor ao consumidor a necessidade de conhecer os cards legados
    TROCAVRS* / NOVRS*.
    """

    mes: int
    ano: int
    versao: str

    @classmethod
    def create(
        cls,
        mes: int,
        ano: int,
        versao: str,
    ) -> "ChangeVersionItem":
        return cls(
            mes=mes,
            ano=ano,
            versao=versao,
        )

    def to_api_model(self) -> TrocaVersaoItemRequest:
        return TrocaVersaoItemRequest(
            mes=self.mes,
            ano=self.ano,
            versao=normalize_version(self.versao),
        )

DecompChangeVersionsBuilder

Bases: BaseChangeVersionsBuilder

Builder para trocas de versões do DECOMP.

Source code in pldpro_sdk/models/change_versions.py 
140
141
142
143
class DecompChangeVersionsBuilder(BaseChangeVersionsBuilder):
    """
    Builder para trocas de versões do DECOMP.
    """

GevazpChangeVersionsBuilder

Bases: BaseChangeVersionsBuilder

Builder para trocas de versões do GEVAZP.

Source code in pldpro_sdk/models/change_versions.py 
146
147
148
149
class GevazpChangeVersionsBuilder(BaseChangeVersionsBuilder):
    """
    Builder para trocas de versões do GEVAZP.
    """

NewaveChangeVersionsBuilder

Bases: BaseChangeVersionsBuilder

Builder para trocas de versões do NEWAVE.

Source code in pldpro_sdk/models/change_versions.py 
134
135
136
137
class NewaveChangeVersionsBuilder(BaseChangeVersionsBuilder):
    """
    Builder para trocas de versões do NEWAVE.
    """