PublicHolidaysOffline Класс

Представляет общедоступный набор данных со сведениями о государственных праздниках.

Описание строк см. в на странице Public Holidays (Государственные праздники) в каталоге Открытых наборов данных Microsoft Azure.

Инициализация полей фильтрации.

Наследование

CountryOrRegionTimePublicData

PublicHolidaysOffline

Конструктор

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)

Параметры

Имя	Описание
country_or_region	str Страна или регион, для которых возвращаются данные. значение по умолчанию: US
start_date	datetime Дата (включительно) начала загрузки данных. При значении None, используется default_start_date. значение по умолчанию: 1970-01-01 00:00:00
end_date	datetime Дата окончания загрузки данных (включительно). При значении None, используется default_end_date. значение по умолчанию: 2099-01-01 00:00:00
cols	list[str] Список имен столбцов для загрузки из набора данных. При значении None загружаются все столбцы. Сведения о доступных столбцах этого набора данных см. на странице Public Holidays (Государственные праздники). значение по умолчанию: None
enable_telemetry	bool Следует ли включить телеметрию для этого набора данных. значение по умолчанию: True
country_or_region Обязательно	str Страна или регион, к которые вы хотите выполнить запрос.
start_date Обязательно	datetime Дата начала запроса включительно.
end_date Обязательно	datetime Конечная дата, которую вы хотите запросить включительно.
cols Обязательно	Optional[List[str]] Список имен столбцов, которые вы хотите получить. По всем столбцам вернется значение None.
enable_telemetry Обязательно	bool Указывает, следует ли отправлять данные телеметрии.

Комментарии

В приведенном ниже примере показано, как получить доступ к набору данных.

   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()

Методы

filter	Фильтр времени.
get_holidays_dates	Получение словаря с ключами в виде дат праздников.
get_holidays_in_range	Получение списка сведений о праздниках в заданном диапазоне дат.
get_holidays_in_range_by_country_or_region	Получение списка сведений о праздниках в заданном диапазоне дат.
get_pandas_limit	Получение экземпляра класса ограничения загрузки данных Pandas.
is_holiday	Обнаружение того, является ли это дата праздником.
is_holiday_by_country_or_region	Обнаружение того, является ли это дата праздником.

filter

Фильтр времени.

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

Параметры

Имя	Описание
env Обязательно	RuntimeEnv Среда выполнения.
min_date Обязательно	datetime Минимальная дата.
max_date Обязательно	Максимальная дата.

Возвращаемое значение

Тип	Описание
	Отфильтрованный кадр данных.

get_holidays_dates

Получение словаря с ключами в виде дат праздников.

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

Параметры

Имя	Описание
country_code	Указание страны или региона, сведения о праздниках в которых будут использоваться для проверки. значение по умолчанию: None
country_or_region	Указание страны или региона, сведения о праздниках в которых будут использоваться для проверки. значение по умолчанию: None

Возвращаемое значение

Тип	Описание
	Словарь с датами праздников в качестве ключей и None в качестве значений.

get_holidays_in_range

Получение списка сведений о праздниках в заданном диапазоне дат.

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

Параметры

Имя	Описание
start_date Обязательно	Дата начала диапазона дат.
end_date Обязательно	Диапазон дат диапазона дат.
country_code	Указание страны или региона, сведения о праздниках в которых будут использоваться для проверки. значение по умолчанию: US

Возвращаемое значение

Тип	Описание
	Кадр данных, который содержит праздники в целевом диапазоне дат.

get_holidays_in_range_by_country_or_region

Получение списка сведений о праздниках в заданном диапазоне дат.

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

Параметры

Имя	Описание
start_date Обязательно	Дата начала диапазона дат.
end_date Обязательно	Диапазон дат диапазона дат.
country_or_region	Указание страны или региона, сведения о праздниках в которых будут использоваться для проверки. значение по умолчанию: United States

Возвращаемое значение

Тип	Описание
	Кадр данных, который содержит праздники в целевом диапазоне дат.

get_pandas_limit

Получение экземпляра класса ограничения загрузки данных Pandas.

get_pandas_limit()

is_holiday

Обнаружение того, является ли это дата праздником.

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

Параметры

Имя	Описание
target_date Обязательно	Дата, которую необходимо проверить.
country_code	Указание страны или региона, сведения о праздниках в которых будут использоваться для проверки. значение по умолчанию: US

Возвращаемое значение

Тип	Описание
	Является ли target_date праздником. Верно или неверно.

is_holiday_by_country_or_region

Обнаружение того, является ли это дата праздником.

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

Параметры

Имя	Описание
target_date Обязательно	Дата, которую необходимо проверить.
country_or_region	Указание страны или региона, сведения о праздниках в которых будут использоваться для проверки. значение по умолчанию: United States

Возвращаемое значение

Тип	Описание
	Является ли target_date праздником. Верно или неверно.

Атрибуты

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)