You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "shahar1 (via GitHub)" <gi...@apache.org> on 2023/12/15 22:33:04 UTC
[PR] Remove black linter example in `STATIC_CODE_CHECKS.rst` [airflow]
shahar1 opened a new pull request, #36249:
URL: https://github.com/apache/airflow/pull/36249
<!--
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/
-->
Black linter was replaced by ruff as a pre-commit, so the example showing how to use the former is not relevant anymore.
<!-- 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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update black linter example in `STATIC_CODE_CHECKS.rst` [airflow]
Posted by "hussein-awala (via GitHub)" <gi...@apache.org>.
hussein-awala commented on code in PR #36249:
URL: https://github.com/apache/airflow/pull/36249#discussion_r1428907632
##########
STATIC_CODE_CHECKS.rst:
##########
@@ -465,18 +465,18 @@ Run the ``ruff`` check for the ``tests/core.py`` file with verbose output:
breeze static-checks --type ruff --file tests/core.py --verbose
-Run the ``ruff for the ``tests.core`` package with verbose output:
+Run the ``ruff`` check for the ``tests.core`` package with verbose output:
.. code-block:: bash
breeze static-checks --type ruff --file tests/core/* --verbose
-Run the ``black`` check for the files ``airflow/example_dags/example_bash_operator.py`` and
+Run the ``ruff-format`` check for the files ``airflow/example_dags/example_bash_operator.py`` and
``airflow/example_dags/example_python_operator.py``:
.. code-block:: bash
- breeze static-checks --type black --file airflow/example_dags/example_bash_operator.py \
+ breeze static-checks --type ruff --file airflow/example_dags/example_bash_operator.py \
Review Comment:
Indeed, nice catch!
--
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] Update black linter example in `STATIC_CODE_CHECKS.rst` [airflow]
Posted by "josh-fell (via GitHub)" <gi...@apache.org>.
josh-fell merged PR #36249:
URL: https://github.com/apache/airflow/pull/36249
--
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] Update black linter example in `STATIC_CODE_CHECKS.rst` [airflow]
Posted by "shahar1 (via GitHub)" <gi...@apache.org>.
shahar1 commented on code in PR #36249:
URL: https://github.com/apache/airflow/pull/36249#discussion_r1428837460
##########
STATIC_CODE_CHECKS.rst:
##########
@@ -465,18 +465,18 @@ Run the ``ruff`` check for the ``tests/core.py`` file with verbose output:
breeze static-checks --type ruff --file tests/core.py --verbose
-Run the ``ruff for the ``tests.core`` package with verbose output:
+Run the ``ruff`` check for the ``tests.core`` package with verbose output:
.. code-block:: bash
breeze static-checks --type ruff --file tests/core/* --verbose
-Run the ``black`` check for the files ``airflow/example_dags/example_bash_operator.py`` and
+Run the ``ruff-format`` check for the files ``airflow/example_dags/example_bash_operator.py`` and
``airflow/example_dags/example_python_operator.py``:
.. code-block:: bash
- breeze static-checks --type black --file airflow/example_dags/example_bash_operator.py \
+ breeze static-checks --type ruff --file airflow/example_dags/example_bash_operator.py \
Review Comment:
It's all good, thanks :)
--
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] Update black linter example in `STATIC_CODE_CHECKS.rst` [airflow]
Posted by "josh-fell (via GitHub)" <gi...@apache.org>.
josh-fell commented on code in PR #36249:
URL: https://github.com/apache/airflow/pull/36249#discussion_r1428837211
##########
STATIC_CODE_CHECKS.rst:
##########
@@ -465,18 +465,18 @@ Run the ``ruff`` check for the ``tests/core.py`` file with verbose output:
breeze static-checks --type ruff --file tests/core.py --verbose
-Run the ``ruff for the ``tests.core`` package with verbose output:
+Run the ``ruff`` check for the ``tests.core`` package with verbose output:
.. code-block:: bash
breeze static-checks --type ruff --file tests/core/* --verbose
-Run the ``black`` check for the files ``airflow/example_dags/example_bash_operator.py`` and
+Run the ``ruff-format`` check for the files ``airflow/example_dags/example_bash_operator.py`` and
``airflow/example_dags/example_python_operator.py``:
.. code-block:: bash
- breeze static-checks --type black --file airflow/example_dags/example_bash_operator.py \
+ breeze static-checks --type ruff --file airflow/example_dags/example_bash_operator.py \
Review Comment:
```suggestion
breeze static-checks --type ruff-format --file airflow/example_dags/example_bash_operator.py \
```
Oops missed this in my earlier review. My fault.
--
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] Remove black linter example in `STATIC_CODE_CHECKS.rst` [airflow]
Posted by "shahar1 (via GitHub)" <gi...@apache.org>.
shahar1 commented on PR #36249:
URL: https://github.com/apache/airflow/pull/36249#issuecomment-1858730181
> Instead you can convert it to use the `ruff-format` static-check type. This is Ruff's formatter that is a effectively drop-in replacement for Black.
There is an example for using ruff just above it, do you find it useful to have an additional example?
--
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] Update black linter example in `STATIC_CODE_CHECKS.rst` [airflow]
Posted by "josh-fell (via GitHub)" <gi...@apache.org>.
josh-fell commented on code in PR #36249:
URL: https://github.com/apache/airflow/pull/36249#discussion_r1428836036
##########
STATIC_CODE_CHECKS.rst:
##########
@@ -465,18 +465,18 @@ Run the ``ruff`` check for the ``tests/core.py`` file with verbose output:
breeze static-checks --type ruff --file tests/core.py --verbose
-Run the ``ruff for the ``tests.core`` package with verbose output:
+Run the ``ruff`` check for the ``tests.core`` package with verbose output:
.. code-block:: bash
breeze static-checks --type ruff --file tests/core/* --verbose
-Run the ``black`` check for the files ``airflow/example_dags/example_bash_operator.py`` and
+Run the ``ruff`` check for the files ``airflow/example_dags/example_bash_operator.py`` and
Review Comment:
```suggestion
Run the ``ruff-format`` check for the files ``airflow/example_dags/example_bash_operator.py`` and
```
Ruff [linter](https://docs.astral.sh/ruff/linter/) and [formatter](https://docs.astral.sh/ruff/formatter/) are [different pre-commit hooks](https://github.com/apache/airflow/blob/20d547ecd886087cd89bcdf0015ce71dd0a12cef/.pre-commit-config.yaml#L181-L187). To your earlier point, there is already a `ruff` example above this example so this one should show `ruff-format` since the Ruff formatter is a [drop-in replacement for Black](https://docs.astral.sh/ruff/formatter/#philosophy).
--
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