Annotate and document info.py.

[knutnergaard]

No description provided.

[knutnergaard]

@benkiel I ran into a few problems with this module:

1. What are the available types for the value parameter in _validateFontInfoAttributeValue?
2. Where are the magic methods in this class defined? mypy throws this error:

   info.py:107: error: "__hasattr__" undefined in superclass  [misc]

3. What value types is BaseInfo.__setattr__ supposed to return? In my experience __setattr__ is supposed to return None, yet here, the method is treated as if returning something else.
4. What is _getAttr supposed to return? mypy throws this error:

   info.py:113: error: "_getAttr" of "BaseInfo" does not return a value (it only ever returns None)  [func-returns-value]

5. Isn't _fromMathInfo supposed to return anything? It's missing a return statement, yet its called in the return of the public equivalent. It also returns this mypy error:

   info.py:271: error: "_fromMathInfo" of "BaseInfo" does not return a value (it only ever returns None)  [func-returns-value]

6. mypy throws the this error due to the differences in signature with the base method:

   info.py:230: error: Signature of "update" incompatible with supertype "DeprecatedBase"  [override]
   info.py:230: note:      Superclass:
   info.py:230: note:          def update(self) -> Any
   info.py:230: note:      Subclass:
   info.py:230: note:          def update(self, other: BaseInfo) -> None

   Not sure of the best way to deal with this.
7. mypy also shows this error, (I think) due to BaseInfo not following the annotations.Interpolatable protocol:

   info.py:369: error: Value of type variable "InterpolatableType" of "interpolate" cannot be "BaseInfo"

   How should this be handled?

[benkiel]

@knutnergaard, this is just a note that I've not forgotten this — I'm caught up in end-of-year things. I will get to it by the weekend.

[benkiel]

Hey @knutnergaard, just a ping to let you know that I have not forgotten this: work and holidays. Will get you answers this coming week.

[knutnergaard]

@benkiel No worries, I'm very busy myself these days.

[knutnergaard]

@benkiel I decided to opt for a simpler solution, utilizing the already defined __getattribute__ and __setattribute__ methods and only adding docstrings to declared type annotation stubs. This works fine in Sphinx.

For now, I've only added the descriptions from the UFO specification as docstrings. Some of these need (manual) editing, but I'm not sure how much information is needed in this case.

Also, In addition to the mypy errors already accounted for, there seems to be some kind of problem with implicit setuptools import which leads to the failure of the test for Python 3.12 on Ubuntu. Not sure how to fix this.

[knutnergaard]

@benkiel I've solved all mypy errors and finished the documentation for all methods. Please review this and suggest any necessary edits to the attribute docs.

[benkiel]

Will do; I can't until next week, fyi!