Getting started¶

Modules¶

In [1]:

import os
from pyfileindex import PyFileIndex

User defined functions¶

In [2]:

def touch(fname, times=None):
    with open(fname, "a"):
        os.utime(fname, times)

In [3]:

def filter_function(file_name):
    return ".txt" in file_name

Demonstrate PyFileIndex¶

Initialise PyFileIndex¶

In [4]:

pfi = PyFileIndex(path=".", filter_function=filter_function, debug=True)
pfi

Out[4]:

	basename	path	dirname	is_directory	mtime	nlink
0	notebooks	/home/jovyan/notebooks	/home/jovyan	True	1.563533e+09	1
1	.ipynb_checkpoints	/home/jovyan/notebooks/.ipynb_checkpoints	/home/jovyan/notebooks	True	1.563532e+09	2

Update PyFileIndex¶

In [5]:

pfi.update()
pfi

Changes:  [] [] []

Out[5]:

	basename	path	dirname	is_directory	mtime	nlink
0	notebooks	/home/jovyan/notebooks	/home/jovyan	True	1.563533e+09	1
1	.ipynb_checkpoints	/home/jovyan/notebooks/.ipynb_checkpoints	/home/jovyan/notebooks	True	1.563532e+09	2

New directory¶

In [6]:

os.makedirs("bla")

In [7]:

pfi.update()
pfi

Changes:  ['/home/jovyan/notebooks/bla'] ['/home/jovyan/notebooks'] []

Out[7]:

	basename	path	dirname	is_directory	mtime	nlink
0	.ipynb_checkpoints	/home/jovyan/notebooks/.ipynb_checkpoints	/home/jovyan/notebooks	True	1.563532e+09	2
1	notebooks	/home/jovyan/notebooks	/home/jovyan	True	1.563533e+09	1
2	bla	/home/jovyan/notebooks/bla	/home/jovyan/notebooks	True	1.563533e+09	2

New sub directory¶

In [8]:

os.makedirs("bla/bla")

In [9]:

pfi.update()
pfi

Changes:  ['/home/jovyan/notebooks/bla/bla'] ['/home/jovyan/notebooks/bla'] []

Out[9]:

	basename	path	dirname	is_directory	mtime	nlink
0	.ipynb_checkpoints	/home/jovyan/notebooks/.ipynb_checkpoints	/home/jovyan/notebooks	True	1.563532e+09	2
1	notebooks	/home/jovyan/notebooks	/home/jovyan	True	1.563533e+09	1
2	bla	/home/jovyan/notebooks/bla	/home/jovyan/notebooks	True	1.563533e+09	3
3	bla	/home/jovyan/notebooks/bla/bla	/home/jovyan/notebooks/bla	True	1.563533e+09	2

New file¶

In [10]:

touch("bla/bla/test.txt")

In [11]:

pfi.update()
pfi

Changes:  ['/home/jovyan/notebooks/bla/bla/test.txt'] ['/home/jovyan/notebooks/bla/bla'] []

Out[11]:

	basename	path	dirname	is_directory	mtime	nlink
0	.ipynb_checkpoints	/home/jovyan/notebooks/.ipynb_checkpoints	/home/jovyan/notebooks	True	1.563532e+09	2
1	notebooks	/home/jovyan/notebooks	/home/jovyan	True	1.563533e+09	1
2	bla	/home/jovyan/notebooks/bla	/home/jovyan/notebooks	True	1.563533e+09	3
3	bla	/home/jovyan/notebooks/bla/bla	/home/jovyan/notebooks/bla	True	1.563533e+09	2
4	test.txt	/home/jovyan/notebooks/bla/bla/test.txt	/home/jovyan/notebooks/bla/bla	False	1.563533e+09	1

Another new file¶

In [12]:

touch("bla/test.txt")

In [13]:

pfi.update()
pfi

Changes:  ['/home/jovyan/notebooks/bla/test.txt'] ['/home/jovyan/notebooks/bla'] []

Out[13]:

	basename	path	dirname	is_directory	mtime	nlink
