Skip to content

Reorder ParameterSource#3248

Merged
Rowlando13 merged 1 commit intopallets:stablefrom
kdeldycke:reorder-parameter-source
Apr 16, 2026
Merged

Reorder ParameterSource#3248
Rowlando13 merged 1 commit intopallets:stablefrom
kdeldycke:reorder-parameter-source

Conversation

@kdeldycke
Copy link
Copy Markdown
Collaborator

This reorder the ParameterSource enum by precedence, as suggested in #2879.

It brings an interesting property of being able to check if a value was explicitly provided with that kind of code:

        source = ctx.get_parameter_source("port")
        if source < click.ParameterSource.DEFAULT_MAP:
            ...  # value was explicitly set

Additionally, this PR:

  • change enum type from generic Enum to IntEnum
  • document the precedence in the Sphinx docs
  • expose ParameterSource to the package root

@kdeldycke kdeldycke changed the title Reorder ParameterSource from most to least explicit Reorder ParameterSource Mar 5, 2026
@kdeldycke kdeldycke force-pushed the reorder-parameter-source branch from c8306cf to 1f42ba5 Compare March 5, 2026 18:54
kdeldycke added a commit to kdeldycke/click-extra that referenced this pull request Mar 5, 2026
@kdeldycke kdeldycke added docs f:parameters feature: input parameter types labels Mar 16, 2026
@kdeldycke kdeldycke added this to the 8.3.3 milestone Mar 16, 2026
@kdeldycke kdeldycke force-pushed the reorder-parameter-source branch 2 times, most recently from d7d41bb to d44d711 Compare April 9, 2026 12:00
@kdeldycke
Copy link
Copy Markdown
Collaborator Author

This PR will need its documentation rewritten from rST to Markdown if #3259 is merged.

@kdeldycke
Copy link
Copy Markdown
Collaborator Author

I intentionally keep this PR in unmergeable state as I am waiting for #3259 to be merge beforehand.

@kdeldycke kdeldycke force-pushed the reorder-parameter-source branch from d44d711 to 4d0a4dd Compare April 16, 2026 08:20
@kdeldycke kdeldycke force-pushed the reorder-parameter-source branch from 4d0a4dd to ac5cec5 Compare April 16, 2026 08:23
@kdeldycke
Copy link
Copy Markdown
Collaborator Author

Now that #3259 has been translated from rST to MyST, I was able to fix the merge conflict. This PR is ready to be merged upstream.

@Rowlando13 Rowlando13 merged commit c7e1ba8 into pallets:stable Apr 16, 2026
12 checks passed
@kdeldycke kdeldycke deleted the reorder-parameter-source branch April 16, 2026 08:30
@kdeldycke kdeldycke linked an issue Apr 16, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs f:parameters feature: input parameter types

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reorder ParameterSource

3 participants