Add a function for performing a JSON Merge Patch.

Review Request #9262 — Created Oct. 11, 2017 and submitted

Information
chipx86
Djblets
release-0.10.x
bb5ba55...
Reviewers
djblets 
This introduces djblets.util.json_utils.json_merge_patch, an

implementation of JSON Merge Patch (RFC 7396), which is used to apply a

set of changes to a JSON-compatible data structure. Merge Patches allow

for adding new values (which may be complex JSON objects) to

dictionaries or arrays, remove keys from dictionaries or arrays, or

replace existing values.


This has additional support for access control around keys, preventing

certain keys from being replaced or added, optionally aborting the

patching process if encountered.
Unit tests pass.


Tested manually with several targets and dictionaries.
Description From Last Updated

It seems to me that if something fails halfway through we'll end up with a halfway applied patch. Do we …

 daviddavid

E127 continuation line over-indented for visual indent

 reviewbotreviewbot
chipx86
david
david 
  1. 
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    2. 

















  2. 
 
    
  
  
    
  
 
    
  
    
   
    
    
     
      djblets/util/json_utils.py
      


       (Diff revision 2)


      
     
    
    
       
   
    
     
    

    
     
    

       
  
    
 
    

   
    
    
    



    
 
    
  
    
   
   
    
    
     
     
     
     
     
    
    Show all issues
   
  
    
 
    

    



    
    It seems to me that if something fails halfway through we'll end up with a halfway applied patch. Do we want to change it to operate on a copy of the target and then replace at the very end?
    
  
    
 
    

 
    
  


    
 
    
 
      

  


    1. 
 
 
      
 
      
  
 
      
 
      
  
      It copies each level of the dictionary that's being modified. It doesn't modify the original dictionary.
      
 
      

      2. 



    2. 
 
 
      
 
      
  
 
      
 
      
  
      Going to flesh out the unit tests to check that the original dictionary is untouched.
      
 
      

      3. 


 
    


    

 
    

    3. 




  3. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    4. 




  

 
















 



 

  

   




chipx86




   

   

  

 



 

  


   

   

    
 Review request changed

    
   


  

  

  








 
Change Summary:

 
    

  • Renamed the "target" attribute (and related variables/docs) to "doc", helping make it clear that the target itself isn't being modified.
    • 

  • Updated unit tests to sanity-check that no operations end up modifying the original document.
    • 






 



  

   
Commit:

   
    
-705c1db6cf6ec30decb9688ef53fd6ae07117131
+bb5ba552322a5994605d30cbc634ff6f38f5b35e

   		
  




  

   
Diff:

   
    
 Revision 3 (+366)
Show changes
 
    djblets/util/json_utils.py 
    djblets/util/tests/test_json_utils.py 
 

   		
  



 









 

  
Checks run (1 failed, 1 succeeded)



  

 flake8
 failed.
 





  

 JSHint
 passed.
 





 







 
flake8

 


 















  

 
















 





 

  

   




david




   

   







  

 



 

  


   

   

    
 
david


    
   


  

  

  



    




  1. 
 
    
  
    
   
    Ship It!
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    2. 















  2. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    3. 




  

 
















 



 

  

   




chipx86




   

   

  

 



 

  


   

   

    
 Review request changed

    
   


  

  

  






 

  Status:
  

  Closed (submitted)

  
 




 
Change Summary:

 
Pushed to release-0.10.x (defeb39)





 


 










  

 









     

    

   

  

  

   
   Loading...