fix: wrap non required values with Optional[] in python

[ChiragAgg5k]

• 🐛 Bug Report: remove default with required is true (Enums and maybe others) sdk-for-python#111

Screen.Recording.2025-10-29.at.1.51.35.PM.mov

Summary by CodeRabbit

• Refactor
  • Improved internal code organization and maintainability of type handling logic for Python SDK.

[coderabbitai]

Walkthrough

The getTypeName method in src/SDK/Language/Python.php is refactored to consolidate its control flow. Instead of using multiple early return statements for different type cases, the method now initializes a local $typeName variable, populates it through conditional logic (handling enums, enumValues, and a switch statement for various parameter types), and then determines whether to wrap the result with Optional[] based on the parameter's required status before returning a single final value.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Key areas requiring attention:
  • Verify that the consolidated return path preserves the behavior of all original early-return cases (InputFile, numeric, boolean, string, array, object, and default types)
  • Confirm that the Optional[] wrapping logic correctly identifies non-required parameters and applies the wrapper consistently
  • Check that enum and enumValues handling produces identical output before and after refactoring
  • Ensure the order of conditions in the new switch statement maintains the same precedence as the original logic

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "fix: wrap non required values with Optional[] in python" directly corresponds to the primary behavioral change described in the raw summary. The refactoring of the getTypeName function is specifically designed to implement this functionality—wrapping optional parameters with Optional[]. The title is concise, uses clear language without vague terms, and is specific enough that someone scanning the repository history would immediately understand this PR adds Optional[] wrapper support for non-required values in the Python SDK. The implementation details about consolidating return paths and restructuring the function are mechanisms to achieve this main goal rather than separate objectives.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore-wrap-optional-python

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1685a96 and b18577e.

📒 Files selected for processing (1)

• src/SDK/Language/Python.php (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

src/SDK/Language/Python.php (3)

src/SDK/Language/Deno.php (1)

• getTypeName (133-155)

src/SDK/Language/PHP.php (1)

• getTypeName (253-271)

src/SDK/Language/GraphQL.php (1)

• getTypeName (19-57)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (16)

• GitHub Check: build (8.3, Ruby30)
• GitHub Check: build (8.3, Node20)
• GitHub Check: build (8.3, KotlinJava17)
• GitHub Check: build (8.3, Python39)
• GitHub Check: build (8.3, FlutterBeta)
• GitHub Check: build (8.3, KotlinJava11)
• GitHub Check: build (8.3, DartBeta)
• GitHub Check: build (8.3, Android14Java17)
• GitHub Check: kotlin (server)
• GitHub Check: build (8.3, Android5Java17)
• GitHub Check: cli (console)
• GitHub Check: go (server)
• GitHub Check: flutter (client)
• GitHub Check: android (client)
• GitHub Check: swift (server)
• GitHub Check: apple (client)

🔇 Additional comments (2)

src/SDK/Language/Python.php (2)

238-239: LGTM! Clean initialization.

The explicit initialization of $typeName ensures the variable is defined before use and makes the code flow clearer.

---

240-273: Code is correct; original concern was based on incorrect assumption about nested Optional wrapping.

The recursive call at line 261 does not create nested Optional types. When $parameter['array'] is passed to the recursive call, it contains only a type field—no required field. The Optional wrapping at lines 275-276 applies only when the specific parameter's required field is explicitly set to false. Since nested array items don't have a required field, they default to true, preventing Optional wrapping at inner levels. The result is Optional[List[str]] (if the outer parameter is optional), not Optional[List[Optional[str]]].

Likely an incorrect or invalid review comment.