feat: Labeled enumerations

[edgarrmondragon]

Summary by Sourcery

New Features:

• Add a "title" field to JSON schema types, allowing for labeled enumerations.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces the ability to add titles to JSON schema types, specifically for Constant and OneOf types, enhancing readability and context within the schema. The JSONTypeHelper class was updated to include a title attribute.

Entity relationship diagram showing JSON Schema type structure

erDiagram
    JSONSchema ||--o{ Constant : contains
    Constant {
        string const
        string title
    }
    JSONSchema ||--o{ OneOf : contains
    OneOf ||--|{ Constant : combines

Loading

Class diagram showing the updated JSONTypeHelper and Constant classes

classDiagram
    class JSONTypeHelper {
        +allowed_values: list[T]
        +examples: list[T]
        +nullable: bool
        +title: str
        +type_dict(): dict
        +extras(): dict
        +to_dict(): dict
    }
    class Constant {
        +value: _JsonValue
        +type_dict(): dict
    }
    JSONTypeHelper <|-- Constant
    note for JSONTypeHelper "Added title attribute"
    note for Constant "Updated to support title"

Loading

File-Level Changes

Change	Details	Files
Added support for 'title' attribute in JSONTypeHelper.	Added title attribute to the JSONTypeHelper class. Updated the constructor to accept a title argument. Modified the extras method to include the title in the output dictionary.	singer_sdk/typing.py
Implemented title support for Constant type.	Updated the Constant class to inherit from JSONTypeHelper and accept keyword arguments. Modified the type_dict method to include the title in the output dictionary.	singer_sdk/typing.py
Added example for OneOf with Constant types.	Added an example demonstrating the usage of OneOf with Constant types, including titles.	singer_sdk/typing.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.

[codecov]

Codecov Report

Attention: Patch coverage is 60.00000% with 4 lines in your changes missing coverage. Please review.

Project coverage is 91.26%. Comparing base (61a0b88) to head (1ddaf53).

Files with missing lines	Patch %	Lines
singer_sdk/typing.py	60.00%	2 Missing and 2 partials ⚠️

❌ Your patch check has failed because the patch coverage (60.00%) is below the target coverage (100.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2875      +/-   ##
==========================================
- Coverage   91.33%   91.26%   -0.07%     
==========================================
  Files          62       62              
  Lines        5203     5211       +8     
  Branches      675      677       +2     
==========================================
+ Hits         4752     4756       +4     
- Misses        319      321       +2     
- Partials      132      134       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[codspeed-hq]

CodSpeed Performance Report

Merging #2875 will not alter performance

_{Comparing edgarrmondragon/feat/labeled-enums (1ddaf53) with main (61a0b88)}

Summary

✅ 7 untouched benchmarks