Lektor

Features

Command Line

- Enabled the [Jinja debug extension][jinja-dbg-ext] when the
`LEKTOR_DEV` env var is set to 1 and `lektor server` is
used. ([984][])

License

- The wording in the LICENSE file was standardized to that of the
current [BSD 3-Clause License][bsd]. ([972][])

Bugs

Markdown Renderer

- Fix overzealous HTML-entity escaping of link and image attributes. ([989][])

Admin API

- Fix a bug in `make_editor_session` when editing non-existant pages
with a non-primary alt. ([964][])
- Fix the ability to add an initial flowblock to a page. (Broken in 3.3.1.)
- Refactor API views to move business logic back into the `Tree`
adapter ([967][]). This fixes [962][].

Admin UI

- Changed the structure of the URLs used by the GUI single-page app ([976][]).
This fixes problems with the "edit" pencil when using alternatives ([975][]),
and issues when page ids include colons ([610][]).
- Other React refactors and fixes ([988][]).

Database

- Fix `Attachment.url_path` when _alternatives_ are in use. There is only
one copy of each attachment emitted — the `url_path` should always be
that corresponding to the _primary alternative_. ([958][])
- `Pad.get`, if not passed an explicit value for the `alt` parameter,
now returns the record for the _primary alternative_ rather than the
fallback record. Similarly, `Pad.root` now returns the root record
for the _primary alternative_. ([958][], [965][])
- Fix for uncaught `OSError(error=EINVAL)` on Windows when `Pad.get`
was called with a path containing characters which are not allowed
in Windows filenames (e.g. `<>*?|\/":`).

Builder

- Pages now record a build dependency on their datamodel `.ini` file.
- Fix sqlite version detection so that we use "without rowid" optimization
with current versions of sqlite. ([1002][])

Command Line

- When running `lektor dev new-theme`: fix check for ability to create symlinks
under Windows. ([996][])
- Fix _rsync_ publisher when deletion enabled on macOS. ([946][], [954][])

Tests

- Fix for test failures when git is not installed. ([998][], [1000][])

Refactorings

- Cleaned up `EditorSession` to split mapping methods (for access to
record data) to a separate class, now available as
`EditorSession.data`. ([969][])

Testing

- Cleaned up and moved our `pylint` and `coverage` configuration to
`pyproject.toml`. ([990][], [991][])

Admin UI

- Move frontend source from `lektor/admin/static/` to `frontend/`.
Compiled frontend code moved from `lektor/admin/static/gen/` to
'lektor/admin/static/`. ([1003][])

Packaging

- Omit `example` subdirectory, frontend source code, developer-centric
config files, as well as other assorted cruft from sdist. ([986][])

[bsd]: https://opensource.org/licenses/BSD-3-Clause
[610]: https://github.com/lektor/lektor/issues/610
[946]: https://github.com/lektor/lektor/issues/946
[954]: https://github.com/lektor/lektor/pull/954
[958]: https://github.com/lektor/lektor/pull/958
[962]: https://github.com/lektor/lektor/issues/962
[964]: https://github.com/lektor/lektor/pull/964
[965]: https://github.com/lektor/lektor/issues/965
[967]: https://github.com/lektor/lektor/pull/967
[969]: https://github.com/lektor/lektor/pull/969
[972]: https://github.com/lektor/lektor/pull/972
[975]: https://github.com/lektor/lektor/issues/975
[976]: https://github.com/lektor/lektor/pull/976
[984]: https://github.com/lektor/lektor/pull/984
[986]: https://github.com/lektor/lektor/pull/986
[988]: https://github.com/lektor/lektor/pull/988
[989]: https://github.com/lektor/lektor/pull/989
[990]: https://github.com/lektor/lektor/pull/990
[991]: https://github.com/lektor/lektor/pull/991
[996]: https://github.com/lektor/lektor/pull/996
[998]: https://github.com/lektor/lektor/issues/998
[1000]: https://github.com/lektor/lektor/pull/1000
[1002]: https://github.com/lektor/lektor/pull/1002
[1003]: https://github.com/lektor/lektor/pull/1003
[jinja-dbg-ext]: https://jinja.palletsprojects.com/en/latest/extensions/#debug-extension

Bugs Fixed

- Fixed an import cycle which caused in `ImportError` if
`lektor.types` was imported before `lektor.environemnt`. [974][]

Deprecations

- Disuse deprecated `Thread.setDaemon()`. [979][]

Admin UI

