Add type annotations to metrics.py#99
Open
arpitjain099 wants to merge 1 commit into
Open
Conversation
Annotate all 18 functions (plus the Quantile helper class) with parameter and return types. Uses `from __future__ import annotations` for native Python 3.12+ syntax (tuple, list, X | None). Also adds `Iterator` from collections.abc for the _split_interval_by_hour generator. Functions covered: get_obs_periods, clip_events_to_time_period, get_noise_events, _split_events, _time_binned_df, _agg_conf_intervals, get_all_geo_stats, calculate_spatial_stats, clip_srcid_to_time_period, get_all_srcid_stats, _split_interval_by_hour, plot_events, circular_sliding_avg, find_circular_peaks, endpoints_around_active, identify_stereotypical_tracks. Signed-off-by: arpitjain099 <arpitjain099@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds type annotations to all 18 functions (and the Quantile helper class)
in metrics.py, which previously had zero annotation coverage. Uses
from __future__ import annotationsfor native 3.12+ syntax.Changes:
get_obs_periods, clip_events_to_time_period, get_noise_events,
get_all_geo_stats, calculate_spatial_stats, clip_srcid_to_time_period,
get_all_srcid_stats, plot_events, circular_sliding_avg,
find_circular_peaks, endpoints_around_active, identify_stereotypical_tracks
_agg_conf_intervals, _split_interval_by_hour
Iteratorimport from collections.abc for the generator functionSimilar in style to #98 (computation.py) and #91 (layered_active_space.py).
No runtime behavior changes.