From 31a17c4677feb7d5e7d54a1f07b6f64bf5bd08e7 Mon Sep 17 00:00:00 2001 From: jwfraustro <36318163+jwfraustro@users.noreply.github.com> Date: Tue, 12 Dec 2023 11:04:24 -0500 Subject: [PATCH 1/4] Update ShortJobDescription class documentation --- vo_models/uws/models.py | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/vo_models/uws/models.py b/vo_models/uws/models.py index 7cac4e4..8100fb0 100644 --- a/vo_models/uws/models.py +++ b/vo_models/uws/models.py @@ -122,7 +122,23 @@ class Results(BaseXmlModel, tag="results", ns="uws", nsmap=NSMAP): class ShortJobDescription(BaseXmlModel, tag="jobref", ns="uws", nsmap=NSMAP): - """A short description of a job.""" + """A short description of a job. + + Elements: + phase (ExecutionPhase): The execution phase - returned at /{jobs}/{job-id}/phase + run_id (str): A client supplied identifier - the UWS system + does nothing other than to return it as part of the + description of the job + owner_id (str): the owner (creator) of the job - this should be + expressed as a string that can be parsed in accordance + with IVOA security standards. + creation_time (datetime): The instant at which the job was created. + + Attributes: + job_id (str): The identifier for the job. + type (XlinkType): The xlink reference type of the job. + href (str): The link to the job. + """ # pylint: disable = no-self-argument From cb1a4866cc07d32983b36d1cce67472bdefcf6db Mon Sep 17 00:00:00 2001 From: jwfraustro <36318163+jwfraustro@users.noreply.github.com> Date: Tue, 12 Dec 2023 11:05:54 -0500 Subject: [PATCH 2/4] Remove unnecessary pylint disable statements in models.py --- vo_models/uws/models.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/vo_models/uws/models.py b/vo_models/uws/models.py index 8100fb0..68ce14f 100644 --- a/vo_models/uws/models.py +++ b/vo_models/uws/models.py @@ -140,8 +140,6 @@ class ShortJobDescription(BaseXmlModel, tag="jobref", ns="uws", nsmap=NSMAP): href (str): The link to the job. """ - # pylint: disable = no-self-argument - phase: ExecutionPhase = element() run_id: Optional[str] = element(tag="runId", default=None) owner_id: Optional[str] = element(tag="ownerId", default=None, nillable=True) @@ -214,7 +212,6 @@ class JobSummary(BaseXmlModel, Generic[ParametersType], tag="job", ns="uws", nsm It will be formally required in the next major revision. """ - # pylint: disable = no-self-argument # pylint: disable = too-few-public-methods job_id: str = element(tag="jobId") From 1120236aa3daa5d76ed59c7b1a1ce43497161b86 Mon Sep 17 00:00:00 2001 From: jwfraustro <36318163+jwfraustro@users.noreply.github.com> Date: Wed, 13 Dec 2023 20:40:54 -0500 Subject: [PATCH 3/4] bump minor version --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 1f7f9c4..d730507 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "vo-models" -version = "0.2.0" +version = "0.2.1" authors = [ {name = "Joshua Fraustro", email="jfraustro@stsci.edu"}, {name = "MAST Archive Developers", email="archive@stsci.edu"} From e34e364246426a53f62155e49d9a8e0fa668b1c6 Mon Sep 17 00:00:00 2001 From: Joshua Fraustro Date: Thu, 14 Dec 2023 11:03:43 -0500 Subject: [PATCH 4/4] fix package discovery --- pyproject.toml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index d730507..c6f2fb2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,7 +39,3 @@ dev = ["pylint"] [project.urls] Homepage = "https://github.com/spacetelescope/vo-models" Issues = "https://github.com/spacetelescope/vo-models/issues" - -[tool.setuptools] -packages = ["vo_models"] -