def_unit#

astropy.units.def_unit(s, represents=None, doc=None, format=None, prefixes=False, exclude_prefixes=[], namespace=None)[源代码]#

定义新单位的工厂函数。

参数:
s : strliststrPYTHON:STR或PYTHON:PYTHON列表:STR

单位名称。如果是列表,第一个元素是规范(短)名称,其余元素是别名。

represents : UnitBase 实例,可选UnitBase实例,可选

此命名单元表示的单元。如果未提供,则 IrreducibleUnit 创建。

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

描述单元的docstring。

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

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

{'latex': r'\Omega'}
prefixes : boollist ,可选Bool或python:列表,可选

什么时候? True ,同时生成该单元的所有SI前缀版本。例如,对于给定的单位 m ,将生成 mmcmkm ,等等。当一个列表时,它是一个前缀定义的列表形式:

(短名称、长表、因子)

默认值为 False 。即使创建了单位的多个缩放版本,此函数也始终返回基本单位对象。

exclude_prefixes : liststr ,可选PYTHON:PYTHON列表:STR,可选

如果需要排除任何SI前缀,可以在此处列出。例如, Pa 可以解释为“petaaniar”或“Pascal”。因此,在定义 aexclude_prefixes 应设置为 ["P"] .

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

当提供时,将单元(及其所有别名和前缀)注入给定的命名空间字典中。

返回:
unitUnitBaseUnitBase

新定义的单元,或已定义的匹配单元。