参考/API#

实用程序函数/类#

astropy.utils.codegen模块#

在运行时生成新Python代码的实用程序。

功能#

make_function_with_signature(func[, args, ...])

从现有函数中生成一个新函数，但具有所需的签名。

astropy.utils.collections模块#

包含专用集合类的模块。

Classes#

HomogeneousList(types[, values])

列表的一个子类，只包含给定类型的元素。

astropy.utils控制台模块#

控制台输入和输出的实用程序。

功能#

`isatty` \(文件)	返回 `True` 如果 `file` 是个tty。
`color_print`(*args[, end])	使用ANSI转义序列将颜色和样式打印到终端。
`human_time` \(秒)	返回一个友好的时间字符串，该字符串的长度始终为6个字符。
`human_file_size` \(尺寸)	返回表示2-4个字符长的文件大小的友好字符串。
`print_code_line`(line[, col, file, tabwidth, ...])	打印一行源代码，突出显示行中的特定字符位置。
`terminal_size`([file])	返回一个包含终端高度和宽度的元组（height，width）。

Classes#

`ProgressBar`(total_or_items[, ...])	在终端中显示进度条的类。
`Spinner`(msg[, color, file, step, chars])	在终端中显示微调器的类。
`ProgressBarOrSpinner`(total, msg[, color, file])	显示 `ProgressBar` 或 `Spinner` 取决于操作的总大小是否已知。

astropy.utils.data_信息模块#

此模块包含与DataInfo类相关的函数和方法，DataInfo类为信息属性和摘要信息方法提供容器。

DataInfo对象附加到astropy中的Quantity、SkyCoord和Time类。在这里，它允许这些类在表中使用，并统一携带表列属性，如名称、格式、数据类型、meta和description。

功能#

`data_info_factory`(names, funcs)	工厂创建可作为 `option` 用于输出数据对象摘要信息。
`dtype_info_name` \(dtype)	返回面向人类的字符串名称 `dtype` 精氨酸

Classes#

`BaseColumnInfo`([bound])	任何可以是astropy表中列的内容的基信息类。
`DataInfo`([bound])	使用数据描述符添加 `info` 用于以统一和可移植的方式存储数据属性的属性。
`MixinInfo`([bound])
`ParentDtypeInfo`([bound])	从父级获取info.dtype的Mixin。

astropy.utils.decorators公司模块#

各种功能和类装饰。

功能#

`deprecated`(since[, message, name, ...])	用于将函数或类标记为已弃用。
`deprecated_attribute`(name, since[, message, ...])	用于将公共属性标记为已弃用。
`deprecated_renamed_argument`(old_name, ...[, ...])	弃用a _renamed_ 或 _removed_ 函数参数。
`format_doc`(docstring, args, *kwargs)	替换装饰对象的docstring，然后格式化它。

Classes#

`classproperty`([fget, doc, lazy])	类似 `property` ，但允许类级属性。
`lazyproperty`(fget[, fset, fdel, doc])	工作方式与property（）类似，但只计算一次该值。
`sharedmethod`	这是一个方法修饰符，它同时允许实例方法和 `classmethod` 共享相同的名字。

astropy.utils.diff模块#

功能#

`diff_values`(a, b[, rtol, atol])	区分两个标量值。
`report_diff_values`(a, b[, fileobj, ...])	将两个值之间的差异报告写入指定的类文件对象。
`where_not_allclose`(a, b[, rtol, atol])	一个版本 `numpy.allclose()` 它返回两个数组不同的索引，而不仅仅是一个布尔值。

astropy.utils.例外模块#

本模块包含astropy的错误/异常和警告。特定于给定子包的异常应该 not 在这里，但在特定的子包装。

Classes#

`AstropyWarning`	所有Astropy警告都应该从中继承的基本警告类。
`AstropyUserWarning`	Astropy 的主要警告等级。
`AstropyDeprecationWarning`	用于指示不推荐使用的功能的警告类。
`AstropyPendingDeprecationWarning`	一个警告类，指示即将被弃用的功能。
`AstropyBackwardsIncompatibleChangeWarning`	一个警告类，指示与以前版本不兼容的astropy更改。
`DuplicateRepresentationWarning`	指示表示名称的警告类已注册。

astropy.utils.iers公司包裹#

Classes#

