Add DeprecatedFIeld for more informative procedure for deprecating fields of artifacts

[dafnapension]

No description provided.

[codecov]

Codecov Report

Attention: Patch coverage is 91.89189% with 3 lines in your changes are missing coverage. Please review.

❗ No coverage uploaded for pull request base (main@cd5ed5b). Click here to learn what that means.

Files	Patch %	Lines
src/unitxt/dataclass.py	86.66%	2 Missing ⚠️
src/unitxt/dict_utils.py	66.66%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #741   +/-   ##
=======================================
  Coverage        ?   91.13%           
=======================================
  Files           ?       98           
  Lines           ?     9897           
  Branches        ?        0           
=======================================
  Hits            ?     9020           
  Misses          ?      877           
  Partials        ?        0           

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

[elronbandel]

This was quick. While doing the job I have two concerns:

1. Seperation: so far dataclass was an independent module which does not know unitxt. It was done so to avoid circular imports and allow any unitxt module to use dataclass. I rather keep it that way if possible.
2. Self-Contained Logic: Every class in unitxt should be self contained and understood from its definition. That way when someone read the code of class they can understand the way it works. Having the deprecation declared in the settings dis obey this principle.

If we don't find other way, this PR does answer the need for more informed field deprecation process.

My alternative suggestion is to create in the data class a new field type: DeprecatedField which will still be a viable field just produce a warning with a custom message given to the field constructor. That way both my concerns are addressed.

What do you think @dafnapension ?

[dafnapension]

I think that you are right as always, @elronbandel , and I respectfully accept your comment, and will implement!

[dafnapension]

Hi @elronbandel , please see if my implementation gets any close to the elegant solution you had in mind.

[dafnapension]

Hi @elronbandel , please see my implementation per your metadata idea