vmware/pyvmomi

pyVmomi should never extend base or core types

Open

#69 opened on Jun 26, 2014

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (2,141 stars) (807 forks)batch import
bughelp wantedhigh priority

Description

This VmomiSupport.py#L179 is considered extremely bad form in the Python community. Extension of core types ties the code to interpreter internals that may not be intended for exposure. This is akin to using a hidden API and should be avoided or at least isolated so that potential damage is easier to control.

Rewrite the code so that the class Link is not needed anymore or so that Link can operate without directly extending a core type.

Contributor guide

Tech stack
python
Domain
backendapi
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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
understanding of Python metaclassesfamiliarity with pyvmomi codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue points to VmomiSupport.py#L179 where the Link class extends a core type (e.g., dict or list). The goal is to refactor the Link class to not extend a core type. Investigate the current usage of Link in the codebase and consider using composition or a wrapper class. Look at how the core type extension is used elsewhere in the code to understand the impact. No comments or linked PRs exist, so the solution is open ended.