Skip to content

Fix inheritance structure for contexts #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ptomecek merged 4 commits into from
Dec 15, 2025
Merged

Fix inheritance structure for contexts #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6cc476a
Fix inheritance structure for contexts
ptomecek Dec 10, 2025
62d0b54
Refactored context classes to improve naming consistency, enforce inh…
github-actions[bot] Dec 10, 2025
3e72b79
Refactored context classes to improve naming consistency, enforce inh…
github-actions[bot] Dec 12, 2025
97cea7b
Merge branch 'main' into pit/context_inheritance
timkpaine Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
241 changes: 201 additions & 40 deletions ccflow/context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
"""This module defines re-usable contexts for the "Callable Model" framework defined in flow.callable.py."""

import warnings
from datetime import date, datetime
from typing import Generic, Hashable, Optional, Sequence, Set, TypeVar

from deprecated import deprecated
from pydantic import field_validator, model_validator

from .base import ContextBase
from .exttypes import Frequency
from .validators import normalize_date, normalize_datetime

warnings.simplefilter("always", DeprecationWarning)


__all__ = (
"NullContext",
"GenericContext",
"DateContext",
"DatetimeContext",
"EntryTimeContext",
"SeedContext",
"SourceContext",
"DateRangeContext",
"DatetimeRangeContext",
"SeededDateRangeContext",
"SeededDatetimeRangeContext",
"VersionedDateContext",
"VersionedDatetimeContext",
"VersionedDateRangeContext",
"VersionedDatetimeRangeContext",
"SeedDateRangeContext",
"SeedDatetimeRangeContext",
"DateEntryTimeContext",
"DatetimeEntryTimeContext",
"DateRangeEntryTimeContext",
"DatetimeRangeEntryTimeContext",
"FreqContext",
"FreqDateContext",
"FreqDatetimeContext",
Expand All @@ -40,14 +46,14 @@
"UniverseDatetimeContext",
"UniverseDateRangeContext",
"UniverseDatetimeRangeContext",
"UniverseFrequencyDateRangeContext",
"UniverseFrequencyDatetimeRangeContext",
"UniverseFrequencyHorizonDateRangeContext",
"UniverseFrequencyHorizonDatetimeRangeContext",
"VersionedUniverseDateContext",
"VersionedUniverseDatetimeContext",
"VersionedUniverseDateRangeContext",
"VersionedUniverseDatetimeRangeContext",
"UniverseFreqDateRangeContext",
"UniverseFreqDatetimeRangeContext",
"UniverseFreqHorizonDateRangeContext",
"UniverseFreqHorizonDatetimeRangeContext",
"UniverseDateEntryTimeContext",
"UniverseDatetimeEntryTimeContext",
"UniverseDateRangeEntryTimeContext",
"UniverseDatetimeRangeEntryTimeContext",
"ModelContext",
"ModelDateContext",
"ModelDatetimeContext",
Expand All @@ -56,6 +62,26 @@
"ModelDateRangeSourceContext",
"ModelFreqDateRangeContext",
"ModelFreqDatetimeRangeContext",
"ModelDateEntryTimeContext",
"ModelDatetimeEntryTimeContext",
"ModelDateRangeEntryTimeContext",
"ModelDatetimeRangeEntryTimeContext",
# deprecated aliases
"SeededContext",
"SeededDateRangeContext",
"SeededDatetimeRangeContext",
"UniverseFrequencyDateRangeContext",
"UniverseFrequencyDatetimeRangeContext",
"UniverseFrequencyHorizonDateRangeContext",
"UniverseFrequencyHorizonDatetimeRangeContext",
"VersionedDateContext",
"VersionedDatetimeContext",
"VersionedDateRangeContext",
"VersionedDatetimeRangeContext",
"VersionedUniverseDateContext",
"VersionedUniverseDatetimeContext",
"VersionedUniverseDateRangeContext",
"VersionedUniverseDatetimeRangeContext",
"VersionedModelDateContext",
"VersionedModelDatetimeContext",
"VersionedModelDateRangeContext",
Expand Down Expand Up @@ -136,6 +162,10 @@ class EntryTimeContext(ContextBase):
entry_time_cutoff: Optional[datetime] = None


class SeedContext(ContextBase):
seed: int = 1234


class SourceContext(ContextBase):
source: Optional[str] = None

Expand All @@ -162,27 +192,27 @@ class DatetimeRangeContext(ContextBase):
_normalize_end = field_validator("end_datetime", mode="before")(normalize_datetime)


class SeededDateRangeContext(DateRangeContext):
seed: int = 1234
class SeedDateRangeContext(DateRangeContext, SeedContext):
pass


class SeededDatetimeRangeContext(DatetimeRangeContext):
seed: int = 1234
class SeedDatetimeRangeContext(DatetimeRangeContext, SeedContext):
pass


class VersionedDateContext(DateContext, EntryTimeContext):
class DateEntryTimeContext(EntryTimeContext, DateContext):
pass


class VersionedDatetimeContext(DatetimeContext, EntryTimeContext):
class DatetimeEntryTimeContext(EntryTimeContext, DatetimeContext):
pass


class VersionedDateRangeContext(DateRangeContext, EntryTimeContext):
class DateRangeEntryTimeContext(EntryTimeContext, DateRangeContext):
pass


class VersionedDatetimeRangeContext(DatetimeRangeContext, EntryTimeContext):
class DatetimeRangeEntryTimeContext(EntryTimeContext, DatetimeRangeContext):
pass


Expand Down Expand Up @@ -210,23 +240,39 @@ class HorizonContext(ContextBase):
horizon: Frequency


class HorizonDateContext(DateContext, HorizonContext):
pass


class HorizonDatetimeContext(DatetimeContext, HorizonContext):
pass


class HorizonDateRangeContext(DateRangeContext, HorizonContext):
pass


class HorizonDatetimeRangeContext(DatetimeRangeContext, HorizonContext):
pass


class FreqHorizonContext(HorizonContext, FreqContext):
pass


class FreqHorizonDateContext(DateContext, HorizonContext, FreqContext):
class FreqHorizonDateContext(HorizonDateContext, FreqDateContext, FreqHorizonContext):
pass


class FreqHorizonDatetimeContext(DatetimeContext, HorizonContext, FreqContext):
class FreqHorizonDatetimeContext(HorizonDatetimeContext, FreqDatetimeContext, FreqHorizonContext):
pass


class FreqHorizonDateRangeContext(DateRangeContext, HorizonContext, FreqContext):
class FreqHorizonDateRangeContext(HorizonDateRangeContext, FreqDateRangeContext, FreqHorizonContext):
pass


class FreqHorizonDatetimeRangeContext(DatetimeRangeContext, HorizonContext, FreqContext):
class FreqHorizonDatetimeRangeContext(HorizonDatetimeRangeContext, FreqDatetimeRangeContext, FreqHorizonContext):
pass


Expand All @@ -250,35 +296,35 @@ class UniverseDatetimeRangeContext(DatetimeRangeContext, UniverseContext):
pass


class UniverseFrequencyDateRangeContext(DateRangeContext, FreqContext, UniverseContext):
class UniverseFreqDateRangeContext(FreqDateRangeContext, UniverseDateRangeContext):
pass


class UniverseFrequencyDatetimeRangeContext(DatetimeRangeContext, FreqContext, UniverseContext):
class UniverseFreqDatetimeRangeContext(FreqDatetimeRangeContext, UniverseDatetimeRangeContext):
pass


class UniverseFrequencyHorizonDateRangeContext(DateRangeContext, HorizonContext, FreqContext, UniverseContext):
class UniverseFreqHorizonDateRangeContext(FreqHorizonDateRangeContext, UniverseFreqDateRangeContext):
pass


class UniverseFrequencyHorizonDatetimeRangeContext(DatetimeRangeContext, HorizonContext, FreqContext, UniverseContext):
class UniverseFreqHorizonDatetimeRangeContext(UniverseFreqDatetimeRangeContext, FreqHorizonDatetimeRangeContext):
pass


class VersionedUniverseDateContext(VersionedDateContext, UniverseContext):
class UniverseDateEntryTimeContext(DateEntryTimeContext, UniverseDateContext):
pass


class VersionedUniverseDatetimeContext(VersionedDatetimeContext, UniverseContext):
class UniverseDatetimeEntryTimeContext(DatetimeEntryTimeContext, UniverseDatetimeContext):
pass


class VersionedUniverseDateRangeContext(VersionedDateRangeContext, UniverseContext):
class UniverseDateRangeEntryTimeContext(DateRangeEntryTimeContext, UniverseDateRangeContext):
pass


class VersionedUniverseDatetimeRangeContext(VersionedDatetimeRangeContext, UniverseContext):
class UniverseDatetimeRangeEntryTimeContext(DatetimeRangeEntryTimeContext, UniverseDatetimeRangeContext):
pass


Expand Down Expand Up @@ -306,25 +352,140 @@ class ModelDateRangeSourceContext(SourceContext, ModelDateRangeContext):
pass


class ModelFreqDateRangeContext(FreqDateRangeContext, ModelContext):
class ModelFreqDateRangeContext(FreqDateRangeContext, ModelDateRangeContext):
pass


class ModelFreqDatetimeRangeContext(FreqDatetimeRangeContext, ModelDatetimeRangeContext):
pass


class ModelDateEntryTimeContext(DateEntryTimeContext, ModelDateContext):
pass


class ModelDatetimeEntryTimeContext(DatetimeEntryTimeContext, ModelDatetimeContext):
pass


class ModelDateRangeEntryTimeContext(DateRangeEntryTimeContext, ModelDateRangeContext):
pass


class ModelDatetimeRangeEntryTimeContext(DatetimeRangeEntryTimeContext, ModelDatetimeRangeContext):
pass


# TODO - remove later to avoid breaking changes for now
@deprecated(version="0.8.0", reason="Use SeedContext instead")
class SeededContext(SeedContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use SeedDateRangeContext instead")
class SeededDateRangeContext(SeedDateRangeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use SeedDatetimeRangeContext instead")
class SeededDatetimeRangeContext(SeedDatetimeRangeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use UniverseFreqDateRangeContext instead")
class UniverseFrequencyDateRangeContext(UniverseFreqDateRangeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use UniverseFreqDatetimeRangeContext instead")
class UniverseFrequencyDatetimeRangeContext(UniverseFreqDatetimeRangeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use UniverseFreqHorizonDateRangeContext instead")
class UniverseFrequencyHorizonDateRangeContext(UniverseFreqHorizonDateRangeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use UniverseFreqHorizonDatetimeRangeContext instead")
class UniverseFrequencyHorizonDatetimeRangeContext(UniverseFreqHorizonDatetimeRangeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use UniverseDateEntryTimeContext instead")
class VersionedUniverseDateContext(UniverseDateEntryTimeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use UniverseDatetimeEntryTimeContext instead")
class VersionedUniverseDatetimeContext(UniverseDatetimeEntryTimeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use UniverseDateRangeEntryTimeContext instead")
class VersionedUniverseDateRangeContext(UniverseDateRangeEntryTimeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use UniverseDatetimeRangeEntryTimeContext instead")
class VersionedUniverseDatetimeRangeContext(UniverseDatetimeRangeEntryTimeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use ModelDateEntryTimeContext instead")
class VersionedModelDateContext(ModelDateEntryTimeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use ModelDatetimeEntryTimeContext instead")
class VersionedModelDatetimeContext(ModelDatetimeEntryTimeContext):
__deprecated__ = True
pass


@deprecated(version="0.8.0", reason="Use ModelDateRangeEntryTimeContext instead")
class VersionedModelDateRangeContext(ModelDateRangeEntryTimeContext):
__deprecated__ = True
pass


class ModelFreqDatetimeRangeContext(FreqDatetimeRangeContext, ModelContext):
@deprecated(version="0.8.0", reason="Use ModelDatetimeRangeEntryTimeContext instead")
class VersionedModelDatetimeRangeContext(ModelDatetimeRangeEntryTimeContext):
__deprecated__ = True
pass


class VersionedModelDateContext(VersionedDateContext, ModelContext):
@deprecated(version="0.8.0", reason="Use DateEntryTimeContext instead")
class VersionedDateContext(EntryTimeContext, DateContext):
__deprecated__ = True
pass


class VersionedModelDatetimeContext(VersionedDatetimeContext, ModelContext):
@deprecated(version="0.8.0", reason="Use DatetimeEntryTimeContext instead")
class VersionedDatetimeContext(EntryTimeContext, DatetimeContext):
__deprecated__ = True
pass


class VersionedModelDateRangeContext(VersionedDateRangeContext, ModelContext):
@deprecated(version="0.8.0", reason="Use DateRangeEntryTimeContext instead")
class VersionedDateRangeContext(EntryTimeContext, DateRangeContext):
__deprecated__ = True
pass


class VersionedModelDatetimeRangeContext(VersionedDatetimeRangeContext, ModelContext):
@deprecated(version="0.8.0", reason="Use DatetimeRangeEntryTimeContext instead")
class VersionedDatetimeRangeContext(EntryTimeContext, DatetimeRangeContext):
__deprecated__ = True
pass
Loading