Skip to content

depr: deprecate GazeDataFrame in favor of Gaze #1119

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.

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

Draft
wants to merge 26 commits into
base: main
Choose a base branch
from

Conversation

dkrako
Copy link
Contributor

@dkrako dkrako commented Apr 24, 2025

⚠️ Deprecation

DeprecationWarning: GazeDataFrame has been renamed to Gaze in v0.22.0 and will be removed in v0.27.0.

Description

Renames GazeDataFrame to the shorter Gaze. Implements GazeDataFrame as deprecated alias.

The following warnings are printed on instantiation and subclassing:

DeprecationWarning: GazeDataFrame has been renamed to Gaze in v0.22.0 and will be removed in v0.27.0.

Implemented changes

  • rename GazeDataFrame to Gaze
  • implement helper metaclass for deprecating old aliases
  • implement GazeDataFrame as deprecated class alias

How Has This Been Tested?

  • Tested instantiation warnings
  • Tested subclassing warnings

Context

related issues:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Copy link

codecov bot commented Apr 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (232c552) to head (c57dbe2).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1119   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           87        89    +2     
  Lines         3818      3869   +51     
  Branches       679       683    +4     
=========================================
+ Hits          3818      3869   +51     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dkrako dkrako marked this pull request as ready for review April 28, 2025 10:44
@dkrako dkrako requested a review from SiQube as a code owner April 28, 2025 10:44
@dkrako dkrako requested a review from prassepaul as a code owner April 28, 2025 10:44
@dkrako dkrako enabled auto-merge (squash) April 28, 2025 11:29
@SiQube
Copy link
Member

SiQube commented May 19, 2025

please fix merge conflicts -- will check asap afterwards

@dkrako dkrako marked this pull request as draft May 27, 2025 05:27
auto-merge was automatically disabled May 27, 2025 05:27

Pull request was converted to draft

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants