Object-oriented file system path manipulation

Currently there is partial support for the python 3 surrogate escaping when reading names from the file.system which were not encoded in the declared filesystem encoding in python 2. The problem with this support is that it is unable to encode the file names back to the original bytes in order to take any action on said files/directories. This pull aims to fix that, and allow the same support for these 'invalid' file names on python 2 as we currently have for python 3.

• Bytes round trip from FS -> Path -> FS properly on PY2
• ~~Path objects instantiated with bytes works~~
• Add fs_path property to get path compatible with os methods, use internally when calling os functions
• ~~Add __bytes__ (__str__ on PY2) method to convert to FS bytes (fix #73, although I don't know if there are any cases surrogateescape doesn't handle that will still warn)~~

I'd like to add a classmethod, "config_dir":

@classmethod
def config_dir(cls, app_name):
    """
    Return a path object referencing a suitable config
    directory for the relevant platform. Honors the
    `XDG Base Directory Specification
    <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_
    on Unix and App Data conventions on Windows.
    Ensures that directory exists.
    """

Thoughts?

Pylint doesn't understand that path.py defines the name "path". It does so with the @alias decorator, which is only used once in the file. So there are six extra lines of code to define a decorator which only serves to confuse pylint.

Would you mind getting rid of the decorator and replacing it with path = Path? Then pylint will understand.

Seems there can be an issue creating the warning text when using the walk method in warn mode. I suspect this might only happen on python 2.

  File "/usr/lib64/python2.7/site-packages/flexget/plugins/filter/exists.py", line 44, in on_task_filter
    for p in folder.walk(errors='warn'):
  File "/usr/lib64/python2.7/site-packages/path.py", line 576, in walk
    TreeWalkWarning)
  File "/usr/lib64/python2.7/warnings.py", line 29, in _show_warning
    file.write(formatwarning(message, category, filename, lineno, line))
  File "/usr/lib64/python2.7/warnings.py", line 38, in formatwarning
    s =  "%s:%s: %s: %s\n" % (filename, lineno, category.__name__, message)
UnicodeEncodeError: 'ascii' codec can't encode characters in position 46-60: ordinal not in range(128)

Hello.

I love the concept of path.py, but this is the first time I use it and I am a bit disappointed.

While working with relative paths, I was wondering why Path("test.txt").parent.parent and Path("test.txt").parent return both "" instead of "../somefolder/" and ".".

My use case is very simple. The user gives me some string path where I need to create a file. So, I first need to create the folder where the file will be located.

Path("test.txt").parent.makedirs_p()

This raises a FileNotFoundError because path Path('') does not exist.

By extension, I notice that parent.parent will unfortunately not return a relative path starting with ...

I have the feeling that we miss the opportunity for a very useful feature here.

Do you think this would make sense to implement this?

On Linux/Python 2/path.py 10.3.1 I am trying to walkfiles() a path that contains a file name which is raw bytes. The specific of this path is that it is not in the fs.encoding (which is UTF-8) and therefore cannot be decoded to unicode as-is, unless I guess surrogate escape are used or something else.

With os.walk it works when the top is bytes, but fails if the top is unicode.

With path.py it fails both when using a bytes or unicode top input. You can see the tests here: https://github.com/nexB/scancode-toolkit/pull/723/files#diff-ada144052a705a1e2fc3c96a033cc425R552

And the test failures are visible here:

• https://travis-ci.org/nexB/scancode-toolkit/jobs/264691364#L1786
• https://travis-ci.org/nexB/scancode-toolkit/jobs/264691364#L1907

The time has come for me to step back and limit my involvement in this project. In order to avoid it being abandoned, I'd like to identify a successor to take over maintenance. I'm happy to mentor a new maintainer and contribute incidentally, but a volunteer is needed to maintain the project. I would like to transfer the repository and assign ownership to the path.py project in PyPI. Please express your interest here (preferred) or message me privately if appropriate.

first compile regex for fnmatch then apply the match using the case insensitive re flag.

Honestly.. this may just be a crazy corner case.. I work with satellite imagery and it's nice to be able to match .TIF and .tif and .TiF

Traceback (most recent call last):
  File "./cleanup.py", line 104, in <module>
    for subdir in reversed(list(path(dir).walkdirs())):
  File "/usr/local/lib/python2.7/dist-packages/path.py", line 535, in walkdirs
    dirs = self.dirs()
  File "/usr/local/lib/python2.7/dist-packages/path.py", line 450, in dirs
    return [p for p in self.listdir(pattern) if p.isdir()]
  File "/usr/local/lib/python2.7/dist-packages/path.py", line 437, in listdir
    return [self / child for child in names]
  File "/usr/local/lib/python2.7/dist-packages/path.py", line 201, in __div__
    return self._next_class(self.module.join(self, rel))
  File "/usr/lib/python2.7/posixpath.py", line 69, in join
    path +=  b
  File "/usr/local/lib/python2.7/dist-packages/path.py", line 185, in __add__
    return self._next_class(super(path, self).__add__(more))
UnicodeDecodeError: 'ascii' codec can't decode byte 0xb0 in position 11: ordinal not in range(128)

Py version should not be specified as it's available for py2&3. It causes below pip install error:

$ pip install path.py
Collecting path.py
  Could not find a version that satisfies the requirement path.py (from versions: )
No matching distribution found for path.py

ciao,

i'm thinking about using the path.py-module in a project.

but i found it counter-intuitive and less effective in terms of simplifying my code when i stumpled over the fact that an instance isn't used as src-argument for the functions from shutil like copy etc. i wonder if this is intentional.

if it is not, i would work on patches to achieve that behaviour.

would you be interested in methods that allow merging filetrees from / to another?

With path you can set file permissions with the chmod method, but you can't "get it back" without using the os module.

Example usage:

from path import Path
p = Path('example_file')
p.chmod(0o777)

do_stuff()
...

# how to get the permissions from file p?
import os
permission = os.stat(p).st_mode & 0o777 # permissions = 438
print(f"permissions = {oct(permission)}") # permissions = '0o666'

# possible implementation
permission = p.st_mode() # permissions = 438
permission_oct = p.st_mode(oct_str = True) # permission_oct = '0o666'

I think this would be a nice addition to the project.

Hi,

Could you add a stacklevel of as least 2 in

https://github.com/jaraco/path/blob/6debbcecd357c30b080ea19bf2cfa0e2ab0fcd50/path/init.py#L682

So that the user can know which code call the function. Without a stacklevel of as least 2, it will only show the deprecation warning originating from path/__init__.py.