cengal-app-dir-path-finder
Advanced tools
Offering a unified API for easy retrieval of OS-specific application directories, enhancing data management across Windows, Linux, and macOS
cengal_app_dir_path_finder is a part of the Cengal library. If you have any questions or would like to participate in discussions, feel free to join the Cengal Discord. Your support and involvement are greatly appreciated as Cengal evolves.
cengal_app_dir_path_finder is a cross-platform Python module designed to simplify the process of locating OS-recommended directories for application data, cache, logs, and more. It seamlessly integrates with Windows, Linux, and macOS, utilizing platform-specific standards like KNOWNFOLDERID constants on Windows, XDG standards on Linux, and NSSearchPathForDirectoriesInDomains on macOS. This module offers a unified API for accessing various types of directories, such as local, roaming, and program-specific paths, enhancing application compatibility and data management across different operating systems.
pip install cengal_app_dir_path_finder
from cengal_app_dir_path_finder import AppDirectoryType, AppDirPath
import os
from cengal_app_dir_path_finder import AppDirectoryType, AppDirPath
app_dir_path: AppDirPath = AppDirPath()
local_data_dir_path: str = app_dir_path(AppDirectoryType.local_data, 'MyApplicationName')
settings_json_path: str = os.path.join(local_data_dir_path, 'settings.json')
with open(settings_json_path, 'w') as file:
file.write(my_app_settings)
Stable. Guaranteed to not have braking changes in the future (see bellow for details).
Any hypothetical further API-breaking changes will lead to new module creation within the package. An old version will continue its existence and continue to be importable by an explicit address (see Details bellow).
The current (currently latest) version can be imported either by:
from cengal_app_dir_path_finder import *
or by
from cengal_app_dir_path_finder.versions.v_0 import *
If further braking changes will be made to the API - a new (v_1) version will be made. As result:
Current (v_0) version will continue to be accessible by an explicit address:
from cengal_app_dir_path_finder.versions.v_0 import *
Latest (v_1) version will be accessible by either:
from cengal_app_dir_path_finder import *
or by
from cengal_app_dir_path_finder.versions.v_1 import *
This is a general approach across the entire Cengal library. It gives me the ability to effectively work on its huge codebase, even by myself.
By the way. I'm finishing an implementation of CengalPolyBuild - my package creation system which provides same approach to users. It is a comprehensive and hackable build system for multilingual Python packages: Cython (including automatic conversion from Python to Cython), C/C++, Objective-C, Go, and Nim, with ongoing expansions to include additional languages. Basically, it will provide easy access to all the same features I'm already using in the Cengal library package creation and management processes.
AppDirectoryType is an enum of all supported kinds of directories.
AppDirectoryType Fields:
Static Data. Your user-specific static data such as application's icons, static text or non-executable binary files, etc.:
local_static_data: Static data specific to the local user, not frequently modified.local_low_static_data: Static data for lower privilege user applications.roaming_static_data: User-specific static data that may sync across devices.program_static_data: Static data shared among all users and applications.Local Data. Your main user-specific data storage:
local_data: Local user-specific data storage, not shared across users, ideal for storing user preferences, game scores, etc.local_cache: Stores temporary, user-specific cache data that can be regenerated as needed.local_config: Configuration files and settings for the current user.local_log: Logs and operation records for the current user.local_temp: Temporary files and data specific to the current user.local_runtime: User-specific runtime data like sockets and named pipes.System-wide Data. For system services and other hi privilege applications:
program_data: Non-static data shared among users, like shared databases.program_cache: Cache for shared applications and services.program_config: Configuration files for system-wide applications.program_log: Log files for system-wide applications.program_temp: Temporary files for shared applications.program_runtime: System-wide runtime data like global sockets and named pipes.Local Low Data. User-specific low privilege local data storage for sandboxed or security-sensitive applications. For example for web browsers:
local_low_data: Low privilege local data storage for sandboxed or security-sensitive applications.local_low_cache: Similar to local_cache but for applications requiring lower access privileges.local_low_config: Configuration for applications with lower privileges.local_low_log: Logs for low privilege applications.local_low_temp: Temporary files for applications with lower privileges.local_low_runtime: Runtime data for applications with lower privileges.Roaming Data. User-specific data that may sync across devices:
roaming_data: User-specific data that may sync across devices, suitable for configurations and settings.roaming_cache: User-specific cache data that could be shared and synced across devices.roaming_config: Configurations that might be synced across a user's devices.roaming_log: User-specific logs that might be shared across devices.roaming_temp: Temporary user-specific files that might be synced across devices.roaming_runtime: User-specific runtime data that could be synced across devices.program_files: Static data shared among all users, like application binaries.
program_files_common: Shared libraries and common resources for multiple applications.
user_profile_data: User-specific application data within the user's home directory. (/home/<Username>/.<ApplicationName> in case of Linux)
user_profile_program_files: Static data specific to user-installed applications. Executable files, etc.
user_profile_program_files_common: Shared resources for user-specific applications. Shared libraries, components, etc.
Purpose: To store data that remains unchanged throughout the application's lifecycle. This includes configuration files, default settings, templates, and read-only resources that are essential for the application's operation but do not require modification or updates after the initial deployment.Use Case: Particularly valuable for applications that rely on a set of immutable resources for functionality—such as image editing software that includes a library of default filters and effects, or a document processing application that uses a collection of templates for various document types. This ensures that these resources are available to the application regardless of user-specific data or settings, providing a consistent foundation upon which the application's features and functionalities operate.local_static_data: Stores static data that doesn't change during the application lifecycle and doesn't need to roam.
FOLDERID_LocalAppDatawith_structure=True: C:\Users\<Username>\AppData\Local\<ApplicationName>\static_datawith_structure=False: C:\Users\<Username>\AppData\Local\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Locallocal_low_static_data: Static data for lower privilege user applications.
FOLDERID_LocalAppDataLowwith_structure=True: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>\static_datawith_structure=False: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\LocalLowroaming_static_data: Similar to roaming_data but specifically for static data that should be available across sessions and machines.
FOLDERID_RoamingAppDatawith_structure=True: C:\Users\<Username>\AppData\Roaming\<ApplicationName>\static_datawith_structure=False: C:\Users\<Username>\AppData\Roaming\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Roamingprogram_static_data: Stores static data similar to program_data, but explicitly indicates its static nature.
FOLDERID_ProgramDatawith_structure=True: C:\ProgramData\<ApplicationName>\static_datawith_structure=False: C:\ProgramData\<ApplicationName>app_name_or_path=None: C:\ProgramDatalocal_static_data: Stores static data that doesn't change during the application lifecycle and doesn't need to roam.
os.environ.get('XDG_DATA_HOME', os.path.join(os.path.expanduser('~'), '.local', 'share'))with_structure=True: /home/<Username>/.local/share/<ApplicationName>/local/static_datawith_structure=False: /home/<Username>/.local/share/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/sharelocal_low_static_data: Static data for lower privilege user applications.
os.environ.get('XDG_DATA_HOME', os.path.join(os.path.expanduser('~'), '.local', 'share'))with_structure=True: /home/<Username>/.local/share/<ApplicationName>/local_low/static_datawith_structure=False: /home/<Username>/.local/share/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/shareroaming_static_data: Similar to roaming_data but specifically for static data that should be available across sessions and machines.
os.environ.get('XDG_DATA_HOME', os.path.join(os.path.expanduser('~'), '.local', 'share'))with_structure=True: /home/<Username>/.local/share/<ApplicationName>/roaming/static_datawith_structure=False: /home/<Username>/.local/share/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/shareprogram_static_data: Stores static data similar to program_data, but explicitly indicates its static nature.
'/usr/share'with_structure=True: /usr/share/<ApplicationName>/static_datawith_structure=False: /usr/share/<ApplicationName>app_name_or_path=None: /usr/sharelocal_static_data: Stores static data that doesn't change during the application lifecycle and doesn't need to roam.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/local/static_datawith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportlocal_low_static_data: Static data for lower privilege user applications.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/local_low/static_datawith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportroaming_static_data: Similar to roaming_data but specifically for static data that should be available across sessions and machines.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/roaming/static_datawith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportprogram_static_data: Stores static data similar to program_data, but explicitly indicates its static nature.
applicationSupportDirectorylocalDomainMaskwith_structure=True: /Library/Application Support/<ApplicationName>/static_datawith_structure=False: /Library/Application Support/<ApplicationName>app_name_or_path=None: /Library/Application SupportPurpose: To store user-specific application data that is local to a machine. Ideal for data that is too large to roam or that is only relevant to the specific device.Use Case: Commonly used for storing temporary files, cache, application logs, and other user-specific data that does not need to be synced across multiple devices.local_data: Stores application data that doesn't roam with the user. Typically used for storing large datasets or files that are specific to a machine.
FOLDERID_LocalAppDatawith_structure=True: C:\Users\<Username>\AppData\Local\<ApplicationName>\datawith_structure=False: C:\Users\<Username>\AppData\Local\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Locallocal_cache: Used for storing temporary files that enhance application startup and operation. Cache files can be deleted without affecting application functionality.
FOLDERID_LocalAppDatawith_structure=True: C:\Users\<Username>\AppData\Local\<ApplicationName>\cachewith_structure=False: C:\Users\<Username>\AppData\Local\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Locallocal_config: Stores configuration files. These files usually include settings that are specific to the machine.
FOLDERID_LocalAppDatawith_structure=True: C:\Users\<Username>\AppData\Local\<ApplicationName>\configwith_structure=False: C:\Users\<Username>\AppData\Local\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Locallocal_log: Used for storing log files generated by the application. Useful for troubleshooting and monitoring application behavior.
FOLDERID_LocalAppDatawith_structure=True: C:\Users\<Username>\AppData\Local\<ApplicationName>\logwith_structure=False: C:\Users\<Username>\AppData\Local\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Locallocal_temp: Intended for temporary files that are needed during the application's execution but not beyond that. These files can be cleared to free up space.
FOLDERID_LocalAppDatawith_structure=True: C:\Users\<Username>\AppData\Local\<ApplicationName>\tempwith_structure=False: C:\Users\<Username>\AppData\Local\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Locallocal_runtime: Stores files required by the application at runtime. These could include dynamic libraries or runtime configurations.
FOLDERID_LocalAppDatawith_structure=True: C:\Users\<Username>\AppData\Local\<ApplicationName>\runtimewith_structure=False: C:\Users\<Username>\AppData\Local\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Locallocal_data: Stores application data that doesn't roam with the user. Typically used for storing large datasets or files that are specific to a machine.
os.environ.get('XDG_STATE_HOME', os.path.join(os.path.expanduser('~'), '.local', 'state'))with_structure=True: /home/<Username>/.local/state/<ApplicationName>/local/datawith_structure=False: /home/<Username>/.local/state/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/statelocal_cache: Used for storing temporary files that enhance application startup and operation. Cache files can be deleted without affecting application functionality.
os.environ.get('XDG_CACHE_HOME', os.path.join(os.path.expanduser('~'), '.cache'))with_structure=True: /home/<Username>/.cache/<ApplicationName>/local/cachewith_structure=False: /home/<Username>/.cache/<ApplicationName>app_name_or_path=None: /home/<Username>/.cachelocal_config: Stores configuration files. These files usually include settings that are specific to the machine.
os.environ.get('XDG_CONFIG_HOME', os.path.join(os.path.expanduser('~'), '.config'))with_structure=True: /home/<Username>/.config/<ApplicationName>/local/configwith_structure=False: /home/<Username>/.config/<ApplicationName>app_name_or_path=None: /home/<Username>/.configlocal_log: Used for storing log files generated by the application. Useful for troubleshooting and monitoring application behavior.
os.environ.get('XDG_STATE_HOME', os.path.join(os.path.expanduser('~'), '.local', 'state'))with_structure=True: /home/<Username>/.local/state/<ApplicationName>/local/logwith_structure=False: /home/<Username>/.local/state/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/statelocal_temp: Intended for temporary files that are needed during the application's execution but not beyond that. These files can be cleared to free up space.
os.environ.get('XDG_RUNTIME_DIR', os.path.join(os.path.expanduser('~'), '.tmp'))with_structure=True: /home/<Username>/.tmp/<ApplicationName>/local/tempwith_structure=False: /home/<Username>/.tmp/<ApplicationName>app_name_or_path=None: /home/<Username>/.tmplocal_runtime: Stores files required by the application at runtime. These could include dynamic libraries or runtime configurations.
os.environ.get('XDG_RUNTIME_DIR', os.path.join(os.path.expanduser('~'), '.tmp'))with_structure=True: /home/<Username>/.tmp/<ApplicationName>/local/runtimewith_structure=False: /home/<Username>/.tmp/<ApplicationName>app_name_or_path=None: /home/<Username>/.tmplocal_data: Stores application data that doesn't roam with the user. Typically used for storing large datasets or files that are specific to a machine.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/local/datawith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportlocal_cache: Used for storing temporary files that enhance application startup and operation. Cache files can be deleted without affecting application functionality.
cachesDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Caches/<ApplicationName>/local/cachewith_structure=False: /Users/<Username>/Library/Caches/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Cacheslocal_config: Stores configuration files. These files usually include settings that are specific to the machine.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/local/configwith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportlocal_log: Used for storing log files generated by the application. Useful for troubleshooting and monitoring application behavior.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/local/logwith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportlocal_temp: Intended for temporary files that are needed during the application's execution but not beyond that. These files can be cleared to free up space.
cachesDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Caches/<ApplicationName>/local/tempwith_structure=False: /Users/<Username>/Library/Caches/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Cacheslocal_runtime: Stores files required by the application at runtime. These could include dynamic libraries or runtime configurations.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/local/runtimewith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application SupportPurpose: To store application data, settings, and resources that need to be shared across all users on a single computer. Used for global application settings and data.Use Case: Ideal for system servicess and applications that require storing configuration files, templates, shared databases, or other data that should be accessible system-wide, regardless of the current user.program_data: For data that is shared across all users on the machine. Often used for application data that doesn't contain user-specific settings.
FOLDERID_ProgramDatawith_structure=True: C:\ProgramData\<ApplicationName>\datawith_structure=False: C:\ProgramData\<ApplicationName>app_name_or_path=None: C:\ProgramDataprogram_cache: Cache for shared applications and services.
FOLDERID_ProgramDatawith_structure=True: C:\ProgramData\<ApplicationName>\cachewith_structure=False: C:\ProgramData\<ApplicationName>app_name_or_path=None: C:\ProgramDataprogram_config: Configuration files for system-wide applications.
FOLDERID_ProgramDatawith_structure=True: C:\ProgramData\<ApplicationName>\configwith_structure=False: C:\ProgramData\<ApplicationName>app_name_or_path=None: C:\ProgramDataprogram_log: Log files for system-wide applications.
FOLDERID_ProgramDatawith_structure=True: C:\ProgramData\<ApplicationName>\logwith_structure=False: C:\ProgramData\<ApplicationName>app_name_or_path=None: C:\ProgramDataprogram_temp: Temporary files for shared applications.
FOLDERID_ProgramDatawith_structure=True: C:\ProgramData\<ApplicationName>\tempwith_structure=False: C:\ProgramData\<ApplicationName>app_name_or_path=None: C:\ProgramDataprogram_runtime: System-wide runtime data like global sockets and named pipes.
FOLDERID_ProgramDatawith_structure=True: C:\ProgramData\<ApplicationName>\runtimewith_structure=False: C:\ProgramData\<ApplicationName>app_name_or_path=None: C:\ProgramDataprogram_data: For data that is shared across all users on the machine. Often used for application data that doesn't contain user-specific settings.
'/var/lib'with_structure=True: /var/lib/<ApplicationName>/datawith_structure=False: /var/lib/<ApplicationName>app_name_or_path=None: /var/libprogram_cache: Cache for shared applications and services.
'/var/cache'with_structure=True: /var/cache/<ApplicationName>/cachewith_structure=False: /var/cache/<ApplicationName>app_name_or_path=None: /var/cacheprogram_config: Configuration files for system-wide applications.
'/etc'with_structure=True: /etc/<ApplicationName>/configwith_structure=False: /etc/<ApplicationName>app_name_or_path=None: /etcprogram_log: Log files for system-wide applications.
'/var/log'with_structure=True: /var/log/<ApplicationName>/logwith_structure=False: /var/log/<ApplicationName>app_name_or_path=None: /var/logprogram_temp: Temporary files for shared applications.
'/tmp'with_structure=True: /tmp/<ApplicationName>/tempwith_structure=False: /tmp/<ApplicationName>app_name_or_path=None: /tmpprogram_runtime: System-wide runtime data like global sockets and named pipes.
'/var/run'with_structure=True: /var/run/<ApplicationName>/runtimewith_structure=False: /var/run/<ApplicationName>app_name_or_path=None: /var/runprogram_data: For data that is shared across all users on the machine. Often used for application data that doesn't contain user-specific settings.
applicationSupportDirectorylocalDomainMaskwith_structure=True: /Library/Application Support/<ApplicationName>/datawith_structure=False: /Library/Application Support/<ApplicationName>app_name_or_path=None: /Library/Application Supportprogram_cache: Cache for shared applications and services.
'/Library/Caches'with_structure=True: /Library/Caches/<ApplicationName>/cachewith_structure=False: /Library/Caches/<ApplicationName>app_name_or_path=None: /Library/Cachesprogram_config: Configuration files for system-wide applications.
applicationSupportDirectorylocalDomainMaskwith_structure=True: /Library/Application Support/<ApplicationName>/configwith_structure=False: /Library/Application Support/<ApplicationName>app_name_or_path=None: /Library/Application Supportprogram_log: Log files for system-wide applications.
applicationSupportDirectorylocalDomainMaskwith_structure=True: /Library/Application Support/<ApplicationName>/logwith_structure=False: /Library/Application Support/<ApplicationName>: /Library/Application Support`program_temp: Temporary files for shared applications.
'/tmp'with_structure=True: /tmp/<ApplicationName>/tempwith_structure=False: /tmp/<ApplicationName>app_name_or_path=None: /tmpprogram_runtime: System-wide runtime data like global sockets and named pipes.
applicationSupportDirectorylocalDomainMaskwith_structure=True: /Library/Application Support/<ApplicationName>/runtimewith_structure=False: /Library/Application Support/<ApplicationName>app_name_or_path=None: /Library/Application SupportPurpose: For storing application data that doesn't require high integrity levels, helping to segregate data based on trust levels and application privileges.Use Case: Commonly used by web browsers and other applications that execute code or process content from less trusted sources.local_low_data: Low privilege local data storage for sandboxed or security-sensitive applications.
FOLDERID_LocalAppDataLowwith_structure=True: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>\datawith_structure=False: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\LocalLowlocal_low_cache: Similar to local_cache but for applications requiring lower access privileges.
FOLDERID_LocalAppDataLowwith_structure=True: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>\cachewith_structure=False: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\LocalLowlocal_low_config: Configuration for applications with lower privileges.
FOLDERID_LocalAppDataLowwith_structure=True: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>\configwith_structure=False: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\LocalLowlocal_low_log: Logs for low privilege applications.
FOLDERID_LocalAppDataLowwith_structure=True: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>\logwith_structure=False: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\LocalLowlocal_low_temp: Temporary files for applications with lower privileges.
FOLDERID_LocalAppDataLowwith_structure=True: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>\tempwith_structure=False: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\LocalLowlocal_low_runtime: Runtime data for applications with lower privileges.
FOLDERID_LocalAppDataLowwith_structure=True: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>\runtimewith_structure=False: C:\Users\<Username>\AppData\LocalLow\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\LocalLowlocal_low_data: Low privilege local data storage for sandboxed or security-sensitive applications.
os.environ.get('XDG_STATE_HOME', os.path.join(os.path.expanduser('~'), '.local', 'state'))with_structure=True: /home/<Username>/.local/state/<ApplicationName>/local_low/datawith_structure=False: /home/<Username>/.local/state/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/statelocal_low_cache: Similar to local_cache but for applications requiring lower access privileges.
os.environ.get('XDG_CACHE_HOME', os.path.join(os.path.expanduser('~'), '.cache'))with_structure=True: /home/<Username>/.cache/<ApplicationName>/local_low/cachewith_structure=False: /home/<Username>/.cache/<ApplicationName>app_name_or_path=None: /home/<Username>/.cachelocal_low_config: Configuration for applications with lower privileges.
os.environ.get('XDG_CONFIG_HOME', os.path.join(os.path.expanduser('~'), '.config'))with_structure=True: /home/<Username>/.config/<ApplicationName>/local_low/configwith_structure=False: /home/<Username>/.config/<ApplicationName>app_name_or_path=None: /home/<Username>/.configlocal_low_log: Logs for low privilege applications.
os.environ.get('XDG_STATE_HOME', os.path.join(os.path.expanduser('~'), '.local', 'state'))with_structure=True: /home/<Username>/.local/state/<ApplicationName>/local_low/logwith_structure=False: /home/<Username>/.local/state/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/statelocal_low_temp: Temporary files for applications with lower privileges.
os.environ.get('XDG_RUNTIME_DIR', os.path.join(os.path.expanduser('~'), '.tmp'))with_structure=True: /home/<Username>/.tmp/<ApplicationName>/local_low/tempwith_structure=False: /home/<Username>/.tmp/<ApplicationName>app_name_or_path=None: /home/<Username>/.tmplocal_low_runtime: Runtime data for applications with lower privileges.
os.environ.get('XDG_RUNTIME_DIR', os.path.join(os.path.expanduser('~'), '.tmp'))with_structure=True: /home/<Username>/.tmp/<ApplicationName>/local_low/runtimewith_structure=False: /home/<Username>/.tmp/<ApplicationName>app_name_or_path=None: /home/<Username>/.tmplocal_low_data: Low privilege local data storage for sandboxed or security-sensitive applications.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/local_low/datawith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportlocal_low_cache: Similar to local_cache but for applications requiring lower access privileges.
cachesDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Caches/<ApplicationName>/local_low/cachewith_structure=False: /Users/<Username>/Library/Caches/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Cacheslocal_low_config: Configuration for applications with lower privileges.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/local_low/configwith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportlocal_low_log: Logs for low privilege applications.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/local_low/logwith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportlocal_low_temp: Temporary files for applications with lower privileges.
cachesDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Caches/<ApplicationName>/local_low/tempwith_structure=False: /Users/<Username>/Library/Caches/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Cacheslocal_low_runtime: Runtime data for applications with lower privileges.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/local_low/runtimewith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application SupportPurpose: For storing user-specific application data that should be available across different machines in a network domain.Use Case: Ideal for applications that need to provide a consistent user experience across multiple workstations, including software configurations, user preferences, and other personal data.roaming_data: Stores user-specific data that should roam with the user profile. Ideal for settings and data that need to be available across different machines.
FOLDERID_RoamingAppDatawith_structure=True: C:\Users\<Username>\AppData\Roaming\<ApplicationName>\datawith_structure=False: C:\Users\<Username>\AppData\Roaming\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Roamingroaming_cache: User-specific cache data that could be shared and synced across devices.
FOLDERID_RoamingAppDatawith_structure=True: C:\Users\<Username>\AppData\Roaming\<ApplicationName>\cachewith_structure=False: C:\Users\<Username>\AppData\Roaming\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Roamingroaming_config: Configurations that might be synced across a user's devices.
FOLDERID_RoamingAppDatawith_structure=True: C:\Users\<Username>\AppData\Roaming\<ApplicationName>\configwith_structure=False: C:\Users\<Username>\AppData\Roaming\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Roamingroaming_log: User-specific logs that might be shared across devices.
FOLDERID_RoamingAppDatawith_structure=True: C:\Users\<Username>\AppData\Roaming\<ApplicationName>\logwith_structure=False: C:\Users\<Username>\AppData\Roaming\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Roamingroaming_temp: Temporary user-specific files that might be synced across devices.
FOLDERID_RoamingAppDatawith_structure=True: C:\Users\<Username>\AppData\Roaming\<ApplicationName>\tempwith_structure=False: C:\Users\<Username>\AppData\Roaming\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Roamingroaming_runtime: User-specific runtime data that could be synced across devices.
FOLDERID_RoamingAppDatawith_structure=True: C:\Users\<Username>\AppData\Roaming\<ApplicationName>\runtimewith_structure=False: C:\Users\<Username>\AppData\Roaming\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Roamingroaming_data: Stores user-specific data that should roam with the user profile. Ideal for settings and data that need to be available across different machines.
os.environ.get('XDG_STATE_HOME', os.path.join(os.path.expanduser('~'), '.local', 'state'))with_structure=True: /home/<Username>/.local/state/<ApplicationName>/roaming/datawith_structure=False: /home/<Username>/.local/state/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/stateroaming_cache: User-specific cache data that could be shared and synced across devices.
os.environ.get('XDG_CACHE_HOME', os.path.join(os.path.expanduser('~'), '.cache'))with_structure=True: /home/<Username>/.cache/<ApplicationName>/roaming/cachewith_structure=False: /home/<Username>/.cache/<ApplicationName>app_name_or_path=None: /home/<Username>/.cacheroaming_config: Configurations that might be synced across a user's devices.
os.environ.get('XDG_CONFIG_HOME', os.path.join(os.path.expanduser('~'), '.config'))with_structure=True: /home/<Username>/.config/<ApplicationName>/roaming/configwith_structure=False: /home/<Username>/.config/<ApplicationName>app_name_or_path=None: /home/<Username>/.configroaming_log: User-specific logs that might be shared across devices.
os.environ.get('XDG_STATE_HOME', os.path.join(os.path.expanduser('~'), '.local', 'state'))with_structure=True: /home/<Username>/.local/state/<ApplicationName>/roaming/logwith_structure=False: /home/<Username>/.local/state/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/stateroaming_temp: Temporary user-specific files that might be synced across devices.
os.environ.get('XDG_RUNTIME_DIR', os.path.join(os.path.expanduser('~'), '.tmp'))with_structure=True: /home/<Username>/.tmp/<ApplicationName>/roaming/tempwith_structure=False: /home/<Username>/.tmp/<ApplicationName>app_name_or_path=None: /home/<Username>/.tmproaming_runtime: User-specific runtime data that could be synced across devices.
os.environ.get('XDG_RUNTIME_DIR', os.path.join(os.path.expanduser('~'), '.tmp'))with_structure=True: /home/<Username>/.tmp/<ApplicationName>/roaming/runtimewith_structure=False: /home/<Username>/.tmp/<ApplicationName>app_name_or_path=None: /home/<Username>/.tmproaming_data: Stores user-specific data that should roam with the user profile. Ideal for settings and data that need to be available across different machines.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/roaming/datawith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportroaming_cache: User-specific cache data that could be shared and synced across devices.
cachesDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Caches/<ApplicationName>/roaming/cachewith_structure=False: /Users/<Username>/Library/Caches/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Cachesroaming_config: Configurations that might be synced across a user's devices.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/roaming/configwith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportroaming_log: User-specific logs that might be shared across devices.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/roaming/logwith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application Supportroaming_temp: Temporary user-specific files that might be synced across devices.
cachesDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Caches/<ApplicationName>/roaming/tempwith_structure=False: /Users/<Username>/Library/Caches/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Cachesroaming_runtime: User-specific runtime data that could be synced across devices.
applicationSupportDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Library/Application Support/<ApplicationName>/roaming/runtimewith_structure=False: /Users/<Username>/Library/Application Support/<ApplicationName>app_name_or_path=None: /Users/<Username>/Library/Application SupportPurpose: To store executable files and static application data for installed programs. It helps in organizing software installations on a Windows system, ensuring that program files are kept in a dedicated location.Use Case: Used by software installation processes to place program files and directories. This standard location is recognized by Windows and users for installed applications.program_files:
FOLDERID_ProgramFileswith_structure=True: C:\Program Files\<ApplicationName>with_structure=False: C:\Program Files\<ApplicationName>app_name_or_path=None: C:\Program Filesprogram_files:
'/opt'with_structure=True: /opt/<ApplicationName>with_structure=False: /opt/<ApplicationName>app_name_or_path=None: /optprogram_files:
allApplicationsDirectorylocalDomainMaskwith_structure=True: /Applications/<ApplicationName>with_structure=False: /Applications/<ApplicationName>app_name_or_path=None: /ApplicationsPurpose: To house shared libraries, components, and resources that can be used by multiple applications, promoting efficient use of disk space and simplifying updates.Use Case: Commonly used for storing shared DLLs, data files, and components that provide functionality required by different applications, such as database engines, media codecs, and common utilities.program_files_common:
FOLDERID_ProgramFilesCommonwith_structure=True: C:\Program Files\Common Files\<ApplicationName>with_structure=False: C:\Program Files\Common Files\<ApplicationName>app_name_or_path=None: C:\Program Files\Common Filesprogram_files_common:
'/opt'with_structure=True: /opt/<ApplicationName>with_structure=False: /opt/<ApplicationName>app_name_or_path=None: /optprogram_files_common:
allApplicationsDirectorylocalDomainMaskwith_structure=True: /Applications/<ApplicationName>with_structure=False: /Applications/<ApplicationName>app_name_or_path=None: /ApplicationsPurpose: To serve as the root folder for all user-specific data, including personal documents, application settings, and user profile configurations.Use Case: Essential for operating systems supporting multiple user accounts, ensuring that each user's data and settings are stored separately and securely. Applications can store user-specific data here to ensure it is associated uniquely with the user's profile.Note: The application name will be prefixed with a leading period on all operating systems.user_profile_data:
FOLDERID_Profilewith_structure=True: C:\Users\<Username>\.<ApplicationName>with_structure=False: C:\Users\<Username>\.<ApplicationName>app_name_or_path=None: C:\Users\<Username>user_profile_data:
os.path.expanduser('~')with_structure=True: /home/<Username>/.<ApplicationName>with_structure=False: /home/<Username>/.<ApplicationName>app_name_or_path=None: /home/<Username>user_profile_data:
userDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/.<ApplicationName>with_structure=False: /Users/<Username>/.<ApplicationName>app_name_or_path=None: /Users/<Username>Purpose: To house user-specific applications and programs, allowing for personalized software installations that do not require administrative privileges for installation or update processes.Use Case: Particularly useful in environments with multiple users, enabling each user to manage their own set of applications independently of others. This is beneficial for software that users wish to install without altering the system-wide software landscape.user_profile_program_files:
FOLDERID_UserProgramFileswith_structure=True: C:\Users\<Username>\AppData\Local\Programs\<ApplicationName>with_structure=False: C:\Users\<Username>\AppData\Local\Programs\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Local\Programsuser_profile_program_files:
os.environ.get('XDG_STATE_HOME', os.path.join(os.path.expanduser('~'), '.local', 'state'))with_structure=True: /home/<Username>/.local/state/<ApplicationName>with_structure=False: /home/<Username>/.local/state/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/stateuser_profile_program_files:
applicationDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Applications/<ApplicationName>with_structure=False: /Users/<Username>/Applications/<ApplicationName>app_name_or_path=None: /Users/<Username>/ApplicationsPurpose: To store shared components, libraries, and resources for applications installed by the current user, promoting efficient use of storage by avoiding duplication and ensuring consistent access to shared resources.Use Case: Useful for applications that a user installs that need to share common files or components without affecting or requiring access to the system-wide common files directory. This setup is particularly beneficial in multi-user environments where each user has a distinct set of applications and configurations.user_profile_program_files_common:
FOLDERID_UserProgramFilesCommonwith_structure=True: C:\Users\<Username>\AppData\Local\Programs\Common\<ApplicationName>with_structure=False: C:\Users\<Username>\AppData\Local\Programs\Common\<ApplicationName>app_name_or_path=None: C:\Users\<Username>\AppData\Local\Programs\Commonuser_profile_program_files_common:
os.environ.get('XDG_STATE_HOME', os.path.join(os.path.expanduser('~'), '.local', 'state'))with_structure=True: /home/<Username>/.local/state/<ApplicationName>with_structure=False: /home/<Username>/.local/state/<ApplicationName>app_name_or_path=None: /home/<Username>/.local/stateuser_profile_program_files_common:
applicationDirectoryuserDomainMaskwith_structure=True: /Users/<Username>/Applications/<ApplicationName>with_structure=False: /Users/<Username>/Applications/<ApplicationName>app_name_or_path=None: /Users/<Username>/Applications__call__(...)def __call__(self, dir_type: AppDirectoryType, app_name_or_path: Optional[DirNameOrPath] = None, with_structure: bool = True, ensure_dir: bool = True) -> str:
Constructs path of the requestet directory type taking into account provided application name.
with_structure:
False: determines base directory provided by OS and followed with an application nameTrue: determines base directory provided by OS, followed with an application name and completed with a suffixes like 'cache', 'config', 'log', etc.ensure_dir:
True: creates directory sequence if does not existscached(...)def cached(self, dir_type: AppDirectoryType, app_name_or_path: Optional[DirNameOrPath] = None, with_structure: bool = True, ensure_dir: bool = True) -> str:
Cached version. Much faster in a repetitive requests.
An Instance service from the Cengal.Coroutines holds globally accessible instance of the AppDirPath as well as globally acessible field for an application name:
{
...
'app_name': str(),
'app_name_for_fs': str(),
'app_version': tuple(),
'app_version_str': str(),
AppDirPath: AppDirPath(),
'app_data_dir_path_type': AppDirectoryType.local_data,
'app_cache_dir_path_type': AppDirectoryType.local_cache,
'app_temp_dir_path_type': AppDirectoryType.local_temp,
'app_log_dir_path_type': AppDirectoryType.local_log,
'app_config_dir_path_type': AppDirectoryType.local_config,
'app_runtime_dir_path_type': AppDirectoryType.local_runtime,
...
}
Several Cengal.Coroutines.Services using these fields and instances in their work. For example such services as db (async LMDB) and log.
Short example of proper usage:
from cengal_app_dir_path_finder import AppDirectoryType, AppDirPath
from cengal.parallel_execution.coroutines.coro_scheduler import cs_acoro
from cengal.parallel_execution.coroutines.coro_standard_services.instance import afast_wait, fast_get, fast_set
from uuid import uuid4
MY_APP_CONFIGURATION_COMPLETED_FLAG_NAME: str = f'My Application Mandatory Configuration Complited {uuid4()}'
@cs_acoro
async def set_app_name(app_name: str) -> None:
fast_set('app_name_for_fs', app_name)
fast_set(MY_APP_CONFIGURATION_COMPLETED_FLAG_NAME, None)
@cs_acoro
async def get_local_temp_dir() -> str:
await afast_wait(MY_APP_CONFIGURATION_COMPLETED_FLAG_NAME)
app_dir_path: AppDirPath = fast_get(AppDirPath)
return app_dir_path.cached(fast_get('app_temp_dir_path_type'), fast_get('app_name_for_fs'))
Same example but a bit faster in an execution performance terms:
from cengal.file_system.app_fs_structure.app_dir_path import AppDirectoryType, AppDirPath # totaly the same import as in a previous example
from cengal.parallel_execution.coroutines.coro_scheduler import Interface
from cengal.parallel_execution.coroutines.coro_standard_services.instance import afast_wait_explicit, fast_get_explicit, fast_set_explicit
from uuid import uuid4
MY_APP_CONFIGURATION_COMPLETED_FLAG_NAME: str = f'My Application Mandatory Configuration Complited {uuid4()}'
async def set_app_name(i: Interface, app_name: str) -> None:
fast_set_explicit(i, 'app_name_for_fs', app_name)
fast_set_explicit(i, MY_APP_CONFIGURATION_COMPLETED_FLAG_NAME, None)
async def get_local_temp_dir(i: Interface) -> str:
await afast_wait_explicit(i, MY_APP_CONFIGURATION_COMPLETED_FLAG_NAME)
app_dir_path: AppDirPath = fast_get_explicit(i, AppDirPath)
return app_dir_path.cached(fast_get_explicit(i, 'app_temp_dir_path_type'),
fast_get_explicit(i, 'app_name_for_fs'))
Represents part of Cengal library:
An equivalent import:
from cengal.file_system.app_fs_structure.app_dir_path import AppDirectoryType, AppDirPath
Cengal library can be installed by:
pip install cengal
Copyright © 2012-2024 ButenkoMS. All rights reserved.
Licensed under the Apache License, Version 2.0.
FAQs
Offering a unified API for easy retrieval of OS-specific application directories, enhancing data management across Windows, Linux, and macOS
We found that cengal-app-dir-path-finder demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.