> ## Documentation Index
> Fetch the complete documentation index at: https://takeprofit.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Package indie.schedule
> Library reference for indie.schedule package. Covers scheduling rules, weekday enums, and time-based conditions. Includes Schedule, ScheduleRule, and built-in constants
export const Anchor = ({id}) => {
return ;
};
export const Field = ({id, name, type, required, defaultVal, children}) => {
return
{id &&
}
{name}
{type}
{required &&
required
}
{defaultVal &&
default:
{defaultVal}
}
{children}
;
};
Schedule package that contains classes for working with schedules.
***
## Variables
List of `week_day`'s from `week_day.MONDAY` to `week_day.SUNDAY`.
List of `week_day`'s from `week_day.SATURDAY` to `week_day.SUNDAY`.
List of `week_day`'s from `week_day.MONDAY` to `week_day.FRIDAY`.
***
## Types
### `Schedule`
*type*
Data type that manages a collection of scheduling rules, allowing for specific times and exceptions to be defined.
Class constructor (initializer for the data type).
List of ScheduleRule instances that define the active scheduling rules.
List of dates that are excluded from the schedule only once.
List of dates that are excluded from the schedule every year.
Timezone for schedule.
Checks if the rules list in Schedule is empty. Returns `True` if list of rules is empty; otherwise, returns `False`.
Checks whether a given timestamp falls within the defined schedule. Returns `True` if the timestamp falls within the schedule's active periods, otherwise returns `False`.
Timestamp to check in defined schedule.
Checks whether a given timestamp falls within the defined schedule. Returns `True` if the timestamp falls within the schedule's active periods, otherwise returns `False`.
Datetime to check in defined schedule.
Determines whether two timestamps fall within the same schedule period on the same day. Returns `True` if both timestamps fall within the same period of the schedule, even if they are in different calendar days. False if the timestamps belong to different periods within the schedule.
First timestamp to check.
Second timestamp to check.
This method checks if two timestamps, which may belong to different calendar days, are part of the same schedule period. It handles cases where a schedule spans across two consecutive days (e.g., a trading schedule that extends past midnight) and ensures both timestamps belong to the same logical period within the schedule.
See also: [`TradingSession`](/indie/Library-reference/package-indie#class_TradingSession) [`ScheduleRule`](/indie/Library-reference/package-indie-schedule#class_ScheduleRule)
***
### `ScheduleRule`
*type*
Data type to represent a rule for a schedule, specifying the start and end times, along with the weekdays when the rule is active.
Class constructor (initializer for the data type).
Start time of the rule.
End time of the rule.
List of weekdays when the rule is active.
```py Example theme={null}
# this rule applies from 9:00 AM to 6:30 PM (6:30 is not included) on weekdays (Monday through Friday).
rule = ScheduleRule(start=time(hour=9), end=time(hour=18, minute=30), days=WORKDAYS)
# this overnight_rule applies from 8:15 PM to 7:30 AM on weekdays (Monday through Friday).
overnight_rule = ScheduleRule(start=time(hour=20, minute=15), end=time(hour=7, minute=30), days=WORKDAYS)
```
For rules that span overnight (e.g., from 10:00 PM to 6:00 AM), the end time should be on the day listed in days, while the start time is understood to be on the previous day. This allows the rule to cover activities that occur late in the evening and extend into the early hours of the next day.
See also: [`Schedule`](/indie/Library-reference/package-indie-schedule#class_Schedule) [`TradingSession`](/indie/Library-reference/package-indie#class_TradingSession)
***
## Enums
### `week_day`
*enum*
Enum-like class with constants for days of week.
Built-in constants that represent days of week.
Built-in constants that represent days of week.
Built-in constants that represent days of week.
Built-in constants that represent days of week.
Built-in constants that represent days of week.
Built-in constants that represent days of week.
Built-in constants that represent days of week.
***