- Fix spastic scroll behavior when editing flow elements. [640][]
- Fix admin GUI when page contains an unknown flowblock type. [968][]
- Fix admin GUI layout on mobile devices. [981][]

Tests

- Increased timeout in `test_watcher.IterateInThread` to prevent
random spurious failures during CI testing.
- Fix `tests/test_prev_next_sibling.py` so as to allow running
multiple test runs in parallel.
- Use per-testenv coverage files to prevent contention when running `tox --parallel`.
- Mark tests that require a working internet connections with pytest mark `requiresinternet`. [983][]

Refactors

Admin UI

- Finish rewriting React class-based components to function-based components. [977][]
- Finish adding types for all API endpoints. [980][]
- Remove disused event-source polyfill.

[640]: https://github.com/lektor/lektor/issues/640
[968]: https://github.com/lektor/lektor/issues/968
[974]: https://github.com/lektor/lektor/pull/974
[977]: https://github.com/lektor/lektor/pull/977
[979]: https://github.com/lektor/lektor/pull/979
[980]: https://github.com/lektor/lektor/pull/980
[981]: https://github.com/lektor/lektor/pull/981
[983]: https://github.com/lektor/lektor/pull/983

This release drops support for versions of Python before 3.6.
In particular, Python 2.7 is no longer supported.

Quite a few bugs have been fixed since the previous release.

The Admin UI has seen a major refactor and various performance optimisations.
It has been rewritten in Typescript, and updated to use v5 of the Bootstrap CSS framework.

Bugs Fixed

Database

- Fix queries with offset but without a limit. [827][]
- Fix the handling of deferred (descriptor-type) model fields when used in `slug_format`
and when used as a sort key. [789][]
- Refrain from issuing warning about future change in implicit image
upscaling behavior in cases that do not involve upscaling. [885][]
- Fix bug with translation fallback of record label. [897][]

Data Modelling

- Fixed pagination issue which caused child-less paginated pages to
not be built. [952][]

Publisher

- Allow rsync deployment to a local path. [830][]
- Clean up subprocess handling in `lektor.publisher`. This fixes
"ResourceWarning: unclosed file" warnings which were being emitted
when using the rsync publisher, as well as possible other
buglets. [896][]

Command Line

- Fix circular imports in `lektor.cli` to allow its use as an executable module (`python -m lektor.cli`).
[682][], [856][]
- Fall back to `watchdog` `PollingObserver` if default `Observer` type fails to start.
This fixes "OSError: inotify watch limit reached" and perhaps other similar failures.
[861][], [886][]

Plugins

- Fix the `Plugin.emit` method so that it works. [859][]
- Reword the (previously incomprehensible) exception message emitted
when attempting to load a plugin from an improperly named
distribution. [875][], [879][]

Build System

- Fix bug in `lektor.sourcesearch.find_files` which was causing intermittent exceptions.
[895][], [897][]

Miscellaneous

- Fix reference cycle in `Environment`. [882][]
- Fix "unclosed file" `ResourceWarning`s. [898][]

Admin UI

- Fix the checkboxes widget. They were broken so as to be uncheckable. [812][], [817][]
- Fix page data being incorrectly marked as _changed_ when flow block is expanded/collapsed in the edit UI. [828][], [842][]
- Fix encoding of URLs when opening the admin UI from the pencil button. [815][], [837][]
- Rename a CSS class in the admin UI to prevent breakage by ad blockers.
The class `add-block` was being blocked by the _EasyList FR_ ad blocker. [785][], [841][]
- Relax URL checking to allow all valid URLs in URL fields. [793][], [840][], [864][]
- Preview iframe was not always updating when it should. [844][], [846][]
- Make the "Save" button always visible (without need to scroll on long pages). [43][], [870][]
- Disable the "Save" button unless there are changes. [872][]
- Add "&lt;ctl&gt;-e" hotkey shortcut to edit page. [876][]
- Update UI to Bootstrap v4. (This fixes a layout issue with the date picker.) [648][], [884][]
- Fix edit page failure for select and checkbox widgets with no choices. [890][], [900][]
- Update UI to Bootstrap v5. [917][], [926][]
- Add missing translation strings, show error dialogs on top of other dialogs [934][].

Internal changes

Python code

