PublicHolidaysOffline 类

表示公共假日离线公共数据集。

有关行的说明，请参阅 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 开始加载数据的日期（含）。 如果为“无”，则使用 default_start_date。 默认值: 1970-01-01 00:00:00
end_date	datetime 结束加载数据的日期（含）。 如果为“无”，则使用 default_end_date。 默认值: 2099-01-01 00:00:00
cols	list[str] 要从数据集加载的列名称的列表。 如果为 None，则加载所有列。 若要了解此数据集中的可用列，请参阅公共假日。 默认值: None
enable_telemetry	bool 是否对此数据集启用遥测。 默认值: True
country_or_region 必需	str 要查询的国家或地区。
start_date 必需	datetime 要查询的开始日期（含）。
end_date 必需	datetime 要查询的结束日期（含）。
cols 必需	Optional[List[str]] 要检索的列名列表。 “无”将获取所有列。
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)