fix dictionary keys changed during iteration error seen in utils when using py3.8 #877

elinnore · 2019-11-25T22:59:34Z

noticed this error when trying to upload a file in jira while using python 3.8 on MacOS 10.14.6:

Python 3.8.0 (default, Nov 25 2019, 19:38:49) 
[Clang 10.0.1 (clang-1001.0.46.4)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from jira import JIRA
>>> jira = JIRA(server='http://localhost:8080', basic_auth=('myuser', 'mypass'))
>>> attached = jira.add_attachment(issue='CSTREQ-1', attachment='file_with_text.log')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/myuser/.pyenv/versions/venv/lib/python3.8/site-packages/jira/client.py", line 126, in wrapper
    result = func(*arg_list, **kwargs)
  File "/Users/myuser/.pyenv/versions/venv/lib/python3.8/site-packages/jira/client.py", line 787, in add_attachment
    url, data=m, headers=CaseInsensitiveDict({'content-type': m.content_type, 'X-Atlassian-Token': 'nocheck'}), retry_data=file_stream)
  File "/Users/myuser/.pyenv/versions/venv/lib/python3.8/site-packages/jira/utils/__init__.py", line 41, in __init__
    for key, value in super(CaseInsensitiveDict, self).items():
RuntimeError: dictionary keys changed during iteration

Tested the fix below and there seems to not be any issues. File uploaded fine, no other errors:

>>> attached = jira.add_attachment(issue='CSTREQ-1', attachment='file_with_text.log')
>>> attached
<JIRA Attachment: filename='file_with_text.log', id='10000', mimeType='text/plain'>

…itiveDict class in py3.8

lan17 · 2019-11-25T23:09:33Z

jira/utils/__init__.py

-            if key != key.lower():
-                self[key.lower()] = value
-                self.pop(key, None)
+#        self.itemlist = {}


Do not leave commented out code. Remove it if it's no longer necessary.

lan17 · 2019-11-25T23:11:46Z

jira/utils/__init__.py


        # self.itemlist[key.lower()] = value
+        itemlist = {}
+        for key, value in super(CaseInsensitiveDict, self).items():
+            itemlist[key.lower()] = value


Why not use a list of keys to remove and remove them in subsequent for loop?

thank you. Yes, that would be clearer actually and appears to work fine too:

def __init__(self, *args, **kw): super(CaseInsensitiveDict, self).__init__(*args, **kw) upper_keys_list = [] for key in super(CaseInsensitiveDict, self).keys(): if key != key.lower(): upper_keys_list.append(key) for upper_key in upper_keys_list: self[upper_key.lower()] = self[upper_key] self.pop(upper_key, None)

lan17

LGTM to me, but I don't have write access 😢

stale · 2019-12-26T18:52:43Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

yhuskov · 2020-01-17T17:24:12Z

Can this pull request be reopened? The bug prevents using the add_attachment method with Python 3.8.

keyroii · 2020-05-05T08:03:00Z

add_attachment method still not working in python 3.8 as of may.

dbaxa · 2020-05-06T22:45:45Z

cc @ssbarnea (this seems like a candidate for review & merge).

ackris · 2020-05-07T11:43:38Z

It is still not working. Please find my comment on Issue . Please do a review and release a working candidate

olologin · 2020-06-03T07:01:11Z

Oh come on, is it so hard to merge this? It still fails on latest master.

dbaxa · 2020-06-03T23:13:33Z

@ssbarnea Can we merge this :-) ?

AnatoliiSliusarievSecurrency · 2020-06-18T13:10:06Z

Can this be merged? It's really a blocker

wesinator · 2020-06-25T15:09:18Z

seems the issue was already fixed in #895 , just hasn't been released

dvaerum · 2020-07-29T14:59:13Z

seems the issue was already fixed in #895 , just hasn't been released

Can we please have a release when? 🥺 I mean it have been 1/2 year

wesinator · 2020-07-31T17:50:40Z

seems the issue was already fixed in #895 , just hasn't been released

Can we please have a release when? 🥺 I mean it have been 1/2 year

