1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
"""Manage filesystems in platform-specific application directories.
These classes abstract away the different requirements for user data
across platforms, which vary in their conventions. They are all
subclasses of `~fs.osfs.OSFS`.
"""
# Thanks to authors of https://pypi.org/project/appdirs
# see http://technet.microsoft.com/en-us/library/cc766489(WS.10).aspx
import typing
import abc
from platformdirs import PlatformDirs
from ._repr import make_repr
from .osfs import OSFS
if typing.TYPE_CHECKING:
from typing import Optional, Text
__all__ = [
"UserDataFS",
"UserConfigFS",
"SiteDataFS",
"SiteConfigFS",
"UserCacheFS",
"UserLogFS",
]
class _CopyInitMeta(abc.ABCMeta):
"""A metaclass that performs a hard copy of the `__init__`.
This is a fix for Sphinx, which is a pain to configure in a way that
it documents the ``__init__`` method of a class when it is inherited.
Copying ``__init__`` makes it think it is not inherited, and let us
share the documentation between all the `_AppFS` subclasses.
"""
def __new__(mcls, classname, bases, cls_dict):
cls_dict.setdefault("__init__", bases[0].__init__)
return super(abc.ABCMeta, mcls).__new__(mcls, classname, bases, cls_dict)
class _AppFS(OSFS,metaclass=_CopyInitMeta):
"""Abstract base class for an app FS."""
# FIXME(@althonos): replace by ClassVar[Text] once
# https://github.com/python/mypy/pull/4718 is accepted
# (subclass override will raise errors until then)
app_dir = None # type: Text
def __init__(
self,
appname, # type: Text
author=None, # type: Optional[Text]
version=None, # type: Optional[Text]
roaming=False, # type: bool
create=True, # type: bool
):
# type: (...) -> None
"""Create a new application-specific filesystem.
Arguments:
appname (str): The name of the application.
author (str): The name of the author (used on Windows).
version (str): Optional version string, if a unique location
per version of the application is required.
roaming (bool): If `True`, use a *roaming* profile on
Windows.
create (bool): If `True` (the default) the directory
will be created if it does not exist.
"""
self.app_dirs = PlatformDirs(appname, author, version, roaming)
self._create = create
super(_AppFS, self).__init__(
getattr(self.app_dirs, self.app_dir), create=create
)
def __repr__(self):
# type: () -> Text
return make_repr(
self.__class__.__name__,
self.app_dirs.appname,
author=(self.app_dirs.appauthor, None),
version=(self.app_dirs.version, None),
roaming=(self.app_dirs.roaming, False),
create=(self._create, True),
)
def __str__(self):
# type: () -> Text
return "<{} '{}'>".format(
self.__class__.__name__.lower(), self.app_dirs.appname
)
class UserDataFS(_AppFS):
"""A filesystem for per-user application data.
May also be opened with
``open_fs('userdata://appname:author:version')``.
"""
app_dir = "user_data_dir"
class UserConfigFS(_AppFS):
"""A filesystem for per-user config data.
May also be opened with
``open_fs('userconf://appname:author:version')``.
"""
app_dir = "user_config_dir"
class UserCacheFS(_AppFS):
"""A filesystem for per-user application cache data.
May also be opened with
``open_fs('usercache://appname:author:version')``.
"""
app_dir = "user_cache_dir"
class SiteDataFS(_AppFS):
"""A filesystem for application site data.
May also be opened with
``open_fs('sitedata://appname:author:version')``.
"""
app_dir = "site_data_dir"
class SiteConfigFS(_AppFS):
"""A filesystem for application config data.
May also be opened with
``open_fs('siteconf://appname:author:version')``.
"""
app_dir = "site_config_dir"
class UserLogFS(_AppFS):
"""A filesystem for per-user application log data.
May also be opened with
``open_fs('userlog://appname:author:version')``.
"""
app_dir = "user_log_dir"
|
