Add projectstatuses method to get project statuses (missing endpoint) #1267

kayx23 · 2021-12-31T04:04:26Z

Added projectstatuses method for /project/{projectIdOrKey}/statuses

Relevant issue: #723

Atlassian Doc for this REST endpoint:

adehad

Looks good to me ! Will wait a bit too see if @studioj spots anything I've missed.

Thanks !

adehad · 2022-01-03T10:36:44Z

jira/client.py

@@ -2927,6 +2927,19 @@ def statuses(self) -> List[Status]:
        ]
        return statuses

+    def projectstatuses(self, projectIdOrKey: str) -> List[Status]:


(non-blocking)

@studioj what are you thoughts on using the more conventional naming convention here?

e.g.:

Suggested change

def projectstatuses(self, projectIdOrKey: str) -> List[Status]:

def project_statuses(self, projectIdOrKey: str) -> List[Status]:

My only concern is that we don't really conform to this anyway, e.g. statuscategories() below. So perhaps we want to have a separate merge request where we add a deprecation warning to the current non snake_case methods, and also convert them to a wrapper of the snake case ones. Something like:

def projectstatuses(self, projectIdOrKey: str) -> List[Status]: warnings.warn("Please use project_statuses()", DeprecationWarning) return self.project_status(projectIdOrKey) def project_statuses(self, projectIdOrKey: str) -> List[Status]: ...

i would indeed do that in a separate PR, but tbh if we add something new i would suggest making it snake case yes

so this method should be snake case
project_statuses

studioj

cool thank you for your addition.
We do prefer PR's where there is a test added so the functionality can keep on running properly

studioj · 2022-01-15T11:53:58Z

jira/client.py

@@ -2927,6 +2927,19 @@ def statuses(self) -> List[Status]:
        ]
        return statuses

+    def projectstatuses(self, projectIdOrKey: str) -> List[Status]:


i would indeed do that in a separate PR, but tbh if we add something new i would suggest making it snake case yes

studioj · 2022-01-15T11:54:29Z

jira/client.py

@@ -2927,6 +2927,19 @@ def statuses(self) -> List[Status]:
        ]
        return statuses

+    def projectstatuses(self, projectIdOrKey: str) -> List[Status]:


so this method should be snake case
project_statuses

for more information, see https://pre-commit.ci

kayx23 · 2022-01-17T00:04:53Z

Apologize for the back and forth... Please review again. I realized I misunderstood what the endpoint returns when writing the test case. I thought it returns all statuses within a project, but it actually returns issue types with statuses within each issue type. I've made some revisions.

CI test for servers passed... cloud failed because Test Manager setUp failed. Was this expected?

studioj · 2022-01-17T16:30:11Z

CI test for servers passed... cloud failed because Test Manager setUp failed. Was this expected?

seems like this is for all PR's i hope @adehad will have the time to check... i'm not that knowledgeable with the cloud CI part.

seems like an ENV var isn't set. That part has been added pretty recent so maybe it still contains some edge cases

adehad · 2022-01-18T00:41:42Z

Sorry yes regarding the Cloud CI, currently it doesn't play nicely with merge requests from forks (it doesn't pass the credentials properly even though we think we've set all the right settings to allow this!)

@studioj from my perspective if the Server tests pass that is good, then on our end we can raise a PR from a branch within this repo and we should be able to activate this test to run on Cloud with the @allow_on_cloud decorator, and hopefully we should see no problems and can merge it.

studioj · 2022-01-18T00:58:16Z

It's a start😀
Better late than not and of course safety first

adehad · 2022-03-05T23:05:01Z

jira/client.py

+    def project_statuses_by_issue_type(self, projectIdOrKey: str) -> List[IssueType]:
+        """Get a list of issue types available within the project with available statuses within each issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.


Hi @kayx23 !

Sorry I'm just reviewing this again and think this function name and docstring could be clarified.

Technically this function is returning issue types rather than project statuses.

So perhaps the function name should be issue_types_for_project()

I also think the short summary for the function could be made clearer with an example.

Perhaps we can modify this like so:

Suggested change

def project_statuses_by_issue_type(self, projectIdOrKey: str) -> List[IssueType]:

"""Get a list of issue types available within the project with available statuses within each issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.

def issue_types_for_project(self, projectIdOrKey: str) -> List[IssueType]:

"""Get a list of issue types available within the project.

Each project has a set of valid issue types and each issue type has a set of valid statuses.

The valid statuses for a given issue type can be extracted via: `issue_type_x.statuses`

We can then probably also update the docstring of statuses() to point to this function to help people find this use case!

"""Get a list of all status Resources from the server. Refer to :py:meth:`JIRA.issue_types_for_project` for getting statuses for a specific issue type within a specific project.

