kacpermuda opened a new pull request, #36952:
URL: https://github.com/apache/airflow/pull/36952
<!--
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/
-->
## Rationale
This is a step number 2 of the process described in #36876, please refer to
it for the rationale and in depth description. Possibly, it can also replace
the mechanism described in #31830.
## TLDR
See the two tests i wrote, for the demo of how it works.
I want to add a decorator (for now only for classes, functions, methods
etc.) that we can use for deprecations in the entire codebase (core and
providers). By defining a custom function, we can have the most common
information (now included in deprecation message) as separate arguments, so
it's easier to parse it and use in CI, docs etc.
## Todo after agreement on core functions
- Unit tests are missing right now, I just included some examples so we can
see how it works. I want to have an accepted functionality and then spend some
time on the tests.
- Also, possibly some changes in the documentation will be required, to
describe how the developers should deprecate things and what are the options.
- In the final solution, we can probably remove the warnings from current
location (`airflow.exceptions.py`) and only keep them in
`airflow.deprecation.py`.
## Questions
This is my first PR that touches the core airflow, so let me know if
anything needs to be changed 😄 I also have some questions to the functionality
itself:
1. Are there any more arguments that we can define in the deprecation
decorator? Some ideas?
2. Is it a good place (deprecation module in core) to have helper functions
like: `get_callable_full_path` or `validate_release_string`. We can just make
them private.
3. Should we define separate `provider_deprecated` decorator that will have
a default category set to AirflowProviderDeprecationWarning ?
4. Should we allow passing a different Adapter, so that You can alter the
deprecation message or we want to enforce standardization in the whole codebase
and remove that option for the end user?
<!-- 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.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
[newsfragments](https://github.com/apache/airflow/tree/main/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]
