Skip to content

feature: API checks: Report new positional-or-keyword parameters inserted before other positional-or-keyword parameters #247

Open
@pawamoy

Description

@pawamoy

Is your feature request related to a problem? Please describe.

I noticed in a git-changelog PR that this diff

 class Commit:
     """A class to represent a commit."""

     def __init__(
         self,
         commit_hash: str,
         author_name: str = "",
         author_email: str = "",
         author_date: str | datetime = "",
         committer_name: str = "",
         committer_email: str = "",
         committer_date: str | datetime = "",
         refs: str = "",
+        parent_hashes: str | list[str] = "",
         subject: str = "",
         body: list[str] | None = None,
         url: str = "",
         *,
         parse_trailers: bool = False,
     ):

...does not yield any warning. However the new parameter parent_hashes shifts subject, body and url positional-or-keyword parameters. So it's a breaking change.

Describe the solution you'd like

Report such inserted positional-or-keyword parameters when checking for breaking changes.

Describe alternatives you've considered

/

Additional context

/

Metadata

Metadata

Assignees

Labels

featureNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions