Update doc8 for new tool support and more reliable output parsing.

 






 

 


  Review Request #11562
  —
  Created March 30, 2021 and submitted  — Latest diff uploaded 

 


















 

  

   Information

  





 
 

  chipx86
 









 
 

  ReviewBot
 









 
 

  release-3.0.x
 









 
 

  
 









 
 

  
 






 




 

  

   Reviewers

  





 
 

  reviewbot
 









 
 

  
 






 








 





  


 
 

  
This updates Doc8Tool to subclass the newer BaseTool, and to use the

newer features it offers (dependencies, improved configurable file

extension handling, centralized base command building, and standardized

error code output).


The new version of the tool has safer report parsing, using a regex

rather than manual string splitting and parsing to match lines. This

simplifies things quite a bit and avoids possible errors, or crashes if

doc8 changes output someday.


Unit tests were added to cover the new doc8 parsing, and to provide

integration tests.

 








  


 
 

  
Unit tests pass on Python 2.7 and 3.x.

 







 









 





  








 




 







   

    
    
Diff Revision 2


This is not the most recent revision of the diff. The latest diff is revision 3. See what's changed.

    

 

 

 

 
orig
1
2
3

 



    


    

      
Commits

      

 

 

  
   First
   Last
  
  Summary
  ID
  Author
 



 
  
   
  
  
   
  
 
 
  
   
    

     Update doc8 for new tool support and more reliable output parsing.
     
This updates `Doc8Tool` to subclass the newer `BaseTool`, and to use the
newer features it offers (dependencies, improved configurable file
extension handling, centralized base command building, and standardized
error code output).

The new version of the tool has safer report parsing, using a regex
rather than manual string splitting and parsing to match lines. This
simplifies things quite a bit and avoids possible errors, or crashes if
doc8 changes output someday.

Unit tests were added to cover the new doc8 parsing, and to provide
integration tests.

    

   
  		
  3c71932cb016c7fc41d26abf242dfd8b70dc31d0
  Christian Hammond
 




    


    
    

   

  

 









 

  

   
    

     
      
      bot/reviewbot/tools/doc8.py
     
    

   
  

 



 

  

   
    

     
      
      bot/reviewbot/tools/tests/test_doc8.py
     
    

   
  

 










     

    

   

  

  

   
   Loading...