Added sorbet typecheck under python module on 5 files #11261

randhircs · 2025-01-09T20:47:08Z

What are you trying to accomplish?

Requirement is to add Sorbet TypeCheck under Python module, Selected files are updated with TypeCheck.

Anything you want to highlight for special attention from reviewers?

TypeCheck are having correct data type params and return data type.

How will you know you've accomplished your goal?

Checklist

I have run the complete test suite to ensure all tests and linters pass.
I have thoroughly tested my code changes to ensure they work as expected, including adding additional tests for new functionality.
I have written clear and descriptive commit messages.
I have provided a detailed description of the changes in the pull request, including the problem it addresses, how it fixes the problem, and any relevant details about the implementation.
I have ensured that the code is well-documented and easy to understand.

python/lib/dependabot/python/file_parser/setup_file_parser.rb

python/lib/dependabot/python/update_checker/index_finder.rb

abdulapopoola

You have to change the typed:true to typed:strict; see this example

randhircs · 2025-01-10T16:18:17Z

Sure, I change it.

python/lib/dependabot/python/file_parser.rb

… setup_file_sanitizer.rb, language_version_manager.rb,pipenv_runner.rb,index_finder.rb

abdulapopoola · 2025-01-14T22:58:55Z

python/lib/dependabot/python/file_parser.rb

@@ -198,14 +198,15 @@ def setup_python_environment
        nil
      end

-      sig { params(package_manager: String, version: String).void }
+      sig { params(package_manager: String, version: String).returns(T.nilable(T::Boolean)) }


why is this a nilable boolean?

Yes, I also think all conditions are handled. It shouldn't be nillable.

Yeah, I corrected it now, thanks to both of you.

abdulapopoola · 2025-01-14T22:59:22Z

python/lib/dependabot/python/file_parser.rb

@@ -383,6 +394,7 @@ def parsed_requirement_files
        raise Dependabot::DependencyFileNotEvaluatable, e.message
      end

+      sig { params(requirements: T.untyped).returns(T.untyped) }


are requirements actually untyped?

abdulapopoola · 2025-01-14T22:59:59Z

python/lib/dependabot/python/file_parser/setup_file_parser.rb

@@ -8,11 +8,13 @@
 require "dependabot/python/file_parser"
 require "dependabot/python/native_helpers"


can you update the typed: strict here too?

kbukum1 · 2025-01-14T23:14:03Z

python/lib/dependabot/python/file_parser.rb

@@ -32,7 +33,7 @@ class FileParser < Dependabot::FileParsers::Base
          pipfile: "dev-packages",
          lockfile: "develop"
        }
-      ].freeze
+      ].freeze, T::Array[T::Hash[T.untyped, T.untyped]])


Suggested Change: Instead of using T::Hash[T.untyped, T.untyped], use T::Hash[Symbol, String] (or another more specific type) to improve type safety and clarity.

Reasoning:

T.untyped allows any type, which weakens Sorbet’s ability to provide meaningful type checks.

By specifying Symbol as the key type and String as the value type (or another suitable type if necessary), you:

Make the code's intent clearer.

Enable Sorbet to catch potential mismatches early.

Provide better documentation for others reading or maintaining the code.

kbukum1 · 2025-01-14T23:16:53Z

python/lib/dependabot/python/file_parser.rb

      def group_from_filename(filename)
        if filename.include?("dev") then ["dev-dependencies"]
        else
          ["dependencies"]
        end
      end

+      sig { params(dep: T.untyped).returns(T::Boolean) }
      def blocking_marker?(dep)


What is this T.untyped? Is it something changing dependency to the situation?

kbukum1 · 2025-01-14T23:17:36Z

python/lib/dependabot/python/file_parser.rb

@@ -316,6 +320,9 @@ def blocking_marker?(dep)
        end
      end

+      sig do
+        params(marker: T.untyped, python_version: T.any(String, Integer, Gem::Version)).returns(T::Boolean)
+      end


I think T.untyped is not proper unless necessary

kbukum1 · 2025-01-14T23:17:56Z

python/lib/dependabot/python/file_parser.rb

@@ -337,6 +344,10 @@ def marker_satisfied?(marker, python_version)
        result
      end

