You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "amoghrajesh (via GitHub)" <gi...@apache.org> on 2025/09/16 08:57:42 UTC
[PR] Adding a backcompat warning layer for airflow.settings.MASK_SECRETS_IN_LOGS [airflow]
amoghrajesh opened a new pull request, #55712:
URL: https://github.com/apache/airflow/pull/55712
<!--
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/
-->
Rare, but there is a chance that folks would use `airflow.settings.MASK_SECRETS_IN_LOGS` for some reason in their deployments.
This constant has been slayed and moved over to inside the SecretsMasker class now. Although it is not too important, but adding an informational warning for this would probably help.
Earlier:
```
Python 3.10.18 (main, Sep 8 2025, 22:04:00) [GCC 12.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
>>>
>>>
>>> from airflow.settings
KeyboardInterrupt
>>> import airflow.settings
>>> settings.MASK_SECRETS_IN_LOGS
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
NameError: name 'settings' is not defined
>>> airflow.settings.MASK_SECRET_IN_LOGS
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: module 'airflow.settings' has no attribute 'MASK_SECRET_IN_LOGS'
>>> airflow.settings.MASK_SECRETS_IN_LOGS
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: module 'airflow.settings' has no attribute 'MASK_SECRETS_IN_LOGS'
>>> exit()
```
Now:
```
root@f6f4a87fe6c4:/opt/airflow# python
Python 3.10.18 (main, Sep 8 2025, 22:04:00) [GCC 12.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import airflow.settings
>>> airflow.settings.MASK_SECRETS_IN_LOGS
<stdin>:1 DeprecationWarning: settings.MASK_SECRETS_IN_LOGS has been removed. Use SecretsMasker.enable_log_masking(), disable_log_masking(), or is_log_masking_enabled() instead
```
<!-- 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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Adding a backcompat warning layer for airflow.settings.MASK_SECRETS_IN_LOGS [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #55712:
URL: https://github.com/apache/airflow/pull/55712#issuecomment-3302579979
I'd like to have this in 3.1 if possible as it is related to a compat thing.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Adding a backcompat warning layer for airflow.settings.MASK_SECRETS_IN_LOGS [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55712:
URL: https://github.com/apache/airflow/pull/55712#discussion_r2351592977
##########
airflow-core/src/airflow/settings.py:
##########
@@ -633,6 +633,21 @@ def prepare_syspath_for_config_and_plugins():
sys.path.append(PLUGINS_FOLDER)
+def __getattr__(name: str):
+ """Handle deprecated module attributes."""
+ if name == "MASK_SECRETS_IN_LOGS":
+ import warnings
+
+ warnings.warn(
+ "settings.MASK_SECRETS_IN_LOGS has been removed. "
+ "Use SecretsMasker.enable_log_masking(), disable_log_masking(), or is_log_masking_enabled() instead.",
+ DeprecationWarning,
+ stacklevel=2,
+ )
+ return
Review Comment:
Was heading in this direction:
```
Python 3.10.18 (main, Sep 8 2025, 22:04:00) [GCC 12.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import airflow.settings
>>> airflow.settings.MASK_SECRETS_IN_LOGS
<stdin>:1 DeprecationWarning: settings.MASK_SECRETS_IN_LOGS has been removed. This shim returns default value of False. Use SecretsMasker.enable_log_masking(), disable_log_masking(), or is_log_masking_enabled() instead.
False
```
I'm not sure if thats the best way ahead :/
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Adding a backcompat warning layer for airflow.settings.MASK_SECRETS_IN_LOGS [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55712:
URL: https://github.com/apache/airflow/pull/55712#discussion_r2351609089
##########
airflow-core/src/airflow/settings.py:
##########
@@ -633,6 +633,21 @@ def prepare_syspath_for_config_and_plugins():
sys.path.append(PLUGINS_FOLDER)
+def __getattr__(name: str):
+ """Handle deprecated module attributes."""
+ if name == "MASK_SECRETS_IN_LOGS":
+ import warnings
+
+ warnings.warn(
+ "settings.MASK_SECRETS_IN_LOGS has been removed. "
+ "Use SecretsMasker.enable_log_masking(), disable_log_masking(), or is_log_masking_enabled() instead.",
+ DeprecationWarning,
+ stacklevel=2,
+ )
+ return
Review Comment:
Pushed in https://github.com/apache/airflow/pull/55712/commits/821b6e9b594bec85001d035f1dd25c5a01ffbb60
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Adding a backcompat warning layer for airflow.settings.MASK_SECRETS_IN_LOGS [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh merged PR #55712:
URL: https://github.com/apache/airflow/pull/55712
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Adding a backcompat warning layer for airflow.settings.MASK_SECRETS_IN_LOGS [airflow]
Posted by "ashb (via GitHub)" <gi...@apache.org>.
ashb commented on code in PR #55712:
URL: https://github.com/apache/airflow/pull/55712#discussion_r2351571742
##########
airflow-core/src/airflow/settings.py:
##########
@@ -633,6 +633,21 @@ def prepare_syspath_for_config_and_plugins():
sys.path.append(PLUGINS_FOLDER)
+def __getattr__(name: str):
+ """Handle deprecated module attributes."""
+ if name == "MASK_SECRETS_IN_LOGS":
+ import warnings
+
+ warnings.warn(
+ "settings.MASK_SECRETS_IN_LOGS has been removed. "
+ "Use SecretsMasker.enable_log_masking(), disable_log_masking(), or is_log_masking_enabled() instead.",
+ DeprecationWarning,
+ stacklevel=2,
+ )
+ return
Review Comment:
Returning None is intentional here? Won't that like cause equally weird things? Or make things think secrets masking is disabled?
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Adding a backcompat warning layer for airflow.settings.MASK_SECRETS_IN_LOGS [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55712:
URL: https://github.com/apache/airflow/pull/55712#discussion_r2351586422
##########
airflow-core/src/airflow/settings.py:
##########
@@ -633,6 +633,21 @@ def prepare_syspath_for_config_and_plugins():
sys.path.append(PLUGINS_FOLDER)
+def __getattr__(name: str):
+ """Handle deprecated module attributes."""
+ if name == "MASK_SECRETS_IN_LOGS":
+ import warnings
+
+ warnings.warn(
+ "settings.MASK_SECRETS_IN_LOGS has been removed. "
+ "Use SecretsMasker.enable_log_masking(), disable_log_masking(), or is_log_masking_enabled() instead.",
+ DeprecationWarning,
+ stacklevel=2,
+ )
+ return
Review Comment:
Oh my bad, wanted to commit with `return False` instead.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org