Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: (low-code cdk) datetime format with milliseconds #369

Merged
merged 2 commits into from
Feb 27, 2025

Conversation

darynaishchenko
Copy link
Contributor

@darynaishchenko darynaishchenko commented Feb 26, 2025

What

https://github.com/airbytehq/airbyte-internal-issues/issues/11527

How

Added new custom placeholder for milliseconds %_ms. To process it %f(microseconds) is used (see airbyte_cdk/sources/declarative/datetime/datetime_parser.py).

Summary by CodeRabbit

  • New Features
    • Enhanced datetime functionality to support flexible parsing and formatting of strings with millisecond precision.
  • Documentation
    • Updated datetime format specifications to include a new zero-padded millisecond option.
  • Tests
    • Added new test cases to verify accurate parsing and formatting of datetime values with millisecond details.

@darynaishchenko darynaishchenko self-assigned this Feb 26, 2025
@github-actions github-actions bot added the enhancement New feature or request label Feb 26, 2025
@darynaishchenko darynaishchenko changed the title feat(low-code cdk) datetime format with milliseconds feat (low-code cdk) datetime format with milliseconds Feb 26, 2025
@darynaishchenko darynaishchenko changed the title feat (low-code cdk) datetime format with milliseconds feat: (low-code cdk) datetime format with milliseconds Feb 26, 2025
Copy link
Contributor

coderabbitai bot commented Feb 26, 2025

📝 Walkthrough

Walkthrough

This PR updates the datetime handling capabilities by modifying the DatetimeParser class. In both its parse and format methods, the code now detects the %_ms pattern and replaces it with %f to properly process millisecond values. The schema documentation is updated to include a %_ms placeholder, and new unit tests verify the correct parsing and formatting of datetime strings that include millisecond precision.
wdyt?

Changes

File(s) Change Summary
airbyte_cdk/sources/declarative/datetime/datetime_parser.py Enhanced parse and format methods to detect and replace %_ms with %f, allowing for correct millisecond parsing and formatting.
airbyte_cdk/.../declarative_component_schema.yaml Added %_ms placeholder (zero-padded to 3 digits) in the datetime format definitions to support millisecond representation.
unit_tests/.../datetime/test_datetime_parser.py Introduced a new test case to validate the parsing and formatting of datetime strings with millisecond precision.

Sequence Diagram(s)

Datetime Parsing Flow

sequenceDiagram
    participant U as User
    participant DP as DatetimeParser
    participant DS as datetime Library (strptime)
    
    U->>DP: call parse(date, format)
    DP->>DP: Check if format contains "%_ms"
    DP->>DP: Replace "%_ms" with "%f" if needed
    DP->>DS: Parse modified date string using strptime
    DS-->>DP: Return datetime object
    DP-->>U: Return parsed datetime
Loading

Datetime Formatting Flow

sequenceDiagram
    participant U as User
    participant DP as DatetimeParser
    participant DS as datetime Library (strftime)
    
    U->>DP: call format(datetime, format)
    DP->>DP: Check if format contains "%_ms"
    DP->>DP: Replace "%_ms" with "%f" if needed
    DP->>DS: Format datetime using strftime
    DP->>DP: Calculate milliseconds from microsecond
    DP->>DP: Replace microsecond part with calculated milliseconds
    DP-->>U: Return formatted datetime string
Loading

Would you like any further adjustments or clarifications?

Tip

CodeRabbit's docstrings feature is now available as part of our Pro Plan! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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.
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
airbyte_cdk/sources/declarative/datetime/datetime_parser.py (1)

52-56: The formatting implementation works well but could be slightly clearer.

The implementation correctly calculates milliseconds from microseconds and formats the output. However, the line 55 packs multiple operations into a single statement, which might be a bit challenging to read.

Would splitting this into multiple lines improve readability? Something like:

_format = format.replace("%_ms", "%f")
milliseconds = int(dt.microsecond / 1000)
formatted_with_micros = dt.strftime(_format)
micros_part = dt.strftime("%f")
milliseconds_formatted = f"{milliseconds:03d}"
formatted_dt = formatted_with_micros.replace(micros_part, milliseconds_formatted)

This is just a suggestion for readability, the current implementation works correctly. wdyt?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a402288 and 612455b.

📒 Files selected for processing (3)
  • airbyte_cdk/sources/declarative/datetime/datetime_parser.py (2 hunks)
  • airbyte_cdk/sources/declarative/declarative_component_schema.yaml (2 hunks)
  • unit_tests/sources/declarative/datetime/test_datetime_parser.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Check: 'source-pokeapi' (skip=false)
  • GitHub Check: Check: 'source-amplitude' (skip=false)
  • GitHub Check: Check: 'source-shopify' (skip=false)
  • GitHub Check: Check: 'source-hardcoded-records' (skip=false)
  • GitHub Check: Pytest (All, Python 3.11, Ubuntu)
  • GitHub Check: Pytest (All, Python 3.10, Ubuntu)
  • GitHub Check: Pytest (Fast)
  • GitHub Check: Analyze (python)
