Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for lektor/lektor#1143 #371

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updates for lektor/lektor#1143 #371

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions content/docs/api/publisher/publish/contents.lr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ and reports an error.

The parameters to the function are as follows:

* `target_url`: a URL object with the parsed URL. This object comes from the
Werkzeug library and gives access to the individual parts of a URL by the
exposed attributes ([Read about the URL object :ext](https://werkzeug.palletsprojects.com/en/2.0.x/urls/)).
* `target_url`: the target URL as a string.
* `credentials`: an optional dictionary with command line supplied credentials.
Note that these credentials might be completely absent and the keys which are
provided might change with future versions of Lektor.
Expand All @@ -30,6 +28,8 @@ The parameters to the function are as follows:
Each line in the generator must be a string which is then either logged to
the output in the console or in the deploy/publish window in the admin UI.

!! Prior to Lektor version 3.4, the `target_url` parameter was passed an instance of [`werkzeug.urls.URL` :ext](https://werkzeug.palletsprojects.com/en/2.3.x/urls/#werkzeug.urls.URL) rather than a `str`.

## Example

This example implements a simple publisher that just copies all built files
Expand All @@ -38,14 +38,19 @@ into a new location.
```python
import os
import shutil
from urllib.parse import urlsplit
from lektor.publisher import Publisher


class CopyPublisher(Publisher):

def publish(self, target_url, credentials=None, **extra):
# Tip: Coerce target_url to str for compatibility with
# Lektor < 3.4.0 where target_url was a werkzeug.urls.URL
# instance rather than a str
target = urlsplit(str(target_url))
src_path = self.output_path
dst_path = target_url.path
dst_path = target.path
strip = len(src_path) + 1

for path, folders, filenames in os.walk(src_path):
Expand Down