- Drop python 2 compatibility. [822][], [850][], [871][], [920][], [922][]
- Drop python 3.5 compatibility. [878][], [880][]
- Support python 3.10. [938][]
- Switch to [PEP-518][]-compatible (pyproject.toml) build process. [933][], [942][]
- Code beautification/reformatting. We now use [black][], [reorder-python-imports][], [flake8][], _and_ [pylint][].
[823][], [916][], [925][], [936][]
- Refactor rsync publisher tests. [836][]
- Restructure code to prevent circular imports. [856][], [871][], [873][]
- Minor docstring fixes. [874][]
- Enabled pylint's no-self-use policy. [887][]

JS code

- We now require node >= 14. [940][]
- Update NPM/JS dependencies. Update to webpack v5. [816][],
[834][], [848][], [852][], [860][], [905][], [917][],
[926][], [945][], [957][]
- Use [prettier][] and [eslint][] for JS (and YAML) beautification and style enforcement. [825][], [936][]
- Disuse unmaintained `jsdomify` to prevent hanging tests. [839][]
- Disuse jQuery. [851][]
- Convert JS code to Typescript. Various other refactoring and cleanups. [857][], [869][], [872][]
- Refactor code to handle hotkeys. [876][]

Dependencies

- Relax `werkzeug<1` to `werkzeug<3`. [829][], [833][], [911][], [923][]
- Drop support for Python 2. [818][], [819][]
- We now require `Jinja2>=3.0`. [921][]

Testing/CI

- Use `tox` for local testing. [824][]
- Pin version of `pylint` used for tests. [891][]
- Complete rewrite of the tests for `lektor.pluginsystem` to increase coverage and reduce running time.
[881][].
- Test under Python 3.9. [845][]
- Test under Node v14 and v16. [852][], [927][]
- Do not run `brew update` in MacOS CI workflow. [853][]
- CI workflow simplification. [927][]

[black]: https://black.readthedocs.io/en/stable/
[pylint]: https://pylint.org/
[reorder-python-imports]: https://github.com/asottile/reorder_python_imports
[flake8]: https://flake8.pycqa.org/en/latest/
[prettier]: https://prettier.io/
[eslint]: https://eslint.org/
[pep-518]: https://www.python.org/dev/peps/pep-0518/
[43]: https://github.com/lektor/lektor/issues/43
[648]: https://github.com/lektor/lektor/issues/648
[682]: https://github.com/lektor/lektor/issues/682
[785]: https://github.com/lektor/lektor/issues/785
[789]: https://github.com/lektor/lektor/pull/789
[793]: https://github.com/lektor/lektor/issues/793
[812]: https://github.com/lektor/lektor/issues/812
[815]: https://github.com/lektor/lektor/issues/815
[816]: https://github.com/lektor/lektor/pull/816
[817]: https://github.com/lektor/lektor/pull/817
[818]: https://github.com/lektor/lektor/issues/818
[819]: https://github.com/lektor/lektor/pull/819
[822]: https://github.com/lektor/lektor/pull/822
[823]: https://github.com/lektor/lektor/pull/823
[824]: https://github.com/lektor/lektor/pull/824
[825]: https://github.com/lektor/lektor/pull/825
[827]: https://github.com/lektor/lektor/pull/827
[828]: https://github.com/lektor/lektor/issues/828
[829]: https://github.com/lektor/lektor/issues/829
[830]: https://github.com/lektor/lektor/pull/830
[833]: https://github.com/lektor/lektor/pull/833
[834]: https://github.com/lektor/lektor/pull/834
[836]: https://github.com/lektor/lektor/pull/836
[837]: https://github.com/lektor/lektor/pull/837
[839]: https://github.com/lektor/lektor/pull/839
[840]: https://github.com/lektor/lektor/pull/840
[841]: https://github.com/lektor/lektor/pull/841
[842]: https://github.com/lektor/lektor/pull/842
[844]: https://github.com/lektor/lektor/issues/844
[845]: https://github.com/lektor/lektor/pull/845
[846]: https://github.com/lektor/lektor/pull/846
[848]: https://github.com/lektor/lektor/pull/848
[850]: https://github.com/lektor/lektor/pull/850
[851]: https://github.com/lektor/lektor/pull/851
[852]: https://github.com/lektor/lektor/pull/852
[853]: https://github.com/lektor/lektor/pull/853
[856]: https://github.com/lektor/lektor/pull/856
[857]: https://github.com/lektor/lektor/pull/857
[859]: https://github.com/lektor/lektor/pull/859
[860]: https://github.com/lektor/lektor/pull/860
[861]: https://github.com/lektor/lektor/issues/861
[864]: https://github.com/lektor/lektor/pull/864
[869]: https://github.com/lektor/lektor/pull/869
[870]: https://github.com/lektor/lektor/pull/870
[871]: https://github.com/lektor/lektor/pull/871
[872]: https://github.com/lektor/lektor/pull/872
[873]: https://github.com/lektor/lektor/pull/873
[874]: https://github.com/lektor/lektor/pull/874
[875]: https://github.com/lektor/lektor/pull/875
[876]: https://github.com/lektor/lektor/pull/876
[878]: https://github.com/lektor/lektor/issues/878
[879]: https://github.com/lektor/lektor/pull/879
[880]: https://github.com/lektor/lektor/pull/880
[881]: https://github.com/lektor/lektor/pull/881
[882]: https://github.com/lektor/lektor/pull/882
[884]: https://github.com/lektor/lektor/pull/884
[885]: https://github.com/lektor/lektor/pull/885
[886]: https://github.com/lektor/lektor/pull/886
[887]: https://github.com/lektor/lektor/pull/887
[890]: https://github.com/lektor/lektor/issues/890
[891]: https://github.com/lektor/lektor/pull/891
[895]: https://github.com/lektor/lektor/issues/895
[896]: https://github.com/lektor/lektor/pull/896
[897]: https://github.com/lektor/lektor/pull/897
[898]: https://github.com/lektor/lektor/pull/898
[900]: https://github.com/lektor/lektor/pull/900
[905]: https://github.com/lektor/lektor/pull/905
[911]: https://github.com/lektor/lektor/pull/911
[916]: https://github.com/lektor/lektor/pull/916
[917]: https://github.com/lektor/lektor/pull/917
[920]: https://github.com/lektor/lektor/pull/920
[921]: https://github.com/lektor/lektor/pull/921
[922]: https://github.com/lektor/lektor/pull/922
[923]: https://github.com/lektor/lektor/pull/923
[925]: https://github.com/lektor/lektor/pull/925
[926]: https://github.com/lektor/lektor/pull/926
[927]: https://github.com/lektor/lektor/pull/927
[933]: https://github.com/lektor/lektor/pull/933
[934]: https://github.com/lektor/lektor/pull/934
[936]: https://github.com/lektor/lektor/pull/936
[938]: https://github.com/lektor/lektor/pull/938
[940]: https://github.com/lektor/lektor/pull/940
[942]: https://github.com/lektor/lektor/pull/942
[945]: https://github.com/lektor/lektor/pull/945
[952]: https://github.com/lektor/lektor/pull/952
[957]: https://github.com/lektor/lektor/pull/957

