Add framework for typing query arguments to methods.

 






 

 


  Review Request #14339
  —
  Created Feb. 10, 2025 and submitted  — Latest diff uploaded 

 


















 

  

   Information

  





 
 

  david
 









 
 

  RBTools
 









 
 

  master
 









 
 

  
 









 
 

  
 






 




 

  

   Reviewers

  





 
 

  rbtools
 









 
 

  
 






 








 





  


 
 

  
This change adds some machinery for rewriting query argument names so we

can more easily deal with API endpoints that use hyphens in parameters.


A couple new classes have been added for basic parameter lists for GET

operations on item and list resources, that include the built-in request

parameters that are supported for all resources.


I've also added additional TypedDicts for existing resource subclasses

which have special parameters for their GET operations. This makes it so

something like root.get_review_requests(branch=False) will pop up a

warning that the branch parameter must be str.

 








  


 
 

  
    

  • Ran unit tests.
    • 

  • Used a test script to verify that typing was correctly passed through
    
  for methods that take kwargs for query parameters.
    • 


 







 









 





  








 




 







   

    
    
Changes between revision 2 and 3



    

 

 

 

 
orig
1
2
3

 



    


    

      
Commits

      

 

 

  
   
  
  Summary
  ID
  Author
 



 
  
 
 
  
   
    

     Add framework for typing query arguments to methods.
     
This change adds some machinery for rewriting query argument names so we
can more easily deal with API endpoints that use hyphens in parameters.

A couple new classes have been added for basic parameter lists for GET
operations on item and list resources, that include the built-in request
parameters that are supported for all resources.

I've also added additional TypedDicts for existing resource subclasses
which have special parameters for their GET operations. This makes it so
something like `root.get_review_requests(branch=False)` will pop up a
warning that the `branch` parameter must be `str`.

Testing Done:
- Ran unit tests.
- Used a test script to verify that typing was correctly passed through
  for methods that take kwargs for query parameters.

    

   
  		
  d13021e064b3427f1e9cd74d84f6cf9329f2278f
  David Trowbridge
 


 
  
 
 
  
   
    

     Add framework for typing query arguments to methods.
     
This change adds some machinery for rewriting query argument names so we
can more easily deal with API endpoints that use hyphens in parameters.

A couple new classes have been added for basic parameter lists for GET
operations on item and list resources, that include the built-in request
parameters that are supported for all resources.

I've also added additional TypedDicts for existing resource subclasses
which have special parameters for their GET operations. This makes it so
something like `root.get_review_requests(branch=False)` will pop up a
warning that the `branch` parameter must be `str`.

Testing Done:
- Ran unit tests.
- Used a test script to verify that typing was correctly passed through
  for methods that take kwargs for query parameters.

    

   
  		
  ccae3d5a8994a0556186a71f38655124406c67ba
  David Trowbridge
 




    


    
    

   

  

 









 

  

   
    

     
      
      rbtools/api/request.py
     
    

   
  

 



 

  

   
    

     
      
      rbtools/api/resource/base.py
     
    

   
  

 



 

  

   
    

     
      
      rbtools/api/resource/diff_file_attachment.py
     
    

   
  

 



 

  

   
    

     
      
      rbtools/api/resource/file_diff.py
     
    

   
  

 



 

  

   
    

     
      
      rbtools/api/resource/review_request.py
     
    

   
  

 










     

    

   

  

  

   
   Loading...