pyield 0.55.1__tar.gz → 0.55.2__tar.gz

{pyield-0.55.1 → pyield-0.55.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyield
-Version: 0.55.1
+Version: 0.55.2
 Summary: Polars-powered toolkit for Brazilian fixed income analysis
 Keywords: fixed-income,brazil,finance,analysis,bonds
 Author: Carlos Carvalho

{pyield-0.55.1 → pyield-0.55.2}/pyield/selic/copom.py

@@ -151,10 +151,10 @@ def calendar(
 
     Examples:
         >>> import pyield as yd
-        >>> cal = yd.selic.copom.calendar()
-        >>> "ExpiryDate" in cal.columns
+        >>> cal = yd.selic.copom.calendar()  # doctest: +SKIP
+        >>> "ExpiryDate" in cal.columns  # doctest: +SKIP
         True
-        >>> cal["EndDate"].is_sorted()
+        >>> cal["EndDate"].is_sorted()  # doctest: +SKIP
         True
     """
     past = _fetch_past_meetings()
@@ -192,8 +192,8 @@ def next_meeting(reference: DateLike | None = None) -> pl.DataFrame:
 
     Examples:
         >>> import pyield as yd
-        >>> row = yd.selic.copom.next_meeting()
-        >>> len(row)
+        >>> row = yd.selic.copom.next_meeting()  # doctest: +SKIP
+        >>> len(row)  # doctest: +SKIP
         1
     """
     ref = relogio.hoje() if reference is None else converter_datas(reference)

{pyield-0.55.1 → pyield-0.55.2}/pyield/selic/cpm.py

@@ -254,8 +254,8 @@ def data(date: DateLike) -> pl.DataFrame:
 
     Examples:
         >>> import pyield as yd
-        >>> df = yd.selic.cpm.data("29-01-2025")
-        >>> df.is_empty() or set(df.schema.keys()) >= {
+        >>> df = yd.selic.cpm.data("29-01-2025")  # doctest: +SKIP
+        >>> df.is_empty() or set(df.schema.keys()) >= {  # doctest: +SKIP
         ...     "data_referencia",
         ...     "codigo_negociacao",
         ...     "data_fim_reuniao",

{pyield-0.55.1 → pyield-0.55.2}/pyield/selic/probabilities.py

@@ -253,11 +253,13 @@ def all_meetings(
     Examples:
         >>> import pyield as yd
         >>> import polars as pl
-        >>> df = yd.selic.probabilities.all_meetings("29-01-2025")
-        >>> df.is_empty() or df["ranking_reuniao"].min() == 1
+        >>> df = yd.selic.probabilities.all_meetings("29-01-2025")  # doctest: +SKIP
+        >>> df.is_empty() or df["ranking_reuniao"].min() == 1  # doctest: +SKIP
         True
-        >>> sums = df.group_by("data_expiracao").agg(pl.col("prob").sum())
-        >>> df.is_empty() or (sums["prob"] - 1.0).abs().max() < 1e-9
+        >>> sums = df.group_by("data_expiracao").agg(
+        ...     pl.col("prob").sum()
+        ... )  # doctest: +SKIP
+        >>> df.is_empty() or (sums["prob"] - 1.0).abs().max() < 1e-9  # doctest: +SKIP
         True
     """
     raw = cpm.data(date)
@@ -318,10 +320,12 @@ def meeting(
 
     Examples:
         >>> import pyield as yd
-        >>> df = yd.selic.probabilities.meeting("29-01-2025")
-        >>> df.is_empty() or abs(df["prob"].sum() - 1.0) < 1e-9
+        >>> df = yd.selic.probabilities.meeting("29-01-2025")  # doctest: +SKIP
+        >>> df.is_empty() or abs(df["prob"].sum() - 1.0) < 1e-9  # doctest: +SKIP
         True
-        >>> df.is_empty() or df["prob_acumulada"].tail(1).item() == 1.0
+        >>> df.is_empty() or df["prob_acumulada"].tail(
+        ...     1
+        ... ).item() == 1.0  # doctest: +SKIP
         True
     """
     df = all_meetings(date, option_type=option_type)

pyield-0.55.2/pyield/tpf/vna/__init__.py

@@ -0,0 +1,5 @@
+"""Cálculos de VNA por tipo de título público."""
+
+from pyield.tpf.vna.calculo import calcular_vna
+
+__all__ = ["calcular_vna"]

pyield-0.55.1/pyield/tpf/vna/_utils.py → pyield-0.55.2/pyield/tpf/vna/calculo.py

@@ -1,4 +1,4 @@
-"""Operações compartilhadas pelos cálculos de VNA."""
+"""Cálculos genéricos de VNA."""
 
 import datetime as dt
 
@@ -20,7 +20,29 @@ def calcular_vna(
     *,
     fator_variacao: float | None = None,
 ) -> float:
-    """Obtém o VNA publicado ou calcula o pró-rata entre pontos publicados."""
+    """Obtém o VNA publicado ou calcula o pró-rata entre pontos publicados.
+
+    Args:
+        df: DataFrame com as colunas ``data`` (Date) e ``vna`` (Float64),
+            contendo no máximo um ponto publicado por data.
+        data: Data para a qual o VNA será obtido ou interpolado.
+        fator_variacao: Fator multiplicativo entre o ponto inicial e o final.
+            Se omitido, é calculado pela razão entre os VNAs dos dois pontos.
+
+    Returns:
+        Float: VNA publicado ou calculado por pró-rata exponencial. Retorna
+        ``float('nan')`` quando não houver pontos publicados dos dois lados da
+        data ou quando ela estiver fora do intervalo disponível.
+
+    Notes:
+        Um ponto publicado exatamente na data tem prioridade e ignora
+        ``fator_variacao``. O expoente do pró-rata é truncado em catorze casas
+        e o resultado em seis casas.
+
+    Raises:
+        ValueError: Se o VNA-base não for positivo ou a variação for menor ou
+            igual a -100%.
+    """
     ponto_exato = df.filter(pl.col("data") == data)
     if ponto_exato.height == 1:
         return float(ponto_exato.item(0, "vna"))
@@ -73,3 +95,6 @@ def calcular_vna_projetado(
         projecao_percentual / 100,
         expoente,
     )
+
+
+__all__ = ["calcular_vna"]

{pyield-0.55.1 → pyield-0.55.2}/pyield/tpf/vna/ntnb.py

@@ -10,7 +10,8 @@ import pyield._internal.converters as conversores
 from pyield._internal.numbers import truncar, truncar_decimal
 from pyield._internal.types import DateLike, any_is_empty
 from pyield.ipca import historico as _ipca
-from pyield.tpf.vna import _download, _utils
+from pyield.tpf.vna import _download
+from pyield.tpf.vna import calculo as _vna
 
 _DIA_INICIO_VIGENCIA = 15
 _QTD_MARCOS_VIGENCIA = 2
@@ -23,7 +24,7 @@ def _processar(df_bruto: pl.DataFrame) -> pl.DataFrame:
     """Normaliza as duas colunas da planilha de NTN-B."""
     return (
         df_bruto.select(
-            data=_utils.expressao_data(),
+            data=_vna.expressao_data(),
             vna=pl.col("column_2").cast(pl.Float64, strict=False),
         )
         .filter(pl.col("data").is_not_null(), pl.col("vna").is_not_null())
@@ -94,7 +95,7 @@ def vna(data: DateLike | None = None) -> Decimal:
     if math.isnan(fator_ipca):
         return Decimal("NaN")
     return truncar_decimal(
-        _utils.calcular_vna(
+        _vna.calcular_vna(
             df,
             data_convertida,
             fator_variacao=fator_ipca,
@@ -174,12 +175,12 @@ def vna_projetado(
     """
     if any_is_empty(data, vna_base, inflacao):
         return Decimal("NaN")
-    if inflacao <= _utils.LIMITE_INFERIOR_PERCENTUAL:
+    if inflacao <= _vna.LIMITE_INFERIOR_PERCENTUAL:
         raise ValueError("A inflação deve ser maior que -100%.")
     data_convertida = conversores.converter_datas(data)
     inicio, fim = _obter_vigencia(data_convertida)
     expoente = (data_convertida - inicio).days / (fim - inicio).days
     return truncar_decimal(
-        _utils.calcular_vna_projetado(float(vna_base), float(inflacao), expoente),
+        _vna.calcular_vna_projetado(float(vna_base), float(inflacao), expoente),
         6,
     )

{pyield-0.55.1 → pyield-0.55.2}/pyield/tpf/vna/ntnc.py

@@ -8,7 +8,8 @@ import polars as pl
 import pyield._internal.converters as conversores
 from pyield._internal.numbers import truncar_decimal
 from pyield._internal.types import DateLike, any_is_empty
-from pyield.tpf.vna import _download, _utils
+from pyield.tpf.vna import _download
+from pyield.tpf.vna import calculo as _vna
 
 _URL_PUBLICACAO = (
     "https://www.tesourotransparente.gov.br/publicacoes/valor-nominal-de-ntn-c/"
@@ -24,7 +25,7 @@ def _processar(df_bruto: pl.DataFrame) -> pl.DataFrame:
     series = []
     for coluna, anos in _ANOS_VENCIMENTO.items():
         serie = df_bruto.select(
-            data=_utils.expressao_data(),
+            data=_vna.expressao_data(),
             anos_vencimento=pl.lit(anos, dtype=pl.List(pl.Int64)),
             vna=pl.col(coluna).cast(pl.Float64, strict=False),
         ).filter(
@@ -100,7 +101,7 @@ def vna(
     df = vnas().filter(
         pl.col("anos_vencimento").list.contains(vencimento_convertido.year)
     )
-    return truncar_decimal(_utils.calcular_vna(df, data_convertida), 6)
+    return truncar_decimal(_vna.calcular_vna(df, data_convertida), 6)
 
 
 def _obter_vigencia(data: dt.date) -> tuple[dt.date, dt.date]:
@@ -153,12 +154,12 @@ def vna_projetado(
     """
     if any_is_empty(data, vna_base, inflacao):
         return Decimal("NaN")
-    if inflacao <= _utils.LIMITE_INFERIOR_PERCENTUAL:
+    if inflacao <= _vna.LIMITE_INFERIOR_PERCENTUAL:
         raise ValueError("A inflação deve ser maior que -100%.")
     data_convertida = conversores.converter_datas(data)
     inicio, fim = _obter_vigencia(data_convertida)
     expoente = (data_convertida - inicio).days / (fim - inicio).days
     return truncar_decimal(
-        _utils.calcular_vna_projetado(float(vna_base), float(inflacao), expoente),
+        _vna.calcular_vna_projetado(float(vna_base), float(inflacao), expoente),
         6,
     )

{pyield-0.55.1 → pyield-0.55.2}/pyproject.toml

@@ -25,7 +25,7 @@ dependencies = [
     "fastexcel>=0.19.0",
     "tzdata>=2024.1; platform_system == 'Windows'",
 ]
-version = "0.55.1"
+version = "0.55.2"
 
 [[project.authors]]
 name = "Carlos Carvalho"

{pyield-0.55.1 → pyield-0.55.2}/pyproject.toml.orig

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

pyield-0.55.1/pyield/tpf/vna/__init__.py

@@ -1 +0,0 @@
-"""Cálculos de VNA por tipo de título público."""