Skip to content

[bug][jira] jira get_issue_tree_recursive method overwrites default params values from previous executions #1461

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.

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

Merged
merged 39 commits into from
Sep 30, 2024

Conversation

gkowalc
Copy link
Contributor

@gkowalc gkowalc commented Sep 30, 2024

Steps to reproduce

Let's say we have two jira issues:

ISSUE_1  #  has 2  sub issues  
ISSUE_2 # has 4 sub issues
list1= [ISSUE_1, ISSUE2]
jira= Jira(<...>)
for issue in list1:
      print(len(jira.get_issue_tree_recursive))

First iteration will return 2 but the second iteration of the loop with return 6 (including the result from previous execution of the loop).

Rootcause

It is caused by python "gotcha": mutable default arguments - https://docs.python-guide.org/writing/gotchas/#mutable-default-arguments

In the code we have initiation of the tree parameter:
def get_issue_tree_recursive(self, issue_key, tree=[], depth=0)

Each execution of the query will overwrite the tree param. The way to fix it is to:
def get_issue_tree_recursive(self, issue_key, tree=None, depth=None): <...> if tree is None: tree = [] if depth is None: depth = 0 (...)

PR solves this specific bug in the get_issue_tree_recursive method.

gkowalc and others added 30 commits February 3, 2024 21:07
Copy link

codecov bot commented Sep 30, 2024

Codecov Report

Attention: Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 34.41%. Comparing base (9b40bb1) to head (5e0217f).
Report is 9 commits behind head on master.

Files with missing lines Patch % Lines
atlassian/jira.py 12.50% 6 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1461      +/-   ##
==========================================
- Coverage   34.42%   34.41%   -0.02%     
==========================================
  Files          46       46              
  Lines        8627     8631       +4     
  Branches     1611     1610       -1     
==========================================
  Hits         2970     2970              
- Misses       5530     5536       +6     
+ Partials      127      125       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@gonchik gonchik merged commit bdeaf3d into atlassian-api:master Sep 30, 2024
10 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants