Fix display of non-indexable attribute values

[leroyvn]

Hi, this is a tentative fix for a bug where global attributes with values that cannot be indexed would be displayed as "empty." This is problematic when an attribute value has a scalar type (e.g. float, int, bool...).

I don't know the criteria for flagging an attribute as "empty", so I simply output the value repr without additional processing (empty strings should by displayed as ''). If this behaviour is not desirable, I'll be happy to change it.

Example

Before:

After:

Summary by Sourcery

Bug Fixes:

• Fixed a bug where global attributes with non-indexable values (e.g., float, int, bool) were displayed as "empty".

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request fixes a bug where global attributes with values that cannot be indexed were displayed as "empty". The fix involves outputting the value repr without additional processing when an IndexError occurs, ensuring that scalar types like float, int, and bool are displayed correctly.

Sequence diagram for global attribute value display process

sequenceDiagram
    participant Client
    participant NCDump
    participant NCFile

    Client->>NCDump: print_global_attrs()
    NCDump->>NCFile: getncattr(nc_attr)
    NCFile-->>NCDump: ncattr_value
    alt value is indexable
        NCDump->>NCDump: process and format value
    else value is not indexable (IndexError)
        NCDump->>NCDump: format using repr(ncattr_value)
    end
    NCDump-->>Client: display formatted attribute

Loading

Flow diagram for attribute value processing

flowchart TD
    A[Get attribute value] --> B{Can value be indexed?}
    B -->|Yes| C[Process value normally]
    B -->|No| D[Use repr of value]
    C --> E[Display formatted value]
    D --> E

Loading

File-Level Changes

Change	Details	Files
Handled the IndexError exception when accessing global attributes to display the attribute's representation instead of flagging it as 'empty'.	Modified the print_global_attrs method to catch IndexError when accessing ncattr_value. Instead of printing '[red]empty[/red]', the code now prints the repr(ncattr_value) when an IndexError occurs.	src/ncdump_rich/ncdump.py
Refactored the print_global_attrs method to improve readability and reduce redundancy.	Assigned the result of self.nc_file.getncattr(nc_attr) to the ncattr_value variable to avoid calling the method multiple times. Replaced string concatenation with f-strings for improved readability. Removed an unnecessary conditional check that always evaluated to true.	src/ncdump_rich/ncdump.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @leroyvn - I've reviewed your changes - here's some feedback:

Overall Comments:

• The approach of catching an IndexError to determine non-indexable attributes works, but it might be clearer to check the type of ncattr_value before attempting to index it. For example, using isinstance(ncattr_value, (list, tuple, str)) would avoid relying on exceptions for control flow.
• The change to use f-string formatting improves readability. However, consider adding a brief inline comment explaining why using repr(ncattr_value) is appropriate here for non-indexable types, to help future maintainers understand the intent.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}