Feature: complete lifecycle signals and documentation #1147

noirbizarre · 2022-06-20T20:51:12Z

Pull Request Check List

A news fragment is added in news/ describing what is new.
Test cases added for changed code.

Describe what you have changed in this PR.

This PR follows #1127 and adds the following:

signals:
- pre_publish executed before publishing
- post_publish executed before publishing
- pre_script executed before each script execution (runs multiple times in case of composite script)
- post_script executed after each script execution (runs multiple times in case of composite script)
- pre_run executed once before a run (run only once in case of composite script)
- post_run executed once after a run (run only once in case of composite script)
commands:
- new: just because I documented if and it wasn't existing (I'm also rust/cargo user, I bootstrap project with it)
documentation:
- a new dedicated Lifecycle and hooks section with detailled lifecycle documentation with flow charts
- update/re-lock doc dependencies (to benefit from latest mermaid)

As it's documentation, as there as been changes since I started writting it (at least the cli reference), there might have some typos and inconsistencies to fix.

It was interesting digging into the commands and the lifecycle. I think some good additions for could be:

pre/post_upload hooks
more plugin docs on signals (I might do a PR)
centralize all signals registeration into hooks.py for clarity and ease of maintainance
link commands to their CLI reference instead of the chapter showcasing its usage (page was added during the contribution)

Note: I made a single PR because to me everything is related but I can split into multiple PRs if required

…tion

noirbizarre · 2022-06-20T21:08:50Z

The failing test is also failing on dev locally. I believe this is a flaky test depending on the current PyPI status.
I didn't had time to check why precisely it is failing

docs/docs/usage/hooks.md

pdm/cli/commands/new.py

frostming · 2022-06-21T04:40:45Z

The failing test is also failing on dev locally.

dev branch runs well locally here.

tests/cli/test_hooks.py

frostming · 2022-06-21T13:36:59Z

pre/post_upload hooks

No, just enough hooks :P

more plugin docs on signals (I might do a PR)

Good.

centralize all signals registration into hooks.py for clarity and ease of maintenance

Agree

link commands to their CLI reference instead of the chapter showcasing its usage (page was added during the contribution)

Good

noirbizarre · 2022-06-21T14:19:55Z

Updated with the comments taken in account (changed some links format, removed the new command and its documentation)
I also removed the lock update (which seemed to be the issue, the test was seeing both a tar.gz and a wheel).

pre/post_upload hooks

No, just enough hooks :P

Noted 😅

more plugin docs on signals (I might do a PR)

Good.

I have some plugin idea I'd like to try, that will be a good opportunity to do it (and dogfooding it at the same time)

centralize all signals registration into hooks.py for clarity and ease of maintenance

Agree

OK, will do 👍🏼

link commands to their CLI reference instead of the chapter showcasing its usage (page was added during the contribution)

Good

Done ✅

codecov-commenter · 2022-06-21T23:18:21Z

Codecov Report

Merging #1147 (d42ccd7) into dev (c80b7ff) will increase coverage by 0.15%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##              dev    #1147      +/-   ##
==========================================
+ Coverage   84.39%   84.54%   +0.15%     
==========================================
  Files          80       80              
  Lines        7075     7086      +11     
  Branches     1681     1683       +2     
==========================================
+ Hits         5971     5991      +20     
+ Misses        737      730       -7     
+ Partials      367      365       -2

