| 1 |
import re |
| 2 |
from importlib import import_module |
| 3 |
from typing import Any |
| 4 |
|
| 5 |
_identifier_plus_dash = "(?:[a-zA-Z_][a-zA-Z_0-9-]+)" |
| 6 |
_dotted_name = f"(?:(?:{_identifier_plus_dash}\\.)*{_identifier_plus_dash})" |
| 7 |
PYTHON_NAME_PATTERN = re.compile(f"^({_dotted_name}):({_dotted_name})$") |
| 8 |
|
| 9 |
|
| 10 |
def _validate_python_name(name: str) -> str: |
| 11 |
"""Assert that `name` is a valid python name: e.g. `module.submodule:funcname`.""" |
| 12 |
if name and not PYTHON_NAME_PATTERN.match(name): |
| 13 |
msg = ( |
| 14 |
f"{name!r} is not a valid python_name. A python_name must " |
| 15 |
"be of the form '{obj.__module__}:{obj.__qualname__}' (e.g. " |
| 16 |
"'my_package.a_module:some_function')." |
| 17 |
) |
| 18 |
if ".<locals>." in name: # pragma: no cover |
| 19 |
*_, a, b = name.split(".<locals>.") |
| 20 |
a = a.split(":")[-1] |
| 21 |
msg += ( |
| 22 |
" Note: functions defined in local scopes are not yet supported. " |
| 23 |
f"Please move function {b!r} to the global scope of module {a!r}" |
| 24 |
) |
| 25 |
raise ValueError(msg) |
| 26 |
return name |
| 27 |
|
| 28 |
|
| 29 |
def import_python_name(python_name: str) -> Any: |
| 30 |
"""Import object from a fully qualified python name. |
| 31 |
|
| 32 |
Examples |
| 33 |
-------- |
| 34 |
>>> import_python_name("my_package.a_module:some_function") |
| 35 |
<function some_function at 0x...> |
| 36 |
>>> import_python_name("pydantic:BaseModel") |
| 37 |
<class 'pydantic.main.BaseModel'> |
| 38 |
""" |
| 39 |
_validate_python_name(python_name) # shows the best error message |
| 40 |
if match := PYTHON_NAME_PATTERN.match(python_name): |
| 41 |
module_name, funcname = match.groups() |
| 42 |
mod = import_module(module_name) |
| 43 |
return getattr(mod, funcname) |
| 44 |
raise ValueError( # pragma: no cover |
| 45 |
f"Could not parse python_name: {python_name!r}" |
| 46 |
) |