Skip to content

Deprecate src_filenames in CsvConcat#667

Merged
skxeve merged 6 commits intoBrainPad:masterfrom
chiradeep-nanabala:master
Apr 3, 2026
Merged

Deprecate src_filenames in CsvConcat#667
skxeve merged 6 commits intoBrainPad:masterfrom
chiradeep-nanabala:master

Conversation

@chiradeep-nanabala
Copy link
Copy Markdown
Contributor

Brief

Deprecate src_filenames parameter in CsvConcat to pave the way for its removal in v4.0.

src_filenames is redundant since src_pattern already covers file selection, is unique to CsvConcat (inconsistent with the rest of the
ecosystem), and adds unnecessary complexity to the validation logic. When src_filenames is used, a DeprecationWarning is now emitted
pointing users to src_pattern instead.

Points to Check

  • DeprecationWarning is emitted via the existing _warn_deprecated utility, consistent with other deprecations in the codebase
    (ObjectStore, cliboa.util.helper, etc.)
  • Backward compatibility is fully maintained — src_filenames still works, no existing behaviour is broken
  • Documentation updated: parameter table marks src_filenames as deprecated, example replaced with src_pattern equivalent

Test

Confirmed

  • Existing test_execute_ok1 and test_execute_ok5 updated to assert DeprecationWarning is emitted
  • New dedicated test test_execute_src_filenames_emits_deprecation_warning added to explicitly verify the warning fires
  • All 11 TestCsvConcat tests pass

Review Limit

  • [Deprecate src_filenames in CsvConcat

Fixes #666

Copy link
Copy Markdown
Collaborator

@skxeve skxeve left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! Could you please address the comments above?

Comment thread cliboa/scenario/transform/csv.py Outdated
else:
_warn_deprecated(
"CsvConcat.src_filenames",
end_version="3.0",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Since the next version will be 3.1.x, the deprecation will take effect in version 3.1 or later.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for flagging. Addressed this issue.

Comment thread cliboa/scenario/transform/csv.py Outdated
files = self.get_src_files()
else:
_warn_deprecated(
"CsvConcat.src_filenames",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Since CsvConcat.src_filenames is not defined, please change it to CsvConcat.Arguments.src_filenames. Please also follow this format for the 'instead' description.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for flagging. Fixed this.

@chiradeep-nanabala
Copy link
Copy Markdown
Contributor Author

Could you please review the PR now?

Copy link
Copy Markdown
Collaborator

@skxeve skxeve left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you for addressing my comments and fixing the issues.

@skxeve skxeve merged commit 1fd8e80 into BrainPad:master Apr 3, 2026
5 checks passed
@skxeve skxeve added the maintenance For repository maintenance and management. label Apr 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance For repository maintenance and management.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecate src_filenames in CsvConcat

2 participants