showbase: Add type annotations to ShowBase/ClientRepositoryBase attributes #1217
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Souzooka
force-pushed
the
minor/direct-base-cr-attribute-annotations
branch
from
cc579fe
to
8f972cf
Compare
Souzooka
force-pushed
the
minor/direct-base-cr-attribute-annotations
branch
from
8f972cf
to
72166c4
Compare
rdb
requested changes
Mar 9, 2023
| self.mouse2cam = None | ||
| self.buttonThrowers = None | ||
| self.mouseWatcher = None | ||
| self.pipeList: List[Optional[GraphicsPipe]] = [] |
There was a problem hiding this comment.
Does this need to be Optional? Will there ever be a None added to the list?
| self.cTravStack = Stack() | ||
| # Ditto for an AppTraverser. | ||
| self.appTrav = 0 | ||
| self.appTrav: Optional[CollisionTraverser] = None |
There was a problem hiding this comment.
I don't think appTrav is meant to be a CollisionTraverser, but I don't know what it's meant to be - I would suggest leaving this Any for now
| @@ -275,7 +278,7 @@ def __init__(self, fStartDirect=True, windowType=None): | |||
|
|
|||
| #: The global :class:`~panda3d.core.GraphicsEngine`, as returned by | |||
| #: GraphicsEngine.getGlobalPtr() | |||
| self.graphicsEngine = GraphicsEngine.getGlobalPtr() | |||
| self.graphicsEngine: GraphicsEngine = GraphicsEngine.getGlobalPtr() | |||
| self.graphics_engine = self.graphicsEngine | |||
There was a problem hiding this comment.
Do we need to add an annotation to the underscored version as well?
| # Typing annotations | ||
| from typing import Optional, TYPE_CHECKING | ||
| if TYPE_CHECKING: | ||
| from direct.distributed.TimeManager import TimeManager |
There was a problem hiding this comment.
Not sure about such an optional import - and is it even necessary since you referred to it by string?
rdb
reviewed
Mar 9, 2023
| self.win = None | ||
| self.frameRateMeter = None | ||
| self.sceneGraphAnalyzerMeter = None | ||
| self.win: Optional[GraphicsWindow] = None |
There was a problem hiding this comment.
Actually, this may also be a GraphicsBuffer, in offscreen mode. But it should in any case be a GraphicsOutput.
|
Ping. Still interested in this? |
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue description
Currently, a lot of attributes contained on ShowBase have properties with non-inferable types, and as such these attributes nor their methods/attributes are hinted in IDEs.
Solution description
This MR adds type annotations to most properties defined during instance initialization for ShowBase (and a few for ClientRepositoryBase), so that developers which access these properties can determine easily determine the type of the attribute and the properties of its methods (if type information exists for said type, i.e.
panda3d.coretypes).A slight caveat is that I did not add typehinting for a few attributes declared in ShowBase, (e.g.
ShowBase.texmem) because their types are imported viaimportlib, and I did not want to break the functionality that is provided via using that import method.Another caveat is that if the names used in type annotations are removed (e.g. the
from panda3d.core import *is changed to import a list of specific names), types imported for annotations (i.e. if they are moved into aif TYPE_CHECKING:block) will need to be modified so that they are a string literal (e.g.Optional["NodePath"]) unlessannotationsis imported from__future__(Python 3.7+) or direct is running on Python 3.11+.I've done my best to verify these type annotations are correct, but please correct me if I have gotten anything wrong.
Checklist
I have done my best to ensure that…