Partager via

PublicHolidaysOffline Classe

  • Référence

Représente le jeu de données public hors connexion relatif aux jours fériés.

Pour obtenir une description des lignes, consultez la section Jours fériés dans le catalogue Microsoft Azure Open Datasets.

Initialiser les champs de filtrage.

Héritage
CountryOrRegionTimePublicData
PublicHolidaysOffline

Constructeur

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)

Paramètres

Nom Description
country_or_region
str

Pays ou région dont les données doivent être retournées.

Valeur par défaut: US
start_date
datetime

Date de début (incluse) du chargement des données. Si None est spécifié, default_start_date est utilisé.

Valeur par défaut: 1970-01-01 00:00:00
end_date
datetime

Date de fin (incluse) du chargement des données. Si None est spécifié, default_end_date est utilisé.

Valeur par défaut: 2099-01-01 00:00:00
cols
list[str]

Liste des noms de colonnes à charger à partir du jeu de données. Si None est spécifié, toutes les colonnes sont chargées. Pour plus d’informations sur les colonnes disponibles dans ce jeu de données, consultez Jours fériés.

Valeur par défaut: None
enable_telemetry
bool

Indique s’il est nécessaire d’activer la télémétrie pour ce jeu de données.

Valeur par défaut: True
country_or_region
Obligatoire
str

Pays ou région sur lequel vous souhaitez interroger.
start_date
Obligatoire
datetime

Date de début que vous souhaitez interroger de manière inclusive.
end_date
Obligatoire
datetime

Date de fin que vous souhaitez interroger de manière inclusive.
cols
Obligatoire
Optional[List[str]]

Liste des noms de colonnes que vous souhaitez récupérer. La valeur None permet d’obtenir toutes les colonnes.
enable_telemetry
Obligatoire
bool

Indique s’il est nécessaire d’envoyer des données de télémétrie.

Remarques

L’exemple ci-dessous montre comment accéder au jeu de données.


   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éthodes

filter

Permet de filtrer le temps.
get_holidays_dates

Obtient un dictionnaire dont les clés correspondent aux dates des jours fériés.
get_holidays_in_range

Obtient une liste d’informations relatives aux jours fériés pour la plage de dates donnée.
get_holidays_in_range_by_country_or_region

Permet d’obtenir une liste d’informations relatives aux jours fériés pour la plage de dates donnée.
get_pandas_limit

Permet d’obtenir une instance de la classe de limitation du chargement de données Pandas.
is_holiday

Détecte si une date est un jour férié ou non.
is_holiday_by_country_or_region

Permet de détecter si une date est un jour férié ou non.

filter

Permet de filtrer le temps.

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

Paramètres

Nom Description
env
Obligatoire
RuntimeEnv

Environnement d’exécution.
min_date
Obligatoire
datetime

Date minimale.
max_date
Obligatoire

Date maximale.

Retours

Type Description

Dataframe filtré.

get_holidays_dates

Obtient un dictionnaire dont les clés correspondent aux dates des jours fériés.

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

Paramètres

Nom Description
country_code

Permet d’indiquer le pays/la région dont les informations sur les jours fériés doivent être utilisées pour la vérification.

Valeur par défaut: None
country_or_region

Permet d’indiquer le pays/la région dont les informations sur les jours fériés doivent être utilisées pour la vérification.

Valeur par défaut: None

Retours

Type Description

Dictionnaire avec les dates des jours fériés en tant que clés et None en tant que valeurs.

get_holidays_in_range

Obtient une liste d’informations relatives aux jours fériés pour la plage de dates donnée.

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

Paramètres

Nom Description
start_date
Obligatoire

Date de début de la plage de dates.
end_date
Obligatoire

Date de fin de la plage de dates.
country_code

Indique le pays/la région dont les informations sur les jours fériés doivent être utilisées pour la vérification.

Valeur par défaut: US

Retours

Type Description

DataFrame qui contient les jours fériés dans la plage de dates cible.

get_holidays_in_range_by_country_or_region

Permet d’obtenir une liste d’informations relatives aux jours fériés pour la plage de dates donnée.

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

Paramètres

Nom Description
start_date
Obligatoire

Date de début de la plage de dates.
end_date
Obligatoire

Date de fin de la plage de dates.
country_or_region

Indique le pays/la région dont les informations sur les jours fériés doivent être utilisées pour la vérification.

Valeur par défaut: United States

Retours

Type Description

DataFrame qui contient les jours fériés dans la plage de dates cible.

get_pandas_limit

Permet d’obtenir une instance de la classe de limitation du chargement de données Pandas.

get_pandas_limit()

is_holiday

Détecte si une date est un jour férié ou non.

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

Paramètres

Nom Description
target_date
Obligatoire

Date à vérifier.
country_code

Indique le pays/la région dont les informations sur les jours fériés doivent être utilisées pour la vérification.

Valeur par défaut: US

Retours

Type Description

Indique si target_date est un jour férié ou non. Vrai ou faux.

is_holiday_by_country_or_region

Permet de détecter si une date est un jour férié ou non.

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

Paramètres

Nom Description
target_date
Obligatoire

Date à vérifier.
country_or_region

Indique le pays/la région dont les informations sur les jours fériés doivent être utilisées pour la vérification.

Valeur par défaut: United States

Retours

Type Description

Indique si target_date est un jour férié ou non. Vrai ou faux.

Attributs

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)