|
| 1 | +use ruff_diagnostics::{Diagnostic, Violation}; |
| 2 | +use ruff_macros::{derive_message_formats, ViolationMetadata}; |
| 3 | +use ruff_python_ast::{Expr, ExprAttribute}; |
| 4 | +use ruff_python_semantic::Modules; |
| 5 | +use ruff_text_size::Ranged; |
| 6 | + |
| 7 | +use crate::checkers::ast::Checker; |
| 8 | + |
| 9 | +#[derive(Debug, Eq, PartialEq)] |
| 10 | +enum Replacement { |
| 11 | + ProviderName { |
| 12 | + name: &'static str, |
| 13 | + provider: &'static str, |
| 14 | + version: &'static str, |
| 15 | + }, |
| 16 | + ImportPathMoved { |
| 17 | + original_path: &'static str, |
| 18 | + new_path: &'static str, |
| 19 | + provider: &'static str, |
| 20 | + version: &'static str, |
| 21 | + }, |
| 22 | +} |
| 23 | + |
| 24 | +/// ## What it does |
| 25 | +/// Checks for uses of Airflow functions and values that have been moved to it providers. |
| 26 | +/// (e.g., apache-airflow-providers-fab) |
| 27 | +/// |
| 28 | +/// ## Why is this bad? |
| 29 | +/// Airflow 3.0 moved various deprecated functions, members, and other |
| 30 | +/// values to its providers. The user needs to install the corresponding provider and replace |
| 31 | +/// the original usage with the one in the provider |
| 32 | +/// |
| 33 | +/// ## Example |
| 34 | +/// ```python |
| 35 | +/// from airflow.auth.managers.fab.fab_auth_manage import FabAuthManager |
| 36 | +/// ``` |
| 37 | +/// |
| 38 | +/// Use instead: |
| 39 | +/// ```python |
| 40 | +/// from airflow.providers.fab.auth_manager.fab_auth_manage import FabAuthManager |
| 41 | +/// ``` |
| 42 | +#[derive(ViolationMetadata)] |
| 43 | +pub(crate) struct Airflow3MovedToProvider { |
| 44 | + deprecated: String, |
| 45 | + replacement: Replacement, |
| 46 | +} |
| 47 | + |
| 48 | +impl Violation for Airflow3MovedToProvider { |
| 49 | + #[derive_message_formats] |
| 50 | + fn message(&self) -> String { |
| 51 | + let Airflow3MovedToProvider { |
| 52 | + deprecated, |
| 53 | + replacement, |
| 54 | + } = self; |
| 55 | + match replacement { |
| 56 | + Replacement::ProviderName { |
| 57 | + name: _, |
| 58 | + provider, |
| 59 | + version: _, |
| 60 | + } => { |
| 61 | + format!("`{deprecated}` is moved into `{provider}` provider in Airflow 3.0;") |
| 62 | + } |
| 63 | + Replacement::ImportPathMoved { |
| 64 | + original_path, |
| 65 | + new_path: _, |
| 66 | + provider, |
| 67 | + version: _, |
| 68 | + } => { |
| 69 | + format!("Import path `{original_path}` is moved into `{provider}` provider in Airflow 3.0;") |
| 70 | + } |
| 71 | + } |
| 72 | + } |
| 73 | + |
| 74 | + fn fix_title(&self) -> Option<String> { |
| 75 | + let Airflow3MovedToProvider { replacement, .. } = self; |
| 76 | + if let Replacement::ProviderName { |
| 77 | + name, |
| 78 | + provider, |
| 79 | + version, |
| 80 | + } = replacement |
| 81 | + { |
| 82 | + Some( |
| 83 | + format!("Install `apache-airflow-provider-{provider}>={version}` and use `{name}` instead.") |
| 84 | + ) |
| 85 | + } else if let Replacement::ImportPathMoved { |
| 86 | + original_path: _, |
| 87 | + new_path, |
| 88 | + provider, |
| 89 | + version, |
| 90 | + } = replacement |
| 91 | + { |
| 92 | + Some(format!("Install `apache-airflow-provider-{provider}>={version}` and import from `{new_path}` instead.")) |
| 93 | + } else { |
| 94 | + None |
| 95 | + } |
| 96 | + } |
| 97 | +} |
| 98 | + |
| 99 | +fn moved_to_provider(checker: &mut Checker, expr: &Expr, ranged: impl Ranged) { |
| 100 | + let result = |
| 101 | + checker |
| 102 | + .semantic() |
| 103 | + .resolve_qualified_name(expr) |
| 104 | + .and_then(|qualname| match qualname.segments() { |
| 105 | + // apache-airflow-providers-fab |
| 106 | + ["airflow", "www", "security", "FabAirflowSecurityManagerOverride"] => Some(( |
| 107 | + qualname.to_string(), |
| 108 | + Replacement::ProviderName { |
| 109 | + name: "airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride", |
| 110 | + provider: "fab", |
| 111 | + version: "1.0.0" |
| 112 | + }, |
| 113 | + )), |
| 114 | + ["airflow","auth","managers","fab","fab_auth_manager", "FabAuthManager"] => Some(( |
| 115 | + qualname.to_string(), |
| 116 | + Replacement::ProviderName{ |
| 117 | + name: "airflow.providers.fab.auth_manager.security_manager.FabAuthManager", |
| 118 | + provider: "fab", |
| 119 | + version: "1.0.0" |
| 120 | + }, |
| 121 | + )), |
| 122 | + ["airflow", "api", "auth", "backend", "basic_auth", ..] => Some(( |
| 123 | + qualname.to_string(), |
| 124 | + Replacement::ImportPathMoved{ |
| 125 | + original_path: "airflow.api.auth.backend.basic_auth", |
| 126 | + new_path: "airflow.providers.fab.auth_manager.api.auth.backend.basic_auth", |
| 127 | + provider:"fab", |
| 128 | + version: "1.0.0" |
| 129 | + }, |
| 130 | + )), |
| 131 | + ["airflow", "api","auth","backend","kerberos_auth", ..] => Some(( |
| 132 | + qualname.to_string(), |
| 133 | + Replacement::ImportPathMoved{ |
| 134 | + original_path:"airflow.api.auth.backend.kerberos_auth", |
| 135 | + new_path: "airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth", |
| 136 | + provider: "fab", |
| 137 | + version:"1.0.0" |
| 138 | + }, |
| 139 | + )), |
| 140 | + ["airflow", "auth", "managers", "fab", "api", "auth", "backend", "kerberos_auth", ..] => Some(( |
| 141 | + qualname.to_string(), |
| 142 | + Replacement::ImportPathMoved{ |
| 143 | + original_path: "airflow.auth_manager.api.auth.backend.kerberos_auth", |
| 144 | + new_path: "airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth", |
| 145 | + provider: "fab", |
| 146 | + version: "1.0.0" |
| 147 | + }, |
| 148 | + )), |
| 149 | + ["airflow","auth","managers","fab","security_manager","override", ..] => Some(( |
| 150 | + qualname.to_string(), |
| 151 | + Replacement::ImportPathMoved{ |
| 152 | + original_path: "airflow.auth.managers.fab.security_manager.override", |
| 153 | + new_path: "airflow.providers.fab.auth_manager.security_manager.override", |
| 154 | + provider: "fab", |
| 155 | + version: "1.0.0" |
| 156 | + }, |
| 157 | + )), |
| 158 | + |
| 159 | + _ => None, |
| 160 | + }); |
| 161 | + if let Some((deprecated, replacement)) = result { |
| 162 | + checker.diagnostics.push(Diagnostic::new( |
| 163 | + Airflow3MovedToProvider { |
| 164 | + deprecated, |
| 165 | + replacement, |
| 166 | + }, |
| 167 | + ranged.range(), |
| 168 | + )); |
| 169 | + } |
| 170 | +} |
| 171 | + |
| 172 | +/// AIR303 |
| 173 | +pub(crate) fn moved_to_provider_in_3(checker: &mut Checker, expr: &Expr) { |
| 174 | + if !checker.semantic().seen_module(Modules::AIRFLOW) { |
| 175 | + return; |
| 176 | + } |
| 177 | + |
| 178 | + match expr { |
| 179 | + Expr::Attribute(ExprAttribute { attr: ranged, .. }) => { |
| 180 | + moved_to_provider(checker, expr, ranged); |
| 181 | + } |
| 182 | + ranged @ Expr::Name(_) => moved_to_provider(checker, expr, ranged), |
| 183 | + _ => {} |
| 184 | + } |
| 185 | +} |
0 commit comments