This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 0ee65307ca5 refactor(providers/common/io): move common io provider to
new structure (#46111)
0ee65307ca5 is described below
commit 0ee65307ca556b57bb382aee2a9abd9db356035d
Author: Josix <[email protected]>
AuthorDate: Mon Jan 27 22:10:01 2025 +0800
refactor(providers/common/io): move common io provider to new structure
(#46111)
---
.github/boring-cyborg.yml | 4 +-
.../tests/test_pytest_args_for_test_types.py | 2 +-
dev/breeze/tests/test_selective_checks.py | 4 +-
docs/.gitignore | 1 +
.../changelog.rst | 25 ---
providers/common/io/README.rst | 81 +++++++++
.../io/docs}/.latest-doc-only-change.txt | 0
.../CHANGELOG.rst => common/io/docs/changelog.rst} | 0
.../common/io/docs}/commits.rst | 0
.../common/io/docs}/configurations-ref.rst | 0
.../common/io/docs}/index.rst | 0
.../io/docs}/installing-providers-from-sources.rst | 0
.../common/io/docs}/operators.rst | 2 +-
.../common/io/docs}/security.rst | 0
.../common/io/docs}/transfer.rst | 0
.../common/io/docs}/xcom_backend.rst | 0
.../airflow/providers => }/common/io/provider.yaml | 3 -
providers/common/io/pyproject.toml | 87 +++++++++
.../io/src/airflow/providers/common/io/LICENSE | 201 +++++++++++++++++++++
.../src/airflow/providers/common/io/__init__.py | 0
.../airflow/providers/common/io/assets/__init__.py | 0
.../providers/common/io/assets/assets/__init__.py | 0
.../src/airflow/providers/common/io/assets/file.py | 0
.../providers/common/io/get_provider_info.py | 108 +++++++++++
.../providers/common/io/operators/__init__.py | 0
.../providers/common/io/operators/file_transfer.py | 0
.../airflow/providers/common/io/version_compat.py | 0
.../airflow/providers/common/io/xcom/__init__.py | 0
.../airflow/providers/common/io/xcom/backend.py | 0
.../__init__.py => common/io/tests/conftest.py} | 20 +-
.../io/tests/provider_tests}/__init__.py | 1 +
.../io/tests/provider_tests/common}/__init__.py | 1 +
.../io/tests/provider_tests}/common/io/__init__.py | 0
.../provider_tests}/common/io/assets/__init__.py | 0
.../provider_tests}/common/io/assets/test_file.py | 0
.../common/io/operators/__init__.py | 0
.../common/io/operators/test_file_transfer.py | 0
.../provider_tests}/common/io/xcom/__init__.py | 0
.../provider_tests}/common/io/xcom/test_backend.py | 5 +-
.../io}/tests/system/common/io/__init__.py | 0
.../common/io/example_file_transfer_local_to_s3.py | 0
pyproject.toml | 3 +
scripts/ci/docker-compose/remove-sources.yml | 1 +
scripts/ci/docker-compose/tests-sources.yml | 1 +
44 files changed, 503 insertions(+), 47 deletions(-)
diff --git a/.github/boring-cyborg.yml b/.github/boring-cyborg.yml
index 76c7f98cd62..96beb19f476 100644
--- a/.github/boring-cyborg.yml
+++ b/.github/boring-cyborg.yml
@@ -145,9 +145,7 @@ labelPRBasedOnFilePath:
- providers/common/compat/**
provider:common-io:
- - providers/src/airflow/providers/common/io/**/*
- - docs/apache-airflow-providers-common-io/**/*
- - providers/tests/system/common/io/**/*
+ - providers/common/io/**
provider:common-sql:
- providers/common/sql/**
diff --git a/dev/breeze/tests/test_pytest_args_for_test_types.py
b/dev/breeze/tests/test_pytest_args_for_test_types.py
index c9e74fd5897..3c71eadd50f 100644
--- a/dev/breeze/tests/test_pytest_args_for_test_types.py
+++ b/dev/breeze/tests/test_pytest_args_for_test_types.py
@@ -90,7 +90,7 @@ def _all_new_providers() -> list[str]:
(
GroupOfTests.PROVIDERS,
"Providers[common.io]",
- ["providers/tests/common/io"],
+ ["providers/common/io/tests"],
),
(
GroupOfTests.PROVIDERS,
diff --git a/dev/breeze/tests/test_selective_checks.py
b/dev/breeze/tests/test_selective_checks.py
index 05d4ed7ed7f..268675d256d 100644
--- a/dev/breeze/tests/test_selective_checks.py
+++ b/dev/breeze/tests/test_selective_checks.py
@@ -798,8 +798,8 @@ def assert_outputs_are_printed(expected_outputs: dict[str,
str], stderr: str):
pytest.param(
(
"tests/always/test_project_structure.py",
- "providers/tests/common/io/operators/__init__.py",
- "providers/tests/common/io/operators/test_file_transfer.py",
+ "providers/common/io/tests/operators/__init__.py",
+ "providers/common/io/tests/operators/test_file_transfer.py",
),
{
"selected-providers-list-as-string": "common.compat common.io
openlineage",
diff --git a/docs/.gitignore b/docs/.gitignore
index c9c611efa80..d7f61d9b567 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -11,6 +11,7 @@ apache-airflow-providers-asana
apache-airflow-providers-celery
apache-airflow-providers-cohere
apache-airflow-providers-common-compat
+apache-airflow-providers-common-io
apache-airflow-providers-common-sql
apache-airflow-providers-datadog
apache-airflow-providers-edge
diff --git a/docs/apache-airflow-providers-common-io/changelog.rst
b/docs/apache-airflow-providers-common-io/changelog.rst
deleted file mode 100644
index 8662eabd816..00000000000
--- a/docs/apache-airflow-providers-common-io/changelog.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-
- .. 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.
-
- .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE
- OVERWRITTEN WHEN PREPARING PACKAGES.
-
- .. IF YOU WANT TO MODIFY THIS FILE, YOU SHOULD MODIFY THE TEMPLATE
- `PROVIDER_CHANGELOG_TEMPLATE.rst.jinja2` IN the
`dev/breeze/src/airflow_breeze/templates` DIRECTORY
-
-.. include:: ../../providers/src/airflow/providers/common/io/CHANGELOG.rst
diff --git a/providers/common/io/README.rst b/providers/common/io/README.rst
new file mode 100644
index 00000000000..5c21c7fd622
--- /dev/null
+++ b/providers/common/io/README.rst
@@ -0,0 +1,81 @@
+
+ .. 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.
+
+ .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!
+
+ .. IF YOU WANT TO MODIFY TEMPLATE FOR THIS FILE, YOU SHOULD MODIFY THE
TEMPLATE
+ `PROVIDER_README_TEMPLATE.rst.jinja2` IN the
`dev/breeze/src/airflow_breeze/templates` DIRECTORY
+
+
+Package ``apache-airflow-providers-common-io``
+
+Release: ``1.5.0``
+
+
+``Common IO Provider``
+
+
+Provider package
+----------------
+
+This is a provider package for ``common.io`` provider. All classes for this
provider package
+are in ``airflow.providers.common.io`` python package.
+
+You can find package information and changelog for the provider
+in the `documentation
<https://airflow.apache.org/docs/apache-airflow-providers-common-io/1.5.0/>`_.
+
+Installation
+------------
+
+You can install this package on top of an existing Airflow 2 installation (see
``Requirements`` below
+for the minimum Airflow version supported) via
+``pip install apache-airflow-providers-common-io``
+
+The package supports the following python versions: 3.9,3.10,3.11,3.12
+
+Requirements
+------------
+
+================== ==================
+PIP package Version required
+================== ==================
+``apache-airflow`` ``>=2.9.0``
+================== ==================
+
+Cross provider package dependencies
+-----------------------------------
+
+Those are dependencies that might be needed in order to use all the features
of the package.
+You need to install the specified provider packages in order to use them.
+
+You can install such cross-provider dependencies when installing from PyPI.
For example:
+
+.. code-block:: bash
+
+ pip install apache-airflow-providers-common-io[common.compat]
+
+
+==================================================================================================================
=================
+Dependent package
Extra
+==================================================================================================================
=================
+`apache-airflow-providers-common-compat
<https://airflow.apache.org/docs/apache-airflow-providers-common-compat>`_
``common.compat``
+`apache-airflow-providers-openlineage
<https://airflow.apache.org/docs/apache-airflow-providers-openlineage>`_
``openlineage``
+==================================================================================================================
=================
+
+The changelog for the provider package can be found in the
+`changelog
<https://airflow.apache.org/docs/apache-airflow-providers-common-io/1.5.0/changelog.html>`_.
diff --git
a/providers/src/airflow/providers/common/io/.latest-doc-only-change.txt
b/providers/common/io/docs/.latest-doc-only-change.txt
similarity index 100%
rename from
providers/src/airflow/providers/common/io/.latest-doc-only-change.txt
rename to providers/common/io/docs/.latest-doc-only-change.txt
diff --git a/providers/src/airflow/providers/common/io/CHANGELOG.rst
b/providers/common/io/docs/changelog.rst
similarity index 100%
rename from providers/src/airflow/providers/common/io/CHANGELOG.rst
rename to providers/common/io/docs/changelog.rst
diff --git a/docs/apache-airflow-providers-common-io/commits.rst
b/providers/common/io/docs/commits.rst
similarity index 100%
rename from docs/apache-airflow-providers-common-io/commits.rst
rename to providers/common/io/docs/commits.rst
diff --git a/docs/apache-airflow-providers-common-io/configurations-ref.rst
b/providers/common/io/docs/configurations-ref.rst
similarity index 100%
rename from docs/apache-airflow-providers-common-io/configurations-ref.rst
rename to providers/common/io/docs/configurations-ref.rst
diff --git a/docs/apache-airflow-providers-common-io/index.rst
b/providers/common/io/docs/index.rst
similarity index 100%
rename from docs/apache-airflow-providers-common-io/index.rst
rename to providers/common/io/docs/index.rst
diff --git
a/docs/apache-airflow-providers-common-io/installing-providers-from-sources.rst
b/providers/common/io/docs/installing-providers-from-sources.rst
similarity index 100%
rename from
docs/apache-airflow-providers-common-io/installing-providers-from-sources.rst
rename to providers/common/io/docs/installing-providers-from-sources.rst
diff --git a/docs/apache-airflow-providers-common-io/operators.rst
b/providers/common/io/docs/operators.rst
similarity index 94%
rename from docs/apache-airflow-providers-common-io/operators.rst
rename to providers/common/io/docs/operators.rst
index fee5bb8eac5..95f55125d19 100644
--- a/docs/apache-airflow-providers-common-io/operators.rst
+++ b/providers/common/io/docs/operators.rst
@@ -40,7 +40,7 @@ Otherwise the data will be streamed from the source to the
destination.
The example below shows how to instantiate the FileTransferOperator task.
-.. exampleinclude::
/../../providers/tests/system/common/io/example_file_transfer_local_to_s3.py
+.. exampleinclude::
/../../providers/common/io/tests/system/common/io/example_file_transfer_local_to_s3.py
:language: python
:dedent: 4
:start-after: [START howto_transfer_local_to_s3]
diff --git a/docs/apache-airflow-providers-common-io/security.rst
b/providers/common/io/docs/security.rst
similarity index 100%
rename from docs/apache-airflow-providers-common-io/security.rst
rename to providers/common/io/docs/security.rst
diff --git a/docs/apache-airflow-providers-common-io/transfer.rst
b/providers/common/io/docs/transfer.rst
similarity index 100%
rename from docs/apache-airflow-providers-common-io/transfer.rst
rename to providers/common/io/docs/transfer.rst
diff --git a/docs/apache-airflow-providers-common-io/xcom_backend.rst
b/providers/common/io/docs/xcom_backend.rst
similarity index 100%
rename from docs/apache-airflow-providers-common-io/xcom_backend.rst
rename to providers/common/io/docs/xcom_backend.rst
diff --git a/providers/src/airflow/providers/common/io/provider.yaml
b/providers/common/io/provider.yaml
similarity index 98%
rename from providers/src/airflow/providers/common/io/provider.yaml
rename to providers/common/io/provider.yaml
index cf0f2fa43a6..143a45fd6a4 100644
--- a/providers/src/airflow/providers/common/io/provider.yaml
+++ b/providers/common/io/provider.yaml
@@ -37,9 +37,6 @@ versions:
- 1.0.1
- 1.0.0
-dependencies:
- - apache-airflow>=2.9.0
-
integrations:
- integration-name: Common IO
external-doc-url:
https://filesystem-spec.readthedocs.io/en/latest/index.html
diff --git a/providers/common/io/pyproject.toml
b/providers/common/io/pyproject.toml
new file mode 100644
index 00000000000..a16bbf5838d
--- /dev/null
+++ b/providers/common/io/pyproject.toml
@@ -0,0 +1,87 @@
+# 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.
+
+# NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!
+
+# IF YOU WANT TO MODIFY THIS FILE EXCEPT DEPENDENCIES, YOU SHOULD MODIFY THE
TEMPLATE
+# `pyproject_TEMPLATE.toml.jinja2` IN the
`dev/breeze/src/airflow_breeze/templates` DIRECTORY
+[build-system]
+requires = ["flit_core==3.10.1"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "apache-airflow-providers-common-io"
+version = "1.5.0"
+description = "Provider package apache-airflow-providers-common-io for Apache
Airflow"
+readme = "README.rst"
+authors = [
+ {name="Apache Software Foundation", email="[email protected]"},
+]
+maintainers = [
+ {name="Apache Software Foundation", email="[email protected]"},
+]
+keywords = [ "airflow-provider", "common.io", "airflow", "integration" ]
+classifiers = [
+ "Development Status :: 5 - Production/Stable",
+ "Environment :: Console",
+ "Environment :: Web Environment",
+ "Intended Audience :: Developers",
+ "Intended Audience :: System Administrators",
+ "Framework :: Apache Airflow",
+ "Framework :: Apache Airflow :: Provider",
+ "License :: OSI Approved :: Apache Software License",
+ "Programming Language :: Python :: 3.9",
+ "Programming Language :: Python :: 3.10",
+ "Programming Language :: Python :: 3.11",
+ "Programming Language :: Python :: 3.12",
+ "Topic :: System :: Monitoring",
+]
+requires-python = "~=3.9"
+
+# The dependencies should be modified in place in the generated file
+# Any change in the dependencies is preserved when the file is regenerated
+dependencies = [
+ "apache-airflow>=2.9.0",
+]
+
+# The optional dependencies should be modified in place in the generated file
+# Any change in the dependencies is preserved when the file is regenerated
+[project.optional-dependencies]
+"common.compat" = [
+ "apache-airflow-providers-common-compat"
+]
+"openlineage" = [
+ "apache-airflow-providers-openlineage"
+]
+
+[project.urls]
+"Documentation" =
"https://airflow.apache.org/docs/apache-airflow-providers-common-io/1.5.0"
+"Changelog" =
"https://airflow.apache.org/docs/apache-airflow-providers-common-io/1.5.0/changelog.html"
+"Bug Tracker" = "https://github.com/apache/airflow/issues"
+"Source Code" = "https://github.com/apache/airflow"
+"Slack Chat" = "https://s.apache.org/airflow-slack"
+"Twitter" = "https://x.com/ApacheAirflow"
+"YouTube" = "https://www.youtube.com/channel/UCSXwxpWZQ7XZ1WL3wqevChA/"
+
+[project.entry-points."apache_airflow_provider"]
+provider_info =
"airflow.providers.common.io.get_provider_info:get_provider_info"
+
+[tool.flit.module]
+name = "airflow.providers.common.io"
+
+[tool.pytest.ini_options]
+ignore = "tests/system/"
diff --git a/providers/common/io/src/airflow/providers/common/io/LICENSE
b/providers/common/io/src/airflow/providers/common/io/LICENSE
new file mode 100644
index 00000000000..11069edd790
--- /dev/null
+++ b/providers/common/io/src/airflow/providers/common/io/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed 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.
diff --git a/providers/src/airflow/providers/common/io/__init__.py
b/providers/common/io/src/airflow/providers/common/io/__init__.py
similarity index 100%
rename from providers/src/airflow/providers/common/io/__init__.py
rename to providers/common/io/src/airflow/providers/common/io/__init__.py
diff --git a/providers/src/airflow/providers/common/io/assets/__init__.py
b/providers/common/io/src/airflow/providers/common/io/assets/__init__.py
similarity index 100%
rename from providers/src/airflow/providers/common/io/assets/__init__.py
rename to providers/common/io/src/airflow/providers/common/io/assets/__init__.py
diff --git
a/providers/src/airflow/providers/common/io/assets/assets/__init__.py
b/providers/common/io/src/airflow/providers/common/io/assets/assets/__init__.py
similarity index 100%
rename from providers/src/airflow/providers/common/io/assets/assets/__init__.py
rename to
providers/common/io/src/airflow/providers/common/io/assets/assets/__init__.py
diff --git a/providers/src/airflow/providers/common/io/assets/file.py
b/providers/common/io/src/airflow/providers/common/io/assets/file.py
similarity index 100%
rename from providers/src/airflow/providers/common/io/assets/file.py
rename to providers/common/io/src/airflow/providers/common/io/assets/file.py
diff --git
a/providers/common/io/src/airflow/providers/common/io/get_provider_info.py
b/providers/common/io/src/airflow/providers/common/io/get_provider_info.py
new file mode 100644
index 00000000000..698e9e61613
--- /dev/null
+++ b/providers/common/io/src/airflow/providers/common/io/get_provider_info.py
@@ -0,0 +1,108 @@
+# 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.
+
+# NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!
+#
+# IF YOU WANT TO MODIFY THIS FILE, YOU SHOULD MODIFY THE TEMPLATE
+# `get_provider_info_TEMPLATE.py.jinja2` IN the
`dev/breeze/src/airflow_breeze/templates` DIRECTORY
+
+
+def get_provider_info():
+ return {
+ "package-name": "apache-airflow-providers-common-io",
+ "name": "Common IO",
+ "description": "``Common IO Provider``\n",
+ "state": "ready",
+ "source-date-epoch": 1734529505,
+ "versions": [
+ "1.5.0",
+ "1.4.2",
+ "1.4.1",
+ "1.4.0",
+ "1.3.2",
+ "1.3.1",
+ "1.3.0",
+ "1.2.0",
+ "1.1.0",
+ "1.0.1",
+ "1.0.0",
+ ],
+ "integrations": [
+ {
+ "integration-name": "Common IO",
+ "external-doc-url":
"https://filesystem-spec.readthedocs.io/en/latest/index.html",
+ "how-to-guide":
["/docs/apache-airflow-providers-common-io/operators.rst"],
+ "tags": ["software"],
+ }
+ ],
+ "operators": [
+ {
+ "integration-name": "Common IO",
+ "python-modules":
["airflow.providers.common.io.operators.file_transfer"],
+ }
+ ],
+ "xcom": ["airflow.providers.common.io.xcom.backend"],
+ "asset-uris": [
+ {
+ "schemes": ["file"],
+ "handler":
"airflow.providers.common.io.assets.file.sanitize_uri",
+ "to_openlineage_converter":
"airflow.providers.common.io.assets.file.convert_asset_to_openlineage",
+ "factory":
"airflow.providers.common.io.assets.file.create_asset",
+ }
+ ],
+ "dataset-uris": [
+ {
+ "schemes": ["file"],
+ "handler":
"airflow.providers.common.io.assets.file.sanitize_uri",
+ "to_openlineage_converter":
"airflow.providers.common.io.assets.file.convert_asset_to_openlineage",
+ "factory":
"airflow.providers.common.io.assets.file.create_asset",
+ }
+ ],
+ "config": {
+ "common.io": {
+ "description": "Common IO configuration section",
+ "options": {
+ "xcom_objectstorage_path": {
+ "description": "Path to a location on object storage
where XComs can be stored in url format.\n",
+ "version_added": "1.3.0",
+ "type": "string",
+ "example": "s3://conn_id@bucket/path",
+ "default": "",
+ },
+ "xcom_objectstorage_threshold": {
+ "description": "Threshold in bytes for storing XComs
in object storage. -1 means always store in the\ndatabase. 0 means always store
in object storage. Any positive number means\nit will be stored in object
storage if the size of the value is greater than the threshold.\n",
+ "version_added": "1.3.0",
+ "type": "integer",
+ "example": "1000000",
+ "default": "-1",
+ },
+ "xcom_objectstorage_compression": {
+ "description": "Compression algorithm to use when
storing XComs in object storage. Supported algorithms\nare a.o.: snappy, zip,
gzip, bz2, and lzma. If not specified, no compression will be used.\nNote that
the compression algorithm must be available in the Python installation
(e.g.\npython-snappy for snappy). Zip, gz, bz2 are available by default.\n",
+ "version_added": "1.3.0",
+ "type": "string",
+ "example": "gz",
+ "default": "",
+ },
+ },
+ }
+ },
+ "dependencies": ["apache-airflow>=2.9.0"],
+ "optional-dependencies": {
+ "common.compat": ["apache-airflow-providers-common-compat"],
+ "openlineage": ["apache-airflow-providers-openlineage"],
+ },
+ }
diff --git a/providers/src/airflow/providers/common/io/operators/__init__.py
b/providers/common/io/src/airflow/providers/common/io/operators/__init__.py
similarity index 100%
rename from providers/src/airflow/providers/common/io/operators/__init__.py
rename to
providers/common/io/src/airflow/providers/common/io/operators/__init__.py
diff --git
a/providers/src/airflow/providers/common/io/operators/file_transfer.py
b/providers/common/io/src/airflow/providers/common/io/operators/file_transfer.py
similarity index 100%
rename from providers/src/airflow/providers/common/io/operators/file_transfer.py
rename to
providers/common/io/src/airflow/providers/common/io/operators/file_transfer.py
diff --git a/providers/src/airflow/providers/common/io/version_compat.py
b/providers/common/io/src/airflow/providers/common/io/version_compat.py
similarity index 100%
rename from providers/src/airflow/providers/common/io/version_compat.py
rename to providers/common/io/src/airflow/providers/common/io/version_compat.py
diff --git a/providers/src/airflow/providers/common/io/xcom/__init__.py
b/providers/common/io/src/airflow/providers/common/io/xcom/__init__.py
similarity index 100%
copy from providers/src/airflow/providers/common/io/xcom/__init__.py
copy to providers/common/io/src/airflow/providers/common/io/xcom/__init__.py
diff --git a/providers/src/airflow/providers/common/io/xcom/backend.py
b/providers/common/io/src/airflow/providers/common/io/xcom/backend.py
similarity index 100%
rename from providers/src/airflow/providers/common/io/xcom/backend.py
rename to providers/common/io/src/airflow/providers/common/io/xcom/backend.py
diff --git a/providers/src/airflow/providers/common/io/xcom/__init__.py
b/providers/common/io/tests/conftest.py
similarity index 62%
rename from providers/src/airflow/providers/common/io/xcom/__init__.py
rename to providers/common/io/tests/conftest.py
index b245035ddbf..068fe6bbf5a 100644
--- a/providers/src/airflow/providers/common/io/xcom/__init__.py
+++ b/providers/common/io/tests/conftest.py
@@ -16,15 +16,17 @@
# under the License.
from __future__ import annotations
-import packaging.version
+import pathlib
-from airflow import __version__ as airflow_version
-from airflow.exceptions import AirflowOptionalProviderFeatureException
+import pytest
-if
packaging.version.parse(packaging.version.parse(airflow_version).base_version)
< packaging.version.parse(
- "2.9.0"
-):
- raise AirflowOptionalProviderFeatureException(
- "The package xcom backend feature of
`apache-airflow-providers-common-io` needs "
- "Apache Airflow 2.9.0+"
+pytest_plugins = "tests_common.pytest_plugin"
+
+
[email protected](tryfirst=True)
+def pytest_configure(config: pytest.Config) -> None:
+ deprecations_ignore_path =
pathlib.Path(__file__).parent.joinpath("deprecations_ignore.yml")
+ dep_path = [deprecations_ignore_path] if deprecations_ignore_path.exists()
else []
+ config.inicfg["airflow_deprecations_ignore"] = (
+ config.inicfg.get("airflow_deprecations_ignore", []) + dep_path #
type: ignore[assignment,operator]
)
diff --git a/providers/tests/common/io/__init__.py
b/providers/common/io/tests/provider_tests/__init__.py
similarity index 90%
copy from providers/tests/common/io/__init__.py
copy to providers/common/io/tests/provider_tests/__init__.py
index 13a83393a91..e8fd2285643 100644
--- a/providers/tests/common/io/__init__.py
+++ b/providers/common/io/tests/provider_tests/__init__.py
@@ -14,3 +14,4 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
+__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type:
ignore
diff --git a/providers/tests/common/io/__init__.py
b/providers/common/io/tests/provider_tests/common/__init__.py
similarity index 90%
copy from providers/tests/common/io/__init__.py
copy to providers/common/io/tests/provider_tests/common/__init__.py
index 13a83393a91..e8fd2285643 100644
--- a/providers/tests/common/io/__init__.py
+++ b/providers/common/io/tests/provider_tests/common/__init__.py
@@ -14,3 +14,4 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
+__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type:
ignore
diff --git a/providers/tests/common/io/__init__.py
b/providers/common/io/tests/provider_tests/common/io/__init__.py
similarity index 100%
rename from providers/tests/common/io/__init__.py
rename to providers/common/io/tests/provider_tests/common/io/__init__.py
diff --git a/providers/tests/common/io/assets/__init__.py
b/providers/common/io/tests/provider_tests/common/io/assets/__init__.py
similarity index 100%
rename from providers/tests/common/io/assets/__init__.py
rename to providers/common/io/tests/provider_tests/common/io/assets/__init__.py
diff --git a/providers/tests/common/io/assets/test_file.py
b/providers/common/io/tests/provider_tests/common/io/assets/test_file.py
similarity index 100%
rename from providers/tests/common/io/assets/test_file.py
rename to providers/common/io/tests/provider_tests/common/io/assets/test_file.py
diff --git a/providers/tests/common/io/operators/__init__.py
b/providers/common/io/tests/provider_tests/common/io/operators/__init__.py
similarity index 100%
rename from providers/tests/common/io/operators/__init__.py
rename to
providers/common/io/tests/provider_tests/common/io/operators/__init__.py
diff --git a/providers/tests/common/io/operators/test_file_transfer.py
b/providers/common/io/tests/provider_tests/common/io/operators/test_file_transfer.py
similarity index 100%
rename from providers/tests/common/io/operators/test_file_transfer.py
rename to
providers/common/io/tests/provider_tests/common/io/operators/test_file_transfer.py
diff --git a/providers/tests/common/io/xcom/__init__.py
b/providers/common/io/tests/provider_tests/common/io/xcom/__init__.py
similarity index 100%
rename from providers/tests/common/io/xcom/__init__.py
rename to providers/common/io/tests/provider_tests/common/io/xcom/__init__.py
diff --git a/providers/tests/common/io/xcom/test_backend.py
b/providers/common/io/tests/provider_tests/common/io/xcom/test_backend.py
similarity index 99%
rename from providers/tests/common/io/xcom/test_backend.py
rename to
providers/common/io/tests/provider_tests/common/io/xcom/test_backend.py
index f4fc7ca8535..5b9b58b6adc 100644
--- a/providers/tests/common/io/xcom/test_backend.py
+++ b/providers/common/io/tests/provider_tests/common/io/xcom/test_backend.py
@@ -22,9 +22,6 @@ import pytest
import airflow.models.xcom
from airflow.models.xcom import BaseXCom, resolve_xcom_backend
from airflow.operators.empty import EmptyOperator
-
-pytestmark = [pytest.mark.db_test]
-
from airflow.providers.common.io.xcom.backend import XComObjectStorageBackend
from airflow.utils import timezone
from airflow.utils.xcom import XCOM_RETURN_KEY
@@ -32,6 +29,8 @@ from airflow.utils.xcom import XCOM_RETURN_KEY
from tests_common.test_utils import db
from tests_common.test_utils.config import conf_vars
+pytestmark = [pytest.mark.db_test]
+
@pytest.fixture(autouse=True)
def reset_db():
diff --git a/providers/tests/system/common/io/__init__.py
b/providers/common/io/tests/system/common/io/__init__.py
similarity index 100%
rename from providers/tests/system/common/io/__init__.py
rename to providers/common/io/tests/system/common/io/__init__.py
diff --git
a/providers/tests/system/common/io/example_file_transfer_local_to_s3.py
b/providers/common/io/tests/system/common/io/example_file_transfer_local_to_s3.py
similarity index 100%
rename from
providers/tests/system/common/io/example_file_transfer_local_to_s3.py
rename to
providers/common/io/tests/system/common/io/example_file_transfer_local_to_s3.py
diff --git a/pyproject.toml b/pyproject.toml
index 0e9f0c2fbc2..f79f1ad43dd 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -632,6 +632,7 @@ dev = [
"apache-airflow-providers-celery",
"apache-airflow-providers-cohere",
"apache-airflow-providers-common-compat",
+ "apache-airflow-providers-common-io",
"apache-airflow-providers-common-sql",
"apache-airflow-providers-datadog",
"apache-airflow-providers-edge",
@@ -684,6 +685,7 @@ apache-airflow-providers-asana = { workspace = true }
apache-airflow-providers-celery = {workspace = true}
apache-airflow-providers-cohere = { workspace = true }
apache-airflow-providers-common-compat = { workspace = true }
+apache-airflow-providers-common-io = { workspace = true }
apache-airflow-providers-common-sql = { workspace = true }
apache-airflow-providers-datadog = { workspace = true }
apache-airflow-providers-edge = {workspace = true}
@@ -734,6 +736,7 @@ members = [
"providers/celery",
"providers/cohere",
"providers/common/compat",
+ "providers/common/io",
"providers/common/sql",
"providers/datadog",
"providers/edge",
diff --git a/scripts/ci/docker-compose/remove-sources.yml
b/scripts/ci/docker-compose/remove-sources.yml
index 3bbf6f4ef9a..bcfc4e32be2 100644
--- a/scripts/ci/docker-compose/remove-sources.yml
+++ b/scripts/ci/docker-compose/remove-sources.yml
@@ -43,6 +43,7 @@ services:
- ../../../empty:/opt/airflow/providers/celery/src
- ../../../empty:/opt/airflow/providers/cohere/src
- ../../../empty:/opt/airflow/providers/common/compat/src
+ - ../../../empty:/opt/airflow/providers/common/io/src
- ../../../empty:/opt/airflow/providers/common/sql/src
- ../../../empty:/opt/airflow/providers/datadog/src
- ../../../empty:/opt/airflow/providers/edge/src
diff --git a/scripts/ci/docker-compose/tests-sources.yml
b/scripts/ci/docker-compose/tests-sources.yml
index 2820bef16e7..2d9f70c6ac5 100644
--- a/scripts/ci/docker-compose/tests-sources.yml
+++ b/scripts/ci/docker-compose/tests-sources.yml
@@ -50,6 +50,7 @@ services:
- ../../../providers/celery/tests:/opt/airflow/providers/celery/tests
- ../../../providers/cohere/tests:/opt/airflow/providers/cohere/tests
-
../../../providers/common/compat/tests:/opt/airflow/providers/common/compat/tests
+ -
../../../providers/common/io/tests:/opt/airflow/providers/common/io/tests
-
../../../providers/common/sql/tests:/opt/airflow/providers/common/sql/tests
- ../../../providers/datadog/tests:/opt/airflow/providers/datadog/tests
- ../../../providers/edge/tests:/opt/airflow/providers/edge/tests