PR: Add natural sort for columns

[skjerns]

It sorted columns as strings, so 10.0 was before 1.0 (see #33 )
I've inserted some code snippet from https://stackoverflow.com/questions/21030719/sort-a-pyside-qtgui-qtreewidget-by-an-alpha-numeric-column to implement natural sort on the table elements.

Additionally I've fixed a bug that prevented the 'Profile by Line' button from working (caused by wdir being set to False and the call to self.process.setWorkingDirectory(wdir)). Excuse that I didn't create another PR for this!

[coveralls]

Coverage increased (+1.6%) to 68.75% when pulling 14247cc on skjerns:patch-1 into 8052536 on spyder-ide:master.

[coveralls]

Coverage increased (+2.0%) to 69.656% when pulling 9e39932 on skjerns:patch-1 into b5f5894 on spyder-ide:master.

[coveralls]

Coverage increased (+1.6%) to 68.762% when pulling 14247cc on skjerns:patch-1 into 8052536 on spyder-ide:master.

[ccordoba12]

Thanks for your help with this one.

@jitseniesen, could you review this one? Thanks!

[jitseniesen]

@jitseniesen, could you review this one? Thanks!

Sure.

[skjerns]

@jitseniesen can we merge it?

[jitseniesen]

@skjerns Sorry, I just found your PR again. Are you still interested in having it merged? If so, can you please explain the code for natural_sort_key, because I don't understand it?

[skjerns]

this is some code snippet that I copied from elsewhere on stackoverflow. It is especially for widgets natural sorting.

in a general sense it splits up the lines into tuples and keeps all numbers it finds as floats. Then these tuples can be compared.

e.g.

'34.25%'

will be split up into float('34.25%') and '%', so when comparing (=sorting) them, the 34.25 will be compared by it's numerical value and not by it's string value.

There are certainly easier ways to do it for this usecase, but this is a generalized solution that will also work with other items.

[jitseniesen]

Thanks, I get it now: this allows the same comparison function to be used for the text and numerical columns.

Could you please add the URL where you copied this from in a comment, and ideally add a doc string to TreeWidgetItem and/or natural_sort_function with some explanation?

Additionally I've fixed a bug that prevented the 'Profile by Line' button from working (caused by wdir being set to False and the call to self.process.setWorkingDirectory(wdir)). Excuse that I didn't create another PR for this!

Can you please explain what bug this is and how I can reproduce it? The button seems to work when I tried it and I don't understand the changes you made.

[skjerns]

Thanks, I get it now: this allows the same comparison function to be used for the text and numerical columns.

Could you please add the URL where you copied this from in a comment, and ideally add a doc string to TreeWidgetItem and/or natural_sort_function with some explanation?

done!

Additionally I've fixed a bug that prevented the 'Profile by Line' button from working (caused by wdir being set to False and the call to self.process.setWorkingDirectory(wdir)). Excuse that I didn't create another PR for this!
Can you please explain what bug this is and how I can reproduce it? The button seems to work when I tried it and I don't understand the changes you made.

If you click the button once it works, but the second time it doesn't finish, this is fixed now

[skjerns]

... @jitseniesen can this be merged? one year later?

[jitseniesen]

I am sorry for taking so long. I have been rather busy recently and I rarely if ever use the plugin myself.

I am afraid I cannot reproduce the bug in the current version from git. I did try clicking the "Profile by line" button multiple times. Looking at the code, it is not obvious to me how wdir can be set to False.

Can you explain more fully how to reproduce the bug using the current code, also mentioning what version of spyder and spyder-line-profiler you are using? Perhaps the bug is only present in the release version of spyder-line-profiler?

[skjerns]

It's some time ago, so I'm not 100% sure, but I think the problem was that the QT-function that calls the start() doesn't initiate wdir with None, but calls the function with False, making the function fail. I've added that it treats False the same as None .

I'll test this again and report back, but I'm using the release version from pip indeed.
I've already upgraded to 4.0, so line-profiler isn't working anyway anymore.

[jitseniesen]

Okay, I think I understand it now. Another user contributed commit 08b0a34 in 2018 which (in a different way) fixes the problem that you are describing. However, we have never made a release with this fix in it.

I will split the natural sort commits off and merge them, because they are a nice improvement. Then we will do a release with the 2018 fix, your natural sort, and the necessary changes to make the plugin compatible with Spyder 4.

[skjerns]

great plan! thanks alot! was already wondering about the other changes in the file which weren't by me.

looking forward to using line-profiler in spyder 4.0 :)

[jitseniesen]

As mentioned above, I split the sorting part of this PR in another PR, namely #38. The other part is no longer necessary.

Thanks @skjerns for your contribution and your patience.