jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-27 23:27:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve

Browse Source
This commit is contained in:
Robert Resch 2024-07-01 12:57:23 +00:00 committed by GitHub
parent ae1339d1ed
commit 855f79cc72
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 48 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
.grit/patterns/runtime_data_migration.md
View File

@ -6,77 +6,70 @@ tags: [migration, code_quality]
Migrate an integration from hass.data to entry.runtime_data Migrate an integration from hass.data to entry.runtime_data
```grit ```grit
engine marzano(0.1)
language python language python
pattern refactor_functions($config_entry_type) { pattern refactor_functions($config_entry_type, $file_name, $config_entry_type_defined) {
function_definition($parameters, $body) where { function_definition($parameters, $body) as $func where {
// change entry type // change config entry type
$entry = $parameters[1], $parameters <: contains typed_parameter(name=$entry_name, $type) where {
$entry <: typed_parameter(name=$entry_name, $type) where {
$type <: type(type="ConfigEntry"), $type <: type(type="ConfigEntry"),
$type => $config_entry_type, $type => $config_entry_type,
//$config_entry_type <: ensure_import_from(source = `.`), if ($file_name <: not `__init__`) {
}, //$config_entry_type <: ensure_import_from(source = `.`),
// migrate hass.data to entry.runtime_data
$body <: maybe contains assignment($left, right=$runtime_data) as $assignment where {
$runtime_data <: `hass.data[$_][entry.entry_id]`,
$assignment => `$left = $entry_name.runtime_data`
},
}
}
pattern refactor_init($config_entry_type) {
function_definition(name="async_setup_entry", $parameters, $body) as $func where {
// change entry type
$entry = $parameters[1],
$entry <: typed_parameter(name=$entry_name, $type) where {
$type => $config_entry_type
},
// migrate hass.data to entry.runtime_data
$body <: contains or {
`hass.data.setdefault($...)[entry.entry_id]`,
`hass.data[$_][entry.entry_id]`,
} as $runtime_data where {
$runtime_data => `$entry_name.runtime_data`
}, },
},
$config_entry_type_definition = `# TODO: Please add the correct type\n`, if (and {$file_name <: `__init__`, $config_entry_type_defined <: undefined}) {
$config_entry_type_definition += `type $config_entry_type = ConfigEntry`, if ($func <: within decorated_definition() as $decorated) {
$func => `$config_entry_type_definition\n\n$func` // we need to insert the new type before all function decorators
$func = $decorated,
},
$config_entry_type_definition = `# TODO: Please add the correct type\n`,
$config_entry_type_definition += `type $config_entry_type = ConfigEntry`,
$func => `$config_entry_type_definition\n\n$func`,
$config_entry_type_defined = true,
},
// migrate hass.data to entry.runtime_data
$body <: maybe contains assignment($left, $right) as $assignment where {
or {
and {
$right <: `hass.data[$_][entry.entry_id]`,
$assignment => `$left = $entry_name.runtime_data`
},
and {
$left <: or {
`hass.data.setdefault($...)[entry.entry_id]`,
`hass.data[$_][entry.entry_id]`,
} as $runtime_data where {
$runtime_data => `$entry_name.runtime_data`
},
}
}
},
} }
} }
multifile { multifile {
bubble($domain_list) file($name, $body) where { bubble($domain_list) file($name, $body) where {
$name <: includes `__init__.py`, // find all integrations, which can be migrated
$file_parts = split($name, "/"), $filename <: r".*components/([^/]+)/__init__\.py$"($domain),
$components_folder = $file_parts[-3], $body <: contains or {
$components_folder <: includes `components`, // with includes we allow also custom_components `hass.data.setdefault($...)[entry.entry_id]`,
$domain = $file_parts[-2], `hass.data[$_][entry.entry_id]`,
$config_entry_type = capitalize($domain),
$config_entry_type += "ConfigEntry",
$body <: contains and {
refactor_init($config_entry_type),
maybe refactor_functions($config_entry_type),
if ($domain_list <: undefined) {
$domain_list = []
},
$domain_list += $domain
}, },
if ($domain_list <: undefined) {
$domain_list = []
},
$domain_list += $domain,
}, },
bubble($domain_list) file($name, $body) where { bubble($domain_list) file($name, $body) where {
$name <: not includes `__init__.py`, // migrate files
$file_parts = split($name, "/"), $filename <: r".*components/([^/]+)/([^/]+)\.py$"($domain, $file_name),
$components_folder = $file_parts[-3],
$components_folder <: includes `components`, // with includes we allow also custom_components
$domain = $file_parts[-2],
$domain_list <: includes $domain, $domain_list <: includes $domain,
$config_entry_type = capitalize($domain), $config_entry_type = capitalize($domain),
$config_entry_type += "ConfigEntry", $config_entry_type += "ConfigEntry",
$body <: contains refactor_functions($config_entry_type) $body <: contains refactor_functions($config_entry_type, $file_name, $config_entry_type_defined),
} },
} }
``` ```