Prepare 1.0.2 release (#140)

ludovicsteinbach · pyansys-ci-bot · web-flow · commit 3fd08608e602 · 2024-10-03T12:37:58.000+02:00
Co-authored-by: pyansys-ci-bot &lt;92810346+pyansys-ci-bot@users.noreply.github.com&gt;
diff --git a/.github/workflows/server_checks.yml b/.github/workflows/server_checks.yml
@@ -162,12 +162,13 @@ jobs:
     name: Check if there are active workflow runs
     needs: doc-build
     uses: ansys/pygranta/.github/workflows/check-concurrent-workflows.yml@main
+    if: ${{ !cancelled() }}
 
   stop-vm:
     name: "Stop Azure VM"
     runs-on: ubuntu-latest
     needs: check-workflow-runs
-    if: always() && !cancelled() && !(inputs.skip-vm-management) && needs.check-workflow-runs.outputs.active-runs != 'true'
+    if: ${{ !cancelled() && !(inputs.skip-vm-management) && needs.check-workflow-runs.outputs.active-runs != 'true' }}
     steps:
       - uses: azure/CLI@v2
         with:
diff --git a/README.rst b/README.rst
@@ -70,12 +70,16 @@ To install a release compatible with a specific version of Granta MI, install th
 
     pip install pygranta==2024.2.0
 
-Alternatively, to install the latest release from the `PyGranta JobQueue repository <https://github.com/ansys/grantami-jobqueue>`_,
+To see which individual PyGranta package versions are installed with each version of the PyGranta metapackage, consult
+the `Package versions <https://grantami.docs.pyansys.com/version/dev/package_versions.html>`_ section of the PyGranta
+documentation.
+
+Alternatively, to install the latest development version from the `PyGranta JobQueue repository <https://github.com/ansys/grantami-jobqueue>`_,
 run this command:
 
 .. code::
 
-    pip install git:https://github.com/ansys/grantami-jobqueue.git
+    pip install git+https://github.com/ansys/grantami-jobqueue.git
 
 
 To install a local *development* version with Git and Poetry, run these commands:
diff --git a/doc/changelog.d/134.documentation.md b/doc/changelog.d/134.documentation.md
@@ -0,0 +1 @@
+Fix installation example for git dependency
diff --git a/doc/changelog.d/135.documentation.md b/doc/changelog.d/135.documentation.md
@@ -0,0 +1 @@
+Add link to supported authentication schemes
diff --git a/doc/changelog.d/136.documentation.md b/doc/changelog.d/136.documentation.md
@@ -0,0 +1 @@
+Add link to PyGranta version compatibility documentation
diff --git a/doc/changelog.d/137.maintenance.md b/doc/changelog.d/137.maintenance.md
@@ -0,0 +1 @@
+Improve VM management in CI
diff --git a/doc/changelog.d/139.fixed.md b/doc/changelog.d/139.fixed.md
@@ -0,0 +1 @@
+Handle lack of job specific outputs
diff --git a/doc/changelog.d/140.fixed.md b/doc/changelog.d/140.fixed.md
@@ -0,0 +1 @@
+Prepare 1.0.2 release
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -52,8 +52,12 @@
     "nbsphinx",
     "sphinx_design",
     "enum_tools.autoenum",
+    "sphinx.ext.extlinks",
 ]
 
+extlinks = {
+    "OpenAPI-Common": ("https://openapi.docs.pyansys.com/version/stable/%s", None),
+}
 
 # numpydoc configuration
 numpydoc_show_class_members = False
diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst
@@ -31,6 +31,8 @@ To verify that you can start the PyGranta JobQueue client from Python, run this
 
     <JobQueueApiClient url: http://my.server.name/mi_servicelayer>
 
+This example uses Windows-based autologon authentication. For all supported authentication schemes, see the :OpenAPI-Common:`OpenAPI-Common documentation <index.html#authentication-schemes>`.
+
 If you see a response from the server, you have successfully installed PyGranta JobQueue and
 can start using the JobQueue client. For more examples, see :ref:`ref_grantami_jobqueue_examples`.
 For comprehensive information on the API, see :ref:`ref_grantami_jobqueue_api_reference`.
diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt
@@ -8,3 +8,4 @@ jupytext
 AsyncJob
 AsyncJobs
 mypy
+autologon
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 # Check https://python-poetry.org/docs/pyproject/ for all available sections
 name = "ansys-grantami-jobqueue"
-version = "1.0.1"
+version = "1.0.2"
 description = "A python wrapper for the Granta MI Job Queue API"
 license = "MIT"
 authors = ["ANSYS, Inc. <pyansys.core@ansys.com>"]
diff --git a/src/ansys/grantami/jobqueue/_models.py b/src/ansys/grantami/jobqueue/_models.py
@@ -1173,7 +1173,7 @@ def update_scheduled_execution_date_time(self, value: datetime.datetime) -> None
         )
 
     @property
-    def output_information(self) -> Dict[str, Any]:
+    def output_information(self) -> Optional[Dict[str, Any]]:
         """
         Additional output information provided by the job (if supported by the job type).
 
@@ -1183,11 +1183,13 @@ def output_information(self) -> Dict[str, Any]:
 
         Returns
         -------
-        dict
+        dict or None
             Additional output information provided by the job.
         """
+        if self._job_specific_outputs is None:
+            return None
         parsed = {}
-        for k, v in self._job_specific_outputs.items():  # type: ignore[union-attr]
+        for k, v in self._job_specific_outputs.items():
             assert isinstance(v, str)
             parsed[k] = json.loads(v)
         return parsed
@@ -1353,6 +1355,7 @@ def status(self) -> JobStatus:
         status = super().status
         if (
             status == JobStatus.Succeeded
+            and self.output_information is not None
             and self.output_information["summary"]["FinishedSuccessfully"] is False
         ):
             return JobStatus.Failed
diff --git a/tests/test_asyncjob.py b/tests/test_asyncjob.py
@@ -246,3 +246,10 @@ def test_failed_success_status(self, importjob_failure_success_status):
 
     def test_failed_failed_status(self, importjob_failure_failed_status):
         assert importjob_failure_failed_status.status == JobStatus.Failed
+
+
+@pytest.mark.parametrize("job_specific_outputs", [None, Unset])
+def test_job_with_no_output(job_model, job_specific_outputs):
+    job_model.job_specific_outputs = job_specific_outputs
+    async_job = AsyncJob(job_model, api.JobQueueApi(Mock()))
+    assert async_job.output_information is None

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Fix installation example for git dependency`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Add link to supported authentication schemes`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Add link to PyGranta version compatibility documentation`