cengal.file_system.app_fs_structure.app_dir_path.versions.v_0.app_directory_types

View Source

 1#!/usr/bin/env python
 2# coding=utf-8
 3
 4# Copyright © 2012-2024 ButenkoMS. All rights reserved. Contacts: <gtalk@butenkoms.space>
 5# 
 6# Licensed under the Apache License, Version 2.0 (the "License");
 7# you may not use this file except in compliance with the License.
 8# You may obtain a copy of the License at
 9# 
10#     http://www.apache.org/licenses/LICENSE-2.0
11# 
12# Unless required by applicable law or agreed to in writing, software
13# distributed under the License is distributed on an "AS IS" BASIS,
14# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15# See the License for the specific language governing permissions and
16# limitations under the License.
17
18
19__all__ = ['AppDirectoryType']
20
21
22"""
23Module Docstring
24Docstrings: http://www.python.org/dev/peps/pep-0257/
25"""
26
27__author__ = "ButenkoMS <gtalk@butenkoms.space>"
28__copyright__ = "Copyright © 2012-2024 ButenkoMS. All rights reserved. Contacts: <gtalk@butenkoms.space>"
29__credits__ = ["ButenkoMS <gtalk@butenkoms.space>", ]
30__license__ = "Apache License, Version 2.0"
31__version__ = "4.4.1"
32__maintainer__ = "ButenkoMS <gtalk@butenkoms.space>"
33__email__ = "gtalk@butenkoms.space"
34# __status__ = "Prototype"
35__status__ = "Development"
36# __status__ = "Production"
37
38
39from enum import IntEnum
40
41
42class AppDirectoryType(IntEnum):
43    local_data = 0  # local data is data that is not shared between users
44    local_low_data = 1  # local data is data that is not shared between users. This folder is intended to be used by applications that require a low privilege level to operate, such as web browsers or sandboxed applications.
45    roaming_data = 2  # roaming data is data that is not shared between users but might be shared and synchronised between devices of this user. On Mac OS X, automatic system backup for a small (few kbytes) files is used
46    
47    local_cache = 3  # Where user-specific non-essential (cached) data should be written
48    local_low_cache = 4  # Where user-specific non-essential (cached) data should be written
49    roaming_cache = 5  # Where user-specific non-essential (cached) data should be written. Might be shared and synchronised between devices of this user
50    
51    local_temp = 6
52    local_low_temp = 7
53    roaming_temp = 8
54    
55    local_log = 9
56    local_low_log = 10
57    roaming_log = 11
58    
59    local_config = 12
60    local_low_config = 13
61    roaming_config = 14
62    
63    local_runtime = 15  # Used for non-essential, user-specific data files such as sockets, named pipes, etc.
64    local_low_runtime = 16  # Used for non-essential, user-specific data files such as sockets, named pipes, etc.
65    roaming_runtime = 17  # Used for non-essential, user-specific data files such as sockets, named pipes, etc. Might be shared and synchronised between devices of this user
66
67    program_files = 18  # program files is program static data that is shared between users
68    program_files_common = 19  # program files common is program static data that is shared between applications and users. For example libraries 
69
70    program_data = 20  # program data is non-static data that is shared between users
71    program_cache = 21  # Where non-essential (cached) data should be written
72    program_temp = 22
73    program_log = 23
74    program_config = 24
75    program_runtime = 25  # Used for non-essential, data files such as sockets, named pipes, etc.
76
77    user_profile_data = 28  # App data in user home directory. It is usually hidden directory
78    user_profile_program_files = 29  # program files is program static data that is shared between users
79    user_profile_program_files_common = 30  # program files common is program static data that is shared between applications and users. For example libraries 
80
81    local_static_data = 31
82    local_low_static_data = 32
83    roaming_static_data = 33
84    program_static_data = 34

class AppDirectoryType(enum.IntEnum): View Source

