# platformdirs.api.PlatformDirsABC - pydoc - phpman

Help on class PlatformDirsABC in platformdirs.api:

platformdirs.api.PlatformDirsABC = class PlatformDirsABC(abc.ABC)
 |  platformdirs.api.PlatformDirsABC(appname: 'str | None' = None, appauthor: 'str | None | Literal[False]' = None, version: 'str | None' = None, roaming: 'bool' = False, multipath: 'bool' = False, opinion: 'bool' = True)
 |
 |  Abstract base class for platform directories.
 |
 |  Method resolution order:
 |      PlatformDirsABC
 |      abc.ABC
 |      builtins.object
 |
 |  Methods defined here:
 |
 |  __init__(self, appname: 'str | None' = None, appauthor: 'str | None | Literal[False]' = None, version: 'str | None' = None, roaming: 'bool' = False, multipath: 'bool' = False, opinion: 'bool' = True)
 |      Create a new platform directory.
 |
 |      :param appname: See `appname`.
 |      :param appauthor: See `appauthor`.
 |      :param version: See `version`.
 |      :param roaming: See `roaming`.
 |      :param multipath: See `multipath`.
 |      :param opinion: See `opinion`.
 |
 |  ----------------------------------------------------------------------
 |  Readonly properties defined here:
 |
 |  site_config_dir
 |      :return: config directory shared by the users
 |
 |  site_config_path
 |      :return: config path shared by the users
 |
 |  site_data_dir
 |      :return: data directory shared by users
 |
 |  site_data_path
 |      :return: data path shared by users
 |
 |  user_cache_dir
 |      :return: cache directory tied to the user
 |
 |  user_cache_path
 |      :return: cache path tied to the user
 |
 |  user_config_dir
 |      :return: config directory tied to the user
 |
 |  user_config_path
 |      :return: config path tied to the user
 |
 |  user_data_dir
 |      :return: data directory tied to the user
 |
 |  user_data_path
 |      :return: data path tied to the user
 |
 |  user_documents_dir
 |      :return: documents directory tied to the user
 |
 |  user_documents_path
 |      :return: documents path tied to the user
 |
 |  user_log_dir
 |      :return: log directory tied to the user
 |
 |  user_log_path
 |      :return: log path tied to the user
 |
 |  user_runtime_dir
 |      :return: runtime directory tied to the user
 |
 |  user_runtime_path
 |      :return: runtime path tied to the user
 |
 |  user_state_dir
 |      :return: state directory tied to the user
 |
 |  user_state_path
 |      :return: state path tied to the user
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |
 |  __dict__
 |      dictionary for instance variables (if defined)
 |
 |  __weakref__
 |      list of weak references to the object (if defined)
 |
 |  ----------------------------------------------------------------------
 |  Data and other attributes defined here:
 |
 |  __abstractmethods__ = frozenset({'site_config_dir', 'site_data_dir', '...