squirrels 0.5.0rc0__tar.gz → 0.5.1__tar.gz

{squirrels-0.5.0rc0 → squirrels-0.5.1}/.gitignore

@@ -1,7 +1,8 @@
 sandbox*
 playground*
 site/
-.venv/ 
+.venv/
+TODOS.md
 
 # pyenv files
 .python-version

{squirrels-0.5.0rc0 → squirrels-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: squirrels
-Version: 0.5.0rc0
+Version: 0.5.1
 Summary: Squirrels - API Framework for Data Analytics
 Project-URL: Homepage, https://squirrels-analytics.github.io
 Project-URL: Repository, https://github.com/squirrels-analytics/squirrels
@@ -13,26 +13,28 @@ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Python: ~=3.10
+Requires-Dist: authlib<2,>=1.5.2
 Requires-Dist: bcrypt<5,>=4.0.1
-Requires-Dist: cachetools<6,>=5.3.2
-Requires-Dist: duckdb<2,>=1.1.3
+Requires-Dist: cachetools>=5.3.2
+Requires-Dist: duckdb<2,>=1.4.0
 Requires-Dist: fastapi<1,>=0.112.1
 Requires-Dist: gitpython<4,>=3.1.41
 Requires-Dist: inquirer<4,>=3.2.1
+Requires-Dist: itsdangerous<3,>=2.2.0
 Requires-Dist: jinja2<4,>=3.1.3
+Requires-Dist: libpass<2,>=1.9.0
 Requires-Dist: matplotlib<4,>=3.8.3
-Requires-Dist: networkx<4,>=3.2.1
+Requires-Dist: mcp>=1.13.1
 Requires-Dist: pandas<3,>=2.1.4
-Requires-Dist: passlib<2,>=1.7.4
 Requires-Dist: polars<2,>=1.14.0
-Requires-Dist: pyarrow<19,>=18.0.0
+Requires-Dist: pyarrow>=19.0.1
 Requires-Dist: pydantic<3,>=2.8.2
 Requires-Dist: pyjwt<3,>=2.8.0
 Requires-Dist: python-dotenv<2,>=1.0.1
 Requires-Dist: python-multipart<1,>=0.0.9
 Requires-Dist: pyyaml<7,>=6.0.1
 Requires-Dist: sqlalchemy<3,>=2.0.25
-Requires-Dist: sqlglot<26,>=25.32.1
+Requires-Dist: sqlglot>=26.12.1
 Requires-Dist: uvicorn<1,>=0.30.6
 Description-Content-Type: text/markdown
 
@@ -48,22 +50,38 @@ Squirrels is an API framework that lets you create REST APIs for dynamic data an
 
 - [Main Features](#main-features)
 - [License](#license)
-- [Contributing to squirrels](#contributing-to-squirrels)
+- [Contributing to Squirrels](#contributing-to-squirrels)
     - [Setup](#setup)
     - [Testing](#testing)
     - [Project Structure](#project-structure)
 
 ## Main Features
 
-Here are a few of the things that squirrels can do:
+Here are a few of the things that Squirrels can do:
 
 - Connect to any database by specifying its SQLAlchemy url (in `squirrels.yml`) or by using its native connector library in python (in `connections.py`).
 - Configure API routes for datasets (in `squirrels.yml`) without writing code.
 - Configure parameter widgets (types include single-select, multi-select, date, number, etc.) for your datasets (in `parameters.py`).
-- Use Jinja SQL templates (just like dbt!) or python functions (that return a Python dataframe such as polars or pandas) to define dynamic query logic based on parameter selections.
+- Use SQL templates (templated with Jinja, like dbt) or python functions (that return a Python dataframe in polars or pandas) to define dynamic query logic based on parameter selections.
 - Query multiple databases and join the results together in a final view in one API endpoint/dataset!
-- Test your API endpoints with an interactive UI or by a command line that generates rendered sql queries and results (for a given set of parameter selections).
-- Define authentication logic (in `auth.py`) and authorize privacy scope per dataset (in `squirrels.yml`). The user's attributes can even be used in your query logic!
+- Test your API endpoints with Squirrels Studio or by a command line that generates rendered sql queries and results as files (for a given set of parameter selections).
+- Define User model (in `user.py`) and authorize privacy scope per dataset (in `squirrels.yml`). The user's attributes can even be used in your query logic!
+- Serve dataset metadata and results to AI agents via MCP (Model Context Protocol)
+
+## Quick Start
+
+In a new virtual environment, install `squirrels`. Then, in your project directory, activate the virtual environment and run the following commands:
+
+```bash
+sqrl new --use-defaults --curr-dir
+sqrl build
+```
+
+To run the API server, simply run:
+
+```bash
+sqrl run
+```
 
 ## License
 
@@ -71,46 +89,40 @@ Squirrels is released under the Apache 2.0 license.
 
 See the file LICENSE for more details.
 
-## Contributing to squirrels
+## Contributing to Squirrels
 
-The sections below describe how to set up your local environment for squirrels development and run unit tests. A high level overview of the project structure is also provided.
+The sections below describe how to set up your local environment for Squirrels development and run unit tests. A high level overview of the project structure is also provided.
 
 ### Setup
 
-This project requires python version 3.10 or above to be installed. It also uses the python build tool `poetry`. Information on setting up poetry can be found at: https://python-poetry.org/docs/.
+This project requires python version 3.10 or above to be installed. It also uses the python package manager `uv`. Information on setting up poetry can be found at: https://docs.astral.sh/uv/getting-started/installation/.
 
-Then, to install all dependencies, run:
+Then, to install all dependencies in a virtual environment, run:
 
-```
-poetry install
+```bash
+uv sync
 ```
 
-And activate the virtual environment created by poetry with:
+And activate the virtual environment with:
 
-```
-poetry shell
+```bash
+source .venv/bin/activate
 ```
 
-To confirm that the setup worked, run the following to show the help page for all squirrels CLI commands:
+To confirm that the setup worked, run the following to show the help page for all Squirrels CLI commands:
 
 ```bash
 sqrl -h
 ```
 
-You can enter `exit` to exit the virtual environment shell. You can also run `poetry run sqrl -h` to run squirrels commands without activating the virtual environment.
-
 ### Testing
 
-In poetry's virtual environment, run `pytest`.
+Run `uv run pytest`. Or if you have the virtual environment activated, simply run `pytest`.
 
 ### Project Structure
 
 From the root of the git repo, the source code can be found in the `squirrels` folder and unit tests can be found in the `tests` folder.
 
-To understand what a specific squirrels command is doing, start from the `_command_line.py` file as your entry point.
+To understand what a specific Squirrels command is doing, start from the `_command_line.py` file as your entry point.
 
 The library version is maintained in both the `pyproject.toml` and the `squirrels/_version.py` files.
-
-When a user initializes a squirrels project using `sqrl init`, the files are copied from the `squirrels/package_data/base_project` folder. The contents in the `database` subfolder were constructed from the scripts in the `database_elt` folder.
-
-For the Squirrels UI activated by `sqrl run`, the HTML, CSS, and Javascript files can be found in the `static` and `templates` subfolders of `squirrels/package_data`. The CSS and Javascript files are minified and built from the source files in this project: https://github.com/squirrels-analytics/squirrels-testing-ui.

squirrels-0.5.1/README.md

@@ -0,0 +1,88 @@
+# Squirrels
+
+Squirrels is an API framework that lets you create REST APIs for dynamic data analytics!
+
+**Documentation**: <a href="https://squirrels-analytics.github.io/" target="_blank">https://squirrels-analytics.github.io/</a>
+
+**Source Code**: <a href="https://github.com/squirrels-analytics/squirrels" target="_blank">https://github.com/squirrels-analytics/squirrels</a>
+
+## Table of Contents
+
+- [Main Features](#main-features)
+- [License](#license)
+- [Contributing to Squirrels](#contributing-to-squirrels)
+    - [Setup](#setup)
+    - [Testing](#testing)
+    - [Project Structure](#project-structure)
+
+## Main Features
+
+Here are a few of the things that Squirrels can do:
+
+- Connect to any database by specifying its SQLAlchemy url (in `squirrels.yml`) or by using its native connector library in python (in `connections.py`).
+- Configure API routes for datasets (in `squirrels.yml`) without writing code.
+- Configure parameter widgets (types include single-select, multi-select, date, number, etc.) for your datasets (in `parameters.py`).
+- Use SQL templates (templated with Jinja, like dbt) or python functions (that return a Python dataframe in polars or pandas) to define dynamic query logic based on parameter selections.
+- Query multiple databases and join the results together in a final view in one API endpoint/dataset!
+- Test your API endpoints with Squirrels Studio or by a command line that generates rendered sql queries and results as files (for a given set of parameter selections).
+- Define User model (in `user.py`) and authorize privacy scope per dataset (in `squirrels.yml`). The user's attributes can even be used in your query logic!
+- Serve dataset metadata and results to AI agents via MCP (Model Context Protocol)
+
+## Quick Start
+
+In a new virtual environment, install `squirrels`. Then, in your project directory, activate the virtual environment and run the following commands:
+
+```bash
+sqrl new --use-defaults --curr-dir
+sqrl build
+```
+
+To run the API server, simply run:
+
+```bash
+sqrl run
+```
+
+## License
+
+Squirrels is released under the Apache 2.0 license.
+
+See the file LICENSE for more details.
+
+## Contributing to Squirrels
+
+The sections below describe how to set up your local environment for Squirrels development and run unit tests. A high level overview of the project structure is also provided.
+
+### Setup
+
+This project requires python version 3.10 or above to be installed. It also uses the python package manager `uv`. Information on setting up poetry can be found at: https://docs.astral.sh/uv/getting-started/installation/.
+
+Then, to install all dependencies in a virtual environment, run:
+
+```bash
+uv sync
+```
+
+And activate the virtual environment with:
+
+```bash
+source .venv/bin/activate
+```
+
+To confirm that the setup worked, run the following to show the help page for all Squirrels CLI commands:
+
+```bash
+sqrl -h
+```
+
+### Testing
+
+Run `uv run pytest`. Or if you have the virtual environment activated, simply run `pytest`.
+
+### Project Structure
+
+From the root of the git repo, the source code can be found in the `squirrels` folder and unit tests can be found in the `tests` folder.
+
+To understand what a specific Squirrels command is doing, start from the `_command_line.py` file as your entry point.
+
+The library version is maintained in both the `pyproject.toml` and the `squirrels/_version.py` files.

squirrels-0.5.1/dateutils/__init__.py

@@ -0,0 +1,6 @@
+from ._enums import DayOfWeekEnum, MonthEnum
+from ._implementation import (
+    DayIdxOfMonthsCycle, DayIdxOfYear, DayIdxOfQuarter, DayIdxOfMonth, DayIdxOfWeek,
+    OffsetYears, OffsetMonths, OffsetWeeks, OffsetDays,
+    DateModPipeline, DateStringModifier, TimestampModifier
+)

squirrels-0.5.1/dateutils/_enums.py

@@ -0,0 +1,25 @@
+from enum import Enum
+
+
+class DayOfWeekEnum(Enum):
+    Sunday = 0
+    Monday = 1
+    Tuesday = 2
+    Wednesday = 3
+    Thursday = 4
+    Friday = 5
+    Saturday = 6
+
+class MonthEnum(Enum):
+    January = 1
+    February = 2
+    March = 3
+    April = 4
+    May = 5
+    June = 6
+    July = 7
+    August = 8
+    September = 9
+    October = 10
+    November = 11
+    December = 12

squirrels-0.5.0rc0/squirrels/dateutils.py → squirrels-0.5.1/dateutils/_implementation.py

@@ -3,33 +3,8 @@ from dataclasses import dataclass
 from datetime import date as Date, datetime
 from dateutil.relativedelta import relativedelta
 from abc import ABCMeta, abstractmethod
-from enum import Enum
-
-from . import _utils as u
-
-
-class DayOfWeek(Enum):
-    Sunday = 0
-    Monday = 1
-    Tuesday = 2
-    Wednesday = 3
-    Thursday = 4
-    Friday = 5
-    Saturday = 6
-
-class Month(Enum):
-    January = 1
-    February = 2
-    March = 3
-    April = 4
-    May = 5
-    June = 6
-    July = 7
-    August = 8
-    September = 9
-    October = 10
-    November = 11
-    December = 12
+
+from ._enums import DayOfWeekEnum, MonthEnum
 
 
 class DateModifier(metaclass=ABCMeta):
@@ -54,20 +29,21 @@ class DateModifier(metaclass=ABCMeta):
         return datetype(year, month, day)
 
 
-class _DayIdxOfCalendarUnit(DateModifier):
+@dataclass
+class DayIdxOfCalendarUnit(DateModifier):
     """
     Interface for adjusting a date to some day of calendar unit
     """
-    def __init__(self, idx: int) -> None:
-        super().__init__()
-        self.idx = idx
+    idx: int
+
+    def __post_init__(self) -> None:
         if self.idx == 0:
-            raise u.ConfigurationError(f"For constructors of class names that start with DayIdxOf_, idx cannot be zero")
+            raise ValueError(f"For constructors of class names that start with DayIdxOf_, idx cannot be zero")
         self.incr = self.idx - 1 if self.idx > 0 else self.idx
 
 
 @dataclass
-class DayIdxOfMonthsCycle(_DayIdxOfCalendarUnit):
+class DayIdxOfMonthsCycle(DayIdxOfCalendarUnit):
     """
     DateModifier class to get the idx-th day of a cycle of months for an input date
 
@@ -76,23 +52,21 @@ class DayIdxOfMonthsCycle(_DayIdxOfCalendarUnit):
         num_months_in_cycle: 2 for one 6th of year, 3 for Quarter, 4 for one 3rd of year, 6 for half year, 12 for full year. Must fit evenly in 12
         first_month_of_cycle: The first month of months cycle of year. Default is January
     """
-    _num_months_in_cycle: int
-    _first_month_of_cycle: Month
+    num_months_in_cycle: int
+    first_month_of_cycle: MonthEnum = MonthEnum.January
 
-    def __init__(self, idx: int, num_months_in_cycle: int, first_month_of_cycle: Month = Month.January) -> None:
-        super().__init__(idx)
-        self._num_months_in_cycle = num_months_in_cycle
-        self._first_month_of_cycle = first_month_of_cycle
-        if 12 % self._num_months_in_cycle != 0:
-            raise u.ConfigurationError(f"Value X must fit evenly in 12")
-        self.first_month_of_first_cycle = (self._first_month_of_cycle.value - 1) % self._num_months_in_cycle + 1
+    def __post_init__(self) -> None:
+        super().__post_init__()
+        if 12 % self.num_months_in_cycle != 0:
+            raise ValueError(f"Argument 'num_months_in_cycle' must fit evenly in 12")
+        self.first_month_of_first_cycle = (self.first_month_of_cycle.value - 1) % self.num_months_in_cycle + 1
 
     def modify(self, date: Date) -> Date:
-        current_cycle = (date.month - self.first_month_of_first_cycle) % 12 // self._num_months_in_cycle
-        first_month_of_curr_cycle = current_cycle * self._num_months_in_cycle + self.first_month_of_first_cycle
+        current_cycle = (date.month - self.first_month_of_first_cycle) % 12 // self.num_months_in_cycle
+        first_month_of_curr_cycle = current_cycle * self.num_months_in_cycle + self.first_month_of_first_cycle
         year = date.year if date.month >= first_month_of_curr_cycle else date.year - 1
         first_day = self._get_date(type(date), year, first_month_of_curr_cycle, 1)
-        ref_date = first_day if self.idx > 0 else first_day + relativedelta(months=self._num_months_in_cycle)
+        ref_date = first_day if self.idx > 0 else first_day + relativedelta(months=self.num_months_in_cycle)
         return ref_date + relativedelta(days=self.incr)
 
 
@@ -106,7 +80,7 @@ class DayIdxOfYear(DayIdxOfMonthsCycle):
         first_month_of_year: The first month of year. Default is January
     """
 
-    def __init__(self, idx: int, first_month_of_year: Month = Month.January):
+    def __init__(self, idx: int, first_month_of_year: MonthEnum = MonthEnum.January):
         super().__init__(idx, num_months_in_cycle=12, first_month_of_cycle=first_month_of_year)
 
 
@@ -120,12 +94,12 @@ class DayIdxOfQuarter(DayIdxOfMonthsCycle):
         first_month_of_quarter: The first month of first quarter. Default is January
     """
 
-    def __init__(self, idx: int, first_month_of_quarter: Month = Month.January):
+    def __init__(self, idx: int, first_month_of_quarter: MonthEnum = MonthEnum.January):
         super().__init__(idx, num_months_in_cycle=3, first_month_of_cycle=first_month_of_quarter)
 
 
 @dataclass
-class DayIdxOfMonth(_DayIdxOfCalendarUnit):
+class DayIdxOfMonth(DayIdxOfCalendarUnit):
     """
     DateModifier class to get the idx-th day of month of an input date
 
@@ -133,9 +107,6 @@ class DayIdxOfMonth(_DayIdxOfCalendarUnit):
         idx: 1 for first, 2 for second, etc. Or, -1 for last, -2 for second last, etc. Must not be 0
     """
 
-    def __init__(self, idx: int) -> None:
-        super().__init__(idx)
-
     def modify(self, date: Date) -> Date:
         first_day = self._get_date(type(date), date.year, date.month, 1)
         ref_date = first_day if self.idx > 0 else first_day + relativedelta(months=1)
@@ -143,7 +114,7 @@ class DayIdxOfMonth(_DayIdxOfCalendarUnit):
 
 
 @dataclass
-class DayIdxOfWeek(_DayIdxOfCalendarUnit):
+class DayIdxOfWeek(DayIdxOfCalendarUnit):
     """
     DateModifier class to get the idx-th day of week of an input date
 
@@ -151,12 +122,11 @@ class DayIdxOfWeek(_DayIdxOfCalendarUnit):
         idx: 1 for first, 2 for second, etc. Or, -1 for last, -2 for second last, etc. Must not be 0
         first_day_of_week: The day of week identified as the "first". Default is Monday
     """
-    _first_day_of_week: DayOfWeek
+    first_day_of_week: DayOfWeekEnum = DayOfWeekEnum.Monday
 
-    def __init__(self, idx: int, first_day_of_week: DayOfWeek = DayOfWeek.Monday) -> None:
-        super().__init__(idx)
-        self._first_day_of_week = first_day_of_week
-        self.first_dow_num = self._first_day_of_week.value
+    def __post_init__(self) -> None:
+        super().__post_init__()
+        self.first_dow_num = self.first_day_of_week.value
     
     def modify(self, date: Date) -> Date:
         distance_from_first_day = (1 + date.weekday() - self.first_dow_num) % 7
@@ -164,17 +134,16 @@ class DayIdxOfWeek(_DayIdxOfCalendarUnit):
         return date + relativedelta(days=total_incr)
 
 
-class _OffsetUnits(DateModifier):
+@dataclass
+class OffsetUnits(DateModifier):
     """
     Abstract DateModifier class to offset an input date by some number of some calendar unit
     """
-    def __init__(self, offset: int) -> None:
-        super().__init__()
-        self.offset = offset
+    offset: int
 
 
 @dataclass
-class OffsetYears(_OffsetUnits):
+class OffsetYears(OffsetUnits):
     """
     DateModifier class to offset an input date by some number of years
 
@@ -182,15 +151,12 @@ class OffsetYears(_OffsetUnits):
         offset: The number of years to offset the input date.
     """
 
-    def __init__(self, offset: int) -> None:
-        super().__init__(offset)
-
     def modify(self, date: Date) -> Date:
         return date + relativedelta(years=self.offset)
     
 
 @dataclass
-class OffsetMonths(_OffsetUnits):
+class OffsetMonths(OffsetUnits):
     """
     DateModifier class to offset an input date by some number of months
 
@@ -198,15 +164,12 @@ class OffsetMonths(_OffsetUnits):
         offset: The number of months to offset the input date.
     """
 
-    def __init__(self, offset: int) -> None:
-        super().__init__(offset)
-
     def modify(self, date: Date) -> Date:
         return date + relativedelta(months=self.offset)
 
 
 @dataclass
-class OffsetWeeks(_OffsetUnits):
+class OffsetWeeks(OffsetUnits):
     """
     DateModifier class to offset an input date by some number of weeks
 
@@ -214,15 +177,12 @@ class OffsetWeeks(_OffsetUnits):
         offset: The number of weeks to offset the input date.
     """
 
-    def __init__(self, offset: int) -> None:
-        super().__init__(offset)
-
     def modify(self, date: Date) -> Date:
         return date + relativedelta(weeks=self.offset)
 
 
 @dataclass
-class OffsetDays(_OffsetUnits):
+class OffsetDays(OffsetUnits):
     """
     DateModifier class to offset an input date by some number of days
 
@@ -230,9 +190,6 @@ class OffsetDays(_OffsetUnits):
         offset: The number of days to offset the input date.
     """
 
-    def __init__(self, offset: int) -> None:
-        super().__init__(offset)
-
     def modify(self, date: Date) -> Date:
         return date + relativedelta(days=self.offset)
 
@@ -245,14 +202,10 @@ class DateModPipeline(DateModifier):
     Attributes:
         modifiers: The list of DateModifier's to apply in sequence.
     """
-    _date_modifiers: Sequence[DateModifier]
+    date_modifiers: Sequence[DateModifier]
 
-    def __init__(self, date_modifiers: Sequence[DateModifier]) -> None:
-        super().__init__()
-        self._date_modifiers = tuple(date_modifiers)
-    
     def modify(self, date: Date) -> Date:
-        for modifier in self._date_modifiers:
+        for modifier in self.date_modifiers:
             date = modifier.modify(date)
         return date
     
@@ -267,7 +220,7 @@ class DateModPipeline(DateModifier):
         Returns:
             A new sequence of DateModifier
         """
-        joined_modifiers = tuple(self._date_modifiers) + tuple(date_modifiers)
+        joined_modifiers = tuple(self.date_modifiers) + tuple(date_modifiers)
         return joined_modifiers
 
     def with_more_modifiers(self, date_modifiers: Sequence[DateModifier]):
@@ -300,9 +253,9 @@ class DateModPipeline(DateModifier):
         Returns:
             A list of datetime objects
         """
-        assert isinstance(step, _OffsetUnits)
+        assert isinstance(step, OffsetUnits)
         if step.offset == 0:
-            raise u.ConfigurationError(f"The length of 'step' must not be zero")
+            raise ValueError(f"The length of 'step' must not be zero")
         
         output: Sequence[Date] = []
         end_date = self.modify(start_date)
@@ -315,12 +268,15 @@ class DateModPipeline(DateModifier):
         return output
 
 
-class _DateRepresentationModifier(metaclass=ABCMeta):
+@dataclass
+class DateRepresentationModifier(metaclass=ABCMeta):
     """
     Abstract class for modifying other representations of dates (such as string or unix timestemp)
     """
-    def __init__(self, date_modifiers: Sequence[DateModifier]):
-        self.date_modifier = DateModPipeline(date_modifiers)
+    date_modifiers: Sequence[DateModifier]
+
+    def __post_init__(self) -> None:
+        self.date_mod_pipeline = DateModPipeline(self.date_modifiers)
 
     @abstractmethod
     def with_more_modifiers(self, date_modifiers: Sequence[DateModifier]):
@@ -328,7 +284,7 @@ class _DateRepresentationModifier(metaclass=ABCMeta):
 
 
 @dataclass
-class DateStringModifier(_DateRepresentationModifier):
+class DateStringModifier(DateRepresentationModifier):
     """
     Class to modify a string representation of a date given a DateModifier
 
@@ -336,12 +292,7 @@ class DateStringModifier(_DateRepresentationModifier):
         date_modifier: The DateModifier to apply on datetime objects
         date_format: Format of the output date string. Default is '%Y-%m-%d'
     """
-    _date_modifiers: Sequence[DateModifier]
-    _date_format: str
-
-    def __init__(self, date_modifiers: Sequence[DateModifier], date_format: str = '%Y-%m-%d'):
-        super().__init__(date_modifiers)
-        self._date_format = date_format
+    date_format: str = '%Y-%m-%d'
 
     def with_more_modifiers(self, date_modifiers: Sequence[DateModifier]):
         """
@@ -353,11 +304,11 @@ class DateStringModifier(_DateRepresentationModifier):
         Returns:
             A new DateStringModifier
         """
-        joined_modifiers = self.date_modifier.get_joined_modifiers(date_modifiers)
-        return DateStringModifier(joined_modifiers, self._date_format)
+        joined_modifiers = self.date_mod_pipeline.get_joined_modifiers(date_modifiers)
+        return DateStringModifier(joined_modifiers, self.date_format)
     
     def _get_input_date_obj(self, date_str: str, input_format: str | None = None) -> Date:
-        input_format = self._date_format if input_format is None else input_format
+        input_format = self.date_format if input_format is None else input_format
         return datetime.strptime(date_str, input_format).date()
 
     def modify(self, date_str: str, input_format: str | None = None) -> str:
@@ -372,7 +323,7 @@ class DateStringModifier(_DateRepresentationModifier):
             The resulting date string
         """
         date_obj = self._get_input_date_obj(date_str, input_format)
-        return self.date_modifier.modify(date_obj).strftime(self._date_format)
+        return self.date_mod_pipeline.modify(date_obj).strftime(self.date_format)
     
     def get_date_list(self, start_date_str: str, step: DateModifier, input_format: str | None = None) -> Sequence[str]:
         """
@@ -392,14 +343,14 @@ class DateStringModifier(_DateRepresentationModifier):
         Returns:
             A list of date strings
         """
-        assert isinstance(step, _OffsetUnits)
+        assert isinstance(step, OffsetUnits)
         curr_date = self._get_input_date_obj(start_date_str, input_format)
-        output = self.date_modifier.get_date_list(curr_date, step)
-        return [x.strftime(self._date_format) for x in output]
+        output = self.date_mod_pipeline.get_date_list(curr_date, step)
+        return [x.strftime(self.date_format) for x in output]
 
 
 @dataclass
-class TimestampModifier(_DateRepresentationModifier):
+class TimestampModifier(DateRepresentationModifier):
     """
     Class to modify a numeric representation of a date (as Unix/Epoch/POSIX timestamp) given a DateModifier
 
@@ -407,10 +358,6 @@ class TimestampModifier(_DateRepresentationModifier):
         date_modifier: The DateModifier to apply on datetime objects
         date_format: Format of the date string. Default is '%Y-%m-%d'
     """
-    _date_modifiers: Sequence[DateModifier]
-
-    def __init__(self, date_modifiers: Sequence[DateModifier]):
-        super().__init__(date_modifiers)
 
     def with_more_modifiers(self, date_modifiers: Sequence[DateModifier]):
         """
@@ -422,7 +369,7 @@ class TimestampModifier(_DateRepresentationModifier):
         Returns:
             A new TimestampModifier
         """
-        joined_modifiers = self.date_modifier.get_joined_modifiers(date_modifiers)
+        joined_modifiers = self.date_mod_pipeline.get_joined_modifiers(date_modifiers)
         return TimestampModifier(joined_modifiers)
 
     def modify(self, timestamp: float) -> float:
@@ -436,7 +383,7 @@ class TimestampModifier(_DateRepresentationModifier):
             The resulting timestamp
         """
         date_obj = datetime.fromtimestamp(timestamp).date()
-        modified_date = self.date_modifier.modify(date_obj)
+        modified_date = self.date_mod_pipeline.modify(date_obj)
         modified_datetime = datetime.combine(modified_date, datetime.min.time())
         return modified_datetime.timestamp()
     
@@ -458,5 +405,5 @@ class TimestampModifier(_DateRepresentationModifier):
             A list of timestamp as floats
         """
         curr_date = datetime.fromtimestamp(start_timestamp).date()
-        output = self.date_modifier.get_date_list(curr_date, step)
+        output = self.date_mod_pipeline.get_date_list(curr_date, step)
         return [datetime.combine(x, datetime.min.time()).timestamp() for x in output]

squirrels-0.5.1/dateutils/types.py

@@ -0,0 +1,6 @@
+from ._implementation import (
+    DateModifier,
+    DayIdxOfCalendarUnit,
+    OffsetUnits,
+    DateRepresentationModifier
+)