[GitHub] [airflow] zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli
zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct
short option in cli
URL: https://github.com/apache/airflow/pull/7148#discussion_r367454779
##
File path: tests/bin/test_cli.py
##
@@ -0,0 +1,139 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# 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.
+
+import re
+from collections import Counter
+from unittest import TestCase
+
+from airflow.bin.cli import CLIFactory
+
+P_LONG_OPTION_ARG = re.compile("^--\\w{2}")
+P_SHORT_OPTION_ARG = re.compile("^-\\w$")
+
+
+class TestCli(TestCase):
Review comment:
So I will change our long option name, BTW, I just know that
name(kebab-case), day ago when I search the stackoverflow ;-)
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli
zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli URL: https://github.com/apache/airflow/pull/7148#discussion_r367378897 ## File path: UPDATING.md ## @@ -57,6 +57,26 @@ https://developers.google.com/style/inclusive-documentation --> +### Cli use exactly single character for short option + +Use exactly one single character for short option in Airflow cli, New commands are available according to the following table: + +| Old command| New command | +||---| +| ``airflow (dags|tasks|scheduler) [-sd, --subdir]`` | ``airflow (dags|tasks|scheduler) [-S, --subdir]`` | +| ``airflow tasks test [-dr, --dry_run]``| ``airflow tasks test [-dr, --dry_run]`` | +| ``airflow dags backfill [-dr, --dry_run]`` | ``airflow dags backfill [-d, --dry_run]`` | +| ``airflow tasks clear [-dx, --dag_regex]`` | ``airflow tasks clear [-R, --dag_regex]`` | +| ``airflow kerberos [-kt, --keytab]`` | ``airflow kerberos [-k, --keytab]`` | +| ``airflow tasks run [-int, --interactive]``| ``airflow tasks run [-N, --interactive]`` | +| ``airflow webserver [-hn, --hostname]``| ``airflow webserver [-H, --hostname]``| +| ``airflow celery worker [-cn, --celery_hostname]`` | ``airflow celery worker [-H, --celery_hostname]`` | +| ``airflow celery flower [-hn, --hostname]``| ``airflow celery flower [-H, --hostname]``| +| ``airflow celery flower [-fc, --flower_conf]`` | ``airflow celery flower [-c, --flower_conf]`` | Review comment: Yeah, I think so, what do you think @mik-laj 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [airflow] zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli
zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli URL: https://github.com/apache/airflow/pull/7148#discussion_r367377595 ## File path: UPDATING.md ## @@ -59,6 +59,26 @@ https://developers.google.com/style/inclusive-documentation --> +### Cli use exactly single character for short option + +Use exactly one single character for short option in Airflow cli, New commands are available according to the following table: + +| Old command| New command | +||---| +| ``airflow (dags|tasks|scheduler) [-sd, --subdir]`` | ``airflow (dags|tasks|scheduler) [-S, --subdir]`` | +| ``airflow tasks test [-dr, --dry_run]``| ``airflow tasks test [-dr, --dry_run]`` | +| ``airflow dags backfill [-dr, --dry_run]`` | ``airflow dags backfill [-n, --dry_run]`` | +| ``airflow tasks clear [-dx, --dag_regex]`` | ``airflow tasks clear [-R, --dag_regex]`` | +| ``airflow kerberos [-kt, --keytab]`` | ``airflow kerberos [-k, --keytab]`` | +| ``airflow tasks run [-int, --interactive]``| ``airflow tasks run [-N, --interactive]`` | Review comment: We already have `-I, --ignore_depends_on_past` in `airflow tasks run`, so I use another letter 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [airflow] zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli
zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli URL: https://github.com/apache/airflow/pull/7148#discussion_r367377698 ## File path: UPDATING.md ## @@ -59,6 +59,26 @@ https://developers.google.com/style/inclusive-documentation --> +### Cli use exactly single character for short option + +Use exactly one single character for short option in Airflow cli, New commands are available according to the following table: + +| Old command| New command | +||---| +| ``airflow (dags|tasks|scheduler) [-sd, --subdir]`` | ``airflow (dags|tasks|scheduler) [-S, --subdir]`` | +| ``airflow tasks test [-dr, --dry_run]``| ``airflow tasks test [-dr, --dry_run]`` | Review comment: Good catch!, fix it 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [airflow] zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli
zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct
short option in cli
URL: https://github.com/apache/airflow/pull/7148#discussion_r367375676
##
File path: tests/bin/test_cli.py
##
@@ -0,0 +1,139 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# 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.
+
+import re
+from collections import Counter
+from unittest import TestCase
+
+from airflow.bin.cli import CLIFactory
+
+P_LONG_OPTION_ARG = re.compile("^--\\w{2}")
+P_SHORT_OPTION_ARG = re.compile("^-\\w$")
+
+
+class TestCli(TestCase):
Review comment:
Hi,Jarek should we change long option name style? from `snake_case` to
`kebab-case`, for example using `airflow tasks test --dry-run` instead of
`airflow tasks test --dry_run`, I start a [discuss] in dev mail list to discuss
it
https://lists.apache.org/thread.html/r95c53953499a236466e0b762dfdadd5ca2ba9d6e2a3516c699a14380%40%3Cdev.airflow.apache.org%3E
WDYT
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli
zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct
short option in cli
URL: https://github.com/apache/airflow/pull/7148#discussion_r365908093
##
File path: airflow/bin/cli.py
##
@@ -102,7 +102,7 @@ class CLIFactory:
("-e", "--end_date"), "Override end_date -MM-DD",
type=parsedate),
'dry_run': Arg(
-("-dr", "--dry_run"), "Perform a dry run", "store_true"),
+("-d", "--dry_run"), "Perform a dry run", "store_true"),
Review comment:
:+1: `-n` is the better choose, but what I talk in this comment is should we
use `--dry-run` to replace `--dry_run`
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli
zhongjiajie commented on a change in pull request #7148: [AIRFLOW-6472] Correct short option in cli URL: https://github.com/apache/airflow/pull/7148#discussion_r365906574 ## File path: UPDATING.md ## @@ -57,6 +57,26 @@ https://developers.google.com/style/inclusive-documentation --> +### Cli use exactly single character for short option + +Use exactly one single character for short option in Airflow cli, New commands are available according to the following table: + +| Old command| New command | +||---| +| ``airflow (dags|tasks|scheduler) [-sd, --subdir]`` | ``airflow (dags|tasks|scheduler) [-S, --subdir]`` | +| ``airflow tasks test [-dr, --dry_run]``| ``airflow tasks test [-dr, --dry_run]`` | +| ``airflow dags backfill [-dr, --dry_run]`` | ``airflow dags backfill [-d, --dry_run]`` | +| ``airflow tasks clear [-dx, --dag_regex]`` | ``airflow tasks clear [-R, --dag_regex]`` | +| ``airflow kerberos [-kt, --keytab]`` | ``airflow kerberos [-k, --keytab]`` | +| ``airflow tasks run [-int, --interactive]``| ``airflow tasks run [-N, --interactive]`` | +| ``airflow webserver [-hn, --hostname]``| ``airflow webserver [-H, --hostname]``| +| ``airflow celery worker [-cn, --celery_hostname]`` | ``airflow celery worker [-H, --celery_hostname]`` | +| ``airflow celery flower [-hn, --hostname]``| ``airflow celery flower [-H, --hostname]``| +| ``airflow celery flower [-fc, --flower_conf]`` | ``airflow celery flower [-c, --flower_conf]`` | Review comment: But those for diff subcommand, do you think we should use unique short option in our cli? I find out if arg conflict our document build pre-test in Travis-CI will failed. 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
