Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(java): add type hints to all java and javax classes and methods #83

Merged
merged 1 commit into from
Sep 1, 2022
Merged

feat(java): add type hints to all java and javax classes and methods #83

merged 1 commit into from
Sep 1, 2022

Conversation

cesarcoatl
Copy link
Member

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

When running mypy --strict we get the following errors for java:

$ mypy --strict src/java
src/dev/thecesrom/utils/decorators.py:5: error: Function is missing a type annotation
src/java/lang/__init__.py:106: error: Function is missing a return type annotation
src/java/lang/__init__.py:106: note: Use "-> None" if function does not return a value
src/java/lang/__init__.py:109: error: Function is missing a return type annotation
src/java/lang/__init__.py:109: note: Use "-> None" if function does not return a value
src/java/lang/__init__.py:196: error: Function is missing a type annotation
src/java/lang/__init__.py:237: error: Function is missing a type annotation
src/java/lang/__init__.py:288: error: Function is missing a type annotation
src/java/lang/__init__.py:466: error: Function is missing a return type annotation
src/java/lang/__init__.py:466: note: Use "-> None" if function does not return a value
src/java/lang/__init__.py:469: error: Function is missing a return type annotation
src/java/lang/__init__.py:469: note: Use "-> None" if function does not return a value
src/java/lang/__init__.py:481: error: Function is missing a type annotation
src/java/lang/__init__.py:484: error: Function is missing a type annotation
src/java/org/jdesktop/core/animation/timing/__init__.py:5: error: Function is missing a return type annotation
src/java/org/jdesktop/core/animation/timing/__init__.py:5: note: Use "-> None" if function does not return a value
src/java/org/jdesktop/core/animation/timing/__init__.py:8: error: Function is missing a return type annotation
src/java/org/jdesktop/core/animation/timing/__init__.py:8: note: Use "-> None" if function does not return a value
src/java/org/jdesktop/core/animation/timing/__init__.py:11: error: Function is missing a return type annotation
src/java/org/jdesktop/core/animation/timing/__init__.py:11: note: Use "-> None" if function does not return a value
src/java/util/__init__.py:135: error: Function is missing a return type annotation
src/java/util/__init__.py:159: error: Function is missing a type annotation
src/java/util/__init__.py:160: error: Call to untyped function "__str__" in typed context
src/java/util/__init__.py:162: error: Function is missing a type annotation
Found 17 errors in 4 files (checked 18 source files)

And for javax:

$ mypy --strict src/javax
src/java/lang/__init__.py:106: error: Function is missing a return type annotation
src/java/lang/__init__.py:106: note: Use "-> None" if function does not return a value
src/java/lang/__init__.py:109: error: Function is missing a return type annotation
src/java/lang/__init__.py:109: note: Use "-> None" if function does not return a value
src/java/lang/__init__.py:196: error: Function is missing a type annotation
src/java/lang/__init__.py:237: error: Function is missing a type annotation
src/java/lang/__init__.py:288: error: Function is missing a type annotation
src/java/lang/__init__.py:466: error: Function is missing a return type annotation
src/java/lang/__init__.py:466: note: Use "-> None" if function does not return a value
src/java/lang/__init__.py:469: error: Function is missing a return type annotation
src/java/lang/__init__.py:469: note: Use "-> None" if function does not return a value
src/java/lang/__init__.py:481: error: Function is missing a type annotation
src/java/lang/__init__.py:484: error: Function is missing a type annotation
src/javax/swing/__init__.py:25: error: Function is missing a return type annotation
src/javax/swing/__init__.py:25: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:28: error: Function is missing a return type annotation
src/javax/swing/__init__.py:28: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:31: error: Function is missing a type annotation
src/javax/swing/__init__.py:83: error: Function is missing a type annotation
src/javax/swing/__init__.py:86: error: Function is missing a type annotation
src/javax/swing/__init__.py:89: error: Function is missing a return type annotation
src/javax/swing/__init__.py:89: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:92: error: Function is missing a return type annotation
src/javax/swing/__init__.py:92: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:95: error: Function is missing a type annotation
src/javax/swing/__init__.py:104: error: Function is missing a return type annotation
src/javax/swing/__init__.py:104: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:107: error: Function is missing a return type annotation
src/javax/swing/__init__.py:107: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:110: error: Function is missing a return type annotation
src/javax/swing/__init__.py:110: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:113: error: Function is missing a return type annotation
src/javax/swing/__init__.py:113: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:116: error: Function is missing a return type annotation
src/javax/swing/__init__.py:116: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:119: error: Function is missing a return type annotation
src/javax/swing/__init__.py:119: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:122: error: Function is missing a return type annotation
src/javax/swing/__init__.py:122: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:125: error: Function is missing a return type annotation
src/javax/swing/__init__.py:125: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:236: error: Function is missing a return type annotation
src/javax/swing/__init__.py:236: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:239: error: Function is missing a return type annotation
src/javax/swing/__init__.py:243: error: Function is missing a return type annotation
src/javax/swing/__init__.py:243: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:262: error: Function is missing a type annotation
src/javax/swing/__init__.py:265: error: Function is missing a return type annotation
src/javax/swing/__init__.py:265: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:268: error: Function is missing a return type annotation
src/javax/swing/__init__.py:273: error: Function is missing a return type annotation
src/javax/swing/__init__.py:273: note: Use "-> None" if function does not return a value
src/javax/swing/__init__.py:277: error: Function is missing a type annotation
src/javax/swing/__init__.py:281: error: Function is missing a type annotation
Found 34 errors in 2 files (checked 3 source files)

