-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Expand file tree
/
Copy pathapply_progress.py
More file actions
185 lines (153 loc) · 5.83 KB
/
Copy pathapply_progress.py
File metadata and controls
185 lines (153 loc) · 5.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
"""
Enhanced progress tracking infrastructure for feast apply operations.
This module provides the ApplyProgressContext class that manages positioned,
color-coded progress bars during apply operations with fixed-width formatting
for perfect alignment.
"""
from dataclasses import dataclass
from typing import Optional
from tqdm import tqdm
try:
from feast.diff.progress_utils import (
create_positioned_tqdm,
get_color_for_phase,
is_tty_available,
)
_PROGRESS_UTILS_AVAILABLE = True
except ImportError:
# Graceful fallback when progress_utils is not available (e.g., in tests)
_PROGRESS_UTILS_AVAILABLE = False
def create_positioned_tqdm(
position: int,
description: str,
total: int,
color: str = "blue",
postfix: Optional[str] = None,
) -> Optional[tqdm]:
return None
def get_color_for_phase(phase: str) -> str:
return "blue"
def is_tty_available() -> bool:
return False
@dataclass
class ApplyProgressContext:
"""
Enhanced context object for tracking progress during feast apply operations.
This class manages multiple positioned progress bars with fixed-width formatting:
1. Overall progress (position 0) - tracks main phases
2. Phase progress (position 1) - tracks operations within current phase
Features:
- Fixed-width alignment for perfect visual consistency
- Color-coded progress bars by phase
- Position coordination to prevent overlap
- TTY detection for CI/CD compatibility
"""
# Core tracking state
current_phase: str = ""
overall_progress: Optional[tqdm] = None
phase_progress: Optional[tqdm] = None
# Progress tracking
total_phases: int = 3
completed_phases: int = 0
tty_available: bool = True
# Position allocation
OVERALL_POSITION = 0
PHASE_POSITION = 1
def __post_init__(self):
"""Initialize TTY detection after dataclass creation."""
self.tty_available = _PROGRESS_UTILS_AVAILABLE and is_tty_available()
def start_overall_progress(self):
"""Initialize the overall progress bar for apply phases."""
if not self.tty_available:
return
if self.overall_progress is None:
try:
self.overall_progress = create_positioned_tqdm(
position=self.OVERALL_POSITION,
description="Applying changes",
total=self.total_phases,
color=get_color_for_phase("overall"),
)
except (TypeError, AttributeError):
# Handle case where fallback functions don't work as expected
self.overall_progress = None
def start_phase(self, phase_name: str, operations_count: int = 0):
"""
Start tracking a new phase.
Args:
phase_name: Human-readable name of the phase
operations_count: Number of operations in this phase (0 for unknown)
"""
if not self.tty_available:
return
self.current_phase = phase_name
# Close previous phase progress if exists
if self.phase_progress:
try:
self.phase_progress.close()
except (AttributeError, TypeError):
pass
self.phase_progress = None
# Create new phase progress bar if operations are known
if operations_count > 0:
try:
self.phase_progress = create_positioned_tqdm(
position=self.PHASE_POSITION,
description=phase_name,
total=operations_count,
color=get_color_for_phase(phase_name.lower()),
)
except (TypeError, AttributeError):
# Handle case where fallback functions don't work as expected
self.phase_progress = None
def update_phase_progress(self, description: Optional[str] = None):
"""
Update progress within the current phase.
Args:
description: Optional description of current operation
"""
if not self.tty_available or not self.phase_progress:
return
try:
if description:
# Update postfix with current operation
self.phase_progress.set_postfix_str(description)
self.phase_progress.update(1)
except (AttributeError, TypeError):
# Handle case where phase_progress is None or fallback function returned None
pass
def complete_phase(self):
"""Mark current phase as complete and advance overall progress."""
if not self.tty_available:
return
# Close phase progress
if self.phase_progress:
try:
self.phase_progress.close()
except (AttributeError, TypeError):
pass
self.phase_progress = None
# Update overall progress
if self.overall_progress:
try:
self.overall_progress.update(1)
# Update postfix with phase completion
phase_text = f"({self.completed_phases + 1}/{self.total_phases} phases)"
self.overall_progress.set_postfix_str(phase_text)
except (AttributeError, TypeError):
pass
self.completed_phases += 1
def cleanup(self):
"""Clean up all progress bars. Should be called in finally blocks."""
if self.phase_progress:
try:
self.phase_progress.close()
except (AttributeError, TypeError):
pass
self.phase_progress = None
if self.overall_progress:
try:
self.overall_progress.close()
except (AttributeError, TypeError):
pass
self.overall_progress = None