Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pysquirrels.com/llms.txt

Use this file to discover all available pages before exploring further.

Parameter option for date range parameters that can vary based on selection of another parameter. This class can be imported from the squirrels.parameter_options or the squirrels module.

​
Constructor

Creates a DateRangeParameterOption object. Typically used in pyconfigs/parameters.py. 
def __init__(
    self, default_start_date: str | date, default_end_date: str | date, 
    *, min_date: str | date | None = None, max_date: str | date | None = None, 
    date_format: str = '%Y-%m-%d', user_groups: Iterable[Any] | str = frozenset(), 
    parent_option_ids: Iterable[str] | str = frozenset()
) -> None:

​
Examples

A DateRangeParameterOption object is created in the pyconfigs/parameters.py file. It must be created in a function decorated with the create_with_options factory method from DateRangeParameter.

​
Usage example in parameters.py

from squirrels import parameters as p, parameter_options as po
from datetime import date

@p.DateRangeParameter.create_with_options(
    name="date_range", 
    label="Date Range",
    description="Date range for the report"
)
def date_range_options():
    return [
        po.DateRangeParameterOption(
            default_start_date=date(2024, 1, 1),
            default_end_date=date(2024, 12, 31),
            min_date=date(2020, 1, 1),
            max_date=date(2024, 12, 31)
        )
    ]
In addition, the following are some additional examples for creating a DateRangeParameterOption object.

​
Using string dates with custom format

This example shows how to specify dates as strings with a custom date format instead of using datetime.date objects. 
po.DateRangeParameterOption(
    default_start_date="01/01/2024",
    default_end_date="12/31/2024",
    min_date="01/01/2020",
    max_date="12/31/2024",
    date_format="%m/%d/%Y"  # US date format
)

​
Setting up cascading parameters with varying date ranges

This example shows how to create date range options that change their constraints based on the selection of a parent parameter (e.g., different fiscal years with different date ranges). 
# Parent parameter for fiscal year
@p.SingleSelectParameter.create_with_options(
    name="fiscal_year", 
    label="Fiscal Year",
    description="Fiscal year for the report"
)
def fiscal_year_options():
    return [
        po.SelectParameterOption(id="fy2023", label="FY 2023"),
        po.SelectParameterOption(id="fy2024", label="FY 2024"),
    ]

# Child date range parameter with ranges that vary by fiscal year
@p.DateRangeParameter.create_with_options(
    name="date_range", 
    label="Date Range",
    description="Date range within the selected fiscal year",
    parent_name="fiscal_year"  # Name of the parent parameter above
)
def date_range_options():
    return [
        po.DateRangeParameterOption(
            default_start_date="2023-01-01",
            default_end_date="2023-12-31",
            min_date="2023-01-01",
            max_date="2023-12-31",
            parent_option_ids="fy2023"  # Only applies when "fy2023" is selected
        ),
        po.DateRangeParameterOption(
            default_start_date="2024-01-01",
            default_end_date="2024-12-31",
            min_date="2024-01-01",
            max_date="2024-12-31",
            parent_option_ids="fy2024"  # Only applies when "fy2024" is selected
        )
    ]

​
Restricting date ranges by user groups

This example shows how to provide different date range constraints based on user access levels using the user_groups parameter. 
@p.DateRangeParameter.create_with_options(
    name="analysis_period", 
    label="Analysis Period",
    description="Period to analyze transactions",
    user_attribute="access_level"
)
def analysis_period_options():
    return [
        po.DateRangeParameterOption(
            default_start_date=date(2025, 1, 1),
            default_end_date=date(2025, 7, 1),
            min_date=date(2025, 1, 1),  # Recent data only
            user_groups=["guest"]  # Guests can only see recent dates
        ),
        po.DateRangeParameterOption(
            default_start_date=date(2024, 1, 1),
            default_end_date=date(2025, 7, 1),
            min_date=date(2020, 1, 1),  # Can see back to 2020
            user_groups=["admin", "member"]  # Members and admins see full history
        )
    ]
If custom user fields are defined in pyconfigs/user.py, then they can be used to restrict date range constraints as well. To do so, the user_attribute argument must be prefixed with custom_fields.. 
@p.DateRangeParameter.create_with_options(
    name="reporting_period", 
    label="Reporting Period",
    description="Period for reporting",
    user_attribute="custom_fields.department"
)
def reporting_period_options():
    return [
        po.DateRangeParameterOption(
            default_start_date=date(2024, 10, 1),
            default_end_date=date(2025, 7, 1),
            min_date=date(2024, 6, 1),  # Recent data only
            user_groups=["sales"]  # Sales team sees only recent dates
        ),
        po.DateRangeParameterOption(
            default_start_date=date(2024, 1, 1),
            default_end_date=date(2025, 7, 1),
            min_date=date(2020, 1, 1),  # Historical data access
            user_groups=["analytics"]  # Analytics team sees full history
        )
    ]