0	.ipynb_checkpoints	/home/jovyan/notebooks/.ipynb_checkpoints	/home/jovyan/notebooks	True	1.563532e+09	2
1	notebooks	/home/jovyan/notebooks	/home/jovyan	True	1.563533e+09	1
2	bla	/home/jovyan/notebooks/bla/bla	/home/jovyan/notebooks/bla	True	1.563533e+09	2
3	test.txt	/home/jovyan/notebooks/bla/bla/test.txt	/home/jovyan/notebooks/bla/bla	False	1.563533e+09	1
4	bla	/home/jovyan/notebooks/bla	/home/jovyan/notebooks	True	1.563533e+09	3
5	test.txt	/home/jovyan/notebooks/bla/test.txt	/home/jovyan/notebooks/bla	False	1.563533e+09	1

Touch an existing file¶

In [14]:

touch("bla/bla/test.txt", (1330712280, 1330712292))

In [15]:

pfi.update()
pfi

Changes:  [] ['/home/jovyan/notebooks/bla/bla/test.txt'] []

Out[15]:

	basename	path	dirname	is_directory	mtime	nlink
0	.ipynb_checkpoints	/home/jovyan/notebooks/.ipynb_checkpoints	/home/jovyan/notebooks	True	1.563532e+09	2
1	notebooks	/home/jovyan/notebooks	/home/jovyan	True	1.563533e+09	1
2	bla	/home/jovyan/notebooks/bla/bla	/home/jovyan/notebooks/bla	True	1.563533e+09	2
3	bla	/home/jovyan/notebooks/bla	/home/jovyan/notebooks	True	1.563533e+09	3
4	test.txt	/home/jovyan/notebooks/bla/test.txt	/home/jovyan/notebooks/bla	False	1.563533e+09	1
5	test.txt	/home/jovyan/notebooks/bla/bla/test.txt	/home/jovyan/notebooks/bla/bla	False	1.330712e+09	1

Remove a file¶

In [16]:

os.remove("bla/bla/test.txt")

In [17]:

pfi.update()
pfi

Changes:  [] ['/home/jovyan/notebooks/bla/bla'] ['/home/jovyan/notebooks/bla/bla/test.txt']

Out[17]:

	basename	path	dirname	is_directory	mtime	nlink
0	.ipynb_checkpoints	/home/jovyan/notebooks/.ipynb_checkpoints	/home/jovyan/notebooks	True	1.563532e+09	2
1	notebooks	/home/jovyan/notebooks	/home/jovyan	True	1.563533e+09	1
2	bla	/home/jovyan/notebooks/bla	/home/jovyan/notebooks	True	1.563533e+09	3
3	test.txt	/home/jovyan/notebooks/bla/test.txt	/home/jovyan/notebooks/bla	False	1.563533e+09	1
4	bla	/home/jovyan/notebooks/bla/bla	/home/jovyan/notebooks/bla	True	1.563533e+09	2

Remove a directory¶

In [18]:

os.rmdir("bla/bla")

In [19]:

pfi.update()
pfi

Changes:  [] ['/home/jovyan/notebooks/bla'] ['/home/jovyan/notebooks/bla/bla']

Out[19]:

	basename	path	dirname	is_directory	mtime	nlink
0	.ipynb_checkpoints	/home/jovyan/notebooks/.ipynb_checkpoints	/home/jovyan/notebooks	True	1.563532e+09	2
1	notebooks	/home/jovyan/notebooks	/home/jovyan	True	1.563533e+09	1
2	test.txt	/home/jovyan/notebooks/bla/test.txt	/home/jovyan/notebooks/bla	False	1.563533e+09	1
3	bla	/home/jovyan/notebooks/bla	/home/jovyan/notebooks	True	1.563533e+09	2

Clean up¶

In [20]:

os.remove("bla/test.txt")

In [21]:

os.rmdir("bla")

In [22]:

pfi.update()
pfi

Changes:  [] ['/home/jovyan/notebooks'] ['/home/jovyan/notebooks/bla/test.txt' '/home/jovyan/notebooks/bla']

Out[22]:

	basename	path	dirname	is_directory	mtime	nlink
0	.ipynb_checkpoints	/home/jovyan/notebooks/.ipynb_checkpoints	/home/jovyan/notebooks	True	1.563532e+09	2
1	notebooks	/home/jovyan/notebooks	/home/jovyan	True	1.563533e+09	1

In [ ]: