refactor: Fix clang-tidy warnings in PyDeserializerBuffer to align with the latest C++ coding guideline.

[LinZhihao-723]

Description

This is one of the PR series trying to implement #96.
This PR fixes all clang-tidy warnings in PyDeserializerBuffer. Other than that, it also fixes the following problem:

• Correct the ordering of class member declaration (and fix the implementation ordering accordingly)
• Use API decoration instead of using extern "C" block explicitly
• Ensure local helper functions are declared before defined

Validation performed

• Ensure workflows passed.

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced static code analysis coverage for PyDeserializerBuffer source files
  • Added new methods for managing Python deserializer buffer instances

• Improvements

  • Refined memory management and object creation for PyDeserializerBuffer
  • Updated Python C API header inclusions for better linting support

• Technical Updates

  • Restructured method implementations for PyDeserializerBuffer
  • Added factory methods for controlled object instantiation

[coderabbitai]

Walkthrough

The pull request introduces modifications to the PyDeserializerBuffer class in the CLP FFI Python implementation. The changes involve restructuring the code by adding new static methods for creating and managing PyDeserializerBuffer instances, updating method declarations, and modifying the header files. The lint-tasks.yml configuration has been updated to include the new source files in the static checking process. These modifications aim to improve the class's initialization, type management, and Python interface integration.

Changes

File	Change Summary
lint-tasks.yml	Added two source files to cpp-static-check task: PyDeserializerBuffer.cpp and PyDeserializerBuffer.hpp
src/clp_ffi_py/ir/native/PyDeserializerBuffer.cpp	- Relocated method implementations - Added new methods: create, get_py_type, get_py_incomplete_stream_error, module_level_init - Updated method signatures with CLP_FFI_PY_METHOD macro
src/clp_ffi_py/ir/native/PyDeserializerBuffer.hpp	- Added static methods for instance creation and type management - Deleted default/copy/move constructors - Updated static variable declarations
src/wrapped_facade_headers/Python.hpp	Added two header files: <bytearrayobject.h> and <pymem.h>

Possibly related issues

• Fix clang-tidy warnings for all C++ source files #96 (Fix clang-tidy warnings): The changes align with the ongoing effort to improve code quality and resolve linting warnings by adding new source files to static checking and updating header inclusions.

Possibly related PRs

• refactor: Fix clang-tidy warnings in PyDeserializer. #111: Similar changes involving adding source files to the cpp-static-check task, specifically for PyDeserializer files related to the PyDeserializerBuffer class.

Suggested reviewers

• haiqi96

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d1361b and 9a43cbd.

📒 Files selected for processing (4)

• lint-tasks.yml (1 hunks)
• src/clp_ffi_py/ir/native/PyDeserializerBuffer.cpp (11 hunks)
• src/clp_ffi_py/ir/native/PyDeserializerBuffer.hpp (3 hunks)
• src/wrapped_facade_headers/Python.hpp (2 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

src/wrapped_facade_headers/Python.hpp (1)

Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

src/clp_ffi_py/ir/native/PyDeserializerBuffer.cpp (1)

Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

src/clp_ffi_py/ir/native/PyDeserializerBuffer.hpp (1)

Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

📓 Learnings (1)

src/clp_ffi_py/ir/native/PyDeserializerBuffer.cpp (1)

Learnt from: LinZhihao-723
PR: y-scope/clp-ffi-py#94
File: src/clp_ffi_py/ir/native/PyDeserializer.hpp:246-248
Timestamp: 2024-11-23T05:54:37.767Z
Learning: In the `src/clp_ffi_py/ir/native` module, raw pointers with `gsl::owner` are intentionally used instead of `std::unique_ptr` to comply with CPython's memory management requirements.

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: linters

🔇 Additional comments (11)

src/clp_ffi_py/ir/native/PyDeserializerBuffer.hpp (4)

6-7: Including necessary headers

The inclusion of <cstddef> and <cstdint> is appropriate for fixed-width integer types and size definitions.

---

10-10: Including CLP IR types

Including <clp/ir/types.hpp> ensures that CLP IR-specific types are available, which is necessary for this context.

---

31-78: Proper encapsulation with static methods and deleted constructors

The addition of static factory methods and deletion of the default and copy/move constructors prevent direct instantiation and copying of PyDeserializerBuffer, enforcing proper usage patterns.

---

217-218: Use of 'static inline' for static member variables

Using static inline for m_py_type and m_py_incomplete_stream_error allows in-header initialization of static member variables in compliance with C++17 standards.

src/wrapped_facade_headers/Python.hpp (2)

20-20: Including <bytearrayobject.h> for bytearray support

Adding <bytearrayobject.h> ensures that bytearray objects are properly handled during linting, which is appropriate.

---

34-34: Including <pymem.h> for memory management

Including <pymem.h> provides access to Python's memory management functions, which is necessary for proper operation and linting.

src/clp_ffi_py/ir/native/PyDeserializerBuffer.cpp (4)

6-7: Including necessary headers

The inclusion of <cstddef> and <cstdint> is appropriate for defining fixed-width integer types and size specifications.

---

10-10: Including <type_traits> for type support

Adding <type_traits> is suitable for using type traits like std::is_trivially_destructible, which enhances type safety.

---

15-15: Consistent use of API decoration

Including <clp_ffi_py/api_decoration.hpp> and applying CLP_FFI_PY_METHOD ensures consistent API decoration across the codebase.

---

331-333: Ensure C++20 support for std::ranges::copy

The use of std::ranges::copy requires C++20. Please verify that the project's build configuration enables C++20. If not, consider using std::copy as an alternative.

Also applies to: 340-342

lint-tasks.yml (1)

122-123: LGTM! The additions are well-structured.

The new source files for PyDeserializerBuffer are properly added to the clang-tidy check list, maintaining alphabetical order and consistent path formatting. This change aligns with the PR's objective to address clang-tidy warnings.

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[haiqi96]

Looks reasonable