PublicHolidaysOffline クラス
祝日のオフライン パブリック データセットを表します。
行の詳細については、Microsoft Azure Open Datasets カタログの「祝日」を参照してください。
フィルター フィールドを初期化します。
- 継承
-
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
|
データを返す国または地域。 規定値: US
|
start_date
|
データの読み込みを開始する日付 (その日を含む)。 None の場合は、 規定値: 1970-01-01 00:00:00
|
end_date
|
データの読み込みを終了する日付 (その日付を含む)。 None の場合は、 規定値: 2099-01-01 00:00:00
|
cols
|
データセットから読み込む列名のリスト。 None の場合は、すべての列が読み込まれます。 このデータセットで使用できる列の詳細については、「祝日」を参照してください。 規定値: None
|
enable_telemetry
|
このデータセットでテレメトリを有効にするかどうか。 規定値: True
|
country_or_region
必須
|
クエリを実行する国または地域。 |
start_date
必須
|
包括的にクエリを実行する開始日。 |
end_date
必須
|
包括的にクエリを実行する終了日。 |
cols
必須
|
取得する列名の一覧。 None の場合、すべての列が取得されます。 |
enable_telemetry
必須
|
テレメトリを送信するかどうかを示します。 |
注釈
データセットにアクセスする方法の例を次に示します。
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
必須
|
ランタイム環境。 |
min_date
必須
|
最小の日付。 |
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)