pyield 0.55.2__tar.gz → 0.56.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyield
-Version: 0.55.2
+Version: 0.56.1
 Summary: Polars-powered toolkit for Brazilian fixed income analysis
 Keywords: fixed-income,brazil,finance,analysis,bonds
 Author: Carlos Carvalho
@@ -142,6 +142,29 @@ du.gerar("22-12-2023", "02-01-2024")
 du.eh_dia_util("25-12-2023")  # -> False (Natal)
 ```
 
+Por padrão, `calendario="auto"` seleciona a lista de feriados com base na data de
+referência de cada operação. Em entradas vetorizadas, a seleção ocorre por
+elemento; em `du.gerar`, ela usa `inicio`. Use `calendario="anterior"` para
+forçar o regime anterior a 26/12/2023 ou `calendario="atual"` para forçar a
+lista vigente na versão instalada:
+
+```python
+du.contar("20-11-2024", "21-11-2024", calendario="anterior")  # -> 1
+du.contar("20-11-2024", "21-11-2024", calendario="atual")     # -> 0
+```
+
+Os parâmetros opcionais usam termos em português. `ajuste` define como tratar uma
+data inicial não útil, enquanto `limites_inclusivos` controla quais extremos de um
+intervalo gerado são incluídos:
+
+```python
+du.deslocar("23-12-2023", 0, ajuste="anterior")
+# -> datetime.date(2023, 12, 22)
+
+du.gerar("08-01-2024", "10-01-2024", limites_inclusivos="inicio").to_list()
+# -> [datetime.date(2024, 1, 8), datetime.date(2024, 1, 9)]
+```
+
 As principais funções de cálculo (`contar`, `deslocar` e `eh_dia_util`)
 suportam operações vetorizadas com listas, Series ou arrays.
 
@@ -308,10 +331,11 @@ Documentação completa: [crdcj.github.io/PYield](https://crdcj.github.io/PYield
 
 ## Compatibilidade e mudanças da API
 
-A versão atual é `v0.55.0`. As mudanças abaixo exigem atualização de código:
+A versão atual é `v0.56.0`. As mudanças abaixo podem exigir atualização de código:
 
 | Versão | Mudança principal |
 |---|---|
+| `v0.56.0` | As funções de dias úteis adotaram `calendario="auto" \| "anterior" \| "atual"`. Em `du.gerar`, substitua `opcao_feriado` por `calendario`; `"inferir"`, `"antigo"` e `"novo"` correspondem agora a `"auto"`, `"anterior"` e `"atual"`. O parâmetro `rolagem` virou `ajuste`; `"forward"` e `"backward"` viraram `"seguinte"` e `"anterior"`. O parâmetro `fechamento` virou `limites_inclusivos`, com os valores `"ambos"`, `"inicio"`, `"fim"` e `"nenhum"`. O padrão de `calendario` passou a ser `"auto"`. `Interpolador` agora levanta `ValueError` quando a curva não contém vértices válidos. |
 | `v0.55.0` | Funções de PU, cotação e VNA dos títulos passaram a retornar `Decimal` com seis casas. Entradas numéricas aceitam `float` ou `Decimal`. |
 | `v0.54.5` | `fluxos_caixa` não aceita mais `ajustar_datas_pagamento`; os cronogramas usam datas contratuais. |
 | `v0.54.2` | `taxas_historicas` foi adicionada e `tpf.taxas(completo=True)` foi removida. |

{pyield-0.55.2 → pyield-0.56.1}/README.md

@@ -117,6 +117,29 @@ du.gerar("22-12-2023", "02-01-2024")
 du.eh_dia_util("25-12-2023")  # -> False (Natal)
 ```
 
+Por padrão, `calendario="auto"` seleciona a lista de feriados com base na data de
+referência de cada operação. Em entradas vetorizadas, a seleção ocorre por
+elemento; em `du.gerar`, ela usa `inicio`. Use `calendario="anterior"` para
+forçar o regime anterior a 26/12/2023 ou `calendario="atual"` para forçar a
+lista vigente na versão instalada:
+
+```python
+du.contar("20-11-2024", "21-11-2024", calendario="anterior")  # -> 1
+du.contar("20-11-2024", "21-11-2024", calendario="atual")     # -> 0
+```
+
+Os parâmetros opcionais usam termos em português. `ajuste` define como tratar uma
+data inicial não útil, enquanto `limites_inclusivos` controla quais extremos de um
+intervalo gerado são incluídos:
+
+```python
+du.deslocar("23-12-2023", 0, ajuste="anterior")
+# -> datetime.date(2023, 12, 22)
+
+du.gerar("08-01-2024", "10-01-2024", limites_inclusivos="inicio").to_list()
+# -> [datetime.date(2024, 1, 8), datetime.date(2024, 1, 9)]
+```
+
 As principais funções de cálculo (`contar`, `deslocar` e `eh_dia_util`)
 suportam operações vetorizadas com listas, Series ou arrays.
 
@@ -283,10 +306,11 @@ Documentação completa: [crdcj.github.io/PYield](https://crdcj.github.io/PYield
 
 ## Compatibilidade e mudanças da API
 
-A versão atual é `v0.55.0`. As mudanças abaixo exigem atualização de código:
+A versão atual é `v0.56.0`. As mudanças abaixo podem exigir atualização de código:
 
 | Versão | Mudança principal |
 |---|---|
+| `v0.56.0` | As funções de dias úteis adotaram `calendario="auto" \| "anterior" \| "atual"`. Em `du.gerar`, substitua `opcao_feriado` por `calendario`; `"inferir"`, `"antigo"` e `"novo"` correspondem agora a `"auto"`, `"anterior"` e `"atual"`. O parâmetro `rolagem` virou `ajuste`; `"forward"` e `"backward"` viraram `"seguinte"` e `"anterior"`. O parâmetro `fechamento` virou `limites_inclusivos`, com os valores `"ambos"`, `"inicio"`, `"fim"` e `"nenhum"`. O padrão de `calendario` passou a ser `"auto"`. `Interpolador` agora levanta `ValueError` quando a curva não contém vértices válidos. |
 | `v0.55.0` | Funções de PU, cotação e VNA dos títulos passaram a retornar `Decimal` com seis casas. Entradas numéricas aceitam `float` ou `Decimal`. |
 | `v0.54.5` | `fluxos_caixa` não aceita mais `ajustar_datas_pagamento`; os cronogramas usam datas contratuais. |
 | `v0.54.2` | `taxas_historicas` foi adicionada e `tpf.taxas(completo=True)` foi removida. |

{pyield-0.55.2 → pyield-0.56.1}/pyield/du/__init__.py

@@ -1,3 +1,9 @@
+"""Dias úteis e calendário brasileiro.
+
+Expõe contagem, deslocamento, geração e verificação de dias úteis, além das
+respectivas expressões Polars.
+"""
+
 from pyield.du.core import (
     contar,
     contar_expr,