time_stats TypeError (method vs dict) #2523

walterrowe · 2023-03-21T17:58:16Z

walterrowe
Mar 21, 2023

I have two instances of GitLab. One is the free community edition. One is EE Premiere Edition.

I query gitlab for a list of issues and accumulate total time spent from time_stats.

I am getting different return types for time_stats between the CE and EE editions. On CE it seems to be a method. On EE it seems to be a dict (as documented in the GitLab API).

On the community edition it seems the time_stats returned with the issue is a method that returns a dict.

If I use this code against the CE (free) edition:

    time_stats = this_issue.time_stats['total_time_spent']` and run against the CE edition I get this error

I get this error:

  File "/Users/wrowe/git-repos/python-gitlab/./time-spent.py", line 209, in <module>
    time_stats = this_issue.time_stats['total_time_spent']
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^
TypeError: 'method' object is not subscriptable

I changed my code as follows and tested it against both editions:

    if type(this_issue.time_stats) is dict:
        time_stats = this_issue.time_stats
    else:
        time_stats = this_issue.time_stats()

This works around the issue. Is this expected?

The GitLab API indicates time_stats should be a dict at all times.

https://docs.gitlab.com/ee/api/issues.html

      "time_stats": {
         "time_estimate": 0,
         "total_time_spent": 0,
         "human_time_estimate": null,
         "human_total_time_spent": null
      },

nejch · 2023-03-21T20:33:01Z

nejch
Mar 21, 2023
Maintainer

TLDR: Just use time_stats() in both cases.

@walterrowe this if sort of expected, and comes from the fact that time_stats is both an attribute returned by the API (but only sometimes, as you've found out), as well as its own endpoint under the issues API (https://docs.gitlab.com/ee/api/issues.html#get-time-tracking-stats). This causes a collision.

python-gitlab actually compensates for that with a custom time_stats() method and it will either return the existing attribute or make an extra API call if not present:

python-gitlab/gitlab/mixins.py

Lines 738 to 750 in 9aecc9e

    
           # Use the existing time_stats attribute if it exist, otherwise make an 
        
           # API call 
        
           if "time_stats" in self.attributes: 
        
               time_stats = self.attributes["time_stats"] 
        
               if TYPE_CHECKING: 
        
                   assert isinstance(time_stats, dict) 
        
               return time_stats 
        
           path = f"{self.manager.path}/{self.encoded_id}/time_stats" 
        
           result = self.manager.gitlab.http_get(path, **kwargs) 
        
           if TYPE_CHECKING: 
        
               assert not isinstance(result, requests.Response) 
        
           return result

So just always use this_issue.time_stats() and python-gitlab will know whether it needs to make an extra API call or return the existing data.

3 replies

walterrowe Mar 22, 2023
Author

Oh if only it were that easy ... I did as you suggested. The EE edition reports an error:

Traceback (most recent call last):
  File "time-spent.py", line 222, in <module>
    time_stats = this_issue.time_stats()
                 ^^^^^^^^^^^^^^^^^^^^^^^
TypeError: 'dict' object is not callable

I should note that the issue object comes from a group.issues.list() or project.issues.list(). The group.issues.list includes subgroups.

Do the group list and project list issue objects differ?

I will leave my work around in place. It works.

% pip list
Package            Version
------------------ ---------
certifi            2022.12.7
charset-normalizer 3.1.0
et-xmlfile         1.1.0
idna               3.4
numpy              1.24.2
openpyxl           3.1.2
pandas             1.5.3
pip                23.0.1
Pygments           2.14.0
python-dateutil    2.8.2
python-gitlab      3.13.0
pytz               2022.7.1
PyYAML             6.0
requests           2.28.2
requests-toolbelt  0.10.1
setuptools         67.6.0
six                1.16.0
urllib3            1.26.15
wheel              0.40.0

% python --version
Python 3.11.2

nejch Mar 22, 2023
Maintainer

Oh, I didn't realize you were working with different objects. Yes, in that case best to handle it yourself as you're essentially working with 2 different types of class instances initialized from different endpoints.

See https://python-gitlab.readthedocs.io/en/stable/faq.html#i-cannot-edit-the-merge-request-issue-i-ve-just-retrieved for other similar situations.

walterrowe Mar 23, 2023
Author

@nejch thanks much. that makes sense. my script lets you specify a list of groups or projects and uses the corresponding object issues.list() api. this api library is amazing. so grateful for it.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

time_stats TypeError (method vs dict) #2523

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 1 comment 3 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Select a reply

Uh oh!

time_stats TypeError (method vs dict) #2523

Uh oh!

Uh oh!

walterrowe Mar 21, 2023

Replies: 1 comment · 3 replies

Uh oh!

nejch Mar 21, 2023 Maintainer

Uh oh!

Uh oh!

walterrowe Mar 22, 2023 Author

Uh oh!

nejch Mar 22, 2023 Maintainer

Uh oh!

Uh oh!

walterrowe Mar 23, 2023 Author

walterrowe
Mar 21, 2023

Replies: 1 comment 3 replies

nejch
Mar 21, 2023
Maintainer

walterrowe Mar 22, 2023
Author

nejch Mar 22, 2023
Maintainer

walterrowe Mar 23, 2023
Author