+      sig do
+        params(condition: T.untyped,


Same here, T.untyped?

kbukum1 · 2025-01-14T23:18:49Z

python/lib/dependabot/python/file_parser.rb

      end

+      sig { returns(T.untyped) }


I think we do have return type here but not sure.

kbukum1

I think mostly there are lots of T.untyped which is not preferred approach. The typing doesn't have any value when it is T.untyped.

randhircs requested a review from a team as a code owner January 9, 2025 20:47

randhircs marked this pull request as draft January 9, 2025 20:47

github-actions bot added the L: python label Jan 9, 2025

randhircs changed the title ~~Added sorbet typecheck under python module~~ Added sorbet typecheck under python module on 5 files Jan 9, 2025

abdulapopoola reviewed Jan 9, 2025

View reviewed changes

python/lib/dependabot/python/file_parser/setup_file_parser.rb Outdated Show resolved Hide resolved

abdulapopoola reviewed Jan 9, 2025

View reviewed changes

python/lib/dependabot/python/file_parser/setup_file_parser.rb Outdated Show resolved Hide resolved

abdulapopoola reviewed Jan 9, 2025

View reviewed changes

python/lib/dependabot/python/update_checker/index_finder.rb Outdated Show resolved Hide resolved

randhircs requested a review from abdulapopoola January 10, 2025 02:41

randhircs self-assigned this Jan 10, 2025

randhircs marked this pull request as ready for review January 10, 2025 02:41

randhircs force-pushed the randhircs/dependabot-core-sorbet-python01 branch from 0032c61 to 601f7de Compare January 10, 2025 13:47

markhallen previously approved these changes Jan 10, 2025

View reviewed changes

abdulapopoola requested changes Jan 10, 2025

View reviewed changes

randhircs dismissed markhallen’s stale review via 1b814d7 January 13, 2025 22:29

randhircs force-pushed the randhircs/dependabot-core-sorbet-python01 branch from 1b814d7 to 6799716 Compare January 13, 2025 22:34

randhircs closed this Jan 13, 2025

randhircs reopened this Jan 13, 2025

randhircs closed this Jan 13, 2025

randhircs reopened this Jan 13, 2025

abdulapopoola reviewed Jan 14, 2025

View reviewed changes

python/lib/dependabot/python/file_parser.rb Outdated Show resolved Hide resolved

randhircs force-pushed the randhircs/dependabot-core-sorbet-python01 branch from 6799716 to bf7b0ec Compare January 14, 2025 14:48

abdulapopoola reviewed Jan 14, 2025

View reviewed changes

python/lib/dependabot/python/file_parser.rb Outdated Show resolved Hide resolved

randhircs added 7 commits January 14, 2025 14:29

Added sorbet typecheck under python module for setup_file_parser.rb ,…

b62d316

… setup_file_sanitizer.rb, language_version_manager.rb,pipenv_runner.rb,index_finder.rb

Fixed issue in index_finder

4047bcb

Fixed issue in setupfilesanitizer

0c7d855

Included TypeCheck for one more file

0682f60

Remvoed from index finder file

c6b8aca

Removed from pyproject_preparer

a0527c8

Commented since return type is not correct

35e77ed

randhircs added 10 commits January 14, 2025 14:29

Added TypeCheck back to setup_file_parser

036aa7f

Added TypeCheck pyproject_preparer.rb

c8aa9af

Removed commented code

e1b473c

Added TypeCheck as strict for file_parser

a7fae08

Added TypeCheck as strict for file_parser

b32c50c

Removed nilable to fix the issue

9586bea

Moved back to untyped

611444e

Moved back to untyped

291f9ab

Moved back to untyped

34a78c7

corrected return type

955f98a

randhircs force-pushed the randhircs/dependabot-core-sorbet-python01 branch from aca58f5 to 955f98a Compare January 14, 2025 19:30

randhircs added 6 commits January 14, 2025 19:48

Corrected returntype to pass end to end error

a58b3e5

Changed requirementfile method return type

8442af3

Changed return type to dependabotset

e6d6fac

Changed return type to dependencySet

e5261c5

Corrected log_if_version_malformed

d9dfa0f

Changed return type in pipenv_runner

f44145f

randhircs requested review from abdulapopoola and kbukum1 January 14, 2025 22:25

abdulapopoola reviewed Jan 14, 2025

View reviewed changes

kbukum1 reviewed Jan 14, 2025

View reviewed changes

kbukum1 requested changes Jan 14, 2025

View reviewed changes

Corrected return type

7dea911

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added sorbet typecheck under python module on 5 files #11261

Added sorbet typecheck under python module on 5 files #11261

randhircs commented Jan 9, 2025 •

edited

Loading

abdulapopoola left a comment

randhircs commented Jan 10, 2025

abdulapopoola Jan 14, 2025

kbukum1 Jan 14, 2025

randhircs Jan 14, 2025

abdulapopoola Jan 14, 2025

abdulapopoola Jan 14, 2025

kbukum1 Jan 14, 2025

kbukum1 Jan 14, 2025 •

edited

Loading

kbukum1 Jan 14, 2025

kbukum1 Jan 14, 2025

kbukum1 Jan 14, 2025 •

edited

Loading

kbukum1 left a comment

		@@ -8,11 +8,13 @@
		require "dependabot/python/file_parser"
		require "dependabot/python/native_helpers"

Added sorbet typecheck under python module on 5 files #11261

Are you sure you want to change the base?

Added sorbet typecheck under python module on 5 files #11261

Conversation

randhircs commented Jan 9, 2025 • edited Loading

What are you trying to accomplish?

Anything you want to highlight for special attention from reviewers?

How will you know you've accomplished your goal?

Checklist

abdulapopoola left a comment

Choose a reason for hiding this comment

randhircs commented Jan 10, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kbukum1 Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kbukum1 Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

kbukum1 left a comment

Choose a reason for hiding this comment

randhircs commented Jan 9, 2025 •

edited

Loading

kbukum1 Jan 14, 2025 •

edited

Loading

kbukum1 Jan 14, 2025 •

edited

Loading