mir/pyrogram
2
0
Fork 0
mirror of https://github.com/pyrogram/pyrogram synced 2025-08-28 21:07:59 +00:00
Code Issues Releases Wiki Activity

Small rewords

Browse Source
This commit is contained in:
Dan 2019-06-20 16:12:14 +02:00
parent 83900f398f
commit 11b4b947ac
2 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/faq.rst
View File

@ -255,7 +255,7 @@ UnicodeEncodeError: '<encoding>' codec can't encode …
Where ``<encoding>`` might be *ascii*, *cp932*, *charmap* or anything else other than **utf-8**. This error usually Where ``<encoding>`` might be *ascii*, *cp932*, *charmap* or anything else other than **utf-8**. This error usually
shows up when you try to print something and has very little to do with Pyrogram itself as it is strictly related to shows up when you try to print something and has very little to do with Pyrogram itself as it is strictly related to
your own terminal. To fix it, either find a way to change the encoding settings of your terminal to UTF-8 or switch to a your own terminal. To fix it, either find a way to change the encoding settings of your terminal to UTF-8 or switch to a
better one. better terminal altogether.
My verification code expires immediately! My verification code expires immediately!
----------------------------------------- -----------------------------------------

24
docs/source/topics/storage-engines.rst
View File

@ -31,7 +31,7 @@ File Storage
^^^^^^^^^^^^ ^^^^^^^^^^^^
This is the most common storage engine. It is implemented by using **SQLite**, which will store the session and peers This is the most common storage engine. It is implemented by using **SQLite**, which will store the session and peers
details. The database will be saved to disk as a single portable file and is designed to efficiently save and retrieve details. The database will be saved to disk as a single portable file and is designed to efficiently store and retrieve
peers whenever they are needed. peers whenever they are needed.
To use this type of engine, simply pass any name of your choice to the ``session_name`` parameter of the To use this type of engine, simply pass any name of your choice to the ``session_name`` parameter of the
@ -51,7 +51,7 @@ session database will be automatically loaded.
Memory Storage Memory Storage
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
In case you don't want to have any session file saved on disk, you can use an in-memory storage by passing the special In case you don't want to have any session file saved to disk, you can use an in-memory storage by passing the special
session name "**:memory:**" to the ``session_name`` parameter of the :obj:`~pyrogram.Client` constructor: session name "**:memory:**" to the ``session_name`` parameter of the :obj:`~pyrogram.Client` constructor:
.. code-block:: python .. code-block:: python
@ -61,16 +61,12 @@ session name "**:memory:**" to the ``session_name`` parameter of the :obj:`~pyro
with Client(":memory:") as app: with Client(":memory:") as app:
print(app.get_me()) print(app.get_me())
This database is still backed by SQLite, but exists purely in memory. However, once you stop a client, the entire This storage engine is still backed by SQLite, but the database exists purely in memory. This means that, once you stop a
database is discarded and the session details used for logging in again will be lost forever. client, the entire database is discarded and the session details used for logging in again will be lost forever.
Session Strings Session Strings
--------------- ---------------
Session strings are useful when you want to run authorized Pyrogram clients on platforms like
`Heroku <https://www.heroku.com/>`_, where their ephemeral filesystems makes it much harder for a file-based storage
engine to properly work as intended.
In case you want to use an in-memory storage, but also want to keep access to the session you created, call In case you want to use an in-memory storage, but also want to keep access to the session you created, call
:meth:`~pyrogram.Client.export_session_string` anytime before stopping the client... :meth:`~pyrogram.Client.export_session_string` anytime before stopping the client...
@ -81,8 +77,8 @@ In case you want to use an in-memory storage, but also want to keep access to th
with Client(":memory:") as app: with Client(":memory:") as app:
print(app.export_session_string()) print(app.export_session_string())
...and save the resulting string somewhere. You can use this string as session name the next time you want to login ...and save the resulting (quite long) string somewhere. You can use this string as session name the next time you want
using the same session; the storage used will still be completely in-memory: to login using the same session; the storage used will still be completely in-memory:
.. code-block:: python .. code-block:: python
@ -93,3 +89,11 @@ using the same session; the storage used will still be completely in-memory:
with Client(session_string) as app: with Client(session_string) as app:
print(app.get_me()) print(app.get_me())
Session strings are useful when you want to run authorized Pyrogram clients on platforms like
`Heroku <https://www.heroku.com/>`_, where their ephemeral filesystems makes it much harder for a file-based storage
engine to properly work as intended.
But, why is the session string so long? Can't it be shorter? No, it can't. The session string already packs the bare
minimum data Pyrogram needs to successfully reconnect to an authorized session, and the 2048-bits auth key is the major
contributor to the overall length. Needless to repeat that this string, as well as any other session storage, represent
strictly personal data. Keep them safe.