Update wire-protocol.md to have working Python3 code examples #6058
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robhoes
approved these changes
Oct 16, 2024
psafont
approved these changes
Oct 16, 2024
lindig
approved these changes
Oct 16, 2024
| @@ -473,8 +473,17 @@ Import the library `xmlrpclib` and create a | |||
| python object referencing the remote server as shown below: | |||
|
|
|||
| ```python | |||
| >>> import xmlrpclib | |||
| >>> xen = xmlrpclib.Server("https://localhost:443") | |||
| >>> import xmlrpc.client | |||
There was a problem hiding this comment.
Above this is referred to as xmlrpclib and should be updated.
The document was updated in f785993 to use Python 3, however the examples were left unchanged. In Python 3, `xmlrpclib` does not exist, it has been replaced by the `xmlrpc` module (specifically in this case `xmlrpclib.Server` has been replaced by `xmlrpc.client.ServerProxy`). Additionally, the `python-jsonrpc` package has not been ported to Python 3, and as such is unavailable. There is no direct replacement, however a combination of the `jsonrpcclient` package and the `requests` packages provide a reasonable solution. This commit updates the examples appropriately so they function in Python 3. Signed-off-by: Alex Brett <alex.brett@cloud.com>
kc284
reviewed
Oct 16, 2024
| @@ -639,7 +656,7 @@ To retrieve the record of a single object as a python dictionary: | |||
| To retrieve all the VM records in a single call: | |||
|
|
|||
| ```python | |||
| >>> records = client.call("VM.get_all_records", session) | |||
| >>> records = jsonrpccall("VM.get_all_records", (session,)) | |||
| >>> records.keys() | |||
There was a problem hiding this comment.
Arriving a bit too late to this, and not caused by this PR, but the output shown is retrieved with list(records.keys()).
records.keys() shows dict_keys(['OpaqueRef:1', 'OpaqueRef:2', 'OpaqueRef:3', 'OpaqueRef:4' ])
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The document was updated in f785993 to use Python 3, however the examples were left unchanged.
In Python 3,
xmlrpclibdoes not exist, it has been replaced by thexmlrpcmodule (specifically in this casexmlrpclib.Serverhas been replaced byxmlrpc.client.ServerProxy).Additionally, the
python-jsonrpcpackage has not been ported to Python 3, and as such is unavailable. There is no direct replacement, however a combination of thejsonrpcclientpackage and therequestspackages provide a reasonable solution.This commit updates the examples appropriately so they function in Python 3.