search

afkiwers / inventree_kicad

KiCad EDA conform API endpoint for KiCad's parts library tool. This plugin provides metadata only and requires matching symbol and footprint libraries within the KiCad EDA.
MIT License
38 stars 8 forks source link

Attachment refactor #98

Closed SchrodingersGat closed 5 months ago

SchrodingersGat commented 5 months ago

This PR adds support for the "modern" attachments table in InvenTree, which uses a single database table to store all attachments.

Ref: https://github.com/inventree/InvenTree/pull/7420

Without this PR, the plugin breaks on any installation running off the 0.16.x dev branch.

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

Walkthrough

The recent changes enhance the import_meta_data functionality within the KiCad Library Plugin by introducing a dedicated add_attachment method to manage attachments for parts. This method now accommodates both modern and legacy attachment tables. Additionally, the get_datasheet method in serializers.py has been optimized to filter datasheets efficiently using case-insensitive matching, improving overall data handling.

Changes

Files/Paths Change Summaries
inventree_kicad/KiCadLibraryPlugin.py Refactored import_meta_data to use a new add_attachment method. Supported handling for both modern and legacy attachment tables. Removed import of PartAttachment.
inventree_kicad/serializers.py Updated get_datasheet to use case-insensitive filtering for datasheet comments, optimizing the logic.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant KiCadLibraryPlugin
  participant Part
  participant PartAttachment (Modern)
  participant PartAttachment (Legacy)

  User ->> KiCadLibraryPlugin: import_meta_data(part)
  KiCadLibraryPlugin ->>+ Part: Retrieve part details
  KiCadLibraryPlugin ->>+ add_attachment: Handle attachments
  add_attachment ->> PartAttachment (Modern): Add to modern table (if applicable)
  add_attachment ->> PartAttachment (Legacy): Add to legacy table (if applicable)
  PartAttachment (Modern) -->> KiCadLibraryPlugin: Attachment added
  PartAttachment (Legacy) -->> KiCadLibraryPlugin: Attachment added

  Note over KiCadLibraryPlugin,User: Attachment process complete
sequenceDiagram
  participant User
  participant serializers.py
  participant Attachment

  User ->> serializers.py: get_datasheet(part)
  serializers.py ->>+ Attachment: Filter attachments by case-insensitive "datasheet"
  Attachment -->> serializers.py: Return filtered datasheet
  serializers.py -->> User: Returned datasheet

Poem

🐰 In code, we find a new delight,
As attachments now are handled right.
Modern or legacy, all in flow,
Improved, the datasheets now show.
With changes swift and filters keen,
Our library's efficiency clearly seen.
📚✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.