Flag	Coverage Δ
unittests	`84.32% <100.00%> (+0.15%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
pdm/cli/commands/build.py	`84.61% <ø> (-2.06%)`	⬇️
pdm/cli/commands/lock.py	`100.00% <ø> (ø)`
pdm/cli/commands/init.py	`100.00% <100.00%> (ø)`
pdm/cli/commands/install.py	`90.00% <100.00%> (-0.91%)`	⬇️
pdm/cli/commands/publish/__init__.py	`86.25% <100.00%> (+0.53%)`	⬆️
pdm/cli/commands/run.py	`90.95% <100.00%> (+0.37%)`	⬆️
pdm/cli/hooks.py	`100.00% <100.00%> (ø)`
pdm/signals.py	`100.00% <100.00%> (ø)`
pdm/installers/synchronizers.py	`86.26% <0.00%> (+3.86%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c80b7ff...d42ccd7. Read the comment docs.

frostming

Hi, I reviewed the content of the new documentation page and left some comments.

docs/docs/usage/hooks.md

…cise test echos

frostming

LGTM, @pawamoy any to add?

pawamoy

Awesome docs 🙂

noirbizarre · 2022-06-22T14:46:20Z

Thx 🙏🏼
Awesome tool so I'm glad to be able to contribute !
LGTM, whenever you want (and whoever has permissions) !

* feat(hooks): Added pre-publish hook * refactor(hooks): dynamic signal/hooks listing avoiding double declaration * feat(hooks): added (pre|post)_script and (pre|post)_run hooks * doc(hooks): added lifecycle and hooks documentation * review fix * fix(tests): add and use the _echo fixture for cross-plateform and concise test echos * refactor(hooks): automatically register the script handler for all hooks

* feat(core): Use tomllib on Python 3.11 (#1072) * docs: 📝 Fix typo in `pip install pdm` description (#1061) * Use tomllib on Python 3.11 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * news * use a compatibility module * missed one import Co-authored-by: t106362512 <33215526+t106362512@users.noreply.github.com> Co-authored-by: hauntsaninja <> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * feat(core): Replace halo, click, and termcolor with rich (#1091) * feat(core): Use `unearth` as the backend to find and download packages (#1096) * perf(resolver): Speed up the resolution with lazy find_matches (#1098) * Improve the output of installing packages * Use confirm instead of ask * feat(core): New command: pdm publish (#1107) * Use rich handler for logging to stderr * feat(scripts): added composite tasks support (#1117) * feat(core): Add option to skip hooks (#1127) * fix(scripts): allow pdm test command to receive path arguments * feat(hooks): added a `--skip` option to skipp scripts and hooks (#1127) fix #948 * feat(hooks): use PDM_SKIP_HOOKS environement variable as fallback for skip list * feat(core): Support setup.py import (#1137) * Update completion script * fix(resolution): fix a bug that versions with local part can't be found and installed Close #1093 * feat(core): forbid editable depenencies in project table (#1140) * Make the error message more friendly * doc: improve the docs about dependencies * doc: add CLI reference doc * doc: use asciiart as the program description * chore: remove remaining artifacts from #1127 (#1152) * Feature: complete lifecycle signals and documentation (#1147) * feat(hooks): Added pre-publish hook * refactor(hooks): dynamic signal/hooks listing avoiding double declaration * feat(hooks): added (pre|post)_script and (pre|post)_run hooks * doc(hooks): added lifecycle and hooks documentation * review fix * fix(tests): add and use the _echo fixture for cross-plateform and concise test echos * refactor(hooks): automatically register the script handler for all hooks * feat: Update pdm-pep517 to 1.0 (#1153) * fix(scripts): merge the Script and Description field from listing (#1151) * feat: fetch the candidate hashes concurrently (#1154) * feat: fetch the candidate hashes concurrently * add news * Feat/respect-source-order (#1155) * doc: restructure the docs about project metadata and build configuration * parse pep 621 metadata to avoid build (#1156) * feat: Remove the compatible support for pdm legacy metadata (#1157) * fix(config): use platform standard directories for all PDM directories (#1161) Fixes #1150 * fix(#1156): only trust parsing result when all are static * New build configuration table * chore: added a tox.ini file for easier local testing against all Python versions (#1160) * feat(CLI): Yarn-like root scripts fallback (#1159) * feat(hooks): added a post_use hook (#1163) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com> Co-authored-by: t106362512 <33215526+t106362512@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Axel H <noirbizarre@users.noreply.github.com>

* feat(hooks): Added pre-publish hook * refactor(hooks): dynamic signal/hooks listing avoiding double declaration * feat(hooks): added (pre|post)_script and (pre|post)_run hooks * doc(hooks): added lifecycle and hooks documentation * review fix * fix(tests): add and use the _echo fixture for cross-plateform and concise test echos * refactor(hooks): automatically register the script handler for all hooks

noirbizarre added 2 commits June 20, 2022 18:20

feat(hooks): Added pre-publish hook

03aa077

refactor(hooks): dynamic signal/hooks listing avoiding double declara…

e0a331d

…tion

noirbizarre added a commit to noirbizarre/pdm that referenced this pull request Jun 20, 2022

chore: added pdm-project#1147 changelog entry

e74b2e0

pawamoy reviewed Jun 20, 2022

View reviewed changes

docs/docs/usage/hooks.md Outdated Show resolved Hide resolved

pawamoy reviewed Jun 20, 2022

View reviewed changes

docs/docs/usage/hooks.md Outdated Show resolved Hide resolved

pawamoy reviewed Jun 20, 2022

View reviewed changes

docs/docs/usage/hooks.md Outdated Show resolved Hide resolved

frostming reviewed Jun 21, 2022

View reviewed changes

pdm/cli/commands/new.py Outdated Show resolved Hide resolved

feat(hooks): added (pre|post)_script and (pre|post)_run hooks

1b653d4

noirbizarre force-pushed the feature/lifecycle branch from e74b2e0 to 58d4801 Compare June 21, 2022 11:24

frostming reviewed Jun 21, 2022

View reviewed changes

tests/cli/test_hooks.py Outdated Show resolved Hide resolved

noirbizarre force-pushed the feature/lifecycle branch 4 times, most recently from 0efaf8b to b05bf5b Compare June 21, 2022 18:01

frostming requested changes Jun 22, 2022

View reviewed changes

noirbizarre added 4 commits June 22, 2022 11:23

doc(hooks): added lifecycle and hooks documentation

6555084

review fix

91bd436

fix(tests): add and use the _echo fixture for cross-plateform and con…

38e31b9

…cise test echos

refactor(hooks): automatically register the script handler for all hooks

9bdbae7

noirbizarre force-pushed the feature/lifecycle branch from 7bbc16f to 9bdbae7 Compare June 22, 2022 09:23

frostming approved these changes Jun 22, 2022

View reviewed changes

pawamoy approved these changes Jun 22, 2022

View reviewed changes

frostming merged commit c3541ba into pdm-project:dev Jun 22, 2022

noirbizarre deleted the feature/lifecycle branch June 22, 2022 16:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: complete lifecycle signals and documentation #1147

Feature: complete lifecycle signals and documentation #1147

noirbizarre commented Jun 20, 2022 •

edited

Loading

noirbizarre commented Jun 20, 2022

frostming commented Jun 21, 2022

frostming commented Jun 21, 2022

noirbizarre commented Jun 21, 2022

codecov-commenter commented Jun 21, 2022 •

edited

Loading

frostming left a comment •

edited

Loading

frostming left a comment

pawamoy left a comment

noirbizarre commented Jun 22, 2022

Feature: complete lifecycle signals and documentation #1147

Feature: complete lifecycle signals and documentation #1147

Conversation

noirbizarre commented Jun 20, 2022 • edited Loading

Pull Request Check List

Describe what you have changed in this PR.

noirbizarre commented Jun 20, 2022

frostming commented Jun 21, 2022

frostming commented Jun 21, 2022

noirbizarre commented Jun 21, 2022

codecov-commenter commented Jun 21, 2022 • edited Loading

Codecov Report

frostming left a comment • edited Loading

Choose a reason for hiding this comment

frostming left a comment

Choose a reason for hiding this comment

pawamoy left a comment

Choose a reason for hiding this comment

noirbizarre commented Jun 22, 2022

noirbizarre commented Jun 20, 2022 •

edited

Loading

codecov-commenter commented Jun 21, 2022 •

edited

Loading

frostming left a comment •

edited

Loading