Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for timeout variable in client settings function get_target_versions #128

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add support for timeout variable in client settings function get_target_versions #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
79c3f9c
Update client_settings.py to include the parameter timeout
SUMMIT-JT Feb 10, 2025
2364d67
Update flashblade client.py to leverage timeout variable
SUMMIT-JT Feb 10, 2025
9ba70a9
Update client_settings.py function get_target_version to leverage tim…
SUMMIT-JT Feb 10, 2025
e5db03c
Update flasharray client.py to leverage timeout variable
SUMMIT-JT Feb 10, 2025
98db554
Update client_settings.py to include a DEFAULT_TIMEOUT
SUMMIT-JT Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion pypureclient/client_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,15 @@ def resolve_ssl_validation(verify_ssl):
return verify_ssl if verify_ssl is not None else False


def get_target_versions(target, target_type, key_to_check, verify_ssl=None):
def get_target_versions(target, target_type, key_to_check, timeout: int, verify_ssl=None):
from ._version import __default_user_agent__
from . import PureError
url = 'https://{target}/api/api_version'.format(target=target)
MAX_TIMEOUT: int = 120
DEFAULT_TIMEOUT: int = 5
response = requests.get(url,
verify=resolve_ssl_validation(verify_ssl),
timeout=min(max(1, int(timeout)), MAX_TIMEOUT) if timeout else DEFAULT_TIMEOUT,
headers={
Headers.user_agent: __default_user_agent__,
Headers.x_request_id: str(uuid.uuid4())}
Expand Down
6 changes: 3 additions & 3 deletions pypureclient/flasharray/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ def Client(target, version=None, id_token=None, private_key_file=None, private_k
Raises:
PureError: If it could not create an ID or access token
"""
array_versions = get_array_versions(target, verify_ssl)
array_versions = get_array_versions(target, timeout, verify_ssl)
if version is not None:
version = validate_version(array_versions, version)
else:
Expand All @@ -116,8 +116,8 @@ def Client(target, version=None, id_token=None, private_key_file=None, private_k
ssl_cert=ssl_cert, user_agent=user_agent, verify_ssl=resolve_ssl_validation(verify_ssl))
return client

def get_array_versions(target, verify_ssl=None):
return get_target_versions(target, 'flasharray', 'version', verify_ssl)
def get_array_versions(target, timeout, verify_ssl=None):
return get_target_versions(target, 'flasharray', 'version', timeout, verify_ssl)

def validate_version(array_versions, version):
if version == MW_DEV_VERSION:
Expand Down
7 changes: 3 additions & 4 deletions pypureclient/flashblade/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@

DEFAULT_RETRIES = 5


def Client(target, version=None, id_token=None, private_key_file=None, private_key_password=None,
username=None, client_id=None, key_id=None, issuer=None, api_token=None,
retries=DEFAULT_RETRIES, timeout=None, ssl_cert=None, user_agent=None,
Expand Down Expand Up @@ -80,7 +79,7 @@ def Client(target, version=None, id_token=None, private_key_file=None, private_k
Raises:
PureError: If it could not create an ID or access token
"""
array_versions = get_array_versions(target, verify_ssl)
array_versions = get_array_versions(target, timeout, verify_ssl)
if version is not None:
validate_version(array_versions, version)
else:
Expand All @@ -93,8 +92,8 @@ def Client(target, version=None, id_token=None, private_key_file=None, private_k
return client


def get_array_versions(target, verify_ssl=None):
return get_target_versions(target, 'flashblade', 'versions', verify_ssl)
def get_array_versions(target, timeout, verify_ssl=None):
return get_target_versions(target, 'flashblade', 'versions', timeout, verify_ssl)


def validate_version(array_versions, version):
Expand Down