Compartilhar via

PublicHolidaysOffline Classe

  • Referência

Representa o conjunto de dados público offline de Feriados Públicos.

Para obter uma descrição das linhas, consulte Feriados Públicos no catálogo do Microsoft Azure Open Datasets.

Inicializar campos de filtragem.

Herança
CountryOrRegionTimePublicData
PublicHolidaysOffline

Construtor

PublicHolidaysOffline(country_or_region: str = 'US', start_date: datetime = datetime.datetime(1970, 1, 1, 0, 0), end_date: datetime = datetime.datetime(2099, 1, 1, 0, 0), cols: List[str] | None = None, enable_telemetry: bool = True)

Parâmetros

Nome Description
country_or_region
str

O país ou a região para a qual retornar dados.

Valor padrão: US
start_date
datetime

A data na qual iniciar o carregamento de dados, inclusive. Se Nenhuma, default_start_date será usado.

Valor padrão: 1970-01-01 00:00:00
end_date
datetime

A data na qual terminar o carregamento de dados, inclusive. Se Nenhuma, default_end_date será usado.

Valor padrão: 2099-01-01 00:00:00
cols
list[str]

Uma lista de nomes de coluna a serem carregados do conjunto de dados. Se Nenhuma, todas as colunas serão carregadas. Para saber mais sobre as colunas disponíveis neste conjunto de dados, confira Feriados Públicos.

Valor padrão: None
enable_telemetry
bool

Se a telemetria deve ser habilitada neste conjunto de dados.

Valor padrão: True
country_or_region
Obrigatório
str

O país ou região em que você gostaria de consultar.
start_date
Obrigatório
datetime

A data de início que você gostaria de consultar inclusive.
end_date
Obrigatório
datetime

A data de término que você deseja consultar inclusive.
cols
Obrigatório
Optional[List[str]]

Uma lista de nomes de coluna que você gostaria de recuperar. Nenhum obterá todas as colunas.
enable_telemetry
Obrigatório
bool

Indica se a telemetria deve ser enviada.

Comentários

O exemplo abaixo mostra como acessar o conjunto de dados.


   from azureml.opendatasets import PublicHolidaysOffline
   from datetime import datetime
   from dateutil.relativedelta import relativedelta

   end_date = datetime.today()
   start_date = datetime.today() - relativedelta(months=1)
   hol = PublicHolidaysOffline(start_date=start_date, end_date=end_date)
   hol_df = hol.to_pandas_dataframe()

Métodos

filter

Tempo de filtro.
get_holidays_dates

Obter um dicionário com a chave das datas de feriados.
get_holidays_in_range

Obter uma lista de informações de feriado com base no intervalo de datas determinado.
get_holidays_in_range_by_country_or_region

Obter uma lista de informações de feriado com base no intervalo de datas determinado.
get_pandas_limit

Obtém uma instância da classe de limite de carregamento de dados do pandas.
is_holiday

Detectar se uma data é um feriado ou não.
is_holiday_by_country_or_region

Detectar se uma data é um feriado ou não.

filter

Tempo de filtro.

filter(env: SparkEnv | PandasEnv, min_date: datetime, max_date: datetime)

Parâmetros

Nome Description
env
Obrigatório
RuntimeEnv

O ambiente de runtime.
min_date
Obrigatório
datetime

A data mín.
max_date
Obrigatório

A data máx.

Retornos

Tipo Description

O dataframe filtrado.

get_holidays_dates

Obter um dicionário com a chave das datas de feriados.

get_holidays_dates(country_code: str | None = None, country_or_region: str | None = None) -> Dict[datetime, None] | None

Parâmetros

Nome Description
country_code

Indica quais informações de feriado do país/região serão usadas para a verificação.

Valor padrão: None
country_or_region

Indica quais informações de feriado do país/região serão usadas para a verificação.

Valor padrão: None

Retornos

Tipo Description

O dicionário com datas de feriados como as chaves e Nenhum como valores.

get_holidays_in_range

Obter uma lista de informações de feriado com base no intervalo de datas determinado.

get_holidays_in_range(start_date: date, end_date: date, country_code: str = 'US') -> DataFrame

Parâmetros

Nome Description
start_date
Obrigatório

A data de início do intervalo de datas.
end_date
Obrigatório

A data de término do intervalo de datas.
country_code

Indica quais informações de feriado do país/região serão usadas para a verificação.

Valor padrão: US

Retornos

Tipo Description

Um DataFrame que contém os feriados no intervalo de datas de destino.

get_holidays_in_range_by_country_or_region

Obter uma lista de informações de feriado com base no intervalo de datas determinado.

get_holidays_in_range_by_country_or_region(start_date: date, end_date: date, country_or_region: str = 'United States') -> DataFrame

Parâmetros

Nome Description
start_date
Obrigatório

A data de início do intervalo de datas.
end_date
Obrigatório

A data de término do intervalo de datas.
country_or_region

Indica quais informações de feriado do país/região serão usadas para a verificação.

Valor padrão: United States

Retornos

Tipo Description

Um DataFrame que contém os feriados no intervalo de datas de destino.

get_pandas_limit

Obtém uma instância da classe de limite de carregamento de dados do pandas.

get_pandas_limit()

is_holiday

Detectar se uma data é um feriado ou não.

is_holiday(target_date: date, country_code: str = 'US') -> bool

Parâmetros

Nome Description
target_date
Obrigatório

A data que precisa ser verificada.
country_code

Indica quais informações de feriado do país/região serão usadas para a verificação.

Valor padrão: US

Retornos

Tipo Description

Se a target_date é um feriado ou não. Verdadeiro ou falso.

is_holiday_by_country_or_region

Detectar se uma data é um feriado ou não.

is_holiday_by_country_or_region(target_date: date, country_or_region: str = 'United States') -> bool

Parâmetros

Nome Description
target_date
Obrigatório

A data que precisa ser verificada.
country_or_region

Indica quais informações de feriado do país/região serão usadas para a verificação.

Valor padrão: United States

Retornos

Tipo Description

Se a target_date é um feriado ou não. Verdadeiro ou falso.

Atributos

HOLIDAYS_DF 

HOLIDAYS_DF = countryOrRegion  ... isPaidTimeOff 0              Denmark  ...          None 1              Belgium  ...          None 2          Netherlands  ...          None 3              Croatia  ...          None 4                Czech  ...          None ...                ...  ...           ... 344981         Croatia  ...          None 344982          Norway  ...          None 344983          Sweden  ...          None 344984          Sweden  ...          None 344985          Norway  ...          None  [344986 rows x 5 columns]

data 

data = None

default_country_or_region 

default_country_or_region = 'US'

default_end_date 

default_end_date = datetime.datetime(2099, 1, 1, 0, 0)

default_start_date 

default_start_date = datetime.datetime(1970, 1, 1, 0, 0)