Describe Path parameters in docstring.
This commit is contained in:
parent
81782383a9
commit
63251b979b
1 changed files with 19 additions and 4 deletions
|
@ -82,10 +82,25 @@ class Extension:
|
||||||
return '.' + self.ext
|
return '.' + self.ext
|
||||||
|
|
||||||
class Path:
|
class Path:
|
||||||
'''
|
def __init__(
|
||||||
I started to use pathlib.Path, but it was too much of a pain.
|
self,
|
||||||
'''
|
path,
|
||||||
def __init__(self, path, force_sep=None, *, _case_correct=False):
|
force_sep=None,
|
||||||
|
*,
|
||||||
|
_case_correct=False,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
force_sep:
|
||||||
|
Normally, the pathclass will use the default separator for your
|
||||||
|
operating system: / on unix and \ on windows. You can use this
|
||||||
|
argument to force a particular separator.
|
||||||
|
|
||||||
|
_case_correct:
|
||||||
|
True or False. If True, this indicates that the path casing is
|
||||||
|
known in advance to be correct, which means calls to correct_case
|
||||||
|
can be skipped. This is helpful because correct_case can be a
|
||||||
|
source of slowdown.
|
||||||
|
'''
|
||||||
self.force_sep = force_sep
|
self.force_sep = force_sep
|
||||||
self.sep = force_sep or os.sep
|
self.sep = force_sep or os.sep
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue