Casing removed from paths on Windows

[SRFU-NN]

With a file called TEST_capitalization.txt

import pathlib
import pathlib2

print(list(pathlib.Path().glob("TEST_capitalization.txt")))
print(list(pathlib2.Path().glob("TEST_capitalization.txt")))

returns

[WindowsPath('TEST_capitalization.txt')]
[WindowsPath('test_capitalization.txt')]

These two should be identical, right?

It is an issue in https://github.com/mbarkhau/bumpver, where files with capital letters in the path are updated, but not staged and comitted in git.

Environment:
pathlib2 2.3.7.post1
Windows 10 Enterprise, Version 10.0.19044 Build 19044
Python 3.9.4

[SRFU-NN]

This issue seems to be Windows specific.

[mcmtroffaes]

Thanks for the report. Is it possible to test against the develop branch instead of 2.3.7.post1? There's a chance this might have been fixed with #75 (which hasn't made it into a release yet).

[SRFU-NN]

A rough test is

def test_capitalisation():
    filename_list = [
        'test/temp/CAPITALIZED.txt',
        'test/temp/uncapitalized.txt',    
    ]
    for filename in filename_list:
        with open(filename,"w") as f:
            f.write("This is a test file for testing capitalization")
    raw_patterns = {filename: filename for filename in filename_list}
    for unfiltered_pattern in filename_list :
        filtered_pattern = list(pathlib2.Path().glob(filepath_pattern))
        filtered_pattern = filtered_pattern.replace("\\","/")
        assert filtered_pattern == unfiltered_pattern

I have modified it from my suggesting to bumpver without running it, so there might be typos.

Note that this leaves files behind, so it is NOT production ready.

I will see if I get time to run it on main and #75, but the rest of my week is rather busy, so it might only be next week.

[mcmtroffaes]

Thanks for the test; that's very helpful.

On a side note, beware that WindowsPath('TEST.TXT') == WindowsPath('test.txt') as far as Python equalities are concerned. Internally, pathlib2 uses "case folding" (basically, applying str.lower() on the path) within __eq__ and __hash__ to treat paths as case insensitive on Windows. However, just roughly inspecting the code, 2.3.7.post1 may be doing more case folding than strictly necessary, as I see it also appearing in the glob function and some other functions. This may lead to bugs when interfacing with other tools that need to preserve case on Windows. The code on the develop branch is a lot cleaner and appears to do less case folding, so I'm hopeful that will sort it.

[SRFU-NN]

The problem in bumpver also shows that it is only sometimes a problem: The files are found by the version update feature, but not by the git staging feature. So it is finicky, probably due to Windows' ambivalence on whether casing in file paths matter.