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
|
'''
Storage Path
============
The StorgePath API can be used to gain access to standard storage locations
across platforms such as home directory, root directory, external storage
directory, documents, downloads, etc.
The :class:`StoragePath` provides access to public methods to access standard
storage locations.
Simple Examples
---------------
To get the path of user's home directory::
>>> from plyer import storagepath
>>> storagepath.get_home_dir()
To get the path of standard downloads directory::
>>> from plyer import storagepath
>>> storagepath.get_downloads_dir()
To get the path of directory holding application files::
>>> from plyer import storagepath
>>> storagepath.get_application_dir()
'''
class StoragePath:
'''
StoragePath facade.
'''
def get_home_dir(self):
'''
Get the path of home directory of current user.
'''
return self._get_home_dir()
def get_external_storage_dir(self):
'''
Get the path of primary shared or external storage directory.
'''
return self._get_external_storage_dir()
def get_sdcard_dir(self):
'''
Get the path of external SD card.
.. versionadded:: 1.4.0
'''
return self._get_sdcard_dir()
def get_root_dir(self):
'''
Get the path of root of the "system" partition holding the core OS.
'''
return self._get_root_dir()
def get_documents_dir(self):
'''
Get the path of standard directory in which to place documents that
have been created by the user.
'''
return self._get_documents_dir()
def get_downloads_dir(self):
'''
Get the path of standard directory in which to place files that have
been downloaded by the user.
'''
return self._get_downloads_dir()
def get_videos_dir(self):
'''
Get the path of standard directory in which to place videos that are
available to the user.
'''
return self._get_videos_dir()
def get_music_dir(self):
'''
Get the path of standard directory in which to place any audio files
that should be in the regular list of music for the user.
'''
return self._get_music_dir()
def get_pictures_dir(self):
'''
Standard directory in which to place pictures that are available to
the user.
'''
return self._get_pictures_dir()
def get_application_dir(self):
'''
Get the path of the directory holding application files.
'''
return self._get_application_dir()
# private
def _get_home_dir(self):
raise NotImplementedError()
def _get_external_storage_dir(self):
raise NotImplementedError()
def _get_sdcard_dir(self):
raise NotImplementedError()
def _get_root_dir(self):
raise NotImplementedError()
def _get_documents_dir(self):
raise NotImplementedError()
def _get_downloads_dir(self):
raise NotImplementedError()
def _get_videos_dir(self):
raise NotImplementedError()
def _get_music_dir(self):
raise NotImplementedError()
def _get_pictures_dir(self):
raise NotImplementedError()
def _get_application_dir(self):
raise NotImplementedError()
|