Compatibility

- Restore python 2.7 compatibility. It was broken in leketor 3.2.2. [951][]
- Pin inifile>=0.4.1 to support python 3.10 [943][], [953][]

[943]: https://github.com/lektor/lektor/issues/943
[951]: https://github.com/lektor/lektor/pull/951
[953]: https://github.com/lektor/lektor/pull/953

Packaging

- Fixes a problem with the uploaded wheel in 3.2.1.

Compatibility

- Fixes to support werkzeug 2.x. [911][]

Compatibility

- Pin `pytest-click<1` for python 2.7. [924][]
- Fixes to support werkzeug 1.x. [833][]

Bugs

- Allow rsync deployment to a local path. [830][], [836][]
- Fix queries with offset but without a limit. [827][]

Admin UI

- Fix select and checkboxes widgets when choices is empty. [900][]
- Update npm packages. [848][], [834][], [816][]
- Fix updating of the preview iframe. [846][]
- Allow `ftps:` and `mailto:` URLs in url fields. [840][]
- Fix the toggling of flow widgets in the admin UI to not mark the content as changed. [842][]
- Rename CSS class to prevent conflict with EasyList FR adblock list. [841][]
- Fix the handling of the URLs when opening the admin UI from the pencil button. [837][]
- Fix the checkboxes widget in the admin UI. [817][]

Testing / CI

- Test under python 3.9. [845][]
- Various CI test fixes. [932][], [839][], [832][], [826][]
- Added a `tox.ini`. [824][]

Code Reformatting

- Blackify, reorder-python-imports, flake8. [823][]
- Reformatted js code with prettier. [825][]
- Update pylint config. [822][]

[826]: https://github.com/lektor/lektor/pull/826
[832]: https://github.com/lektor/lektor/pull/832
[924]: https://github.com/lektor/lektor/pull/924
[932]: https://github.com/lektor/lektor/pull/932