Dias Úteis (DU)
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.
contar(inicio, fim, calendario='auto')
Conta dias úteis entre inicio (inclusivo) e fim (exclusivo).
Considera feriados brasileiros com seleção de regime de feriados por elemento.
PRESERVAÇÃO DE ORDEM (crítico): A ordem de saída SEMPRE corresponde à ordem
elemento a elemento das entradas originais. Nenhuma ordenação, deduplicação,
alinhamento ou remodelação é realizada. Se você passar arrays, o i-ésimo
resultado corresponde ao i-ésimo par de (inicio, fim) após expansão.
Isso garante atribuição segura de volta ao DataFrame de origem.
Regime de feriados: Por padrão, para cada valor de inicio, a lista de
feriados (anterior vs. atual) é escolhida com base na data de transição
26-12-2023. Também é possível selecionar explicitamente uma das listas para toda
a contagem.
Propagação de nulos: Se qualquer argumento escalar for nulo, retorna None.
Nulos dentro de arrays de entrada produzem nulos nas posições correspondentes
do resultado.
Tipo de retorno: Se ambas as entradas forem escalares (não-nulos), um int
é retornado; caso contrário, uma polars.Series de contagens inteiras
(nome: 'dias_uteis'). Se um escalar nulo causar curto-circuito, None é
retornado.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
inicio
|
None | DateLike | DatesLike
|
Data única ou coleção (limite inclusivo). |
required |
fim
|
None | DateLike | DatesLike
|
Data única ou coleção (limite exclusivo). |
required |
calendario
|
Calendario
|
Lista de feriados a considerar. |
'auto'
|
Returns:
| Type | Description |
|---|---|
None | int | Series
|
Inteiro ou |
None | int | Series
|
se qualquer um deles for um array de datas. |
Notes
- Esta função é um encapsulamento de
polars.business_day_count. - Com
calendario="auto", a lista é determinada por linha com base na datainicio. - Strings de data aceitas:
DD-MM-YYYY,DD/MM/YYYYeYYYY-MM-DD. - Strings inválidas são tratadas como
nulle propagadas ao resultado.
Examples:
Transição do feriado de 20 de novembro a partir de 26-12-2023:
Seleção explícita da lista anterior, que não inclui 20 de novembro:
Contagem negativa quando inicio é posterior a fim:
Total de dias úteis em janeiro e fevereiro desde o início do ano:
Dias úteis restantes de janeiro/fevereiro até o fim do ano:
Total de dias úteis em janeiro e fevereiro de 2024:
>>> inicios = ["01-01-2024", "01-02-2024"]
>>> fins = ["01-02-2024", "01-03-2024"]
>>> du.contar(inicios, fins).to_list()
[22, 19]
Valores nulos escalares são propagados:
Nulo dentro do array:
>>> datas_inicio = ["01-01-2024", "01-02-2024", "01-03-2024"]
>>> du.contar(datas_inicio, "01-01-2025").to_list()
[253, 231, 212]
Source code in pyield/du/core.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |
contar_expr(inicio, fim, calendario='auto')
Cria uma expressão Polars para contar dias úteis (com suporte a LazyFrame).
Esta função foi projetada para ser usada dentro de contextos do Polars,
como df.select(), df.with_columns() ou df.filter().
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
inicio
|
Expr | str | date
|
Nome da coluna, expressão Polars ou data literal. |
required |
fim
|
Expr | str | date
|
Nome da coluna, expressão Polars ou data literal. |
required |
calendario
|
Calendario
|
Lista de feriados a considerar. |
'auto'
|
Returns:
| Type | Description |
|---|---|
Expr
|
Uma |
Examples:
>>> import polars as pl
>>> from pyield import du
>>> inicio = [dt.date(2024, 1, 1), dt.date(2024, 2, 9)]
>>> fim = [dt.date(2024, 1, 5), dt.date(2024, 2, 12)]
>>> df = pl.DataFrame({"inicio": inicio, "fim": fim})
>>> df.select(du.contar_expr("inicio", "fim").alias("dias_uteis"))
shape: (2, 1)
┌────────────┐
│ dias_uteis │
│ --- │
│ i64 │
╞════════════╡
│ 3 │
│ 1 │
└────────────┘
Uso com literais (ex: contar dias até o fim do ano):
>>> df.select(dias_uteis=du.contar_expr("inicio", dt.date(2024, 12, 31)))
shape: (2, 1)
┌────────────┐
│ dias_uteis │
│ --- │
│ i64 │
╞════════════╡
│ 252 │
│ 224 │
└────────────┘
Source code in pyield/du/core.py
deslocar(datas, deslocamento, ajuste='seguinte', calendario='auto')
Desloca data(s) por um número de dias úteis com regime de feriados brasileiro.
A operação é realizada em duas etapas por elemento:
1) AJUSTE: Se a data original cair em fim de semana ou feriado, move-a de acordo
com ajuste ("seguinte" ou "anterior").
2) DESLOCAMENTO: Aplica a quantidade de dias úteis com sinal (positivo avança,
negativo retrocede, zero mantém a data após o ajuste).
PRESERVAÇÃO DE ORDEM (crítico): A ordenação de saída corresponde estritamente
ao pareamento elemento a elemento após expansão entre datas e deslocamento.
Nenhuma ordenação, deduplicação ou mudança de forma ocorre. O i-ésimo resultado
corresponde ao i-ésimo par (data, deslocamento), permitindo atribuição segura
de volta ao DataFrame de origem.
Regime de feriados: Por padrão, para cada data, a lista de feriados apropriada (anterior vs. atual) é escolhida com base na data de transição 26-12-2023. Também é possível selecionar explicitamente uma das listas para todo o deslocamento.
Semântica do ajuste: ajuste só atua quando a data original não é um dia útil
sob seu regime. Após o ajuste, a adição de dias úteis subsequente é aplicada a
partir dessa âncora. Um deslocamento de 0 retorna a data original, se ela já
for útil, ou a data resultante do ajuste.
Propagação de nulos: Se qualquer argumento escalar for nulo, a função faz
curto-circuito para None. Nulos dentro de arrays de entrada propagam para
suas posições correspondentes na saída.
Expansão: datas e deslocamento podem ser escalares ou array-like. Regras
padrão de expansão do Polars aplicam-se ao construir os pares por linha.
Tipo de retorno: Se ambas as entradas forem escalares não-nulos, um
datetime.date é retornado. Caso contrário, uma polars.Series de datas
nomeada 'data_ajustada' é produzida. Entradas escalares nulas resultam
em None.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
datas
|
DateLike | DatesLike | None
|
Data única ou coleção de datas a serem ajustadas, se necessário, e então deslocadas. Cada data seleciona independentemente o regime de feriados. |
required |
deslocamento
|
int | ArrayLike | None
|
Contagem com sinal de dias úteis a aplicar após o ajuste. Positivo move para frente, negativo para trás e zero mantém a data ajustada. |
required |
ajuste
|
Ajuste
|
Como tratar uma data inicial não-útil: |
'seguinte'
|
calendario
|
Calendario
|
Lista de feriados a considerar. |
'auto'
|
Returns:
| Type | Description |
|---|---|
date | Series | None
|
Um |
date | Series | None
|
qualquer entrada de array, ou |
date | Series | None
|
fornecido. |
Notes
- Encapsulamento de
polars.Expr.dt.add_business_daysaplicado condicionalmente. - Com
calendario="auto", o regime é decidido por elemento comparando com a data de transição 26-12-2023. - Fins de semana são sempre tratados como não-úteis.
- Strings de data aceitas:
DD-MM-YYYY,DD/MM/YYYYeYYYY-MM-DD. - Strings inválidas são tratadas como
nulle propagadas ao resultado.
Examples:
Transição do feriado de 20 de novembro a partir de 26-12-2023:
>>> du.deslocar("20-11-2020", 0)
datetime.date(2020, 11, 20)
>>> du.deslocar("20-11-2024", 0)
datetime.date(2024, 11, 21)
Seleção explícita da lista anterior, que não inclui 20 de novembro:
Desloca sábado antes do Natal para o próximo dia útil (terça após Natal):
Desloca sexta antes do Natal (sem deslocamento pois é dia útil):
Desloca para o dia útil anterior se não for útil (deslocamento=0 e ajuste="anterior"):
Sem deslocamento pois é dia útil:
Desloca para o primeiro dia útil antes de "23-12-2023":
Avança para o próximo dia útil (deslocamento=1 e ajuste="seguinte"):
Desloca sexta para o próximo dia útil (sexta é pulada -> segunda):
Desloca sábado para o próximo dia útil (segunda é pulada -> terça):
Volta para o dia útil anterior (deslocamento=-1 e ajuste="anterior"):
Desloca sexta para o dia útil anterior (sexta é pulada -> quinta):
Desloca sábado para o dia útil anterior (sexta é pulada -> quinta):
Lista de datas e deslocamentos:
>>> du.deslocar(["19-09-2024", "20-09-2024"], 1)
shape: (2,)
Series: 'data_ajustada' [date]
[
2024-09-20
2024-09-23
]
>>> du.deslocar("19-09-2024", [1, 2]) # lista de deslocamentos
shape: (2,)
Series: 'data_ajustada' [date]
[
2024-09-20
2024-09-23
]
Nulos escalares propagam para None:
Nulo escalar propaga dentro de arrays:
Nulos dentro de arrays são preservados:
>>> du.deslocar(["19-09-2024", None], 1)
shape: (2,)
Series: 'data_ajustada' [date]
[
2024-09-20
null
]
>>> datas = ["19-09-2024", "20-09-2024", "21-09-2024"]
>>> du.deslocar(datas, 1)
shape: (3,)
Series: 'data_ajustada' [date]
[
2024-09-20
2024-09-23
2024-09-24
]
Source code in pyield/du/core.py
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 | |
deslocar_expr(data, deslocamento, ajuste='seguinte', calendario='auto')
Cria uma expressão Polars para somar dias úteis.
Ideal para operações vetorizadas em DataFrames ou LazyFrames.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
Expr | str
|
Coluna de data original. |
required |
deslocamento
|
int | Expr | str
|
Número de dias úteis a somar. Pode ser um inteiro fixo ou outra coluna. |
required |
ajuste
|
Ajuste
|
Como tratar uma data inicial não-útil: |
'seguinte'
|
calendario
|
Calendario
|
Lista de feriados a considerar. |
'auto'
|
Returns:
| Type | Description |
|---|---|
Expr
|
Uma |
Examples:
>>> import datetime as dt
>>> import polars as pl
>>> from pyield import du
>>> datas = [dt.date(2023, 12, 22), dt.date(2023, 12, 29)]
>>> offsets = [1, 5]
>>> df = pl.DataFrame({"dt": datas, "n": offsets})
Adicionando um valor fixo (1 dia útil):
>>> df.select(du.deslocar_expr("dt", 1).alias("t_plus_1"))
shape: (2, 1)
┌────────────┐
│ t_plus_1 │
│ --- │
│ date │
╞════════════╡
│ 2023-12-26 │
│ 2024-01-02 │
└────────────┘
Adicionando uma coluna dinâmica (prazo variável por linha):
>>> df.select(du.deslocar_expr("dt", "n").alias("vencimento"))
shape: (2, 1)
┌────────────┐
│ vencimento │
│ --- │
│ date │
╞════════════╡
│ 2023-12-26 │
│ 2024-01-08 │
└────────────┘
Source code in pyield/du/core.py
eh_dia_util(datas, calendario='auto')
Determina se data(s) são dias úteis brasileiros.
REGIME DE FERIADOS: Por padrão, para cada data, a lista de feriados apropriada (anterior vs. atual) é escolhida com base na data de transição 26-12-2023. Também é possível selecionar explicitamente uma das listas para toda a avaliação.
PRESERVAÇÃO DE ORDEM E FORMA: A saída preserva a ordem original dos elementos. Nenhuma ordenação, deduplicação, remodelação ou alinhamento é realizado; o i-ésimo resultado corresponde à i-ésima data fornecida após expansão (se alguma expansão ocorreu de uma entrada escalar em outro lugar da cadeia de chamadas).
PROPAGAÇÃO DE NULOS: Um argumento escalar nulo faz curto-circuito para None.
Valores nulos dentro de entradas array-like produzem nulos nas posições
correspondentes da saída.
TIPO DE RETORNO: Se a entrada (não-nula) resolve para um único elemento, um
bool Python é retornado. Se esse único elemento for nulo, None é
retornado. Caso contrário, uma polars.Series de booleanos nomeada
'eh_dia_util' é produzida.
FINS DE SEMANA: Sábados e domingos nunca são dias úteis independentemente do regime de feriados.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
datas
|
None | DateLike | DatesLike
|
Data única ou coleção (list/tuple/Polars Series).
Pode incluir nulos que propagam. Entrada escalar nula retorna |
required |
calendario
|
Calendario
|
Lista de feriados a considerar. |
'auto'
|
Returns:
| Type | Description |
|---|---|
None | bool | Series
|
|
None | bool | Series
|
|
None | bool | Series
|
(nome: |
Examples:
>>> from pyield import du
>>> du.eh_dia_util("25-12-2023") # Natal (calendário anterior)
False
>>> du.eh_dia_util("20-11-2024") # Dia Nacional de Zumbi
False
>>> du.eh_dia_util("20-11-2024", calendario="anterior")
True
Períodos mistos:
Notes
- A data de transição é 26-12-2023.
- Com
calendario="auto", espelha a lógica por linha usada emcontaredeslocar. - Fins de semana sempre avaliam como
False. - Elementos nulos propagam.
- Strings de data aceitas:
DD-MM-YYYY,DD/MM/YYYYeYYYY-MM-DD. - Strings inválidas são tratadas como
nulle propagadas ao resultado.
Source code in pyield/du/core.py
eh_dia_util_expr(data, calendario='auto')
Cria expressão Polars para verificar se é dia útil (True/False).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
Expr | str
|
Coluna de datas ou expressão Polars. |
required |
calendario
|
Calendario
|
Lista de feriados a considerar. |
'auto'
|
Returns:
| Type | Description |
|---|---|
Expr
|
Uma |
Examples:
>>> import datetime as dt
>>> import polars as pl
>>> from pyield import du
>>> datas = [dt.date(2023, 12, 25), dt.date(2023, 12, 26)]
>>> df = pl.DataFrame({"data": datas})
Criando uma flag booleana:
>>> df.with_columns(eh_dia_util=du.eh_dia_util_expr("data"))
shape: (2, 2)
┌────────────┬─────────────┐
│ data ┆ eh_dia_util │
│ --- ┆ --- │
│ date ┆ bool │
╞════════════╪═════════════╡
│ 2023-12-25 ┆ false │
│ 2023-12-26 ┆ true │
└────────────┴─────────────┘
Usando para filtrar apenas dias úteis:
>>> df.filter(du.eh_dia_util_expr("data"))
shape: (1, 1)
┌────────────┐
│ data │
│ --- │
│ date │
╞════════════╡
│ 2023-12-26 │
└────────────┘
Source code in pyield/du/core.py
gerar(inicio=None, fim=None, limites_inclusivos='ambos', calendario='auto')
Gera uma Series de dias úteis entre inicio e fim.
Considera a lista de feriados brasileiros.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
inicio
|
DateLike | None
|
Data inicial. Se None, usa a data atual. |
None
|
fim
|
DateLike | None
|
Data final. Se None, usa a data atual. |
None
|
limites_inclusivos
|
LimitesInclusivos
|
Define quais limites pertencem ao intervalo. Opções
válidas: |
'ambos'
|
calendario
|
Calendario
|
Lista de feriados a considerar. |
'auto'
|
Returns:
| Type | Description |
|---|---|
Series
|
Series de dias úteis (nome: 'data'). |
Notes
- Strings de data aceitas:
DD-MM-YYYY,DD/MM/YYYYeYYYY-MM-DD. inicioefimnulos usam a data atual.- Datas inválidas levantam
ValueError.
Examples:
>>> from pyield import du
>>> du.gerar(inicio="22-12-2023", fim="02-01-2024")
shape: (6,)
Series: 'data' [date]
[
2023-12-22
2023-12-26
2023-12-27
2023-12-28
2023-12-29
2024-01-02
]
Seleção automática do calendário conforme a data inicial:
Inclusão apenas do limite inicial:
>>> du.gerar(
... "08-01-2024",
... "10-01-2024",
... limites_inclusivos="inicio",
... ).to_list()
[datetime.date(2024, 1, 8), datetime.date(2024, 1, 9)]
Source code in pyield/du/core.py
ultimo_dia_util()
Retorna o último dia útil no Brasil.
Se a data atual for um dia útil, retorna a data atual. Se for fim de semana ou feriado, retorna o último dia útil antes da data atual.
Returns:
| Type | Description |
|---|---|
date
|
O último dia útil no Brasil. |
Notes
- A determinação do último dia útil considera a lista de feriados brasileiros correta (antes ou depois da transição 2023-12-26) aplicável à data atual.