Set public API markers for task and util

Review Request #3520 — Created March 1, 2016 and submitted

molsen
pants
2710, 2992
3752
pants-reviews
benjyw, gmalmquist, jsirois, kwlzn, stuhood, zundel

Set public API markers for task and util

The following modules were reviewed and all api's were left as private. As
far as I can tell these modules are not currently used by plugins.

  • pants.task.changed_file_task_mixin
  • pants.task.changed_target_task
  • pants.task.console_task
  • pants.task.mutex_task_mixin
  • pants.task.noop_exec_task
  • pants.task.scm_publish_mixin
  • pants.task.testrunner_task_mixin
  • pants.util.eval
  • pants.util.fileutil
  • pants.util.meta
  • pants.util.netrc
  • pants.util.objects
  • pants.util.process_handler
  • pants.util.rwbuf
  • pants.util.socket
  • pants.util.strutil
  • pants.util.timeout
  • pants.util.xml_parser

CI pending: https://travis-ci.org/pantsbuild/pants/builds/113022929

MO
MO
NH
  1. Ship It!
  2. 
      
ST
  1. Bunch more to mark in Task probably.

    1. Added public markers for Task.

  2. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

    (and could use a docstring)

  3. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  4. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  5. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  6. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  7. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  8. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  9. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  10. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  11. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  12. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  13. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  14. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  15. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  16. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  17. src/python/pants/task/task.py (Diff revision 1)
     
     

    This one is actually intended for subclassing, so you might want to copy the constructor from TaskBase to here and then mark it public as well?

  18. src/python/pants/task/task.py (Diff revision 1)
     
     

    public

  19. 
      
MO
MO
MO
BE
  1. 
      
  2. src/python/pants/task/task.py (Diff revision 4)
     
     

    Maybe we should take this opportunity (in a separate change) and merge Task and TaskBase? It'll be harder to do post 1.0.

    1. I'll have to take a look and make sure no one is subclassing off TaskBase instead of Task. Seems reasonable though having two classes here doesn't seem justified other than legacy reasons.

  3. src/python/pants/task/task.py (Diff revision 4)
     
     
    
      
  4. 
      
BE
  1. Ship It!
  2. 
      
MO
Review request changed

Status: Closed (submitted)

Change Summary:

commit 2ece0c2f068f83b629855e204969f46fb891022e

Loading...