o 2g@sdZddlmZddlmZmZddlmZddlm Z ddl m Z e r,ddl Z ddl Z Gd d d eZGd d d eZGd ddeZdS)aToken Manager classes. There should be a 1-to-1 mapping between an instance of a subclass of :class:`.BaseTokenManager` and a :class:`.Reddit` instance. A few proof of concept token manager classes are provided here, but it is expected that PRAW users will create their own token manager classes suitable for their needs. .. deprecated:: 7.4.0 Tokens managers have been deprecated and will be removed in the near future. ) annotations)ABCabstractmethod)Path) TYPE_CHECKING)_deprecate_argsNc@sReZdZdZedddZedddZedd d Zej dd d ZddZ dS)BaseTokenManagerz)An abstract class for all token managers. authorizerprawcore.auth.BaseAuthorizercCdS)azHandle callback that is invoked after a refresh token is used. :param authorizer: The ``prawcore.Authorizer`` instance used containing ``access_token`` and ``refresh_token`` attributes. This function will be called after refreshing the access and refresh tokens. This callback can be used for saving the updated ``refresh_token``. Nselfr r r O/home/garg/my-data/venv/lib/python3.10/site-packages/praw/util/token_manager.pypost_refresh_callback z&BaseTokenManager.post_refresh_callbackcCr )aHandle callback that is invoked before refreshing PRAW's authorization. :param authorizer: The ``prawcore.Authorizer`` instance used containing ``access_token`` and ``refresh_token`` attributes. This callback can be used to inspect and modify the attributes of the ``prawcore.Authorizer`` instance, such as setting the ``refresh_token``. Nr rr r rpre_refresh_callback,rz%BaseTokenManager.pre_refresh_callbackreturn praw.RedditcCs|jS)z@Return the :class:`.Reddit` instance bound to the token manager._redditrr r rreddit8szBaseTokenManager.redditvaluecCs |jdur d}t|||_dS)Nz7'reddit' can only be set once and is done automatically)r RuntimeError)rrmsgr r rr=s  cCs d|_dS)z1Initialize a :class:`.BaseTokenManager` instance.Nrrr r r__init__Ds zBaseTokenManager.__init__Nr r )rr)rr) __name__ __module__ __qualname____doc__rrrpropertyrsetterrr r r rr s     r cs6eZdZdZd fdd Zd dd Zd d d ZZS)FileTokenManageraProvides a single-file based token manager. It is expected that the file with the initial ``refresh_token`` is created prior to use. .. warning:: The same ``file`` should not be used by more than one instance of this class concurrently. Doing so may result in data corruption. Consider using :class:`.SQLiteTokenManager` if you want more than one instance of PRAW to concurrently manage a specific ``refresh_token`` chain. filenamestrcst||_dS)z~Initialize a :class:`.FileTokenManager` instance. :param filename: The file the contains the refresh token. N)superr _filename)rr& __class__r rrXs  zFileTokenManager.__init__r r cCsBt|jd}||jWddS1swYdS)z+Update the saved copy of the refresh token.wN)rr)openwrite refresh_tokenrr fpr r rras"z&FileTokenManager.post_refresh_callbackcCsP|jdur&t|j}||_WddS1swYdSdS)z%Load the refresh token from the file.N)r/rr)r-readstripr0r r rrfs "z%FileTokenManager.pre_refresh_callback)r&r'r)rr r!r"rrr __classcell__r r r*rr%Is  r%csfeZdZdZedddfdd ZddZdd d ZdddZdddZ dddZ dddZ Z S)SQLiteTokenManageraProvides a SQLite3 based token manager. Unlike, :class:`.FileTokenManager`, the initial database need not be created ahead of time, as it'll automatically be created on first use. However, initial refresh tokens will need to be registered via :meth:`.register` prior to use. .. warning:: This class is untested on Windows because we encountered file locking issues in the test environment. databasekeyr'csJtddl}|||_|jd|jd|j||_dS)aInitialize a :class:`.SQLiteTokenManager` instance. :param database: The path to the SQLite database. :param key: The key used to locate the refresh token. This ``key`` can be anything. You might use the ``client_id`` if you expect to have unique a refresh token for each ``client_id``, or you might use a redditor's ``username`` if you're managing multiple users' authentications. rNzACREATE TABLE IF NOT EXISTS tokens (id, refresh_token, updated_at)z)rr@r r r is_registereds z SQLiteTokenManager.is_registeredr r cCs||jd|_dS)z)Update the refresh token in the database.N)rCr/rr r rrs  z(SQLiteTokenManager.post_refresh_callbackcCs|jdusJ||_dS)z)Load the refresh token from the database.N)r/rBrr r rrsz'SQLiteTokenManager.pre_refresh_callbackcCs(|jd|j|f}|j|jdkS)zRegister the initial refresh token in the database. :returns: ``True`` if ``refresh_token`` is saved to the database, otherwise, ``False`` if there is already a ``refresh_token`` for the associated ``key``. z;INSERT OR IGNORE INTO tokens VALUES (?, ?, datetime('now'))r)r:r;r7r<rowcount)rr/r@r r rregisters   zSQLiteTokenManager.register)r6r'r7r')r/r')rrDr)r/r'rrD) rr r!r"rrrBrCrErrrGr4r r r*rr5ms   r5)r" __future__rabcrrpathlibrtypingrrprawcoreprawr r%r5r r r rs    ,$