AlexisBRENON opened a new pull request, #49766:
URL: https://github.com/apache/airflow/pull/49766
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
Split the execute method to move the "file listing" retrieval to a dedicated
method.
This allow to apply arbitrary modification of file listing more easily.
My use case is to sample the file listing (to avoid to copy too much file on
a run, just copy 1/1000).
With the previous implementation, I had to override the whole `execute`
method, to be able to manipulate the `s3_objects` list before passing it to the
transfer methods.
```py
class MyOperator(S3ToGcsOperator):
def execute(...):
# [...]
s3_objects = S3ListOperator.execute(self, context) # Update here to
call the right method
s3_objects = sample(s3_objects) # Add my sampling method
# [...] Copy the rest of the method, keeping it in sync with upstream
```
With the new implementation, I can only override the `_get_files` one,
mostly calling the `super` method and just modify the list before return.
```py
class MyOperator(S3ToGcsOperator):
def _get_files(...):
s3_objects = super()._get_files(...)
return sample(s3_objects) # Add my sampling method
```
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a
newsfragment file, named `{pr_number}.significant.rst` or
`{issue_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