Good suggestion! This makes a lot of sense. I've added them in.

for more information, see https://pre-commit.ci

Add projectstatuses method and edit statuses method docstring

014480e

kayx23 force-pushed the main branch from 9da6808 to 014480e Compare December 31, 2021 04:29

adehad requested review from adehad and studioj and removed request for adehad January 3, 2022 10:26

adehad added the feature label Jan 3, 2022

adehad linked an issue Jan 3, 2022 that may be closed by this pull request

Get statuses that relates to a specific project #723

Closed

adehad previously approved these changes Jan 3, 2022

View reviewed changes

studioj requested changes Jan 15, 2022

View reviewed changes

kayx23 added 2 commits January 16, 2022 15:00

Change function name to snake case

af92229

Add test for project_statuses

c3a380e

kayx23 dismissed adehad’s stale review via c3a380e January 16, 2022 20:57

pre-commit-ci bot and others added 3 commits January 16, 2022 20:58

[pre-commit.ci] auto fixes from pre-commit.com hooks

2f0c60a

for more information, see https://pre-commit.ci

Fix fstring mistake...

c9c219e

Revise implementation and test

c851886

kayx23 force-pushed the main branch from 946f450 to c851886 Compare January 16, 2022 23:20

adehad requested changes Mar 5, 2022

View reviewed changes

kayx23 and others added 3 commits March 10, 2022 22:33

Merge branch 'pycontribs:main' into main

86ae477

Update function name and docstring per review suggestion

8859e64

[pre-commit.ci] auto fixes from pre-commit.com hooks

4c72326

for more information, see https://pre-commit.ci

kayx23 requested a review from adehad March 11, 2022 04:20

studioj approved these changes Feb 9, 2023

View reviewed changes

adehad enabled auto-merge (squash) February 10, 2023 09:58

adehad disabled auto-merge February 10, 2023 10:16

adehad merged commit d717272 into pycontribs:main Feb 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add projectstatuses method to get project statuses (missing endpoint) #1267

Add projectstatuses method to get project statuses (missing endpoint) #1267

kayx23 commented Dec 31, 2021 •

edited

Loading

adehad left a comment

adehad Jan 3, 2022

studioj Jan 15, 2022

studioj Jan 15, 2022

studioj left a comment

studioj Jan 15, 2022

studioj Jan 15, 2022

kayx23 commented Jan 17, 2022

studioj commented Jan 17, 2022 •

edited

Loading

adehad commented Jan 18, 2022

studioj commented Jan 18, 2022

adehad Mar 5, 2022

kayx23 Mar 11, 2022

	def projectstatuses(self, projectIdOrKey: str) -> List[Status]:
	def project_statuses(self, projectIdOrKey: str) -> List[Status]:

		def project_statuses_by_issue_type(self, projectIdOrKey: str) -> List[IssueType]:
		"""Get a list of issue types available within the project with available statuses within each issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.

-    def project_statuses_by_issue_type(self, projectIdOrKey: str) -> List[IssueType]:
-        """Get a list of issue types available within the project with available statuses within each issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.
+    def issue_types_for_project(self, projectIdOrKey: str) -> List[IssueType]:
+        """Get a list of issue types available within the project.
+         Each project has a set of valid issue types and each issue type has a set of valid statuses.
+         The valid statuses for a given issue type can be extracted via: `issue_type_x.statuses`

Add projectstatuses method to get project statuses (missing endpoint) #1267

Add projectstatuses method to get project statuses (missing endpoint) #1267

Conversation

kayx23 commented Dec 31, 2021 • edited Loading

adehad left a comment

Choose a reason for hiding this comment

adehad Jan 3, 2022

Choose a reason for hiding this comment

studioj Jan 15, 2022

Choose a reason for hiding this comment

studioj Jan 15, 2022

Choose a reason for hiding this comment

studioj left a comment

Choose a reason for hiding this comment

studioj Jan 15, 2022

Choose a reason for hiding this comment

studioj Jan 15, 2022

Choose a reason for hiding this comment

kayx23 commented Jan 17, 2022

studioj commented Jan 17, 2022 • edited Loading

adehad commented Jan 18, 2022

studioj commented Jan 18, 2022

adehad Mar 5, 2022

Choose a reason for hiding this comment

kayx23 Mar 11, 2022

Choose a reason for hiding this comment

kayx23 commented Dec 31, 2021 •

edited

Loading

studioj commented Jan 17, 2022 •

edited

Loading