43class AppDirectoryType(IntEnum):
44    local_data = 0  # local data is data that is not shared between users
45    local_low_data = 1  # local data is data that is not shared between users. This folder is intended to be used by applications that require a low privilege level to operate, such as web browsers or sandboxed applications.
46    roaming_data = 2  # roaming data is data that is not shared between users but might be shared and synchronised between devices of this user. On Mac OS X, automatic system backup for a small (few kbytes) files is used
47    
48    local_cache = 3  # Where user-specific non-essential (cached) data should be written
49    local_low_cache = 4  # Where user-specific non-essential (cached) data should be written
50    roaming_cache = 5  # Where user-specific non-essential (cached) data should be written. Might be shared and synchronised between devices of this user
51    
52    local_temp = 6
53    local_low_temp = 7
54    roaming_temp = 8
55    
56    local_log = 9
57    local_low_log = 10
58    roaming_log = 11
59    
60    local_config = 12
61    local_low_config = 13
62    roaming_config = 14
63    
64    local_runtime = 15  # Used for non-essential, user-specific data files such as sockets, named pipes, etc.
65    local_low_runtime = 16  # Used for non-essential, user-specific data files such as sockets, named pipes, etc.
66    roaming_runtime = 17  # Used for non-essential, user-specific data files such as sockets, named pipes, etc. Might be shared and synchronised between devices of this user
67
68    program_files = 18  # program files is program static data that is shared between users
69    program_files_common = 19  # program files common is program static data that is shared between applications and users. For example libraries 
70
71    program_data = 20  # program data is non-static data that is shared between users
72    program_cache = 21  # Where non-essential (cached) data should be written
73    program_temp = 22
74    program_log = 23
75    program_config = 24
76    program_runtime = 25  # Used for non-essential, data files such as sockets, named pipes, etc.
77
78    user_profile_data = 28  # App data in user home directory. It is usually hidden directory
79    user_profile_program_files = 29  # program files is program static data that is shared between users
80    user_profile_program_files_common = 30  # program files common is program static data that is shared between applications and users. For example libraries 
81
82    local_static_data = 31
83    local_low_static_data = 32
84    roaming_static_data = 33
85    program_static_data = 34

An enumeration.

local_data = <AppDirectoryType.local_data: 0>

local_low_data = <AppDirectoryType.local_low_data: 1>

roaming_data = <AppDirectoryType.roaming_data: 2>

local_cache = <AppDirectoryType.local_cache: 3>

local_low_cache = <AppDirectoryType.local_low_cache: 4>

roaming_cache = <AppDirectoryType.roaming_cache: 5>

local_temp = <AppDirectoryType.local_temp: 6>

local_low_temp = <AppDirectoryType.local_low_temp: 7>

roaming_temp = <AppDirectoryType.roaming_temp: 8>

local_log = <AppDirectoryType.local_log: 9>

local_low_log = <AppDirectoryType.local_low_log: 10>

roaming_log = <AppDirectoryType.roaming_log: 11>

local_config = <AppDirectoryType.local_config: 12>

local_low_config = <AppDirectoryType.local_low_config: 13>

roaming_config = <AppDirectoryType.roaming_config: 14>

local_runtime = <AppDirectoryType.local_runtime: 15>

local_low_runtime = <AppDirectoryType.local_low_runtime: 16>

roaming_runtime = <AppDirectoryType.roaming_runtime: 17>

program_files = <AppDirectoryType.program_files: 18>

program_files_common = <AppDirectoryType.program_files_common: 19>

program_data = <AppDirectoryType.program_data: 20>

program_cache = <AppDirectoryType.program_cache: 21>

program_temp = <AppDirectoryType.program_temp: 22>

program_log = <AppDirectoryType.program_log: 23>

program_config = <AppDirectoryType.program_config: 24>

program_runtime = <AppDirectoryType.program_runtime: 25>

user_profile_data = <AppDirectoryType.user_profile_data: 28>

user_profile_program_files = <AppDirectoryType.user_profile_program_files: 29>

user_profile_program_files_common = <AppDirectoryType.user_profile_program_files_common: 30>

local_static_data = <AppDirectoryType.local_static_data: 31>

local_low_static_data = <AppDirectoryType.local_low_static_data: 32>

roaming_static_data = <AppDirectoryType.roaming_static_data: 33>

program_static_data = <AppDirectoryType.program_static_data: 34>

Inherited Members

enum.Enum

name

value

builtins.int

conjugate

bit_length

to_bytes

from_bytes

as_integer_ratio

real

imag

numerator

denominator