This is an automated email from the ASF dual-hosted git repository.
vincbeck 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 ab9e2e166e fix: D401 lint issues in airflow core (#37274)
ab9e2e166e is described below
commit ab9e2e166eb363d8316b24b8548d401faa7d517b
Author: Kalyan <[email protected]>
AuthorDate: Fri Feb 9 20:15:31 2024 +0530
fix: D401 lint issues in airflow core (#37274)
---
airflow/auth/managers/utils/fab.py | 4 ++--
airflow/decorators/bash.py | 2 +-
airflow/executors/debug_executor.py | 2 +-
airflow/models/baseoperator.py | 2 +-
airflow/models/dagrun.py | 4 ++--
airflow/models/taskinstance.py | 12 ++++++------
airflow/operators/python.py | 4 ++--
airflow/plugins_manager.py | 6 +++---
airflow/providers_manager.py | 26 +++++++++++++-------------
airflow/serialization/serde.py | 6 +++---
airflow/utils/file.py | 2 +-
airflow/utils/log/task_context_logger.py | 2 +-
airflow/utils/sqlalchemy.py | 2 ++
airflow/www/auth.py | 4 ++--
airflow/www/blueprints.py | 2 +-
airflow/www/views.py | 2 +-
pyproject.toml | 16 ----------------
17 files changed, 42 insertions(+), 56 deletions(-)
diff --git a/airflow/auth/managers/utils/fab.py
b/airflow/auth/managers/utils/fab.py
index 316e5ecff1..22b572e07f 100644
--- a/airflow/auth/managers/utils/fab.py
+++ b/airflow/auth/managers/utils/fab.py
@@ -40,12 +40,12 @@ _MAP_METHOD_NAME_TO_FAB_ACTION_NAME: dict[ResourceMethod,
str] = {
def get_fab_action_from_method_map():
- """Returns the map associating a method to a FAB action."""
+ """Return the map associating a method to a FAB action."""
return _MAP_METHOD_NAME_TO_FAB_ACTION_NAME
def get_method_from_fab_action_map():
- """Returns the map associating a FAB action to a method."""
+ """Return the map associating a FAB action to a method."""
return {
**{v: k for k, v in _MAP_METHOD_NAME_TO_FAB_ACTION_NAME.items()},
ACTION_CAN_ACCESS_MENU: "GET",
diff --git a/airflow/decorators/bash.py b/airflow/decorators/bash.py
index 70011c3079..36fc646370 100644
--- a/airflow/decorators/bash.py
+++ b/airflow/decorators/bash.py
@@ -84,7 +84,7 @@ def bash_task(
python_callable: Callable | None = None,
**kwargs,
) -> TaskDecorator:
- """Wraps a function into a BashOperator.
+ """Wrap a function into a BashOperator.
Accepts kwargs for operator kwargs. Can be reused in a single DAG. This
function is only used only used
during type checking or auto-completion.
diff --git a/airflow/executors/debug_executor.py
b/airflow/executors/debug_executor.py
index 750b0ba20b..9b376cdb01 100644
--- a/airflow/executors/debug_executor.py
+++ b/airflow/executors/debug_executor.py
@@ -61,7 +61,7 @@ class DebugExecutor(BaseExecutor):
self.fail_fast = conf.getboolean("debug", "fail_fast")
def execute_async(self, *args, **kwargs) -> None:
- """The method is replaced by custom trigger_task implementation."""
+ """Replace the method with a custom trigger_task implementation."""
def sync(self) -> None:
task_succeeded = True
diff --git a/airflow/models/baseoperator.py b/airflow/models/baseoperator.py
index ce55b24350..e2406776d8 100644
--- a/airflow/models/baseoperator.py
+++ b/airflow/models/baseoperator.py
@@ -1602,7 +1602,7 @@ class BaseOperator(AbstractOperator,
metaclass=BaseOperatorMeta):
raise TaskDeferred(trigger=trigger, method_name=method_name,
kwargs=kwargs, timeout=timeout)
def resume_execution(self, next_method: str, next_kwargs: dict[str, Any] |
None, context: Context):
- """This method is called when a deferred task is resumed."""
+ """Call this method when a deferred task is resumed."""
# __fail__ is a special signal value for next_method that indicates
# this task was scheduled specifically to fail.
if next_method == "__fail__":
diff --git a/airflow/models/dagrun.py b/airflow/models/dagrun.py
index aba2ce3fbb..f9126dd631 100644
--- a/airflow/models/dagrun.py
+++ b/airflow/models/dagrun.py
@@ -568,7 +568,7 @@ class DagRun(Base, LoggingMixin):
session: Session = NEW_SESSION,
) -> list[TI]:
"""
- Returns the task instances for this dag run.
+ Return the task instances for this dag run.
Redirect to DagRun.fetch_task_instances method.
Keep this method because it is widely used across the code.
@@ -611,7 +611,7 @@ class DagRun(Base, LoggingMixin):
map_index: int = -1,
) -> TI | TaskInstancePydantic | None:
"""
- Returns the task instance specified by task_id for this dag run.
+ Return the task instance specified by task_id for this dag run.
:param dag_id: the DAG id
:param dag_run_id: the DAG run id
diff --git a/airflow/models/taskinstance.py b/airflow/models/taskinstance.py
index 38b787cbe8..01a84fc883 100644
--- a/airflow/models/taskinstance.py
+++ b/airflow/models/taskinstance.py
@@ -461,7 +461,7 @@ def _refresh_from_db(
*, task_instance: TaskInstance | TaskInstancePydantic, session: Session,
lock_for_update: bool = False
) -> None:
"""
- Refreshes the task instance from the database based on the primary key.
+ Refresh the task instance from the database based on the primary key.
:param task_instance: the task instance
:param session: SQLAlchemy ORM Session
@@ -531,7 +531,7 @@ def _set_duration(*, task_instance: TaskInstance |
TaskInstancePydantic) -> None
def _stats_tags(*, task_instance: TaskInstance | TaskInstancePydantic) ->
dict[str, str]:
"""
- Returns task instance tags.
+ Return task instance tags.
:param task_instance: the task instance
@@ -943,7 +943,7 @@ def _get_previous_dagrun(
session: Session | None = None,
) -> DagRun | None:
"""
- The DagRun that ran before this task instance's DagRun.
+ Return the DagRun that ran prior to this task instance's DagRun.
:param task_instance: the task instance
:param state: If passed, it only take into account instances of a specific
state.
@@ -983,7 +983,7 @@ def _get_previous_execution_date(
session: Session,
) -> pendulum.DateTime | None:
"""
- The execution date from property previous_ti_success.
+ Get execution date from property previous_ti_success.
:param task_instance: the task instance
:param session: SQLAlchemy ORM Session
@@ -1178,7 +1178,7 @@ def _get_previous_ti(
state: DagRunState | None = None,
) -> TaskInstance | TaskInstancePydantic | None:
"""
- The task instance for the task that ran before this task instance.
+ Get task instance for the task that ran before this task instance.
:param task_instance: the task instance
:param state: If passed, it only take into account instances of a specific
state.
@@ -1436,7 +1436,7 @@ class TaskInstance(Base, LoggingMixin):
@try_number.expression
def try_number(cls):
"""
- This is what will be used by SQLAlchemy when filtering on try_number.
+ Return the expression to be used by SQLAlchemy when filtering on
try_number.
This is required because the override in the get_try_number function
causes
try_number values to be off by one when listing tasks in the UI.
diff --git a/airflow/operators/python.py b/airflow/operators/python.py
index 1b1453cc5e..0f005f43b2 100644
--- a/airflow/operators/python.py
+++ b/airflow/operators/python.py
@@ -640,7 +640,7 @@ class
PythonVirtualenvOperator(_BasePythonVirtualenvOperator):
)
def _calculate_cache_hash(self) -> tuple[str, str]:
- """Helper to generate the hash of the cache folder to use.
+ """Generate the hash of the cache folder to use.
The following factors are used as input for the hash:
- (sorted) list of requirements
@@ -666,7 +666,7 @@ class
PythonVirtualenvOperator(_BasePythonVirtualenvOperator):
return requirements_hash[:8], hash_text
def _ensure_venv_cache_exists(self, venv_cache_path: Path) -> Path:
- """Helper to ensure a valid virtual environment is set up and will
create inplace."""
+ """Ensure a valid virtual environment is set up and will create
inplace."""
cache_hash, hash_data = self._calculate_cache_hash()
venv_path = venv_cache_path / f"venv-{cache_hash}"
self.log.info("Python virtual environment will be cached in %s",
venv_path)
diff --git a/airflow/plugins_manager.py b/airflow/plugins_manager.py
index 143e3af570..6514409ef4 100644
--- a/airflow/plugins_manager.py
+++ b/airflow/plugins_manager.py
@@ -171,14 +171,14 @@ class AirflowPlugin:
@classmethod
def validate(cls):
- """Validates that plugin has a name."""
+ """Validate if plugin has a name."""
if not cls.name:
raise AirflowPluginException("Your plugin needs a name.")
@classmethod
def on_load(cls, *args, **kwargs):
"""
- Executed when the plugin is loaded; This method is only called once
during runtime.
+ Execute when the plugin is loaded; This method is only called once
during runtime.
:param args: If future arguments are passed in on call.
:param kwargs: If future arguments are passed in on call.
@@ -296,7 +296,7 @@ def load_providers_plugins():
def make_module(name: str, objects: list[Any]):
- """Creates new module."""
+ """Create new module."""
if not objects:
return None
log.debug("Creating module %s", name)
diff --git a/airflow/providers_manager.py b/airflow/providers_manager.py
index 075473796b..1f1fe397b9 100644
--- a/airflow/providers_manager.py
+++ b/airflow/providers_manager.py
@@ -146,7 +146,7 @@ def _read_schema_from_resources_or_local_file(filename:
str) -> dict:
def _create_provider_info_schema_validator():
- """Creates JSON schema validator from the provider_info.schema.json."""
+ """Create JSON schema validator from the provider_info.schema.json."""
import jsonschema
schema =
_read_schema_from_resources_or_local_file("provider_info.schema.json")
@@ -156,7 +156,7 @@ def _create_provider_info_schema_validator():
def _create_customized_form_field_behaviours_schema_validator():
- """Creates JSON schema validator from the
customized_form_field_behaviours.schema.json."""
+ """Create JSON schema validator from the
customized_form_field_behaviours.schema.json."""
import jsonschema
schema =
_read_schema_from_resources_or_local_file("customized_form_field_behaviours.schema.json")
@@ -305,7 +305,7 @@ def _correctness_check(
provider_package: str, class_name: str, provider_info: ProviderInfo
) -> type[BaseHook] | None:
"""
- Performs coherence check on provider classes.
+ Perform coherence check on provider classes.
For apache-airflow providers - it checks if it starts with appropriate
package. For all providers
it tries to import the provider - checking that there are no exceptions
during importing.
@@ -408,7 +408,7 @@ class ProvidersManager(LoggingMixin, metaclass=Singleton):
return ProvidersManager._initialization_stack_trace
def __init__(self):
- """Initializes the manager."""
+ """Initialize the manager."""
super().__init__()
ProvidersManager._initialized = True
ProvidersManager._initialization_stack_trace =
"".join(traceback.format_stack(inspect.currentframe()))
@@ -445,7 +445,7 @@ class ProvidersManager(LoggingMixin, metaclass=Singleton):
self._init_airflow_core_hooks()
def _init_airflow_core_hooks(self):
- """Initializes the hooks dict with default hooks from Airflow core."""
+ """Initialize the hooks dict with default hooks from Airflow core."""
core_dummy_hooks = {
"generic": "Generic",
"email": "Email",
@@ -563,7 +563,7 @@ class ProvidersManager(LoggingMixin, metaclass=Singleton):
def _initialize_providers_configuration(self):
"""
- Internal method to initialize providers configuration information.
+ Initialize providers configuration information.
Should be used if we do not want to trigger caching for
``initialize_providers_configuration`` method.
In some cases we might want to make sure that the configuration is
initialized, but we do not want
@@ -626,7 +626,7 @@ class ProvidersManager(LoggingMixin, metaclass=Singleton):
def _discover_all_airflow_builtin_providers_from_local_sources(self) ->
None:
"""
- Finds all built-in airflow providers if airflow is run from the local
sources.
+ Find all built-in airflow providers if airflow is run from the local
sources.
It finds `provider.yaml` files for all such providers and registers
the providers using those.
@@ -654,7 +654,7 @@ class ProvidersManager(LoggingMixin, metaclass=Singleton):
def _add_provider_info_from_local_source_files_on_path(self, path) -> None:
"""
- Finds all the provider.yaml files in the directory specified.
+ Find all the provider.yaml files in the directory specified.
:param path: path where to look for provider.yaml files
"""
@@ -672,7 +672,7 @@ class ProvidersManager(LoggingMixin, metaclass=Singleton):
def _add_provider_info_from_local_source_file(self, path, package_name) ->
None:
"""
- Parses found provider.yaml file and adds found provider to the
dictionary.
+ Parse found provider.yaml file and adds found provider to the
dictionary.
:param path: full file path of the provider.yaml file
:param package_name: name of the package
@@ -1069,7 +1069,7 @@ class ProvidersManager(LoggingMixin, metaclass=Singleton):
)
def _discover_auth_managers(self) -> None:
- """Retrieves all auth managers defined in the providers."""
+ """Retrieve all auth managers defined in the providers."""
for provider_package, provider in self._provider_dict.items():
if provider.data.get("auth-managers"):
for auth_manager_class_name in provider.data["auth-managers"]:
@@ -1077,7 +1077,7 @@ class ProvidersManager(LoggingMixin, metaclass=Singleton):
self._auth_manager_class_name_set.add(auth_manager_class_name)
def _discover_notifications(self) -> None:
- """Retrieves all notifications defined in the providers."""
+ """Retrieve all notifications defined in the providers."""
for provider_package, provider in self._provider_dict.items():
if provider.data.get("notifications"):
for notification_class_name in provider.data["notifications"]:
@@ -1085,7 +1085,7 @@ class ProvidersManager(LoggingMixin, metaclass=Singleton):
self._notification_info_set.add(notification_class_name)
def _discover_extra_links(self) -> None:
- """Retrieves all extra links defined in the providers."""
+ """Retrieve all extra links defined in the providers."""
for provider_package, provider in self._provider_dict.items():
if provider.data.get("extra-links"):
for extra_link_class_name in provider.data["extra-links"]:
@@ -1149,7 +1149,7 @@ class ProvidersManager(LoggingMixin, metaclass=Singleton):
@provider_info_cache("triggers")
def initialize_providers_triggers(self):
- """Initialization of providers triggers."""
+ """Initialize providers triggers."""
self.initialize_providers_list()
for provider_package, provider in self._provider_dict.items():
for trigger in provider.data.get("triggers", []):
diff --git a/airflow/serialization/serde.py b/airflow/serialization/serde.py
index a214acc9a6..fd7eb33af7 100644
--- a/airflow/serialization/serde.py
+++ b/airflow/serialization/serde.py
@@ -288,20 +288,20 @@ def _convert(old: dict) -> dict:
def _match(classname: str) -> bool:
- """Checks if the given classname matches a path pattern either using glob
format or regexp format."""
+ """Check if the given classname matches a path pattern either using glob
format or regexp format."""
return _match_glob(classname) or _match_regexp(classname)
@functools.lru_cache(maxsize=None)
def _match_glob(classname: str):
- """Checks if the given classname matches a pattern from
allowed_deserialization_classes using glob syntax."""
+ """Check if the given classname matches a pattern from
allowed_deserialization_classes using glob syntax."""
patterns = _get_patterns()
return any(fnmatch(classname, p.pattern) for p in patterns)
@functools.lru_cache(maxsize=None)
def _match_regexp(classname: str):
- """Checks if the given classname matches a pattern from
allowed_deserialization_classes_regexp using regexp."""
+ """Check if the given classname matches a pattern from
allowed_deserialization_classes_regexp using regexp."""
patterns = _get_regexp_patterns()
return any(p.match(classname) is not None for p in patterns)
diff --git a/airflow/utils/file.py b/airflow/utils/file.py
index 7e15eeb2f8..c66358a10a 100644
--- a/airflow/utils/file.py
+++ b/airflow/utils/file.py
@@ -385,7 +385,7 @@ def iter_airflow_imports(file_path: str) -> Generator[str,
None, None]:
def get_unique_dag_module_name(file_path: str) -> str:
- """Returns a unique module name in the format unusual_prefix_{sha1 of
module's file path}_{original module name}."""
+ """Return a unique module name in the format unusual_prefix_{sha1 of
module's file path}_{original module name}."""
if isinstance(file_path, str):
path_hash = hashlib.sha1(file_path.encode("utf-8")).hexdigest()
org_mod_name = Path(file_path).stem
diff --git a/airflow/utils/log/task_context_logger.py
b/airflow/utils/log/task_context_logger.py
index 84ed207e3a..46e8cf8cee 100644
--- a/airflow/utils/log/task_context_logger.py
+++ b/airflow/utils/log/task_context_logger.py
@@ -65,7 +65,7 @@ class TaskContextLogger:
@staticmethod
def _get_task_handler() -> FileTaskHandler | None:
- """Returns the task handler that supports task context logging."""
+ """Return the task handler that supports task context logging."""
handlers = [
handler
for handler in logging.getLogger("airflow.task").handlers
diff --git a/airflow/utils/sqlalchemy.py b/airflow/utils/sqlalchemy.py
index 2dc495811a..6ce0d00207 100644
--- a/airflow/utils/sqlalchemy.py
+++ b/airflow/utils/sqlalchemy.py
@@ -271,6 +271,8 @@ class ExecutorConfigType(PickleType):
def compare_values(self, x, y):
"""
+ Compare x and y using self.comparator if available. Else, use __eq__.
+
The TaskInstance.executor_config attribute is a pickled object that
may contain kubernetes objects.
If the installed library version has changed since the object was
originally pickled,
diff --git a/airflow/www/auth.py b/airflow/www/auth.py
index a34621d56c..39c8444f99 100644
--- a/airflow/www/auth.py
+++ b/airflow/www/auth.py
@@ -88,7 +88,7 @@ def has_access(permissions: Sequence[tuple[str, str]] | None
= None) -> Callable
def has_access_with_pk(f):
"""
- This decorator is used to check permissions on views.
+ Check permissions on views.
The implementation is very similar from
https://github.com/dpgaspar/Flask-AppBuilder/blob/c6fecdc551629e15467fde5d06b4437379d90592/flask_appbuilder/security/decorators.py#L134
@@ -345,5 +345,5 @@ def has_access_variable(method: ResourceMethod) ->
Callable[[T], T]:
def has_access_view(access_view: AccessView = AccessView.WEBSITE) ->
Callable[[T], T]:
- """Decorator that checks current user's permissions to access the
website."""
+ """Check current user's permissions to access the website."""
return _has_access_no_details(lambda:
get_auth_manager().is_authorized_view(access_view=access_view))
diff --git a/airflow/www/blueprints.py b/airflow/www/blueprints.py
index 0312a9ffa7..fda6b65397 100644
--- a/airflow/www/blueprints.py
+++ b/airflow/www/blueprints.py
@@ -24,5 +24,5 @@ routes = Blueprint("routes", __name__)
@routes.route("/")
def index():
- """Main Airflow page."""
+ """Return main Airflow page."""
return redirect(url_for("Airflow.index"))
diff --git a/airflow/www/views.py b/airflow/www/views.py
index 6e6caeba3c..1625307890 100644
--- a/airflow/www/views.py
+++ b/airflow/www/views.py
@@ -3994,7 +3994,7 @@ class AirflowModelView(ModelView):
@expose("/action_post", methods=["POST"])
def action_post(self):
"""
- Action method to handle multiple records selected from a list view.
+ Handle multiple records selected from a list view.
Same implementation as
https://github.com/dpgaspar/Flask-AppBuilder/blob/2c5763371b81cd679d88b9971ba5d1fc4d71d54b/flask_appbuilder/views.py#L677
diff --git a/pyproject.toml b/pyproject.toml
index 3e56623f6f..94d629db75 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1350,22 +1350,6 @@ combine-as-imports = true
"tests/providers/elasticsearch/log/elasticmock/utilities/__init__.py" =
["E402"]
# All the modules which do not follow D401 yet, please remove as soon as it
becomes compatible
-"airflow/auth/managers/utils/fab.py" = ["D401"]
-"airflow/decorators/bash.py" = ["D401"]
-"airflow/executors/debug_executor.py" = ["D401"]
-"airflow/models/baseoperator.py" = ["D401"]
-"airflow/models/dagrun.py" = ["D401"]
-"airflow/models/taskinstance.py" = ["D401"]
-"airflow/operators/python.py" = ["D401"]
-"airflow/plugins_manager.py" = ["D401"]
-"airflow/providers_manager.py" = ["D401"]
-"airflow/serialization/serde.py" = ["D401"]
-"airflow/utils/log/task_context_logger.py" = ["D401"]
-"airflow/utils/sqlalchemy.py" = ["D401"]
-"airflow/www/auth.py" = ["D401"]
-"airflow/www/blueprints.py" = ["D401"]
-"airflow/www/views.py" = ["D401"]
-"airflow/utils/file.py" = ["D401"]
"airflow/providers/airbyte/hooks/airbyte.py" = ["D401"]
"airflow/providers/airbyte/operators/airbyte.py" = ["D401"]
"airflow/providers/airbyte/sensors/airbyte.py" = ["D401"]