Issue Number: N/A

What is the new behavior?

All places possible we've added type comments, leaving only a few methods behind.

java and javax report the same:

$ mypy --strict src/java 
src/java/lang/__init__.py:106: error: Function is missing a return type annotation
src/java/lang/__init__.py:106: note: Use "-> None" if function does not return a value
src/java/lang/__init__.py:109: error: Function is missing a return type annotation
src/java/lang/__init__.py:109: note: Use "-> None" if function does not return a value
src/java/util/__init__.py:160: error: Function is missing a type annotation
src/java/util/__init__.py:161: error: Call to untyped function "__str__" in typed context
src/java/util/__init__.py:163: error: Function is missing a type annotation
Found 5 errors in 2 files (checked 18 source files)

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

We've added the following supporting classes:

  • java.awt.AWTEvent
  • java.awt.Graphics
  • javax.swing.DesktopManager
  • javax.swing.event.AncestorEvent
  • javax.swing.event.AncestorListener
  • javax.swing.plaf.ComponentUI
  • javax.swing.plaf.DesktopPaneUI

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Sep 1, 2022

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.07%.

Quality metrics Before After Change
Complexity 0.03 ⭐ 0.03 ⭐ 0.00
Method Length 12.60 ⭐ 12.75 ⭐ 0.15 👎
Working memory 3.15 ⭐ 3.21 ⭐ 0.06 👎
Quality 97.86% 97.79% -0.07% 👎
Other metrics Before After Change
Lines 844 945 101
Changed files Quality Before Quality After Quality Change
src/dev/thecesrom/utils/decorators.py 95.18% ⭐ 95.18% ⭐ 0.00%
src/java/awt/init.py 98.18% ⭐ 97.94% ⭐ -0.24% 👎
src/java/lang/init.py 98.28% ⭐ 98.23% ⭐ -0.05% 👎
src/java/org/jdesktop/core/animation/timing/init.py 100.00% ⭐ 100.00% ⭐ 0.00%
src/java/util/init.py 98.44% ⭐ 98.44% ⭐ 0.00%
src/javax/swing/init.py 95.71% ⭐ 96.09% ⭐ 0.38% 👍

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation
src/javax/swing/init.py JOptionPane.showOptionDialog 0 ⭐ 44 ⭐ 11 😞 75.56% ⭐ Extract out complex expressions
src/javax/swing/init.py JOptionPane.showInputDialog 0 ⭐ 38 ⭐ 10 😞 78.43% ⭐ Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

@cesarcoatl cesarcoatl merged commit 87d9d4f into ignition-devs:main Sep 1, 2022
@cesarcoatl cesarcoatl deleted the feat/java/fully-typed branch September 1, 2022 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant