|
8 | 8 | Filetracker base supports caching of files downloaded from the remote
|
9 | 9 | master store.
|
10 | 10 |
|
11 |
| - Filetracker API allows versioning of the stored files, but its |
12 |
| - implementation is optional and not provided by default store classes. |
13 |
| -
|
14 | 11 | -------------------------
|
15 | 12 | Files, names and versions
|
16 | 13 | -------------------------
|
17 | 14 |
|
18 |
| - A file may contain arbitrary data. Each file has a name, which looks like |
| 15 | + A file may contain arbitrary data. Each file has a name, which is |
19 | 16 | an absolute filesystem path (components separated by slashes and the first
|
20 |
| - symbol in the filename must be a slash). Filetracker does not support |
21 |
| - folders explicitly. At the moment you may assume that a file in filetracker |
22 |
| - is identified by name which by convention looks like a filesystem path. |
23 |
| - In the future we may make use of this fact, so please obey. |
| 17 | + symbol in the filename must be a slash). |
24 | 18 |
|
25 | 19 | Many methods accept or return *versioned names*, which look like regular
|
26 | 20 | names with version number appended, separated by ``@``. For those methods,
|
|
30 | 24 | Configuration and usage
|
31 | 25 | -----------------------
|
32 | 26 |
|
33 |
| - Probably the only class you'd like to know and use is :class:`Client`. |
| 27 | + Probably the only class you'd like to know and use is |
| 28 | + :class:`filetracker.client.Client`. |
34 | 29 |
|
35 |
| - .. autoclass:: Client |
| 30 | + .. autoclass:: filetracker.client.Client |
36 | 31 | :members:
|
37 | 32 |
|
38 | 33 | If you write tests, you may be also interested in
|
39 |
| - :class:`filetracker.dummy.DummyClient`. |
| 34 | + :class:`filetracker.client.dummy.DummyClient`. |
40 | 35 |
|
41 | 36 | ------------------
|
42 | 37 | Filetracker server
|
|
73 | 68 | :members:
|
74 | 69 |
|
75 | 70 | ----------------------
|
76 |
| - Internal API Reference |
| 71 | + API Reference |
77 | 72 | ----------------------
|
78 | 73 |
|
79 |
| - .. autofunction:: split_name |
| 74 | + .. autofunction:: filetracker.utils.split_name |
80 | 75 |
|
81 |
| - .. autofunction:: versioned_name |
| 76 | + .. autofunction:: filetracker.utils.versioned_name |
82 | 77 |
|
83 |
| - .. autoclass:: DataStore |
| 78 | + .. autoclass:: filetracker.client.data_store.DataStore |
84 | 79 | :members:
|
85 | 80 |
|
86 |
| - .. autoclass:: LocalDataStore |
| 81 | + .. autoclass:: filetracker.client.local_data_store.LocalDataStore |
87 | 82 |
|
88 |
| - .. autoclass:: RemoteDataStore |
| 83 | + .. autoclass:: filetracker.client.remote_data_store.RemoteDataStore |
89 | 84 |
|
90 |
| - .. autoclass:: LockManager |
| 85 | + .. autoclass:: filetracker.client.lock_manager.LockManager |
91 | 86 | :members:
|
92 | 87 |
|
93 |
| - .. autoclass:: FcntlLockManager |
94 |
| -
|
95 |
| - .. autoclass:: NoOpLockManager |
| 88 | + .. autoclass:: filetracker.client.lock_manager.FcntlLockManager |
96 | 89 |
|
97 |
| - .. autoclass:: filetracker.dummy.DummyDataStore |
| 90 | + .. autoclass:: filetracker.client.lock_manager.NoOpLockManager |
98 | 91 |
|
99 |
| - .. autoclass:: filetracker.dummy.DummyClient |
| 92 | + .. autoclass:: filetracker.client.dummy.DummyDataStore |
100 | 93 |
|
101 |
| - ---------------- |
102 |
| - To-dos and ideas |
103 |
| - ---------------- |
104 |
| - - access control |
105 |
| - - cache pruning |
106 |
| - - support for "directories": especially ls |
107 |
| - - fuse client |
108 |
| - - rm |
| 94 | + .. autoclass:: filetracker.client.dummy.DummyClient |
109 | 95 | """
|
110 |
| - |
111 |
| -# Some symbols from 'client' package are reexported here to prevent |
112 |
| -# breaking oioioi. oioioi.filetracker package should be adapted to |
113 |
| -# use new paths. |
114 |
| - |
115 |
| -from filetracker.client import Client, dummy |
116 |
| -from filetracker.utils import split_name |
0 commit comments