Accept pathlib.Path object in Context.cd

[jimm-domingo]

Allow the path parameter to be a pathlib.Path instance as well as a string parameter. As a convenience as pathlib.Path are used more and more for path handling. Thanks.

[bitprophet]

On one hand, I'm not sure how we could go about this without actually depending on pathlib existing. On the other, I do use pathlib or similar libs more often lately myself, and wouldn't be super opposed to using it internally where sensible, which would then open us up to vendoring it & thus enabling this feature.

[brutus]

I just stumbled upon this while investigating a somewhat misleading error message:

$ inv isort
checking import statement order in '/home/brutus/Projekte/LinterTest/src'…
Traceback (most recent call last):
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/config.py", line 97, in __getattr__
    return self._get(key)
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/config.py", line 164, in _get
    value = self._config[key]
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/config.py", line 153, in __getitem__
    return self._get(key)
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/config.py", line 164, in _get
    value = self._config[key]
KeyError: 'cwd'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/brutus/Projekte/LinterTest/.venv/bin/inv", line 11, in <module>
    load_entry_point('invoke==0.20.2', 'console_scripts', 'inv')()
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/program.py", line 294, in run
    self.execute()
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/program.py", line 409, in execute
    executor.execute(*self.tasks)
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/executor.py", line 129, in execute
    result = call.task(*args, **call.kwargs)
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/tasks.py", line 109, in __call__
    result = self.body(*args, **kwargs)
  File "/home/brutus/Projekte/LinterTest/tasks/isort.py", line 31, in check
    ctx.run(cmd)
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/context.py", line 82, in run
    return self._run(runner, command, **kwargs)
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/context.py", line 88, in _run
    command = self._prefix_commands(command)
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/context.py", line 223, in _prefix_commands
    current_directory = self.cwd
  File "/home/brutus/Projekte/LinterTest/.venv/lib/python3.6/site-packages/invoke/config.py", line 109, in __getattr__
    raise AttributeError(err)
AttributeError: No attribute or config key found for 'cwd'

Valid keys: ['isort', 'path', 'run', 'runners', 'sudo', 'tasks']

Valid real attributes: ['cd', 'clear', 'config', 'cwd', 'from_data', 'pop', 'popitem', 'prefix', 'run', 'setdefault', 'sudo', 'update']

I used a Path object instead of a string as argument for ctx.cd. If I cast it to a a string, it works.

So… how about just casting the argument to a string at the start of the method? No need to depend on pathlib for it. Just duck typing ;)

e.g. master...brutus:patch-1

[fndari]

I was also recently bitten by this (I don't remember for sure, but I think not for the first time...), so I prepared a very basic pull request implementing @brutus's suggestion: #583.

[m1keil]

I had the exact same problem. I wonder if there is anything stopping the PR from being merged?

[nateph]

wondering about this as well. would be a great feature to have.

[JnyJny]

The pull request #583 seems to address this problem, any reason to not accept it?

[vxx1]

Path objects are really neat, would be great to use them in invoke's tasks