Skip to content

Commit 0cf6ca8

Browse files
kodek16accek
authored andcommitted
Removed filetracker 1.0 compatible API reexports. (#42)
1 parent 8b1affb commit 0cf6ca8

File tree

2 files changed

+17
-43
lines changed

2 files changed

+17
-43
lines changed

filetracker/__init__.py

Lines changed: 17 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,13 @@
88
Filetracker base supports caching of files downloaded from the remote
99
master store.
1010
11-
Filetracker API allows versioning of the stored files, but its
12-
implementation is optional and not provided by default store classes.
13-
1411
-------------------------
1512
Files, names and versions
1613
-------------------------
1714
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
1916
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).
2418
2519
Many methods accept or return *versioned names*, which look like regular
2620
names with version number appended, separated by ``@``. For those methods,
@@ -30,13 +24,14 @@
3024
Configuration and usage
3125
-----------------------
3226
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`.
3429
35-
.. autoclass:: Client
30+
.. autoclass:: filetracker.client.Client
3631
:members:
3732
3833
If you write tests, you may be also interested in
39-
:class:`filetracker.dummy.DummyClient`.
34+
:class:`filetracker.client.dummy.DummyClient`.
4035
4136
------------------
4237
Filetracker server
@@ -73,44 +68,28 @@
7368
:members:
7469
7570
----------------------
76-
Internal API Reference
71+
API Reference
7772
----------------------
7873
79-
.. autofunction:: split_name
74+
.. autofunction:: filetracker.utils.split_name
8075
81-
.. autofunction:: versioned_name
76+
.. autofunction:: filetracker.utils.versioned_name
8277
83-
.. autoclass:: DataStore
78+
.. autoclass:: filetracker.client.data_store.DataStore
8479
:members:
8580
86-
.. autoclass:: LocalDataStore
81+
.. autoclass:: filetracker.client.local_data_store.LocalDataStore
8782
88-
.. autoclass:: RemoteDataStore
83+
.. autoclass:: filetracker.client.remote_data_store.RemoteDataStore
8984
90-
.. autoclass:: LockManager
85+
.. autoclass:: filetracker.client.lock_manager.LockManager
9186
:members:
9287
93-
.. autoclass:: FcntlLockManager
94-
95-
.. autoclass:: NoOpLockManager
88+
.. autoclass:: filetracker.client.lock_manager.FcntlLockManager
9689
97-
.. autoclass:: filetracker.dummy.DummyDataStore
90+
.. autoclass:: filetracker.client.lock_manager.NoOpLockManager
9891
99-
.. autoclass:: filetracker.dummy.DummyClient
92+
.. autoclass:: filetracker.client.dummy.DummyDataStore
10093
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
10995
"""
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

filetracker/dummy.py

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)