refactor: Fix clang-tidy warnings in Py_utils.

[LinZhihao-723]

Description

This is one of PRs to resolve #96

This PR fixes clang-tidy warnings in Py_utils under clang-tidy 19 using the latest clang-tidy config from https://github.com/y-scope/yscope-dev-utils/blob/main/lint-configs/.clang-tidy
One noticeable change is that we introduced a consteval function to wrap constexpr string view to resolve this warning: https://clang.llvm.org/extra/clang-tidy/checks/bugprone/suspicious-stringview-data-usage.html. We might also need this for other CLP repos

Validation performed

• Ensure workflow passed
• Ensure unit tests all passed locally
• Ensure clang-tidy warnings all resolved for Py_utils

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced new string handling functions for improved efficiency, including get_c_str_from_constexpr_string_view and parse_py_string_as_string_view.

• Improvements

  • Updated function name constants to enhance clarity and type safety.
  • Changed header file inclusions for better functionality and compatibility.

• Configuration

  • Updated linting task configurations for enhanced readability and adjusted paths for linting tools.
  • Introduced a configuration file for Clang-Tidy to customize linting behaviour.

[coderabbitai]

Walkthrough

The pull request introduces several modifications primarily to the Py_utils.cpp, Py_utils.hpp, Python.hpp, and utils.hpp files within the clp_ffi_py namespace. Key changes include the refactoring of function pointer variables and constants to improve type safety, the addition of new utility functions for handling std::string_view, and updates to header file inclusions. These changes enhance code clarity and maintainability while preserving existing functionalities.

Changes

File	Change Summary
src/clp_ffi_py/Py_utils.cpp	- Renamed function pointer variables to a new naming convention and changed their type to std::string_view. - Updated constants from constexpr char const* const to constexpr std::string_view. - Modified function implementations to utilize new variable names and initialization methods.
src/clp_ffi_py/Py_utils.hpp	- Replaced the inclusion of <clp/ffi/encoding_methods.hpp> with <clp/ir/types.hpp>.
src/clp_ffi_py/Python.hpp	- Added include directive for <import.h> within a conditional compilation block for linting purposes.
src/clp_ffi_py/utils.hpp	- Added include for <string_view>. - Introduced get_c_str_from_constexpr_string_view and parse_py_string_as_string_view functions.
src/clp_ffi_py/.clang-tidy	- Introduced configuration for Clang-Tidy to customize linting behavior related to variable naming.
lint-tasks.yml	- Updated cpp-static-check task configuration for clarity and modified the path for the configuration file.

Assessment against linked issues

Objective	Addressed	Explanation
Fix clang-tidy warnings for all C++ source files (#96)	✅
Update linting tasks to reflect changes in source files (#96)	✅

Possibly related PRs

• feat(linting): Add Taskfile tasks to run linters. #76: This PR enhances the linting process, which is relevant as the main PR also involves changes to the code structure and function declarations that may affect linting rules.
• feat: Add Python class KeyValuePairLogEvent as a wrapper of clp::ffi::KeyValuePairLogEvent. #81: The introduction of the KeyValuePairLogEvent class as a wrapper for clp::ffi::KeyValuePairLogEvent is directly related to the changes in the main PR, which also deals with function declarations and conversions involving similar log events.
• perf: Optimize KeyValuePairLogEvent.to_dict to directly convert clp::KeyValuePairLogEvent to PyDictObject via CPython APIs. #90: This PR focuses on optimizing the conversion of clp::ffi::KeyValuePairLogEvent to a Python dictionary, which aligns with the main PR's modifications to function declarations and utility functions related to JSON and dictionary handling.

Suggested reviewers

• kirkrodrigues
• haiqi96

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 06a50d3 and e40a85c.

📒 Files selected for processing (1)

• src/clp_ffi_py/Python.hpp (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/clp_ffi_py/Python.hpp

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 823caa3 and d595a37.

📒 Files selected for processing (1)

• lint-tasks.yml (1 hunks)

🔇 Additional comments (1)

lint-tasks.yml (1)

Line range hint 41-43: Re-enable clang-tidy tasks after fixes.

The PR aims to fix clang-tidy warnings, but the tasks are currently disabled. Consider re-enabling these tasks once the fixes are confirmed to work:

  cpp-check:
    cmds:
      - task: "cpp-format-check"
-     # TODO: re-enable this once all clang-tidy has been fixed
-     # - task: "cpp-static-check"
+     - task: "cpp-static-check"

  cpp-fix:
    cmds:
      - task: "cpp-format-fix"
-     # TODO: re-enable this once all clang-tidy has been fixed
-     # - task: "cpp-static-fix"
+     - task: "cpp-static-fix"

Let's verify if there are any remaining clang-tidy warnings:

Also applies to: 52-54