Mercurial: CONTRIBUTING@09f3a6790e56 (annotated)

interfaces: add the optional `bdiff.xdiffblocks()` method PyCharm flagged where this was called on the protocol class in `mdiff.py` in the previous commit, but pytype completely missed it. PyCharm is correct here, but I'm committing this separately to highlight this potential problem- some of the implementations don't implement _all_ of the methods the others do, and there's not a great way to indicate on a protocol class that a method or attribute is optional- that's kinda the opposite of what static typing is about. Making the method an `Optional[Callable]` attribute works here, and keeps both PyCharm and pytype happy, and the generated `mdiff.pyi` and `modules.pyi` look reasonable. We might be getting a little lucky, because the method isn't invoked directly- it is returned from another method that selects which block function to use. Except since it is declared on the protocol class, every module needs this attribute (in theory, but in practice this doesn't seem to be checked), so the check for it on the module has to change from `hasattr()` to `getattr(..., None)`. We defer defining the optional attrs to the type checking phase as an extra precaution- that way it isn't an attr with a `None` value at runtime if someone is still using `hasattr()`. As to why pytype missed this, I have no clue. The generated `mdiff.pyi` even has the global variable typed as `bdiff: intmod.BDiff`, so uses of it really should comply with what is on the class, protocol class or not.

30084 a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	1	Our full contribution guidelines are in our wiki, please see:
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	2
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	3	https://www.mercurial-scm.org/wiki/ContributingChanges
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	4
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	5	If you just want a checklist to follow, you can go straight to
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	6
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	7	https://www.mercurial-scm.org/wiki/ContributingChanges#Submission_checklist
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	8
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	9	If you can't run the entire testsuite for some reason (it can be
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	10	difficult on Windows), please at least run `contrib/check-code.py` on
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	11	any files you've modified and run `python contrib/check-commit` on any
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	12	commits you've made (for example, `python contrib/check-commit
a492610a2fc1 contributing: add new file with a pointer to the wiki Augie Fackler <augie@google.com> parents: diff changeset	13	273ce12ad8f1` will report some style violations on a very old commit).

author	Matt Harbison <matt_harbison@yahoo.com>
	Sun, 29 Sep 2024 02:03:20 -0400
changeset 51934	09f3a6790e56
parent 30084	a492610a2fc1
permissions	-rw-r--r--