Mercurial > libervia-backend
annotate doc/make.bat @ 4212:5f2d496c633f
core: get rid of `pickle`:
Use of `pickle` to serialise data was a technical legacy that was causing trouble to store
in database, to update (if a class was serialised, a change could break update), and to
security (pickle can lead to code execution).
This patch remove all use of Pickle in favour in JSON, notably:
- for caching data, a Pydantic model is now used instead
- for SQLAlchemy model, the LegacyPickle is replaced by JSON serialisation
- in XEP-0373 a class `PublicKeyMetadata` was serialised. New method `from_dict` and
`to_dict` method have been implemented to do serialisation.
- new methods to (de)serialise data can now be specified with Identity data types. It is
notably used to (de)serialise `path` of avatars.
A migration script has been created to convert data (for upgrade or downgrade), with
special care for XEP-0373 case. Depending of size of database, this migration script can
be long to run.
rel 443
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 23 Feb 2024 13:31:04 +0100 |
| parents | ce16847a7b6d |
| children |
| rev | line source |
|---|---|
| 2946 | 1 @ECHO OFF |
| 2 | |
| 3 pushd %~dp0 | |
| 4 | |
| 5 REM Command file for Sphinx documentation | |
| 6 | |
| 7 if "%SPHINXBUILD%" == "" ( | |
| 8 set SPHINXBUILD=sphinx-build | |
| 9 ) | |
| 10 set SOURCEDIR=. | |
| 11 set BUILDDIR=.build | |
| 12 | |
| 13 if "%1" == "" goto help | |
| 14 | |
| 15 %SPHINXBUILD% >NUL 2>NUL | |
| 16 if errorlevel 9009 ( | |
| 17 echo. | |
| 18 echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | |
| 19 echo.installed, then set the SPHINXBUILD environment variable to point | |
| 20 echo.to the full path of the 'sphinx-build' executable. Alternatively you | |
| 21 echo.may add the Sphinx directory to PATH. | |
| 22 echo. | |
| 23 echo.If you don't have Sphinx installed, grab it from | |
| 24 echo.http://sphinx-doc.org/ | |
| 25 exit /b 1 | |
| 26 ) | |
| 27 | |
| 28 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% | |
| 29 goto end | |
| 30 | |
| 31 :help | |
| 32 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% | |
| 33 | |
| 34 :end | |
| 35 popd |