`Conf` \()	的配置参数 `astropy.utils.iers` .
`IERS`([data, masked, names, dtype, meta, ...])	泛型IERS表类，定义插值函数。
`IERSDegradedAccuracyWarning`	IERS时间转换通常会因设置而降低精度 `conf.auto_download = False` 和 `conf.iers_degraded_accuracy = 'warn'` 。
`IERSRangeError`	当日期超出IERS的有效范围时出现的任何错误。
`IERSStaleWarning`	下载的IERS表可能已过时。
`IERSWarning`	IERS的通用警告类。
`IERS_A`([data, masked, names, dtype, meta, ...])	针对IERS A的IERS表类，由USNO提供。
`IERS_Auto`([data, masked, names, dtype, ...])	提供最新的IERS数据，并根据需要自动处理更新值的下载。
`IERS_B`([data, masked, names, dtype, meta, ...])	针对IERB的IERS表类，由IERS本身提供。
`LeapSeconds`([data, masked, names, dtype, ...])	闰秒类，保持太古标准差。
`earth_orientation_table` \()	地球自转和参考系统服务的默认IERS表。

astropy.utils.自省模块#

与Python运行时自省相关的函数。

功能#

`resolve_name`(name, *additional_parts)	将名称解析为 `module.object` 返回一个对象。
`minversion`(module, version[, inclusive])	返回 `True` 如果指定的Python模块满足最低版本要求，并且 `False` 如果没有。
`find_current_module`([depth, finddiff])	确定从中调用此函数的模块/包。
`isinstancemethod`(cls, obj)	返回 `True` 如果给定对象是定义它的类的实例方法（与 `staticmethod` 或A `classmethod` ）

Asterpy.utils.元数据包#

此模块包含用于处理元数据的帮助函数和类。

功能#

`enable_merge_strategies`(*merge_strategies)	上下文管理器临时启用一个或多个自定义元数据合并策略。
`merge`(left, right[, merge_func, ...])	合并 `left` 和 `right` 元数据对象。
`common_dtype` (ARRS)	使用numpy查找ndarray列表的公共数据类型。

Classes#

`MetaData`([doc, copy, default_factory])	类的描述符 `meta` 财产。
`MetaAttribute`([default])	用于定义存储在对象中的自定义属性的描述符 `meta` dict和可以有一个已定义的默认值。
`MergeStrategyMeta`(name, bases, members)	将MergeStrategy子类注册到MERGEu STRATEGIES注册表的元类。
`MergeStrategy` \()	基类，用于定义将来自左、右两个源的元数据合并到单个输出中的策略。
`MergePlus` \()	合并 `left` 和 `right` 使用加号运算符的对象。
`MergeNpConcatenate` \()	合并 `left` 和 `right` 对象使用np.连接.
`MergeConflictError`
`MergeConflictWarning`

astropy.utils.misc模块#

由相对较小的通用实用程序组成的“抓包”，没有明确的模块/包可供居住。

功能#

`isiterable` \(OBJ)	返回 `True` 如果给定的对象是iterable。
`silence` \()	沉默的上下文管理器系统标准输出以及系统标准.
`format_exception`(msg, args, *kwargs)	填写有关发生的异常的信息。
`find_api_page`(obj[, version, openinbrowser, ...])	确定指定对象的API页的URL，并可选择在web浏览器中打开该页。
`is_path_hidden` \(文件路径)	自 6.0 版本弃用.
`walk_skip_hidden`(top[, onerror, followlinks])	自 6.0 版本弃用.
`indent`(s[, shift, width])	缩进文本块。
`dtype_bytes_or_chars` \(dtype)	解析出数据类型.str值，如“<U5”或“<f8”。

Classes#

`NumpyRNGContext` \(种子)	上下文管理器（用于 `with` 语句）将把numpy随机数生成器（RNG）种子设定为特定值，然后将RNG状态恢复到以前的状态。
`JsonCustomEncoder`(*[, skipkeys, ...])	支持JSON默认编码器不支持的数据类型。

Asterpy.utils.Parsing模块#

用于铺层的包装物，以提供螺纹安全。

功能#

`lex`(lextab, package[, reflags])	从局部变量创建词法分析器。
`yacc`(tabmodule, package)	从局部变量创建解析器。

Classes#

ThreadSafeParser \(解析器)

包装由生成的解析器 ply.yacc.yacc 。

astropy.utils.state模块#

一个管理全球科学状态的简单类。看见添加新配置项了解更多详细信息。

Classes#

ScienceState \()

科学状态子类用于管理可能影响科学结果的全局项。

astropy.utils.shapes模块#

shapedLikardarray mixin类和与形状相关的函数。

功能#

`check_broadcast`(*shapes)	确定是否可以仅基于两个或多个Numpy数组的形状元组相互广播。
`simplify_basic_index`(basic_index, *, shape)	在给定Numpy基本索引的情况下，返回一个整数元组和不带缺省值的切片对象 (`None` )如果可能的话。
`unbroadcast` \(数组)	给定一个数组，返回一个新数组，它是原始数组的最小子集，可以重新广播回原始数组。

Classes#

