Add Dataset.tables_columns and tables_rows

[hagenw]

Closes #111

This adds the cached properties audbcards.Dataset.tables_columns and audbcards.Dataset.tables_rows,
which return the number of columns and rows for each table of a dataset.

In addition, it uses those in the HTML table preview:

Under the hood, it adds the private cached property audbcards.Dataset._tables_stats() to avoid loading the tables multiple times.

Summary by Sourcery

Add new cached properties tables_columns and tables_rows to the audbcards.Dataset class to provide table dimensions, and enhance the HTML table preview to display these dimensions. Update tests to cover the new properties.

New Features:

• Introduce cached properties tables_columns and tables_rows in the audbcards.Dataset class to provide the number of columns and rows for each table in a dataset.

Enhancements:

• Enhance the HTML table preview by displaying the number of rows and columns for each table.

Tests:

• Update tests to include validation for the new tables_columns and tables_rows properties.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds new cached properties tables_columns and tables_rows to the audbcards.Dataset class, providing information about the number of columns and rows for each table in a dataset. It also introduces a private cached property _tables_stats to optimize performance by avoiding multiple table loads. The changes are integrated into the HTML table preview to display table statistics.

User journey diagram for HTML table preview enhancement

journey
    title User Journey for Enhanced HTML Table Preview
    section Accessing Dataset Table Information
      User accesses dataset table preview: 5: User
      System retrieves table statistics using tables_columns and tables_rows: 4: System
      System displays enhanced table preview with row and column counts: 5: System
    section Viewing Table Statistics
      User views table statistics in HTML preview: 5: User
      User sees number of rows and columns for each table: 5: User

Loading

Class diagram for audbcards.Dataset with new properties

classDiagram
    class Dataset {
        +cached_property tables_columns: Dict[str, int]
        +cached_property tables_rows: Dict[str, int]
        +cached_property tables_preview: Dict[str, List[List[str]]]
        +cached_property tables_table: List[str]
        +cached_property _tables_stats: Dict[str, dict]
    }
    note for Dataset "New properties tables_columns and tables_rows added"
    note for Dataset "Private cached property _tables_stats added for performance optimization"

Loading

File-Level Changes

Change	Details	Files
Add new cached properties to Dataset class	Implement tables_columns property to return number of columns for each table Implement tables_rows property to return number of rows for each table Add private _tables_stats property to cache table information and improve performance	audbcards/core/dataset.py
Update HTML table preview to include row and column counts	Modify table preview template to display row and column counts for each table Add CSS styling for the new table statistics	audbcards/core/templates/datacard_tables.j2 audbcards/sphinx/table-preview.css
Extend and update tests for new functionality	Add test cases for tables_columns and tables_rows properties Update existing tests to accommodate new properties and behavior Modify test parameters to include expected values for new properties	tests/test_dataset.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.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a 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. You can also use
  this command to specify where the summary should be inserted.

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 @hagenw - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 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.}

[sourcery-ai]

Hey @hagenw - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟡 Complexity: 1 issue found
• 🟢 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.}

[hagenw]

@sourcery-ai review

[sourcery-ai]

Hey @hagenw - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 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.}

[ChristianGeng]

The caching structure will be modified in #115. This MR is a precursor work and will be approved.