NamedUnit#

class astropy.units.NamedUnit(st: str | list[str] | tuple[list[str], list[str]], doc: str | None = None, format: Mapping[str, str] | None = None, namespace: MutableMapping[str, object] | None = None)[源代码]#

基类:UnitBase

具有名称的单元的基类。

参数:
st : strliststr ,2-元组PYTHON:字符串,PYTHON:PYTHON列表:STR,2元组

单位名称。如果是字符串列表,第一个元素是规范(短)名称,其余元素是别名。如果是一个列表元组,第一个元素是短名称列表,第二个元素是长名称列表;除了第一个短名称之外,所有元素都被视为“别名”。每个名字 应该 是一个有效的Python标识符,以便于访问,但这不是必需的。

namespace : dict ,可选Python:Dict,可选

当提供时,将单元及其所有别名插入给定的命名空间字典中。如果名称空间中已存在同名的单元,则会引发ValueError。

doc : str ,可选Python:字符串,可选

描述单元的docstring。

format : dict ,可选Python:Dict,可选

用于格式化此单元的特定表示形式的映射。例如,对于 Ohm 单位,最好把它显示为 \Omegalatex 格式化程序。那样的话, format 参数应设置为::

{'latex': r'\Omega'}
加薪:
ValueError

如果任何给定的单元名称已经在注册表中。

ValueError

如果任何给定的单元名不是有效的Python标记。

属性摘要

aliases 

单位的别名(长)名称。

long_names 

与该单元相关的所有长名称。

name 

与单位相关的规范(短)名称。

names 

与该单位相关的所有名称。

short_names 

与该单位相关的所有简短名称。

方法总结

get_format_name \(格式)

属性文档

aliases#

单位的别名(长)名称。

long_names#

与该单元相关的所有长名称。

name#

与单位相关的规范(短)名称。

names#

与该单位相关的所有名称。

short_names#

与该单位相关的所有简短名称。

方法文件

get_format_name(format)[源代码]#

自 7.0 版本弃用: get_form_list函数已被弃用,可能会在未来的版本中删除。 改为使用to_字符串()。

获取此单元特定于特定格式的名称。

使用传递到 format 构造器中的kwarg。

参数:
format : strPython :字符串

格式的名称

返回:
name : strPython :字符串

给定格式的单位名称。