`NDArrayShapeMethods` \()	提供形状更改方法的Mixin类。
`ShapedLikeNDArray` \()	提供形状更改方法的Mixin类。
`IncompatibleShapeError`(shape_a, shape_a_idx, ...)

文件下载#

astropy.utils数据模块#

用于访问、下载和缓存数据文件的函数。

功能#

`download_file`(remote_url[, cache, ...])	下载一个URL并选择性地缓存结果。
`download_files_in_parallel`(urls[, cache, ...])	从给定的url并行下载多个文件。
`get_readable_fileobj`(name_or_obj[, ...])	从文件或URL生成一个可读的、可查找的类似文件的对象。
`get_pkg_data_fileobj`(data_name[, package, ...])	从包的标准位置检索数据文件，并将该文件作为读取字节的类似文件的对象提供。
`get_pkg_data_filename`(data_name[, package, ...])	从包的标准位置检索数据文件，并提供数据的本地文件名。
`get_pkg_data_contents`(data_name[, package, ...])	从标准位置检索数据文件，并将其内容作为bytes对象返回。
`get_pkg_data_fileobjs`(datadir[, package, ...])	返回给定目录中与给定glob模式匹配的所有数据文件的可读文件对象。
`get_pkg_data_filenames`(datadir[, package, ...])	返回给定目录中与给定glob模式匹配的所有数据文件的路径。
`get_pkg_data_path`(*path[, package])	从包含源的数据目录中获取路径。
`is_url` \(字符串)	字符串对于测试URL是否有效 `download_file()` .
`is_url_in_cache`(url_key[, pkgname])	检查是否下载了 `url_key` 在缓存中。
`get_cached_urls`([pkgname])	获取缓存中的URL列表。
`cache_total_size`([pkgname])	返回缓存中所有文件的总大小（以字节为单位）。
`cache_contents`([pkgname])	获取将缓存的url映射到文件名的dict。
`export_download_cache`(filename_or_obj[, ...])	将缓存内容导出为ZIP文件。
`import_download_cache`(filename_or_obj[, ...])	将ZIP文件的内容导入缓存。
`import_file_to_cache`(url_key, filename[, ...])	将filename指定的磁盘文件导入缓存。
`check_download_cache`([pkgname])	对缓存执行一致性检查。
`clear_download_cache`([hashorurl, pkgname])	通过删除本地文件来清除数据文件缓存。
`compute_hash` \(本地信息)	计算文件的MD5哈希。
`get_free_space_in_dir`(path[, unit])	给定一个目录的路径，返回该文件系统上的可用空间量。
`check_free_space_in_dir`(path, size)	确定给定目录是否有足够的空间来存放给定大小的文件。
`get_file_contents`(args, *kwargs)	检索文件名或类似文件的对象的内容。

Classes#

`Conf` \()	的配置参数 `astropy.utils.data` .
`CacheMissingWarning`	此警告表示标准缓存目录不可访问，第一个参数提供警告消息。
`CacheDamaged`(*args[, bad_urls, bad_files])	记录出现问题的URL或文件。

XML#

这个 astropy.utils.xml.* 模块提供各种 XML 加工工具。

astropy.utils.xml.检查模块#

用于检查各种XML相关字符串是否符合标准的函数集合。

功能#

`check_anyuri` \(URI)	返回 `True` 如果 uri 是RFC 2396中定义的有效URI。
`check_id` \(ID)	返回 `True` 如果 ID 是有效的XML ID。
`check_mime_content_type`(content_type)	返回 `True` 如果 content_type 是一个有效的MIME内容类型（至少在语法上），如rfc2045所定义。
`check_token` \(令牌)	返回 `True` 如果令牌是一个有效的XML标记，如xmlschema第2部分所定义的那样。
`fix_id` \(ID)	给定一个任意字符串，创建一个可用作xml id的字符串。

astropy.utils.xml.iterparser模块#

这个模块包括一个基于快速迭代器的XML解析器。

功能#

`get_xml_iterator`(source[, ...])	返回XML文件元素上的迭代器。
`get_xml_encoding` \(来源)	通过读取XML文件的头来确定XML文件的编码。
`xml_readlines` \(来源)	从给定的XML文件中获取行。

astropy.utils.xml.unescaper模块#

URL unescaper函数。

功能#

unescape_all \(URL)

递归地取消给定URL的转义。

astropy.utils.xml.验证模块#

函数来执行XML模式和DTD验证。此时，这将对xmlint进行子进程调用。如果能找到合适的工具，将来某个时候可以使用基于Python的库。

功能#

validate_schema(filename, schema_file)

根据架构或DTD验证XML文件。

astropy.utils.xml.writer模块#

包含一个类，该类简化了格式良好且缩进良好的XML的流式输出。

Classes#

XMLWriter \(文件)

一个编写格式良好且缩进良好的XML的类。