factory docs upd

This commit is contained in:
AF 2022-11-22 12:26:30 +00:00
parent b9c83d13f2
commit b34aae1051

View File

@ -54,7 +54,9 @@ class LineRequest(Request):
class KVFactory:
"""note: unstable signature."""
"""this class is for working with already normalised data values, not for data transformation (e.g. reducing keys to a common form).
that functionality may be added in the future, though, probably, only for custom DbConnection implementations.
note: unstable signature."""
__slots__ = ()
@ -216,7 +218,7 @@ class DbConnection:
def __init__(
self,
parametres: 'DbParametres',
parametres: DbParametres,
/
) -> None:
self.__kvfactory = parametres.kvfactory
@ -511,10 +513,10 @@ intended for heavy tasks."""
await self._initialize_running()
@classmethod
async def create(cls, parametres: 'DbParametres', /) -> 'DbConnection':
async def create(cls, parametres: DbParametres, /) -> 'DbConnection':
"""connect to the factory.
note: unstable signature."""
dbconnection = DbConnection(parametres)
dbconnection = cls(parametres)
await dbconnection._initialize()
return dbconnection