(add comments and docstrings to namespace.py for clarity)

branch-yixin
yixin 7 months ago
parent b4d46a2542
commit eff398104d

@ -16,131 +16,136 @@
# ============================================================================ # ============================================================================
"""Define the namespace of parse.""" """Define the namespace of parse."""
import builtins import builtins # 导入内置模块builtins
from mindspore import log as logger
from mindspore import log as logger # 从mindspore库导入log模块并重命名为logger
class Namespace: class Namespace:
""" """
Base class of namespace for resolve variables. 基类用于解析变量命名空间
Args: Args:
name (str): The namespace's name. name (str): 命名空间的名称
dicts (dict): A list of dict containing the namespace's variable. dicts (dict): 包含命名空间变量的字典列表
""" """
def __init__(self, name, *dicts): def __init__(self, name, *dicts):
self.name = name self.name = name # 初始化命名空间名称
self.dicts = dicts self.dicts = dicts # 初始化包含变量的字典列表
def __contains__(self, name): def __contains__(self, name):
# 检查命名空间中是否包含指定名称的变量
for d in self.dicts: for d in self.dicts:
if name in d: if name in d:
return True return True
return False return False
def __getitem__(self, name): def __getitem__(self, name):
# 获取命名空间中指定名称的变量
for d in self.dicts: for d in self.dicts:
if name in d: if name in d:
return d[name] return d[name]
raise NameError(name) raise NameError(name) # 如果未找到抛出NameError
def __repr__(self): def __repr__(self):
# 返回命名空间的字符串表示
return f'Namespace:{self.name}' return f'Namespace:{self.name}'
class CellNamespace(Namespace): class CellNamespace(Namespace):
""" """
Namespace for Cell object. Cell对象的命名空间
Args: Args:
name (str): Valid module name, it can be imported. name (str): 可导入的有效模块名称
""" """
def __init__(self, name): def __init__(self, name):
mod_dict = vars(__import__(name, fromlist=['_'])) mod_dict = vars(__import__(name, fromlist=['_'])) # 导入模块并获取其变量字典
builtins_dict = vars(builtins) builtins_dict = vars(builtins) # 获取内置模块的变量字典
super().__init__(name, mod_dict, builtins_dict) super().__init__(name, mod_dict, builtins_dict) # 调用父类初始化
def __getstate__(self): def __getstate__(self):
# 获取对象的状态,用于序列化
return (self.name,) return (self.name,)
def __setstate__(self, state): def __setstate__(self, state):
# 设置对象的状态,用于反序列化
name, = state name, = state
mod_dict = vars(__import__(name, fromlist=['_'])) mod_dict = vars(__import__(name, fromlist=['_'])) # 重新导入模块
builtins_dict = vars(builtins) builtins_dict = vars(builtins) # 重新获取内置模块字典
super().__init__(name, mod_dict, builtins_dict) super().__init__(name, mod_dict, builtins_dict) # 重新初始化父类
class ClosureNamespace(Namespace): class ClosureNamespace(Namespace):
""" """
Namespace for function closure. 函数闭包的命名空间
Args: Args:
fn (Function): A python function. fn (Function): 一个Python函数
""" """
def __init__(self, fn): def __init__(self, fn):
name = f'{fn.__module__}..<{fn.__name__}>' name = f'{fn.__module__}..<{fn.__name__}>' # 构造命名空间名称
names = fn.__code__.co_freevars names = fn.__code__.co_freevars # 获取函数的自由变量名称
cells = fn.__closure__ cells = fn.__closure__ # 获取函数的闭包
ns = dict(zip(names, cells or ())) ns = dict(zip(names, cells or ())) # 构造命名空间字典
super().__init__(name, ns) super().__init__(name, ns) # 调用父类初始化
def __getitem__(self, name): def __getitem__(self, name):
# 获取命名空间中指定名称的变量
d, = self.dicts d, = self.dicts
try: try:
return d[name].cell_contents return d[name].cell_contents # 返回闭包内容
except ValueError: except ValueError:
raise UnboundLocalError(name) raise UnboundLocalError(name) # 如果未找到抛出UnboundLocalError
class ClassMemberNamespace(Namespace): class ClassMemberNamespace(Namespace):
""" """
Namespace of a class's closure. 类闭包的命名空间
Args: Args:
obj (Object): A python class object. obj (Object): 一个Python类对象
""" """
def __init__(self, obj): def __init__(self, obj):
self.__class_member_namespace__ = True self.__class_member_namespace__ = True # 标记为类成员命名空间
label = f'{obj.__module__}..<{obj.__class__.__name__}::{id(obj)}>' label = f'{obj.__module__}..<{obj.__class__.__name__}::{id(obj)}>' # 构造命名空间标签
super().__init__(label, obj) super().__init__(label, obj) # 调用父类初始化
def __getitem__(self, name): def __getitem__(self, name):
# 获取命名空间中指定名称的变量
d, = self.dicts d, = self.dicts
if name == "self": if name == "self":
return d return d # 如果名称是self返回对象本身
if name == "namespace": if name == "namespace":
return self return self # 如果名称是namespace返回命名空间对象
try: try:
if hasattr(d, name): if hasattr(d, name):
return getattr(d, name) return getattr(d, name) # 如果对象有该属性,返回属性值
return d.__dict__[name] return d.__dict__[name] # 否则从对象字典中获取
except ValueError: except ValueError:
raise UnboundLocalError(name) raise UnboundLocalError(name) # 如果未找到抛出UnboundLocalError
except KeyError: except KeyError:
logger.info(f"'{d.__class__.__name__ }' object has no attribute or method: '{name}', so will return None.") logger.info(f"'{d.__class__.__name__ }' object has no attribute or method: '{name}', so will return None.")
raise AttributeError(name) raise AttributeError(name) # 如果未找到属性记录日志并抛出AttributeError
class ClassAttrNamespace(Namespace): class ClassAttrNamespace(Namespace):
""" """
Namespace of a class. 类的命名空间
Args: Args:
obj (Object): A python class object. obj (Object): 一个Python类对象
""" """
def __init__(self, obj): def __init__(self, obj):
name = f'{obj.__module__}..<{obj.__class__.__name__}::{id(obj)}>' name = f'{obj.__module__}..<{obj.__class__.__name__}::{id(obj)}>' # 构造命名空间名称
super().__init__(name, obj) super().__init__(name, obj) # 调用父类初始化
def __getattr__(self, name): def __getattr__(self, name):
# 获取命名空间中指定名称的属性
d, = self.dicts d, = self.dicts
try: try:
if hasattr(d, name): if hasattr(d, name):
return getattr(d, name) return getattr(d, name) # 如果对象有该属性,返回属性值
return d.__dict__[name] return d.__dict__[name] # 否则从对象字典中获取
except ValueError: except ValueError:
raise UnboundLocalError(name) raise UnboundLocalError(name) # 如果未找到抛出UnboundLocalError
except KeyError: except KeyError:
logger.info(f"'{d.__class__.__name__ }' object has no attribute or method: '{name}', so will return None.") logger.info(f"'{d.__class__.__name__ }' object has no attribute or method: '{name}', so will return None.")
raise AttributeError(name) raise AttributeError(name) # 如果未找到属性记录日志并抛出AttributeError

Loading…
Cancel
Save