https://github.com/pycontribs/jira/releases/tag/3.0

CyberTraitsProject · 2020-08-23T08:34:51Z

we need this change, Why not work on it and release the change?
PLEASE

russoz · 2020-08-23T09:20:18Z

Do you want to help? The project 's CI has broken and folks need a hand. That would be a more positive way to collaborate on a volunteer-basis project, instead of thumping your feet making demands.

sdanelli · 2020-09-02T21:17:53Z

@russoz I think we can help as we are also affected, do you have the details on what is broken to ship this fix?

russoz · 2020-09-05T08:51:24Z

@sdanelli I am not a maintainer of the project, but issue #896 is pinned on the Issues tab - the project maintainers are asking for help.

jd-ssg · 2020-11-20T09:20:42Z

Could we merge this fix, please ?

adehad · 2021-06-26T16:43:35Z

No idea if people are still following this, but I've made a PR for the move to requests.structures.CaseInsensitiveDict #1084 which I think also addresses this, I've added a test in which suggests it does, but the test also passes before the change so would be great to confirm with others.

fix dictionary keys changed during iteration error seen in CaseInsens…

d02cbe1

…itiveDict class in py3.8

lan17 suggested changes Nov 25, 2019

View reviewed changes

lan17 approved these changes Nov 26, 2019

View reviewed changes

create separate list of upper keys to remove from dict

9caed80

stale bot added the stale Ticket that is likely to go nowhere and that will be closed soon label Dec 26, 2019

stale bot closed this Jan 9, 2020

dbaxa reopened this Jun 3, 2020

dbabbitt approved these changes Jul 1, 2020

View reviewed changes

ssbarnea closed this Jul 29, 2020

adehad mentioned this pull request Jun 26, 2021

use requests.structures.CaseInsensitiveDict directly #1084

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix dictionary keys changed during iteration error seen in utils when using py3.8 #877

fix dictionary keys changed during iteration error seen in utils when using py3.8 #877

elinnore commented Nov 25, 2019

lan17 Nov 25, 2019

lan17 Nov 25, 2019

elinnore Nov 26, 2019

lan17 left a comment

stale bot commented Dec 26, 2019

yhuskov commented Jan 17, 2020

keyroii commented May 5, 2020

dbaxa commented May 6, 2020

ackris commented May 7, 2020

olologin commented Jun 3, 2020

dbaxa commented Jun 3, 2020

AnatoliiSliusarievSecurrency commented Jun 18, 2020

wesinator commented Jun 25, 2020

dvaerum commented Jul 29, 2020

wesinator commented Jul 31, 2020

CyberTraitsProject commented Aug 23, 2020

russoz commented Aug 23, 2020

sdanelli commented Sep 2, 2020

russoz commented Sep 5, 2020

jd-ssg commented Nov 20, 2020

adehad commented Jun 26, 2021

fix dictionary keys changed during iteration error seen in utils when using py3.8 #877

fix dictionary keys changed during iteration error seen in utils when using py3.8 #877

Conversation

elinnore commented Nov 25, 2019

lan17 Nov 25, 2019

Choose a reason for hiding this comment

lan17 Nov 25, 2019

Choose a reason for hiding this comment

elinnore Nov 26, 2019

Choose a reason for hiding this comment

lan17 left a comment

Choose a reason for hiding this comment

stale bot commented Dec 26, 2019

yhuskov commented Jan 17, 2020

keyroii commented May 5, 2020

dbaxa commented May 6, 2020

ackris commented May 7, 2020

olologin commented Jun 3, 2020

dbaxa commented Jun 3, 2020

AnatoliiSliusarievSecurrency commented Jun 18, 2020

wesinator commented Jun 25, 2020

dvaerum commented Jul 29, 2020

wesinator commented Jul 31, 2020

CyberTraitsProject commented Aug 23, 2020

russoz commented Aug 23, 2020

sdanelli commented Sep 2, 2020

russoz commented Sep 5, 2020

jd-ssg commented Nov 20, 2020

adehad commented Jun 26, 2021