vmware/pyvmomi

pyVmomi should never use 'print'

Open

#68 opened on Jun 26, 2014

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (2,141 stars) (807 forks)batch import
enhancementhelp wantedwishlist

Description

https://docs.python.org/2/library/warnings.html

pyVmomi is a deep level library and it should avoid making use of logging or printing features directly which are application elements we should leave 100% in control of the end application developer.

To close this issue:

  • remove all use of 'print'
  • introduce use of warnings to replace 'print'
  • introduce verbose logging of SOAP messages

Contributor guide

Tech stack
python
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Pythonfamiliarity with warnings module
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Find all occurrences of 'print' in the pyVmomi codebase using grep or similar tools. Replace them with Python's warnings module for deprecation messages and introduce Python's logging module for verbose SOAP logging. The documentation link provided (https://docs.python.org/2/library/warnings.html) shows how to use warnings. Ensure no console output is left for library users.