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)

參數

名稱	Description
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，則會載入所有資料行。 如需此資料集中可用資料行的資訊，請參閱 公用假日。 預設值: 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)

參數

名稱	Description
env 必要	RuntimeEnv 執行時間環境。
min_date 必要	datetime 最小日期。
max_date 必要	最大日期。

傳回

類型	Description
	篩選的資料框架。

get_holidays_dates

取得具有假日日期索引鍵的聽寫。

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

參數

名稱	Description
country_code	指出要用於檢查的國家/地區的假日資訊。 預設值: None
country_or_region	指出要用於檢查的國家/地區的假日資訊。 預設值: None

傳回

類型	Description
	具有假日日期做為索引鍵和 None 做為值的聽寫。

get_holidays_in_range

根據指定的日期範圍取得假日資訊清單。

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

參數

名稱	Description
start_date 必要	日期範圍的開始日期。
end_date 必要	日期範圍的結束日期。
country_code	指出要用於檢查的國家/地區的假日資訊。 預設值: US

傳回

類型	Description
	DataFrame，其中包含目標日期範圍內的假日。

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

參數

名稱	Description
start_date 必要	日期範圍的開始日期。
end_date 必要	日期範圍的結束日期。
country_or_region	指出要用於檢查的國家/地區的假日資訊。 預設值: United States

傳回

類型	Description
	DataFrame，其中包含目標日期範圍內的假日。

get_pandas_limit

取得 pandas 資料載入限制類別的實例。

get_pandas_limit()

is_holiday

偵測日期是假日。

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

參數

名稱	Description
target_date 必要	需要檢查的日期。
country_code	指出要用於檢查的國家/地區的假日資訊。 預設值: US

傳回

類型	Description
	target_date是否為假日。 是非題。

is_holiday_by_country_or_region

偵測日期是假日。

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

參數

名稱	Description
target_date 必要	需要檢查的日期。
country_or_region	指出要用於檢查的國家/地區的假日資訊。 預設值: United States

傳回

類型	Description
	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)