8f937f0417
* half of the way there * add dataclass support * Forbid Computed var shadowing (#3843) * get it right pyright * fix unit tests * rip out more pydantic * fix weird issues with merge_imports * add missing docstring * make special props a list instead of a set * fix moment pyi * actually ignore the runtime error * it's ruff out there --------- Co-authored-by: benedikt-bartscher <31854409+benedikt-bartscher@users.noreply.github.com>
129 lines
3.5 KiB
Python
129 lines
3.5 KiB
Python
"""Import operations."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import dataclasses
|
|
from collections import defaultdict
|
|
from typing import DefaultDict, Dict, List, Optional, Tuple, Union
|
|
|
|
|
|
def merge_imports(
|
|
*imports: ImportDict | ParsedImportDict | ImmutableParsedImportDict,
|
|
) -> ParsedImportDict:
|
|
"""Merge multiple import dicts together.
|
|
|
|
Args:
|
|
*imports: The list of import dicts to merge.
|
|
|
|
Returns:
|
|
The merged import dicts.
|
|
"""
|
|
all_imports: DefaultDict[str, List[ImportVar]] = defaultdict(list)
|
|
for import_dict in imports:
|
|
for lib, fields in (
|
|
import_dict if isinstance(import_dict, tuple) else import_dict.items()
|
|
):
|
|
if isinstance(fields, (list, tuple, set)):
|
|
all_imports[lib].extend(
|
|
(
|
|
ImportVar(field) if isinstance(field, str) else field
|
|
for field in fields
|
|
)
|
|
)
|
|
else:
|
|
all_imports[lib].append(
|
|
ImportVar(fields) if isinstance(fields, str) else fields
|
|
)
|
|
return all_imports
|
|
|
|
|
|
def parse_imports(imports: ImportDict | ParsedImportDict) -> ParsedImportDict:
|
|
"""Parse the import dict into a standard format.
|
|
|
|
Args:
|
|
imports: The import dict to parse.
|
|
|
|
Returns:
|
|
The parsed import dict.
|
|
"""
|
|
|
|
def _make_list(value: ImportTypes) -> list[str | ImportVar] | list[ImportVar]:
|
|
if isinstance(value, (str, ImportVar)):
|
|
return [value]
|
|
return value
|
|
|
|
return {
|
|
package: [
|
|
ImportVar(tag=tag) if isinstance(tag, str) else tag
|
|
for tag in _make_list(maybe_tags)
|
|
]
|
|
for package, maybe_tags in imports.items()
|
|
}
|
|
|
|
|
|
def collapse_imports(
|
|
imports: ParsedImportDict | ImmutableParsedImportDict,
|
|
) -> ParsedImportDict:
|
|
"""Remove all duplicate ImportVar within an ImportDict.
|
|
|
|
Args:
|
|
imports: The import dict to collapse.
|
|
|
|
Returns:
|
|
The collapsed import dict.
|
|
"""
|
|
return {
|
|
lib: (
|
|
list(set(import_vars))
|
|
if isinstance(import_vars, list)
|
|
else list(import_vars)
|
|
)
|
|
for lib, import_vars in (
|
|
imports if isinstance(imports, tuple) else imports.items()
|
|
)
|
|
}
|
|
|
|
|
|
@dataclasses.dataclass(order=True, frozen=True)
|
|
class ImportVar:
|
|
"""An import var."""
|
|
|
|
# The name of the import tag.
|
|
tag: Optional[str]
|
|
|
|
# whether the import is default or named.
|
|
is_default: Optional[bool] = False
|
|
|
|
# The tag alias.
|
|
alias: Optional[str] = None
|
|
|
|
# Whether this import need to install the associated lib
|
|
install: Optional[bool] = True
|
|
|
|
# whether this import should be rendered or not
|
|
render: Optional[bool] = True
|
|
|
|
# whether this import package should be added to transpilePackages in next.config.js
|
|
# https://nextjs.org/docs/app/api-reference/next-config-js/transpilePackages
|
|
transpile: Optional[bool] = False
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
"""The name of the import.
|
|
|
|
Returns:
|
|
The name(tag name with alias) of tag.
|
|
"""
|
|
if self.alias:
|
|
return (
|
|
self.alias if self.is_default else " as ".join([self.tag, self.alias]) # type: ignore
|
|
)
|
|
else:
|
|
return self.tag or ""
|
|
|
|
|
|
ImportTypes = Union[str, ImportVar, List[Union[str, ImportVar]], List[ImportVar]]
|
|
ImportDict = Dict[str, ImportTypes]
|
|
ParsedImportDict = Dict[str, List[ImportVar]]
|
|
ImmutableParsedImportDict = Tuple[Tuple[str, Tuple[ImportVar, ...]], ...]
|