This is an automated email from the ASF dual-hosted git repository.
jscheffl 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 240a147fcd7 refactor(providers/openai): move openai provider to new
structure (#46099)
240a147fcd7 is described below
commit 240a147fcd7f4ccec51c22a2f5bccc1fd031f8df
Author: Josix <[email protected]>
AuthorDate: Mon Jan 27 06:02:37 2025 +0800
refactor(providers/openai): move openai provider to new structure (#46099)
---
.github/boring-cyborg.yml | 5 +-
docs/.gitignore | 1 +
docs/apache-airflow-providers-openai/changelog.rst | 25 ---
providers/openai/README.rst | 62 +++++++
.../docs}/.latest-doc-only-change.txt | 0
.../CHANGELOG.rst => openai/docs/changelog.rst} | 0
.../openai/docs}/commits.rst | 0
.../openai/docs}/connections.rst | 0
.../openai/docs}/index.rst | 0
.../docs}/installing-providers-from-sources.rst | 0
.../openai/docs}/operators/openai.rst | 4 +-
.../openai/docs}/security.rst | 0
.../airflow/providers => }/openai/provider.yaml | 4 -
providers/openai/pyproject.toml | 78 ++++++++
.../openai/src/airflow/providers/openai/LICENSE | 201 +++++++++++++++++++++
.../src/airflow/providers/openai/__init__.py | 0
.../src/airflow/providers/openai/exceptions.py | 0
.../airflow/providers/openai/get_provider_info.py | 56 ++++++
.../src/airflow/providers/openai/hooks/__init__.py | 0
.../src/airflow/providers/openai/hooks/openai.py | 0
.../airflow/providers/openai/operators/__init__.py | 0
.../airflow/providers/openai/operators/openai.py | 2 +-
.../airflow/providers/openai/triggers/__init__.py | 0
.../airflow/providers/openai/triggers/openai.py | 0
.../exceptions.py => openai/tests/conftest.py} | 16 +-
.../tests/provider_tests}/__init__.py | 1 +
.../tests/provider_tests}/openai/__init__.py | 0
.../tests/provider_tests}/openai/hooks/__init__.py | 0
.../provider_tests}/openai/hooks/test_openai.py | 9 +-
.../provider_tests}/openai/operators/__init__.py | 0
.../openai/operators/test_openai.py | 4 +-
.../provider_tests}/openai/test_exceptions.py | 0
.../provider_tests}/openai/triggers/__init__.py | 0
.../provider_tests}/openai/triggers/test_openai.py | 5 +-
.../{ => openai}/tests/system/openai/__init__.py | 0
.../tests/system/openai/example_openai.py | 0
.../openai/example_trigger_batch_operator.py | 0
pyproject.toml | 3 +
scripts/ci/docker-compose/remove-sources.yml | 1 +
scripts/ci/docker-compose/tests-sources.yml | 1 +
40 files changed, 424 insertions(+), 54 deletions(-)
diff --git a/.github/boring-cyborg.yml b/.github/boring-cyborg.yml
index 40f4b45cb10..dccb8064144 100644
--- a/.github/boring-cyborg.yml
+++ b/.github/boring-cyborg.yml
@@ -328,10 +328,7 @@ labelPRBasedOnFilePath:
- providers/tests/odbc/**/*
provider:openai:
- - providers/src/airflow/providers/openai/**/*
- - docs/apache-airflow-providers-openai/**/*
- - providers/tests/openai/**/*
- - providers/tests/system/openai/**/*
+ - providers/openai/**
provider:openfaas:
- providers/src/airflow/providers/openfaas/**/*
diff --git a/docs/.gitignore b/docs/.gitignore
index 542ee43621d..7cf1684544c 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -9,6 +9,7 @@ apache-airflow-providers-cohere
apache-airflow-providers-common-sql
apache-airflow-providers-datadog
apache-airflow-providers-edge
+apache-airflow-providers-openai
apache-airflow-providers-pgvector
apache-airflow-providers-pinecone
apache-airflow-providers-postgres
diff --git a/docs/apache-airflow-providers-openai/changelog.rst
b/docs/apache-airflow-providers-openai/changelog.rst
deleted file mode 100644
index 50402f1c992..00000000000
--- a/docs/apache-airflow-providers-openai/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/openai/CHANGELOG.rst
diff --git a/providers/openai/README.rst b/providers/openai/README.rst
new file mode 100644
index 00000000000..003aee55ebc
--- /dev/null
+++ b/providers/openai/README.rst
@@ -0,0 +1,62 @@
+
+ .. 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-openai``
+
+Release: ``1.5.0``
+
+
+`OpenAI <https://platform.openai.com/docs/introduction>`__
+
+
+Provider package
+----------------
+
+This is a provider package for ``openai`` provider. All classes for this
provider package
+are in ``airflow.providers.openai`` python package.
+
+You can find package information and changelog for the provider
+in the `documentation
<https://airflow.apache.org/docs/apache-airflow-providers-openai/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-openai``
+
+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``
+``openai[datalib]`` ``>=1.32.0``
+=================== ==================
+
+The changelog for the provider package can be found in the
+`changelog
<https://airflow.apache.org/docs/apache-airflow-providers-openai/1.5.0/changelog.html>`_.
diff --git a/providers/src/airflow/providers/openai/.latest-doc-only-change.txt
b/providers/openai/docs/.latest-doc-only-change.txt
similarity index 100%
rename from providers/src/airflow/providers/openai/.latest-doc-only-change.txt
rename to providers/openai/docs/.latest-doc-only-change.txt
diff --git a/providers/src/airflow/providers/openai/CHANGELOG.rst
b/providers/openai/docs/changelog.rst
similarity index 100%
rename from providers/src/airflow/providers/openai/CHANGELOG.rst
rename to providers/openai/docs/changelog.rst
diff --git a/docs/apache-airflow-providers-openai/commits.rst
b/providers/openai/docs/commits.rst
similarity index 100%
rename from docs/apache-airflow-providers-openai/commits.rst
rename to providers/openai/docs/commits.rst
diff --git a/docs/apache-airflow-providers-openai/connections.rst
b/providers/openai/docs/connections.rst
similarity index 100%
rename from docs/apache-airflow-providers-openai/connections.rst
rename to providers/openai/docs/connections.rst
diff --git a/docs/apache-airflow-providers-openai/index.rst
b/providers/openai/docs/index.rst
similarity index 100%
rename from docs/apache-airflow-providers-openai/index.rst
rename to providers/openai/docs/index.rst
diff --git
a/docs/apache-airflow-providers-openai/installing-providers-from-sources.rst
b/providers/openai/docs/installing-providers-from-sources.rst
similarity index 100%
rename from
docs/apache-airflow-providers-openai/installing-providers-from-sources.rst
rename to providers/openai/docs/installing-providers-from-sources.rst
diff --git a/docs/apache-airflow-providers-openai/operators/openai.rst
b/providers/openai/docs/operators/openai.rst
similarity index 92%
rename from docs/apache-airflow-providers-openai/operators/openai.rst
rename to providers/openai/docs/operators/openai.rst
index d82a8058f29..31448689b5f 100644
--- a/docs/apache-airflow-providers-openai/operators/openai.rst
+++ b/providers/openai/docs/operators/openai.rst
@@ -32,7 +32,7 @@ connect to your account.
An example using the operator is in way:
-.. exampleinclude:: /../../providers/tests/system/openai/example_openai.py
+.. exampleinclude::
/../../providers/openai/tests/system/openai/example_openai.py
:language: python
:start-after: [START howto_operator_openai_embedding]
:end-before: [END howto_operator_openai_embedding]
@@ -57,7 +57,7 @@ The OpenAITriggerBatchOperator
An example using the operator is in way:
-.. exampleinclude::
/../../providers/tests/system/openai/example_trigger_batch_operator.py
+.. exampleinclude::
/../../providers/openai/tests/system/openai/example_trigger_batch_operator.py
:language: python
:start-after: [START howto_operator_openai_trigger_operator]
:end-before: [END howto_operator_openai_trigger_operator]
diff --git a/docs/apache-airflow-providers-openai/security.rst
b/providers/openai/docs/security.rst
similarity index 100%
rename from docs/apache-airflow-providers-openai/security.rst
rename to providers/openai/docs/security.rst
diff --git a/providers/src/airflow/providers/openai/provider.yaml
b/providers/openai/provider.yaml
similarity index 96%
rename from providers/src/airflow/providers/openai/provider.yaml
rename to providers/openai/provider.yaml
index 7950e4e3e4c..3e0e3e63310 100644
--- a/providers/src/airflow/providers/openai/provider.yaml
+++ b/providers/openai/provider.yaml
@@ -45,10 +45,6 @@ integrations:
- /docs/apache-airflow-providers-openai/operators/openai.rst
tags: [software]
-dependencies:
- - apache-airflow>=2.9.0
- - openai[datalib]>=1.32.0
-
hooks:
- integration-name: OpenAI
python-modules:
diff --git a/providers/openai/pyproject.toml b/providers/openai/pyproject.toml
new file mode 100644
index 00000000000..f619a9c0c90
--- /dev/null
+++ b/providers/openai/pyproject.toml
@@ -0,0 +1,78 @@
+# 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-openai"
+version = "1.5.0"
+description = "Provider package apache-airflow-providers-openai 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", "openai", "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",
+ "openai[datalib]>=1.32.0",
+]
+
+[project.urls]
+"Documentation" =
"https://airflow.apache.org/docs/apache-airflow-providers-openai/1.5.0";
+"Changelog" =
"https://airflow.apache.org/docs/apache-airflow-providers-openai/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.openai.get_provider_info:get_provider_info"
+
+[tool.flit.module]
+name = "airflow.providers.openai"
+
+[tool.pytest.ini_options]
+ignore = "tests/system/"
diff --git a/providers/openai/src/airflow/providers/openai/LICENSE
b/providers/openai/src/airflow/providers/openai/LICENSE
new file mode 100644
index 00000000000..11069edd790
--- /dev/null
+++ b/providers/openai/src/airflow/providers/openai/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/openai/__init__.py
b/providers/openai/src/airflow/providers/openai/__init__.py
similarity index 100%
rename from providers/src/airflow/providers/openai/__init__.py
rename to providers/openai/src/airflow/providers/openai/__init__.py
diff --git a/providers/src/airflow/providers/openai/exceptions.py
b/providers/openai/src/airflow/providers/openai/exceptions.py
similarity index 100%
copy from providers/src/airflow/providers/openai/exceptions.py
copy to providers/openai/src/airflow/providers/openai/exceptions.py
diff --git a/providers/openai/src/airflow/providers/openai/get_provider_info.py
b/providers/openai/src/airflow/providers/openai/get_provider_info.py
new file mode 100644
index 00000000000..39881c6a3b7
--- /dev/null
+++ b/providers/openai/src/airflow/providers/openai/get_provider_info.py
@@ -0,0 +1,56 @@
+# 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-openai",
+ "name": "OpenAI",
+ "description": "`OpenAI
<https://platform.openai.com/docs/introduction>`__\n",
+ "state": "ready",
+ "source-date-epoch": 1734535841,
+ "versions": ["1.5.0", "1.4.0", "1.3.0", "1.2.2", "1.2.1", "1.2.0",
"1.1.0", "1.0.1", "1.0.0"],
+ "integrations": [
+ {
+ "integration-name": "OpenAI",
+ "external-doc-url":
"https://platform.openai.com/docs/introduction";,
+ "how-to-guide":
["/docs/apache-airflow-providers-openai/operators/openai.rst"],
+ "tags": ["software"],
+ }
+ ],
+ "hooks": [
+ {"integration-name": "OpenAI", "python-modules":
["airflow.providers.openai.hooks.openai"]}
+ ],
+ "operators": [
+ {"integration-name": "OpenAI", "python-modules":
["airflow.providers.openai.operators.openai"]}
+ ],
+ "triggers": [
+ {"integration-name": "OpenAI", "python-modules":
["airflow.providers.openai.triggers.openai"]}
+ ],
+ "connection-types": [
+ {
+ "hook-class-name":
"airflow.providers.openai.hooks.openai.OpenAIHook",
+ "connection-type": "openai",
+ }
+ ],
+ "dependencies": ["apache-airflow>=2.9.0", "openai[datalib]>=1.32.0"],
+ }
diff --git a/providers/src/airflow/providers/openai/hooks/__init__.py
b/providers/openai/src/airflow/providers/openai/hooks/__init__.py
similarity index 100%
rename from providers/src/airflow/providers/openai/hooks/__init__.py
rename to providers/openai/src/airflow/providers/openai/hooks/__init__.py
diff --git a/providers/src/airflow/providers/openai/hooks/openai.py
b/providers/openai/src/airflow/providers/openai/hooks/openai.py
similarity index 100%
rename from providers/src/airflow/providers/openai/hooks/openai.py
rename to providers/openai/src/airflow/providers/openai/hooks/openai.py
diff --git a/providers/src/airflow/providers/openai/operators/__init__.py
b/providers/openai/src/airflow/providers/openai/operators/__init__.py
similarity index 100%
rename from providers/src/airflow/providers/openai/operators/__init__.py
rename to providers/openai/src/airflow/providers/openai/operators/__init__.py
diff --git a/providers/src/airflow/providers/openai/operators/openai.py
b/providers/openai/src/airflow/providers/openai/operators/openai.py
similarity index 99%
rename from providers/src/airflow/providers/openai/operators/openai.py
rename to providers/openai/src/airflow/providers/openai/operators/openai.py
index 63ca8380c88..878c5f8870e 100644
--- a/providers/src/airflow/providers/openai/operators/openai.py
+++ b/providers/openai/src/airflow/providers/openai/operators/openai.py
@@ -133,7 +133,7 @@ class OpenAITriggerBatchOperator(BaseOperator):
"""Return an instance of the OpenAIHook."""
return OpenAIHook(conn_id=self.conn_id)
- def execute(self, context: Context) -> str:
+ def execute(self, context: Context) -> str | None:
batch = self.hook.create_batch(file_id=self.file_id,
endpoint=self.endpoint)
self.batch_id = batch.id
if self.wait_for_completion:
diff --git a/providers/src/airflow/providers/openai/triggers/__init__.py
b/providers/openai/src/airflow/providers/openai/triggers/__init__.py
similarity index 100%
copy from providers/src/airflow/providers/openai/triggers/__init__.py
copy to providers/openai/src/airflow/providers/openai/triggers/__init__.py
diff --git a/providers/src/airflow/providers/openai/triggers/openai.py
b/providers/openai/src/airflow/providers/openai/triggers/openai.py
similarity index 100%
rename from providers/src/airflow/providers/openai/triggers/openai.py
rename to providers/openai/src/airflow/providers/openai/triggers/openai.py
diff --git a/providers/src/airflow/providers/openai/exceptions.py
b/providers/openai/tests/conftest.py
similarity index 61%
rename from providers/src/airflow/providers/openai/exceptions.py
rename to providers/openai/tests/conftest.py
index eafba088c4b..068fe6bbf5a 100644
--- a/providers/src/airflow/providers/openai/exceptions.py
+++ b/providers/openai/tests/conftest.py
@@ -1,4 +1,3 @@
-#
# 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
@@ -17,12 +16,17 @@
# under the License.
from __future__ import annotations
-from airflow.exceptions import AirflowException
+import pathlib
+import pytest
-class OpenAIBatchJobException(AirflowException):
- """Raise when OpenAI Batch Job fails to start AFTER processing the
request."""
+pytest_plugins = "tests_common.pytest_plugin"
-class OpenAIBatchTimeout(AirflowException):
- """Raise when OpenAI Batch Job times out."""
[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/src/airflow/providers/openai/triggers/__init__.py
b/providers/openai/tests/provider_tests/__init__.py
similarity index 90%
rename from providers/src/airflow/providers/openai/triggers/__init__.py
rename to providers/openai/tests/provider_tests/__init__.py
index 13a83393a91..e8fd2285643 100644
--- a/providers/src/airflow/providers/openai/triggers/__init__.py
+++ b/providers/openai/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/openai/__init__.py
b/providers/openai/tests/provider_tests/openai/__init__.py
similarity index 100%
rename from providers/tests/openai/__init__.py
rename to providers/openai/tests/provider_tests/openai/__init__.py
diff --git a/providers/tests/openai/hooks/__init__.py
b/providers/openai/tests/provider_tests/openai/hooks/__init__.py
similarity index 100%
rename from providers/tests/openai/hooks/__init__.py
rename to providers/openai/tests/provider_tests/openai/hooks/__init__.py
diff --git a/providers/tests/openai/hooks/test_openai.py
b/providers/openai/tests/provider_tests/openai/hooks/test_openai.py
similarity index 99%
rename from providers/tests/openai/hooks/test_openai.py
rename to providers/openai/tests/provider_tests/openai/hooks/test_openai.py
index 6c84845c755..bb54fae0cab 100644
--- a/providers/tests/openai/hooks/test_openai.py
+++ b/providers/openai/tests/provider_tests/openai/hooks/test_openai.py
@@ -17,14 +17,9 @@
from __future__ import annotations
import os
-from unittest.mock import patch
+from unittest.mock import mock_open, patch
import pytest
-
-openai = pytest.importorskip("openai")
-
-from unittest.mock import mock_open
-
from openai.pagination import SyncCursorPage
from openai.types import Batch, CreateEmbeddingResponse, Embedding,
FileDeleted, FileObject
from openai.types.beta import (
@@ -58,6 +53,8 @@ VECTOR_STORE_NAME = "Test Vector Store"
VECTOR_FILE_STORE_BATCH_ID = "test_vfsb_abc123"
BATCH_ID = "test_batch_abc123"
+openai = pytest.importorskip("openai")
+
def create_batch(status) -> Batch:
return Batch(
diff --git a/providers/tests/openai/operators/__init__.py
b/providers/openai/tests/provider_tests/openai/operators/__init__.py
similarity index 100%
rename from providers/tests/openai/operators/__init__.py
rename to providers/openai/tests/provider_tests/openai/operators/__init__.py
diff --git a/providers/tests/openai/operators/test_openai.py
b/providers/openai/tests/provider_tests/openai/operators/test_openai.py
similarity index 99%
rename from providers/tests/openai/operators/test_openai.py
rename to providers/openai/tests/provider_tests/openai/operators/test_openai.py
index 6494e88727c..e160163db85 100644
--- a/providers/tests/openai/operators/test_openai.py
+++ b/providers/openai/tests/provider_tests/openai/operators/test_openai.py
@@ -19,9 +19,6 @@ from __future__ import annotations
from unittest.mock import Mock
import pytest
-
-openai = pytest.importorskip("openai")
-
from openai.types.batch import Batch
from airflow.exceptions import TaskDeferred
@@ -34,6 +31,7 @@ except ImportError:
# TODO: Remove once provider drops support for Airflow 2
from airflow.utils.context import Context
+openai = pytest.importorskip("openai")
TASK_ID = "TaskId"
CONN_ID = "test_conn_id"
BATCH_ID = "batch_id"
diff --git a/providers/tests/openai/test_exceptions.py
b/providers/openai/tests/provider_tests/openai/test_exceptions.py
similarity index 100%
rename from providers/tests/openai/test_exceptions.py
rename to providers/openai/tests/provider_tests/openai/test_exceptions.py
diff --git a/providers/tests/openai/triggers/__init__.py
b/providers/openai/tests/provider_tests/openai/triggers/__init__.py
similarity index 100%
rename from providers/tests/openai/triggers/__init__.py
rename to providers/openai/tests/provider_tests/openai/triggers/__init__.py
diff --git a/providers/tests/openai/triggers/test_openai.py
b/providers/openai/tests/provider_tests/openai/triggers/test_openai.py
similarity index 99%
rename from providers/tests/openai/triggers/test_openai.py
rename to providers/openai/tests/provider_tests/openai/triggers/test_openai.py
index bb658feebac..7fe7546c263 100644
--- a/providers/tests/openai/triggers/test_openai.py
+++ b/providers/openai/tests/provider_tests/openai/triggers/test_openai.py
@@ -22,15 +22,14 @@ from typing import Literal
from unittest import mock
import pytest
-
-openai = pytest.importorskip("openai")
-
from openai.types import Batch
from airflow.providers.openai.hooks.openai import BatchStatus
from airflow.providers.openai.triggers.openai import OpenAIBatchTrigger
from airflow.triggers.base import TriggerEvent
+openai = pytest.importorskip("openai")
+
class TestOpenAIBatchTrigger:
BATCH_ID = "batch_id"
diff --git a/providers/tests/system/openai/__init__.py
b/providers/openai/tests/system/openai/__init__.py
similarity index 100%
rename from providers/tests/system/openai/__init__.py
rename to providers/openai/tests/system/openai/__init__.py
diff --git a/providers/tests/system/openai/example_openai.py
b/providers/openai/tests/system/openai/example_openai.py
similarity index 100%
rename from providers/tests/system/openai/example_openai.py
rename to providers/openai/tests/system/openai/example_openai.py
diff --git a/providers/tests/system/openai/example_trigger_batch_operator.py
b/providers/openai/tests/system/openai/example_trigger_batch_operator.py
similarity index 100%
rename from providers/tests/system/openai/example_trigger_batch_operator.py
rename to providers/openai/tests/system/openai/example_trigger_batch_operator.py
diff --git a/pyproject.toml b/pyproject.toml
index a9877fa3b9d..30e21d44099 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -627,6 +627,7 @@ dev = [
"apache-airflow-providers-common-sql",
"apache-airflow-providers-datadog",
"apache-airflow-providers-edge",
+ "apache-airflow-providers-openai",
"apache-airflow-providers-pgvector",
"apache-airflow-providers-pinecone",
"apache-airflow-providers-postgres",
@@ -651,6 +652,7 @@ apache-airflow-providers-cohere = { workspace = true }
apache-airflow-providers-common-sql = { workspace = true }
apache-airflow-providers-datadog = { workspace = true }
apache-airflow-providers-edge = {workspace = true}
+apache-airflow-providers-openai = { workspace = true }
apache-airflow-providers-pinecone = { workspace = true }
apache-airflow-providers-postgres = { workspace = true }
apache-airflow-providers-pgvector = { workspace = true }
@@ -673,6 +675,7 @@ members = [
"providers/common/sql",
"providers/datadog",
"providers/edge",
+ "providers/openai",
"providers/pinecone",
"providers/postgres",
"providers/pgvector",
diff --git a/scripts/ci/docker-compose/remove-sources.yml
b/scripts/ci/docker-compose/remove-sources.yml
index b99454cd071..674319ddd1f 100644
--- a/scripts/ci/docker-compose/remove-sources.yml
+++ b/scripts/ci/docker-compose/remove-sources.yml
@@ -41,6 +41,7 @@ services:
- ../../../empty:/opt/airflow/providers/common/sql/src
- ../../../empty:/opt/airflow/providers/datadog/src
- ../../../empty:/opt/airflow/providers/edge/src
+ - ../../../empty:/opt/airflow/providers/openai/src
- ../../../empty:/opt/airflow/providers/pgvector/src
- ../../../empty:/opt/airflow/providers/pinecone/src
- ../../../empty:/opt/airflow/providers/postgres/src
diff --git a/scripts/ci/docker-compose/tests-sources.yml
b/scripts/ci/docker-compose/tests-sources.yml
index 91d3311e2bb..077d1b121e6 100644
--- a/scripts/ci/docker-compose/tests-sources.yml
+++ b/scripts/ci/docker-compose/tests-sources.yml
@@ -48,6 +48,7 @@ services:
-
../../../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
+ - ../../../providers/openai/tests:/opt/airflow/providers/openai/tests
- ../../../providers/pgvector/tests:/opt/airflow/providers/pgvector/tests
- ../../../providers/pinecone/tests:/opt/airflow/providers/pinecone/tests
- ../../../providers/postgres/tests:/opt/airflow/providers/postgres/tests