🔇 Additional comments (6)
unit_tests/sources/declarative/datetime/test_datetime_parser.py (2)

53-58: Great test case for the new millisecond format!

The test case properly validates that parsing a datetime string with milliseconds using the new %_ms format works correctly. It correctly expects a datetime object with 640000 microseconds (equivalent to 640 milliseconds).


100-105: Test case looks good for formatting with milliseconds!

This test complements the parsing test by verifying that formatting a datetime object with the %_ms specifier correctly produces a string with milliseconds. Good to see both directions being tested.

airbyte_cdk/sources/declarative/declarative_component_schema.yaml (2)

847-847: Documentation for the new format specifier looks good!

Clear documentation for the new %_ms millisecond format specifier. This will help users understand how to format datetime strings with milliseconds.


2405-2405: Documentation is consistent across the file.

Good job maintaining consistency by adding the same documentation in both relevant sections of the schema file.

airbyte_cdk/sources/declarative/datetime/datetime_parser.py (2)

34-35: Implementation for parsing milliseconds looks good!

The approach to replace %_ms with %f for parsing is elegant and leverages the existing microsecond parsing capability.


52-56:

✅ Verification successful

Consider edge cases with multiple %_ms occurrences.

The current implementation would handle multiple %_ms occurrences in the format string, but it might not replace all microsecond instances correctly since the replacement on line 55 would only affect the first occurrence of %f.

If this is a supported use case, would it be worth handling multiple replacements? If not, perhaps add a comment noting this limitation? wdyt?


🏁 Script executed:

#!/bin/bash
# Check if there are any format strings with multiple %_ms occurrences in tests or examples
grep -r "%_ms.*%_ms" --include="*.py" --include="*.yaml" .

Length of output: 60


Subject: Clarification on %_ms Replacement Behavior in DateTime Parser

I checked for multiple %_ms occurrences in tests and examples, and nothing was found. Additionally, since Python’s str.replace replaces all matches by default, the current implementation correctly handles multiple occurrences. Would you like to add a clarifying comment documenting that behavior, or are we comfortable leaving it as is? wdyt?

Copy link
Contributor

@artem1205 artem1205 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@darynaishchenko darynaishchenko merged commit 406542d into main Feb 27, 2025
23 of 26 checks passed
@darynaishchenko darynaishchenko deleted the daryna/low-code/milliseconds-datetime-format branch February 27, 2025 15:26
rpopov added a commit to rpopov/airbyte-python-cdk that referenced this pull request Mar 5, 2025
* main:
  fix: update cryptography package to latest version to address CVE (airbytehq#377)
  fix: (CDK) (HttpRequester) - Make the `HttpRequester.path` optional (airbytehq#370)
  feat: improved custom components handling (airbytehq#350)
  feat: add microseconds timestamp format (airbytehq#373)
  fix: Replace Unidecode with anyascii for permissive license (airbytehq#367)
  feat: add IncrementingCountCursor (airbytehq#346)
  feat: (low-code cdk)  datetime format with milliseconds (airbytehq#369)
  fix: (CDK) (AsyncRetriever) - Improve UX on variable naming and interpolation (airbytehq#368)
  fix: (CDK) (AsyncRetriever) - Add the `request` and `response` to each `async` operations (airbytehq#356)
  fix: (CDK) (ConnectorBuilder) - Add `auxiliary requests` to slice; support `TestRead` for AsyncRetriever (part 1/2) (airbytehq#355)
  feat(concurrent perpartition cursor): Add parent state updates (airbytehq#343)
  fix: update csv parser for builder compatibility (airbytehq#364)
  feat(low-code cdk): add interpolation for limit field in Rate (airbytehq#353)
  feat(low-code cdk): add AbstractStreamFacade processing as concurrent streams in declarative source (airbytehq#347)
  fix: (CDK) (CsvParser) - Fix the `\\` escaping when passing the `delimiter` from Builder's UI (airbytehq#358)
  feat: expose `str_to_datetime` jinja macro (airbytehq#351)
  fix: update CDK migration for 6.34.0 (airbytehq#348)
  feat: Removes `stream_state` interpolation from CDK (airbytehq#320)
  fix(declarative): Pass `extra_fields` in `global_substream_cursor` (airbytehq#195)
  feat(concurrent perpartition cursor): Refactor ConcurrentPerPartitionCursor (airbytehq#331)
  feat(HttpMocker): adding support for PUT requests and bytes responses (airbytehq#342)
  chore: use certified source for manifest-only test (airbytehq#338)
  feat: check for request_option mapping conflicts in individual components (airbytehq#328)
  feat(file-based): sync file acl permissions and identities (airbytehq#260)
  fix: (CDK) (Connector Builder) - refactor the `MessageGrouper` > `TestRead` (airbytehq#332)
  fix(low code): Fix missing cursor for ClientSideIncrementalRecordFilterDecorator (airbytehq#334)
  feat(low-code): Add API Budget (airbytehq#314)
  chore(decoder): clean decoders and make csvdecoder available (airbytehq#326)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants