| from __future__ import annotations |
| |
| import os |
| |
| from .api import PlatformDirsABC |
| |
| |
| class MacOS(PlatformDirsABC): |
| """ |
| Platform directories for the macOS operating system. Follows the guidance from `Apple documentation |
| <https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/MacOSXDirectories/MacOSXDirectories.html>`_. |
| Makes use of the `appname <platformdirs.api.PlatformDirsABC.appname>`, |
| `version <platformdirs.api.PlatformDirsABC.version>`, |
| `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`. |
| """ |
| |
| @property |
| def user_data_dir(self) -> str: |
| """:return: data directory tied to the user, e.g. ``~/Library/Application Support/$appname/$version``""" |
| return self._append_app_name_and_version(os.path.expanduser("~/Library/Application Support")) |
| |
| @property |
| def site_data_dir(self) -> str: |
| """:return: data directory shared by users, e.g. ``/Library/Application Support/$appname/$version``""" |
| return self._append_app_name_and_version("/Library/Application Support") |
| |
| @property |
| def user_config_dir(self) -> str: |
| """:return: config directory tied to the user, same as `user_data_dir`""" |
| return self.user_data_dir |
| |
| @property |
| def site_config_dir(self) -> str: |
| """:return: config directory shared by the users, same as `site_data_dir`""" |
| return self.site_data_dir |
| |
| @property |
| def user_cache_dir(self) -> str: |
| """:return: cache directory tied to the user, e.g. ``~/Library/Caches/$appname/$version``""" |
| return self._append_app_name_and_version(os.path.expanduser("~/Library/Caches")) |
| |
| @property |
| def site_cache_dir(self) -> str: |
| """:return: cache directory shared by users, e.g. ``/Library/Caches/$appname/$version``""" |
| return self._append_app_name_and_version("/Library/Caches") |
| |
| @property |
| def user_state_dir(self) -> str: |
| """:return: state directory tied to the user, same as `user_data_dir`""" |
| return self.user_data_dir |
| |
| @property |
| def user_log_dir(self) -> str: |
| """:return: log directory tied to the user, e.g. ``~/Library/Logs/$appname/$version``""" |
| return self._append_app_name_and_version(os.path.expanduser("~/Library/Logs")) |
| |
| @property |
| def user_documents_dir(self) -> str: |
| """:return: documents directory tied to the user, e.g. ``~/Documents``""" |
| return os.path.expanduser("~/Documents") |
| |
| @property |
| def user_runtime_dir(self) -> str: |
| """:return: runtime directory tied to the user, e.g. ``~/Library/Caches/TemporaryItems/$appname/$version``""" |
| return self._append_app_name_and_version(os.path.expanduser("~/Library/Caches/TemporaryItems")) |
| |
| |
| __all__ = [ |
| "MacOS", |
| ] |
