[air] Add stacklevel option to deprecation_warning #58357
      
        
          +8
        
        
          −1
        
        
          
        
      
    
  
  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.
  
    
  
    
Currently are deprecation warnings sometimes not informative enough. The the warning is triggered it does not tell us where the deprecated feature is used. For example, ray internally raises a deprecation warning when an
RLModuleConfigis initialized.This is confusing, where did I use a config, what am I doing wrong? This raises issues like: https://discuss.ray.io/t/warning-deprecation-py-50-deprecationwarning-rlmodule-config-rlmoduleconfig-object-has-been-deprecated-use-rlmodule-observation-space-action-space-inference-only-model-config-catalog-class-instead/23064
Tracing where the error actually happens is tedious - is it my code or internal? The output just shows
deprecation.:50. Not helpful.This PR adds a stacklevel option with stacklevel=2 as the default to all
deprecation_warnings. So devs and users can better see where is the deprecated option actually used.