Rooba
/
pydu
mirror of https://github.com/flaggo/pydu.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add description for symlink,link and so on

This commit is contained in:
xuzg 2017-12-06 20:28:18 +08:00
parent ba3593cac3
commit 783c0e1913
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/file.rst
View File

@ -10,7 +10,6 @@ File
>>> from pydu.file import makedirs >>> from pydu.file import makedirs
>>> makedirs('test1/test2') >>> makedirs('test1/test2')
>>> makedirs('test1/test2/test3')
>>> makedirs('test1',exist_ok=True) >>> makedirs('test1',exist_ok=True)
>>> makedirs('test1') >>> makedirs('test1')
Traceback (most recent call last): Traceback (most recent call last):
@ -95,6 +94,33 @@ File
test.link -> test.txt test.link -> test.txt
test_copy2.link -> test.txt test_copy2.link -> test.txt
.. py:function:: pydu.file.touch(path):
open a file as write,and then close it.
>>> from pydu.file import touch
>>> touch('test.txt')
.. py:function:: pydu.file.symlink(src, dst, overwrite=False, ignore_errors=False)
`symlink` only work on `Linux/Unix`,it create a symbolic link pointing
to source named link_name.If dist is exist and overwrite is true,a new
symlink will be created.
>>> from pydu.file import symlink
>>> symlink('test.txt','test.link')
.. py:function:: pydu.file.link(src, dst, overwrite=False, ignore_errors=False):
`link` only work on `Linux/Unix`,it create a hard link pointing to
source named link_name.If dist is exist and overwrite is true,a
new symlink will be created.
>>> from pydu.file import link
>>> link('test.txt','test.link')