| """macOS.""" |
|
|
| from __future__ import annotations |
|
|
| import os.path |
| import sys |
|
|
| 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``. |
| If we're using a Python binary managed by `Homebrew <https://brew.sh>`_, the directory |
| will be under the Homebrew prefix, e.g. ``/opt/homebrew/share/$appname/$version``. |
| If `multipath <platformdirs.api.PlatformDirsABC.multipath>` is enabled and we're in Homebrew, |
| the response is a multi-path string separated by ":", e.g. |
| ``/opt/homebrew/share/$appname/$version:/Library/Application Support/$appname/$version`` |
| """ |
| is_homebrew = sys.prefix.startswith("/opt/homebrew") |
| path_list = [self._append_app_name_and_version("/opt/homebrew/share")] if is_homebrew else [] |
| path_list.append(self._append_app_name_and_version("/Library/Application Support")) |
| if self.multipath: |
| return os.pathsep.join(path_list) |
| return path_list[0] |
|
|
| @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``. |
| If we're using a Python binary managed by `Homebrew <https://brew.sh>`_, the directory |
| will be under the Homebrew prefix, e.g. ``/opt/homebrew/var/cache/$appname/$version``. |
| If `multipath <platformdirs.api.PlatformDirsABC.multipath>` is enabled and we're in Homebrew, |
| the response is a multi-path string separated by ":", e.g. |
| ``/opt/homebrew/var/cache/$appname/$version:/Library/Caches/$appname/$version`` |
| """ |
| is_homebrew = sys.prefix.startswith("/opt/homebrew") |
| path_list = [self._append_app_name_and_version("/opt/homebrew/var/cache")] if is_homebrew else [] |
| path_list.append(self._append_app_name_and_version("/Library/Caches")) |
| if self.multipath: |
| return os.pathsep.join(path_list) |
| return path_list[0] |
|
|
| @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_downloads_dir(self) -> str: |
| """:return: downloads directory tied to the user, e.g. ``~/Downloads``""" |
| return os.path.expanduser("~/Downloads") |
|
|
| @property |
| def user_pictures_dir(self) -> str: |
| """:return: pictures directory tied to the user, e.g. ``~/Pictures``""" |
| return os.path.expanduser("~/Pictures") |
|
|
| @property |
| def user_videos_dir(self) -> str: |
| """:return: videos directory tied to the user, e.g. ``~/Movies``""" |
| return os.path.expanduser("~/Movies") |
|
|
| @property |
| def user_music_dir(self) -> str: |
| """:return: music directory tied to the user, e.g. ``~/Music``""" |
| return os.path.expanduser("~/Music") |
|
|
| @property |
| def user_desktop_dir(self) -> str: |
| """:return: desktop directory tied to the user, e.g. ``~/Desktop``""" |
| return os.path.expanduser("~/Desktop") |
|
|
| @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")) |
|
|
| @property |
| def site_runtime_dir(self) -> str: |
| """:return: runtime directory shared by users, same as `user_runtime_dir`""" |
| return self.user_runtime_dir |
|
|
|
|
| __all__ = [ |
| "MacOS", |
| ] |
|
|
