pyield 0.52.1__tar.gz → 0.52.2__tar.gz

{pyield-0.52.1 → pyield-0.52.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyield
-Version: 0.52.1
+Version: 0.52.2
 Summary: Polars-powered toolkit for Brazilian fixed income analysis
 Keywords: fixed-income,brazil,finance,analysis,bonds
 Author: Carlos Carvalho
@@ -120,7 +120,7 @@ documentação.
 | `yd.ntnb1` | módulo | NTN-B1 | `datas_pagamento`, `fluxos_caixa`, `cotacao`, `pu`, `duration`, `dv01` |
 | `yd.ntnbprinc` | módulo | NTN-B Principal | `pu`, `dv01` |
 | `yd.ntnc` | módulo | NTN-C | `dados`, `datas_pagamento`, `fluxos_caixa`, `cotacao`, `pu`, `taxa`, `duration`, `duration_expr`, `dv01`, `dv01_expr` |
-| `yd.ntnf` | módulo | NTN-F | `dados`, `vencimentos`, `datas_pagamento`, `fluxos_caixa`, `pu`, `taxa`, `taxas_zero`, `premio`, `premio_limpo`, `rentabilidade`, `rentabilidade_expr`, `duration`, `duration_expr`, `dv01`, `dv01_expr` |
+| `yd.ntnf` | módulo | NTN-F | `dados`, `vencimentos`, `datas_pagamento`, `fluxos_caixa`, `pu`, `taxa`, `taxas_zero`, `premio`, `premio_limpo`, `premio_limpo_expr`, `rentabilidade`, `rentabilidade_expr`, `duration`, `duration_expr`, `dv01`, `dv01_expr` |
 | `yd.selic` | módulo | Selic, COPOM e política monetária | `over`, `over_serie`, `meta`, `meta_serie`, `compromissadas`, `copom`, `cpm`, `probabilities` |
 | `yd.ipca` | módulo | IPCA histórico e projetado | `indice`, `indices`, `indices_ultimos`, `taxa`, `taxas`, `taxas_ultimas`, `taxa_projetada` |
 | `yd.ptax(data)` | função | PTAX para uma data |  |

{pyield-0.52.1 → pyield-0.52.2}/README.md

@@ -76,7 +76,7 @@ documentação.
 | `yd.ntnb1` | módulo | NTN-B1 | `datas_pagamento`, `fluxos_caixa`, `cotacao`, `pu`, `duration`, `dv01` |
 | `yd.ntnbprinc` | módulo | NTN-B Principal | `pu`, `dv01` |
 | `yd.ntnc` | módulo | NTN-C | `dados`, `datas_pagamento`, `fluxos_caixa`, `cotacao`, `pu`, `taxa`, `duration`, `duration_expr`, `dv01`, `dv01_expr` |
-| `yd.ntnf` | módulo | NTN-F | `dados`, `vencimentos`, `datas_pagamento`, `fluxos_caixa`, `pu`, `taxa`, `taxas_zero`, `premio`, `premio_limpo`, `rentabilidade`, `rentabilidade_expr`, `duration`, `duration_expr`, `dv01`, `dv01_expr` |
+| `yd.ntnf` | módulo | NTN-F | `dados`, `vencimentos`, `datas_pagamento`, `fluxos_caixa`, `pu`, `taxa`, `taxas_zero`, `premio`, `premio_limpo`, `premio_limpo_expr`, `rentabilidade`, `rentabilidade_expr`, `duration`, `duration_expr`, `dv01`, `dv01_expr` |
 | `yd.selic` | módulo | Selic, COPOM e política monetária | `over`, `over_serie`, `meta`, `meta_serie`, `compromissadas`, `copom`, `cpm`, `probabilities` |
 | `yd.ipca` | módulo | IPCA histórico e projetado | `indice`, `indices`, `indices_ultimos`, `taxa`, `taxas`, `taxas_ultimas`, `taxa_projetada` |
 | `yd.ptax(data)` | função | PTAX para uma data |  |

{pyield-0.52.1 → pyield-0.52.2}/pyield/_internal/types.py

@@ -1,13 +1,13 @@
 import datetime as dt
 import math
-from collections.abc import Sequence, Sized
+from collections.abc import Sized
 from typing import Any, TypeAlias, TypeGuard
 
 import polars as pl
 
 DateLike: TypeAlias = str | dt.datetime | dt.date
 ArrayLike: TypeAlias = list[Any] | tuple[Any, ...] | pl.Series
-DatesLike: TypeAlias = Sequence[DateLike] | pl.Series
+DatesLike: TypeAlias = list[DateLike] | tuple[DateLike, ...] | pl.Series
 
 
 def _is_empty(arg: Any) -> bool:

{pyield-0.52.1 → pyield-0.52.2}/pyield/tpf/_titulos/ntnb.py

@@ -5,7 +5,7 @@ import polars as pl
 
 import pyield._internal.converters as conversores
 from pyield import du, fwd, interpolador
-from pyield._internal.types import ArrayLike, DateLike, any_is_empty
+from pyield._internal.types import ArrayLike, DateLike, DatesLike, any_is_empty
 from pyield.tpf import utils
 
 """
@@ -367,7 +367,7 @@ def pu(
 
 def _validar_entradas_taxas_zero(
     data_liquidacao: DateLike,
-    vencimentos: ArrayLike,
+    vencimentos: DatesLike,
     taxas: ArrayLike,
 ) -> tuple[dt.date, pl.Series, pl.Series]:
     # Processa e valida os dados de entrada
@@ -459,7 +459,7 @@ def _calcular_valor_presente_cupons(
 
 def taxas_zero(
     data_liquidacao: DateLike,
-    vencimentos: ArrayLike,
+    vencimentos: DatesLike,
     taxas: ArrayLike,
     incluir_cupons: bool = False,
 ) -> pl.DataFrame:
@@ -471,7 +471,7 @@ def taxas_zero(
 
     Args:
         data_liquidacao (DateLike): Data de liquidação.
-        vencimentos (ArrayLike): Datas de vencimento dos títulos.
+        vencimentos (DatesLike): Datas de vencimento dos títulos.
         taxas (ArrayLike): TIRs correspondentes.
         incluir_cupons (bool, optional): Se True, inclui datas intermediárias de cupom.
             Padrão False.
@@ -586,9 +586,9 @@ def taxas_zero(
 
 def implicitas(  # noqa: PLR0913
     data_liquidacao: DateLike,
-    vencimentos_tir: ArrayLike,
+    vencimentos_tir: DatesLike,
     taxas_tir: ArrayLike,
-    vencimentos_nominais: ArrayLike,
+    vencimentos_nominais: DatesLike,
     taxas_nominais: ArrayLike,
     *,
     extrapolar: bool = False,
@@ -601,12 +601,12 @@ def implicitas(  # noqa: PLR0913
 
     Args:
         data_liquidacao (DateLike): Data de liquidação da operação.
-        vencimentos_tir (ArrayLike): Vencimentos das NTN-B usadas como vértices
+        vencimentos_tir (DatesLike): Vencimentos das NTN-B usadas como vértices
             da curva de TIR real.
         taxas_tir (ArrayLike): TIRs reais observadas das NTN-B correspondentes
             aos vencimentos informados. A função calcula a curva zero real a
             partir dessas taxas.
-        vencimentos_nominais (ArrayLike): Vencimentos da curva nominal de
+        vencimentos_nominais (DatesLike): Vencimentos da curva nominal de
             referência.
         taxas_nominais (ArrayLike): Taxas da curva nominal de referência. Pode
             representar DI Futuro, curva soberana prefixada ou outra curva
@@ -709,9 +709,9 @@ def implicitas(  # noqa: PLR0913
 
 def curva(  # noqa: PLR0913
     data_liquidacao: DateLike,
-    vencimentos_tir: ArrayLike,
+    vencimentos_tir: DatesLike,
     taxas_tir: ArrayLike,
-    vencimentos_nominais: ArrayLike,
+    vencimentos_nominais: DatesLike,
     taxas_nominais: ArrayLike,
     *,
     extrapolar: bool = False,
@@ -725,12 +725,12 @@ def curva(  # noqa: PLR0913
 
     Args:
         data_liquidacao (DateLike): Data de liquidação da operação.
-        vencimentos_tir (ArrayLike): Vencimentos das NTN-B usadas como vértices
+        vencimentos_tir (DatesLike): Vencimentos das NTN-B usadas como vértices
             da curva de TIR real.
         taxas_tir (ArrayLike): TIRs reais observadas das NTN-B correspondentes
             aos vencimentos informados. A função calcula a curva zero real a
             partir dessas taxas.
-        vencimentos_nominais (ArrayLike): Vencimentos da curva nominal de
+        vencimentos_nominais (DatesLike): Vencimentos da curva nominal de
             referência.
         taxas_nominais (ArrayLike): Taxas da curva nominal de referência. Pode
             representar DI Futuro, curva soberana prefixada ou outra curva

{pyield-0.52.1 → pyield-0.52.2}/pyield/tpf/_titulos/ntnf.py

@@ -7,7 +7,7 @@ import polars as pl
 import pyield._internal.converters as cv
 import pyield.interpolador as ip
 from pyield import du
-from pyield._internal.types import ArrayLike, DateLike, any_is_empty
+from pyield._internal.types import ArrayLike, DateLike, DatesLike, any_is_empty
 from pyield.futuro import di1
 from pyield.tpf import utils
 
@@ -96,15 +96,12 @@ def dados(data: DateLike) -> pl.DataFrame:
     # Calcula prêmios e rentabilidade para cada vencimento
     df = df.with_columns(
         premio=pl.col("taxa_indicativa") - pl.col("taxa_di"),
-        premio_limpo=pl.struct("data_vencimento", "taxa_indicativa").map_elements(
-            lambda row: premio_limpo(
-                data_liquidacao=data,
-                data_vencimento=row["data_vencimento"],
-                taxa_ntnf=row["taxa_indicativa"],
-                vencimentos_di=df_di["data_vencimento"],
-                taxas_di=df_di["taxa_ajuste"],
-            ),
-            return_dtype=pl.Float64,
+        premio_limpo=premio_limpo_expr(
+            data_liquidacao=data,
+            data_vencimento="data_vencimento",
+            taxa_ntnf="taxa_indicativa",
+            vencimentos_di=df_di["data_vencimento"],
+            taxas_di=df_di["taxa_ajuste"],
         ),
         rentabilidade=rentabilidade_expr(
             data_liquidacao=data,
@@ -343,9 +340,9 @@ def pu(
 
 def taxas_zero(  # noqa
     data_liquidacao: DateLike,
-    vencimentos_ltn: ArrayLike,
+    vencimentos_ltn: DatesLike,
     taxas_ltn: ArrayLike,
-    vencimentos_ntnf: ArrayLike,
+    vencimentos_ntnf: DatesLike,
     taxas_ntnf: ArrayLike,
     incluir_cupons: bool = False,
 ) -> pl.DataFrame:
@@ -360,11 +357,11 @@ def taxas_zero(  # noqa
 
     Args:
         data_liquidacao (DateLike): Data de liquidação para o cálculo.
-        vencimentos_ltn (ArrayLike): Datas de vencimento das LTNs usadas como
+        vencimentos_ltn (DatesLike): Datas de vencimento das LTNs usadas como
             vértices prefixados zero cupom.
         taxas_ltn (ArrayLike): Taxas das LTNs. Como a LTN é zero cupom, essas
             taxas são usadas diretamente como taxas zero no bootstrap.
-        vencimentos_ntnf (ArrayLike): Datas de vencimento das NTN-F usadas no
+        vencimentos_ntnf (DatesLike): Datas de vencimento das NTN-F usadas no
             bootstrap.
         taxas_ntnf (ArrayLike): TIRs das NTN-F correspondentes aos vencimentos
             informados.
@@ -524,7 +521,7 @@ def rentabilidade(  # noqa
     data_liquidacao: DateLike,
     data_vencimento: DateLike,
     taxa_ntnf: float,
-    vencimentos_di: ArrayLike,
+    vencimentos_di: DatesLike,
     taxas_di: ArrayLike,
 ) -> float:
     """
@@ -539,7 +536,7 @@ def rentabilidade(  # noqa
         data_liquidacao (DateLike): Data de liquidação para o cálculo.
         data_vencimento (DateLike): Data de vencimento da NTN-F.
         taxa_ntnf (float): TIR da NTN-F.
-        vencimentos_di (ArrayLike): Datas de vencimento da curva DI.
+        vencimentos_di (DatesLike): Datas de vencimento da curva DI.
         taxas_di (ArrayLike): Taxas DI correspondentes aos vencimentos.
 
     Returns:
@@ -629,7 +626,7 @@ def rentabilidade_expr(
     data_liquidacao: DateLike,
     data_vencimento: pl.Expr | str,
     taxa_ntnf: pl.Expr | str,
-    vencimentos_di: ArrayLike,
+    vencimentos_di: DatesLike,
     taxas_di: ArrayLike,
 ) -> pl.Expr:
     """Cria expressão Polars para a rentabilidade da NTN-F sobre a curva DI.
@@ -717,7 +714,7 @@ def premio_limpo(  # noqa
     data_liquidacao: DateLike,
     data_vencimento: DateLike,
     taxa_ntnf: float,
-    vencimentos_di: ArrayLike,
+    vencimentos_di: DatesLike,
     taxas_di: ArrayLike,
 ) -> float:
     """
@@ -731,7 +728,7 @@ def premio_limpo(  # noqa
         data_liquidacao (DateLike): Data de liquidação para o cálculo.
         data_vencimento (DateLike): Data de vencimento do título.
         taxa_ntnf (float): TIR do título.
-        vencimentos_di (ArrayLike): Vencimentos da curva DI.
+        vencimentos_di (DatesLike): Vencimentos da curva DI.
         taxas_di (ArrayLike): Série de taxas DI.
 
     Returns:
@@ -796,6 +793,45 @@ def premio_limpo(  # noqa
     return utils.encontrar_raiz(diferenca_preco)
 
 
+def premio_limpo_expr(
+    data_liquidacao: DateLike,
+    data_vencimento: pl.Expr | str,
+    taxa_ntnf: pl.Expr | str,
+    vencimentos_di: DatesLike,
+    taxas_di: ArrayLike,
+) -> pl.Expr:
+    """Cria expressão Polars para o prêmio limpo da NTN-F sobre a curva DI.
+
+    O cálculo é aplicado linha a linha porque o prêmio limpo depende dos fluxos
+    de caixa do título, da interpolação da curva DI e da resolução de raiz.
+
+    Args:
+        data_liquidacao: Data de liquidação para o cálculo.
+        data_vencimento: Nome de coluna ou expressão Polars com a data de
+            vencimento da NTN-F.
+        taxa_ntnf: Nome de coluna ou expressão Polars com a TIR da NTN-F.
+        vencimentos_di: Datas de vencimento da curva DI.
+        taxas_di: Taxas DI correspondentes aos vencimentos.
+
+    Returns:
+        pl.Expr: Expressão sem alias com o prêmio limpo da NTN-F sobre a curva
+        DI.
+    """
+    return pl.struct(
+        utils.coluna_ou_expr(data_vencimento, "data_vencimento"),
+        utils.coluna_ou_expr(taxa_ntnf, "taxa_ntnf"),
+    ).map_elements(
+        lambda row: premio_limpo(
+            data_liquidacao=data_liquidacao,
+            data_vencimento=row["data_vencimento"],
+            taxa_ntnf=row["taxa_ntnf"],
+            vencimentos_di=vencimentos_di,
+            taxas_di=taxas_di,
+        ),
+        return_dtype=pl.Float64,
+    )
+
+
 def duration(
     data_liquidacao: DateLike,
     data_vencimento: DateLike,

{pyield-0.52.1 → pyield-0.52.2}/pyield/tpf/leiloes.py

@@ -24,6 +24,7 @@ DEFINICOES_COLUNAS = [
     ("liquidacao_segunda_volta", "data_liquidacao_2v", pl.String),
     ("numero_edital", "numero_edital", pl.Int64),
     ("tipo_leilao", "tipo_leilao", pl.String),
+    ("tipo_ocorrencia", "tipo_ocorrencia", pl.String),
     ("titulo", "titulo", pl.String),
     ("benchmark", "benchmark", pl.String),
     ("vencimento", "data_vencimento", pl.String),
@@ -31,6 +32,8 @@ DEFINICOES_COLUNAS = [
     ("quantidade_aceita", "quantidade_aceita_1v", pl.Int64),
     ("oferta_segunda_volta", "quantidade_ofertada_2v", pl.Int64),
     ("quantidade_aceita_segunda_volta", "quantidade_aceita_2v", pl.Int64),
+    ("quantidade_liquidada", "quantidade_liquidada_1v", pl.Int64),
+    ("quantidade_liquidada_segunda_volta", "quantidade_liquidada_2v", pl.Int64),
     ("financeiro_aceito", "financeiro_aceito_1v", pl.Float64),
     ("financeiro_aceito_segunda_volta", "financeiro_aceito_2v", pl.Float64),
     ("quantidade_bcb", "quantidade_bcb", pl.Int64),
@@ -50,6 +53,7 @@ ORDEM_FINAL_COLUNAS = [
     "data_liquidacao_2v",
     "numero_edital",
     "tipo_leilao",
+    "tipo_ocorrencia",
     "titulo",
     "benchmark",
     "data_vencimento",
@@ -62,6 +66,8 @@ ORDEM_FINAL_COLUNAS = [
     "quantidade_aceita_1v",
     "quantidade_aceita_2v",
     "quantidade_aceita_total",
+    "quantidade_liquidada_1v",
+    "quantidade_liquidada_2v",
     "financeiro_ofertado_1v",
     "financeiro_ofertado_2v",
     "financeiro_ofertado_total",
@@ -155,7 +161,9 @@ def _transformar_dados_brutos(dados_brutos: list[dict]) -> pl.DataFrame:
         "liquidacao_segunda_volta": pl.String,
         "oferta_segunda_volta": pl.Int64,
         "financeiro_aceito_segunda_volta": pl.Float64,
+        "tipo_ocorrencia": pl.String,
         "quantidade_liquidada": pl.Int64,
+        "quantidade_liquidada_segunda_volta": pl.Int64,
         "quantidade_aceita_segunda_volta": pl.Int64,
     }
 
@@ -371,6 +379,7 @@ def leiloes(
         * data_liquidacao_2v (Date): data de liquidação financeira da 2ª volta.
         * numero_edital (Int64): número do edital do leilão.
         * tipo_leilao (String): tipo da operação.
+        * tipo_ocorrencia (String): classificação da ocorrência do leilão.
         * titulo (String): código do título público leiloado.
         * benchmark (String): descrição de referência do título.
         * data_vencimento (Date): data de vencimento do título.
@@ -383,6 +392,8 @@ def leiloes(
         * quantidade_aceita_1v (Int64): quantidade aceita na 1ª volta.
         * quantidade_aceita_2v (Int64): quantidade aceita na 2ª volta.
         * quantidade_aceita_total (Int64): quantidade aceita total.
+        * quantidade_liquidada_1v (Int64): quantidade liquidada na 1ª volta.
+        * quantidade_liquidada_2v (Int64): quantidade liquidada na 2ª volta.
         * financeiro_ofertado_1v (Float64): financeiro ofertado na 1ª volta.
         * financeiro_ofertado_2v (Float64): financeiro ofertado na 2ª volta.
         * financeiro_ofertado_total (Float64): financeiro ofertado total.

{pyield-0.52.1 → pyield-0.52.2}/pyproject.toml

@@ -19,7 +19,7 @@ dependencies = [
     "fastexcel>=0.19.0",
     "tzdata>=2024.1; platform_system == 'Windows'",
 ]
-version = "0.52.1"
+version = "0.52.2"
 
 [project.urls]
 Homepage = "https://github.com/crdcj/PYield"