ENH: Add include_groups parameter to handle deprecated groupby.apply behavior

[hainaweiben]

What do these changes do?

• Add include_groups field to GroupByApply class
• Update groupby_apply function signature and documentation
• Modify execute method to handle the new parameter

Related issue number

Fixes #xxxx

Check code requirements

• tests added / passed (if needed)
• Ensure all linting tests pass

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.54%. Comparing base (081d5f9) to head (1257663).

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #841       +/-   ##
===========================================
+ Coverage   69.29%   81.54%   +12.24%     
===========================================
  Files        1071     1071               
  Lines       80149    80153        +4     
  Branches    12201    12202        +1     
===========================================
+ Hits        55537    65358     +9821     
+ Misses      22649    13256     -9393     
+ Partials     1963     1539      -424     

Flag	Coverage Δ
unittests	81.43% <ø> (+12.26%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[hainaweiben]

Changes were made referencing Deprecation Warning with groupby.apply.

It's important to note that the groupby parameter include_groups is slated for deprecation:

Deprecated since version 2.2.0: Setting include_groups to True is deprecated. Only the value False will be allowed in a future version of pandas.

Please take this into account during review, and we may need to plan further updates to accommodate future versions of pandas.