LoginRequest¶
- class wwt_api_client.LoginRequest(client)[source]¶
Bases:
APIRequest
Indicate a client login to the server.
Attributes Summary
The version of the client logging in.
Whether this client is of the "Equinox" release (~2008) or later.
A GUID associated with the user logging in.
Methods Summary
Check whether the parameters of this request are valid.
Generate a
requests.Request
from the current parameters.Attributes Documentation
- client_version = '6.0.0.0'¶
The version of the client logging in.
- equinox_version_or_later = True¶
Whether this client is of the “Equinox” release (~2008) or later.
- user_guid = '00000000-0000-0000-0000-000000000000'¶
A GUID associated with the user logging in. The server doesn’t track these.
Methods Documentation
- invalidity_reason()[source]¶
Check whether the parameters of this request are valid.
- Returns:
- reasonstring or None
If None, indicates that this request is valid. Otherwise, the returned string explains what about the request’ parameters is invalid.
Examples
You can manually check if a request is correctly set up:
>>> from wwt_api_client import Client >>> req = Client().show_image('http://example.com/space.jpg', 'My Image') >>> assert req.invalidity_reason() is None
- make_request()[source]¶
Generate a
requests.Request
from the current parameters.This method returns a
requests.Request
object ready for sending to the API server.- Returns:
- request
requests.Request
object The HTTP request.
- request
Examples
Get the URL that will be accessed for a request:
>>> from urllib.parse import urlparse >>> from wwt_api_client import Client >>> req = Client().show_image('http://example.com/space.jpg', 'My Image') >>> parsed_url = urlparse(req.make_request().prepare().url) >>> print(parsed_url.path) /WWTWeb/ShowImage.aspx