change_files

BaseChangeFilesBuilder

Builder base para montagem de trocas de arquivos do caso.

Source code in pldpro_sdk/models/change_files.py

class BaseChangeFilesBuilder:
    """
    Builder base para montagem de trocas de arquivos do caso.
    """

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

    def add_file(
        self,
        file_path: str | Path,
        mes: int,
        ano: int,
        nome_arquivo: str,
        extensao: str,
        revisao: int | None = None,
        file_key: str | None = None,
    ) -> "BaseChangeFilesBuilder":
        self._items.append(
            ChangeFileItem.create(
                file_path=file_path,
                mes=mes,
                ano=ano,
                nome_arquivo=nome_arquivo,
                extensao=extensao,
                revisao=revisao,
                file_key=file_key,
            )
        )
        return self

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

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

    def _validate_common_item(self, item: ChangeFileItem) -> None:
        if not item.file_path.exists():
            raise FileNotFoundError(f"Arquivo não encontrado: {item.file_path}")

        if not item.file_path.is_file():
            raise ValueError(f"O caminho informado não é um arquivo: {item.file_path}")

        if item.mes < 1 or item.mes > 12:
            raise ValueError(f"Mês inválido para '{item.file_path.name}': {item.mes}")

        if item.ano < 1:
            raise ValueError(f"Ano inválido para '{item.file_path.name}': {item.ano}")

        if item.revisao is not None and item.revisao < 0:
            raise ValueError(f"Revisão inválida para '{item.file_path.name}': {item.revisao}")

    def _validate_specific_item(self, item: ChangeFileItem) -> None:
        return None

    def _build_duplicate_key(self, item: ChangeFileItem) -> tuple:
        return (
            item.ano,
            item.mes,
            normalize(item.nome_arquivo),
            normalize(item.extensao),
        )

    def validate(self) -> None:
        if not self._items:
            raise ValueError("É necessário informar ao menos uma troca de arquivo.")

        duplicates: set[tuple] = set()

        for item in self._items:
            self._validate_common_item(item)
            self._validate_specific_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} "
                    f"e arquivo {item.nome_arquivo}.{item.extensao}"
                )

            duplicates.add(duplicate_key)

    def build(self) -> list[ChangeFileItem]:
        self.validate()
        return self.items()

ChangeFileItem dataclass

Representa uma troca lógica de arquivo do caso.

O SDK usa essa estrutura para abstrair o payload multipart esperado pela API, sem expor ao consumidor a necessidade de montar manualmente o JSON de metadata.

Source code in pldpro_sdk/models/change_files.py

@dataclass(frozen=True)
class ChangeFileItem:
    """
    Representa uma troca lógica de arquivo do caso.

    O SDK usa essa estrutura para abstrair o payload multipart esperado pela API,
    sem expor ao consumidor a necessidade de montar manualmente o JSON de metadata.
    """

    file_path: Path
    mes: int
    ano: int
    nome_arquivo: str
    extensao: str
    revisao: int | None = None
    file_key: str | None = None

    @classmethod
    def create(
        cls,
        file_path: str | Path,
        mes: int,
        ano: int,
        nome_arquivo: str,
        extensao: str,
        revisao: int | None = None,
        file_key: str | None = None,
    ) -> "ChangeFileItem":
        return cls(
            file_path=Path(file_path),
            mes=mes,
            ano=ano,
            nome_arquivo=nome_arquivo,
            extensao=extensao,
            revisao=revisao,
            file_key=file_key,
        )

DecompChangeFilesBuilder

Bases: BaseChangeFilesBuilder

Builder para trocas de arquivos do DECOMP.

Source code in pldpro_sdk/models/change_files.py

class DecompChangeFilesBuilder(BaseChangeFilesBuilder):
    """
    Builder para trocas de arquivos do DECOMP.
    """

    def add_file(
        self,
        file_path: str | Path,
        mes: int,
        ano: int,
        nome_arquivo: str,
        extensao: str,
        revisao: int | None = None,
        file_key: str | None = None,
    ) -> "DecompChangeFilesBuilder":
        return super().add_file(
            file_path=file_path,
            mes=mes,
            ano=ano,
            nome_arquivo=nome_arquivo,
            extensao=extensao,
            revisao=revisao,
            file_key=file_key,
        )

    def _validate_specific_item(self, item: ChangeFileItem) -> None:
        ext = normalize(item.extensao)

        if is_revision_token(ext) and item.revisao is not None:
            expected = f"rv{item.revisao}"
            if expected != ext:
                raise ValueError(
                    f"revisao incompatível com extensao para '{item.nome_arquivo}': "
                    f"extensao={item.extensao}, revisao={item.revisao}"
                )

NewaveChangeFilesBuilder

Bases: BaseChangeFilesBuilder

Builder para trocas de arquivos do NEWAVE.

Source code in pldpro_sdk/models/change_files.py

class NewaveChangeFilesBuilder(BaseChangeFilesBuilder):
    """
    Builder para trocas de arquivos do NEWAVE.
    """

    def add_file(
        self,
        file_path: str | Path,
        mes: int,
        ano: int,
        nome_arquivo: str,
        extensao: str,
        file_key: str | None = None,
    ) -> "NewaveChangeFilesBuilder":
        return super().add_file(
            file_path=file_path,
            mes=mes,
            ano=ano,
            nome_arquivo=nome_arquivo,
            extensao=extensao,
            revisao=None,
            file_key=file_key,
        )

    def _validate_specific_item(self, item: ChangeFileItem) -> None:
        if item.revisao is not None:
            raise ValueError("revisao não é permitida para trocas do NEWAVE.")