Add method to run job and wait for result #229
Conversation
This file contains 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
Renrut5
changed the title
|
@joewesch rebased and updated. |
joewesch
reviewed
Oct 10, 2024
pynautobot/core/endpoint.py
Outdated
Comment on lines
700
to
706
| >>> nb.extras.jobs.run_and_wait( | ||
| class_path="local/data_quality/VerifyHostnames", | ||
| data={"hostname_regex": ".*"}, | ||
| commit=True, | ||
| interval=5, | ||
| max_rechecks=10, | ||
| ) |
There was a problem hiding this comment.
Can you add an example of setting the response to a variable and maybe how they can use the response in a meaningful way (e.g., printing something)?
There was a problem hiding this comment.
@joewesch added some changes, is that what you're looking for?
|
@Renrut5 do you plan on finishing this PR or should we close it? |
…dd-run-job-and-wait-method
joewesch
reviewed
Jan 21, 2025
pynautobot/core/endpoint.py
Outdated
Comment on lines
700
to
707
| >>> job_response = nb.extras.jobs.run_and_wait( | ||
| class_path="local/data_quality/VerifyHostnames", | ||
| data={"hostname_regex": ".*"}, | ||
| commit=True, | ||
| interval=5, | ||
| max_rechecks=10, | ||
| ) | ||
| >>> print(f"Job completed, Job Result ID: {job_response.job_result.id}") |
There was a problem hiding this comment.
This method doesn't seem to return the same object as .run()
In [1]: from pynautobot import api
In [2]: nb = api(url="https://demo.nautobot.com/", token=40*"a")
In [3]: response1 = nb.extras.jobs.run(job_id="d15877c4-dc10-45db-9d70-9405727cfb55")
In [4]: response1.job_result.id
Out[4]: '6875ec6b-39b3-4d22-a174-41f09d00dc3b'
In [5]: response2 = nb.extras.jobs.run_and_wait(job_id="d15877c4-dc10-45db-9d70-9405727cfb55")
In [6]: response2.job_result.id
---------------------------------------------------------------------------
AttributeError Traceback (most recent call last)
Cell In[6], line 1
----> 1 response2.job_result.id
File ~/pynautobot/pynautobot/core/response.py:187, in Record.__getattr__(self, k)
184 if ret or hasattr(self, k):
185 return ret
--> 187 raise AttributeError('object has no attribute "{}"'.format(k))
AttributeError: object has no attribute "job_result"
In [7]: response2.id
Out[7]: '8179b813-6819-4b3c-8caf-e064d7a7c676'There was a problem hiding this comment.
To be clear, I think it should return the same object type, so please fix it to do that.
joewesch
reviewed
Jan 29, 2025
Comment on lines
+714
to
+715
| job_result_id = job_obj.job_result.id | ||
| job_result_url = f"{self.base_url}/extras/job-results/{job_result_id}/" |
There was a problem hiding this comment.
Suggested change
| job_result_id = job_obj.job_result.id | |
| job_result_url = f"{self.base_url}/extras/job-results/{job_result_id}/" | |
| job_result = job_obj.job_result |
Comment on lines
+733
to
+744
| req = Request( | ||
| base=job_result_url, | ||
| token=self.token, | ||
| http_session=self.api.http_session, | ||
| api_version=api_version, | ||
| ).get() | ||
|
|
||
| result = req.get("job_result", {}) | ||
| status = result.get("status", {}).get("value") | ||
|
|
||
| if status not in active_job_statuses: | ||
| return job_obj |
There was a problem hiding this comment.
Suggested change
| req = Request( | |
| base=job_result_url, | |
| token=self.token, | |
| http_session=self.api.http_session, | |
| api_version=api_version, | |
| ).get() | |
| result = req.get("job_result", {}) | |
| status = result.get("status", {}).get("value") | |
| if status not in active_job_statuses: | |
| return job_obj | |
| # Refresh the job result | |
| job_result.full_details() | |
| if job_result.status not in active_job_statuses: | |
| return job_obj |
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.
closes #32